From be5769eb1f7acb73afd32bc222977a864a975442 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Mon, 11 May 2026 18:16:08 -0500 Subject: [PATCH 1/3] docs(graphql): publish 2.4.9 reference and pin 2.4.8 SpectaQL output --- package.json | 2 +- ...nfig_2.4.9-beta-1.yml => config_2.4.8.yml} | 8 +- spectaql/schema.json | 22518 +++++----- ...ma_2.4.9-beta-1.json => schema_2.4.8.json} | 20071 ++++----- src/data/navigation/header.js | 4 +- src/data/navigation/sections/graphql.js | 4 +- src/openapi/admin-schema-2.4.9-beta-1.yaml | 37205 ---------------- src/openapi/customer-schema-2.4.9-beta-1.yaml | 7870 ---- src/openapi/guest-schema-2.4.9-beta-1.yaml | 6073 --- src/pages/graphql/reference/index.md | 2 +- src/pages/reference/graphql/2.4.8/index.md | 2 +- .../graphql/{2.4.9-beta-1 => 2.4.9}/index.md | 4 +- .../{2.4.9-beta-1 => 2.4.8}/index.html | 5703 +-- .../javascripts/spectaql.min.js | 0 .../stylesheets/spectaql.min.css | 0 static/graphql-api/index.html | 7258 ++- 16 files changed, 26073 insertions(+), 80651 deletions(-) rename spectaql/{config_2.4.9-beta-1.yml => config_2.4.8.yml} (99%) rename spectaql/{schema_2.4.9-beta-1.json => schema_2.4.8.json} (98%) delete mode 100644 src/openapi/admin-schema-2.4.9-beta-1.yaml delete mode 100644 src/openapi/customer-schema-2.4.9-beta-1.yaml delete mode 100644 src/openapi/guest-schema-2.4.9-beta-1.yaml rename src/pages/reference/graphql/{2.4.9-beta-1 => 2.4.9}/index.md (61%) rename static/graphql-api/{2.4.9-beta-1 => 2.4.8}/index.html (97%) rename static/graphql-api/{2.4.9-beta-1 => 2.4.8}/javascripts/spectaql.min.js (100%) rename static/graphql-api/{2.4.9-beta-1 => 2.4.8}/stylesheets/spectaql.min.css (100%) diff --git a/package.json b/package.json index 1a68361ef..d086759a2 100644 --- a/package.json +++ b/package.json @@ -40,7 +40,7 @@ "build:spectaql:2.4.6": "spectaql --target-file index.html --config spectaql/config_2.4.6.yml", "build:spectaql:2.4.7": "spectaql --target-file index.html --config spectaql/config_2.4.7.yml", "build:spectaql:saas": "spectaql --target-file index.html --config spectaql/config_saas.yml", - "build:spectaql:beta": "spectaql --target-file index.html --config spectaql/config_2.4.9-beta-1.yml", + "build:spectaql:2.4.8": "spectaql --target-file index.html --config spectaql/config_2.4.8.yml", "dev:spectaql": "spectaql --development-mode-live --config spectaql/config.yml" }, "packageManager": "yarn@3.2.4" diff --git a/spectaql/config_2.4.9-beta-1.yml b/spectaql/config_2.4.8.yml similarity index 99% rename from spectaql/config_2.4.9-beta-1.yml rename to spectaql/config_2.4.8.yml index bd02d3e17..c38990dcd 100644 --- a/spectaql/config_2.4.9-beta-1.yml +++ b/spectaql/config_2.4.8.yml @@ -17,7 +17,7 @@ spectaql: # Set to null to not write the output to the filesystem, making it only available via the API (default: public) # # Default: public - targetDir: static/graphql-api/2.4.9-beta-1 + targetDir: static/graphql-api/2.4.8 # Optional path to an image to use as the logo in the top-left of the output # logoFile: path/to/logo.png @@ -111,7 +111,7 @@ introspection: # schemaFile: path/to/schema.gql # File containing Introspection Query response in JS module export, or JSON format - introspectionFile: spectaql/schema_2.4.9-beta-1.json + introspectionFile: spectaql/schema_2.4.8.json # URL of the GraphQL endpoint to hit if you want to generate the documentation based on live Introspection Query results # NOTE: If not using introspection.url OR servers[], you need to provide x-url below @@ -422,8 +422,8 @@ info: ############################################## description: The Adobe Commerce GraphQL API allows you to quickly and efficiently transfer information between your Commerce store and your storefront. The schema documented here is autogenerated from an instance of Adobe Commerce with B2B. You can find examples of each query and mutation in the main GraphQL documentation. - version: 2.4.9-beta-1 - title: Adobe Commerce GraphQL API (2.4.9-beta-1) + version: 2.4.8 + title: Adobe Commerce GraphQL API (2.4.8) # This is non-standard and optional. If omitted, will use "title". Also only relevant # when building non-embedded. x-htmlTitle: GraphQL API diff --git a/spectaql/schema.json b/spectaql/schema.json index 2afcfb97c..b8003bcd9 100644 --- a/spectaql/schema.json +++ b/spectaql/schema.json @@ -524,6 +524,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "customerGroup", + "description": "Provides Customer Group assigned to the Customer or Guest.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerGroupStorefront", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "customerOrders", "description": null, @@ -548,6 +564,37 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "customerSegments", + "description": "Customer segments associated with the current customer or guest/visitor.", + "args": [ + { + "name": "cartId", + "description": "The unique ID of the cart to query.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerSegmentStorefront", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "dynamicBlocks", "description": "Return a list of dynamic blocks filtered by type, location, or UIDs.", @@ -955,7 +1002,7 @@ "name": null, "ofType": { "kind": "INPUT_OBJECT", - "name": "OrderInformationInput", + "name": "GuestOrderInformationInput", "ofType": null } }, @@ -1878,6 +1925,41 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "addProductsToNewCart", + "description": "Creates a new cart and add any type of product to it", + "args": [ + { + "name": "cartItems", + "description": "An array that defines the products to add to the new cart", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddProductsToNewCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "addProductsToRequisitionList", "description": "Add items to the specified requisition list.", @@ -2608,6 +2690,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "clearWishlist", + "description": "Remove all the products from the specified wish list.", + "args": [ + { + "name": "wishlistId", + "description": "The ID of a wish list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveProductsFromWishlistOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "closeNegotiableQuotes", "description": "Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront.", @@ -2635,6 +2744,29 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "completeOrder", + "description": "Synchronizes order details and place the order", + "args": [ + { + "name": "input", + "description": "Describes the variables needed to complete or place the order", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompleteOrderInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PlaceOrderOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "confirmCancelOrder", "description": "Cancel the specified guest customer order.", @@ -3611,6 +3743,33 @@ "name": "Boolean", "ofType": null }, + "isDeprecated": true, + "deprecationReason": "Use `deleteCustomerAddressV2` instead." + }, + { + "name": "deleteCustomerAddressV2", + "description": "Delete the billing or shipping address of a customer.", + "args": [ + { + "name": "uid", + "description": "The unique ID of the customer address to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, @@ -3918,6 +4077,29 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "exchangeExternalCustomerToken", + "description": "Generate a token for specified customer.", + "args": [ + { + "name": "input", + "description": "Contains details about external customer.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ExchangeExternalCustomerTokenInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ExchangeExternalCustomerTokenOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "generateCustomerToken", "description": "Generate a token for specified customer.", @@ -5251,6 +5433,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "setCartAsInactive", + "description": "Sets the cart as inactive", + "args": [ + { + "name": "cartId", + "description": "The customer cart ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetCartAsInactiveOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "setGiftOptionsOnCart", "description": "Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards.", @@ -5718,33 +5927,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "trackViewedProduct", - "description": "Track that a product was viewed in adobe commerce", - "args": [ - { - "name": "sku", - "description": "The sku for a `ProductInterface` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "updateCartItems", "description": "Modify items in the cart.", @@ -5964,6 +6146,43 @@ "name": "CustomerAddress", "ofType": null }, + "isDeprecated": true, + "deprecationReason": "Use `updateCustomerAddressV2` instead." + }, + { + "name": "updateCustomerAddressV2", + "description": "Update the billing or shipping address of a customer or guest.", + "args": [ + { + "name": "uid", + "description": "The unique ID of the customer address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "An input object that contains changes to the customer address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAddress", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, @@ -9250,6 +9469,11 @@ "kind": "OBJECT", "name": "AttributeSelectedOptions", "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCartAttributeValue", + "ofType": null } ] }, @@ -10779,6 +11003,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "cart_merge_preference", + "description": "Configuration data from checkout/cart/cart_merge_preference", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "cart_printed_card", "description": "Indicates if printed card prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).", @@ -11351,34 +11591,14 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "graphql_share_all_customer_groups", - "description": "Configuration data from customer/account_information/graphql_share_all_customer_groups", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "graphql_share_customer_group", "description": "Configuration data from customer/account_information/graphql_share_customer_group", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "isDeprecated": false, "deprecationReason": null @@ -12280,65 +12500,25 @@ "deprecationReason": null }, { - "name": "share_all_catalog_rules", - "description": "Configuration data from catalog/rule/share_all_catalog_rules", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "share_all_sales_rule", - "description": "Configuration data from promo/graphql/share_all_sales_rule", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "share_applied_catalog_rules", - "description": "Configuration data from catalog/rule/share_applied_catalog_rules", + "name": "share_active_segments", + "description": "Configuration data from customer/magento_customersegment/share_active_segments", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "share_applied_sales_rule", - "description": "Configuration data from promo/graphql/share_applied_sales_rule", + "name": "share_applied_cart_rule", + "description": "Configuration data from promo/graphql/share_applied_cart_rule", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "isDeprecated": false, "deprecationReason": null @@ -13032,255 +13212,314 @@ "possibleTypes": null }, { - "kind": "INTERFACE", - "name": "ProductInterface", - "description": "Contains fields that are common to all types of products.", + "kind": "OBJECT", + "name": "Price", + "description": "Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments.", "fields": [ { - "name": "activity", - "description": null, + "name": "adjustments", + "description": "An array that provides information about tax, weee, or weee_tax adjustments.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceAdjustment", + "ofType": null + } }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "Use `ProductPrice` instead." }, { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", + "name": "amount", + "description": "The price of a product plus a three-letter currency code.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "Money", "ofType": null }, "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, + "deprecationReason": "Use `ProductPrice` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceAdjustment", + "description": "Deprecated. Taxes will be included or excluded in the price. Defines the amount of money to apply as an adjustment, the type of adjustment to apply, and whether the item is included or excluded from the adjustment.", + "fields": [ { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "name": "amount", + "description": "The amount of the price adjustment and its currency code.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "categories", - "description": "The categories assigned to a product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_gear", - "description": null, + "name": "code", + "description": "Indicates whether the adjustment involves tax, weee, or weee_tax.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "ENUM", + "name": "PriceAdjustmentCodesEnum", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "`PriceAdjustment` is deprecated." }, { - "name": "climate", - "description": null, + "name": "description", + "description": "Indicates whether the entity described by the code attribute is included or excluded from the adjustment.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "ENUM", + "name": "PriceAdjustmentDescriptionEnum", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "`PriceAdjustment` is deprecated." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceAdjustmentCodesEnum", + "description": "`PriceAdjustment.code` is deprecated.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TAX", + "description": "", + "isDeprecated": true, + "deprecationReason": "`PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog." }, { - "name": "collar", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "WEEE", + "description": "", "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "WEEE code is deprecated. Use `fixed_product_taxes.label` instead." }, { - "name": "color", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, + "name": "WEEE_TAX", + "description": "", "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog." + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceAdjustmentDescriptionEnum", + "description": "`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INCLUDED", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "name": "country_of_manufacture", - "description": "The product's country of origin.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "EXCLUDED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceTypeEnum", + "description": "Defines the price type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FIXED", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "name": "PERCENT", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "name": "crosssell_products", - "description": "An array of cross-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, + "name": "DYNAMIC", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomizableDateTypeEnum", + "description": "Defines the customizable date type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DATE", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "ofType": null - }, + "name": "DATE_TIME", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", + "name": "TIME", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductPrices", + "description": "Deprecated. Use `PriceRange` instead. Contains the regular price of an item, as well as its minimum and maximum prices. Only composite products, which include bundle, configurable, and grouped products, can contain a minimum and maximum price.", + "fields": [ + { + "name": "maximalPrice", + "description": "The highest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the `to` value.", "args": [], "type": { "kind": "OBJECT", - "name": "ComplexTextValue", + "name": "Price", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `PriceRange.maximum_price` instead." }, { - "name": "eco_collection", - "description": null, + "name": "minimalPrice", + "description": "The lowest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the `from` value.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "Price", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "Use `PriceRange.minimum_price` instead." }, { - "name": "erin_recommends", - "description": null, + "name": "regularPrice", + "description": "The base price of a product.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "Price", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "deprecationReason": "Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRange", + "description": "Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same.", + "fields": [ { - "name": "features_bags", - "description": null, + "name": "maximum_price", + "description": "The highest possible price for the product.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "ProductPrice", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "format", - "description": null, + "name": "minimum_price", + "description": "The lowest possible price for the product.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPrice", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductPrice", + "description": "Represents a product price.", + "fields": [ { - "name": "gender", - "description": null, + "name": "discount", + "description": "The price discount. Represents the difference between the regular and final price.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "ProductDiscount", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "gift_message_available", - "description": "Returns a value indicating gift message availability for the product.", + "name": "final_price", + "description": "The final price of the product after applying discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Boolean", + "kind": "OBJECT", + "name": "Money", "ofType": null } }, @@ -13288,15 +13527,15 @@ "deprecationReason": null }, { - "name": "gift_wrapping_available", - "description": "Returns a value indicating gift wrapping availability for the product.", + "name": "fixed_product_taxes", + "description": "An array of the multiple Fixed Product Taxes that can be applied to a product price.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Boolean", + "kind": "OBJECT", + "name": "FixedProductTax", "ofType": null } }, @@ -13304,44 +13543,70 @@ "deprecationReason": null }, { - "name": "gift_wrapping_price", - "description": "Returns value and currency indicating gift wrapping price for the product.", + "name": "regular_price", + "description": "The regular price of the product.", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductDiscount", + "description": "Contains the discount applied to a product price.", + "fields": [ { - "name": "id", - "description": "The ID number assigned to the product.", + "name": "amount_off", + "description": "The actual value of the discount.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "image", - "description": "The relative path to the main image on the product page.", + "name": "percent_off", + "description": "The discount expressed a percentage.", "args": [], "type": { - "kind": "OBJECT", - "name": "ProductImage", + "kind": "SCALAR", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductLinks", + "description": "An implementation of `ProductLinksInterface`.", + "fields": [ { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", + "name": "link_type", + "description": "One of related, associated, upsell, or crosssell.", "args": [], "type": { "kind": "SCALAR", @@ -13352,26 +13617,363 @@ "deprecationReason": null }, { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", + "name": "linked_product_sku", + "description": "The SKU of the linked product.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "material", - "description": null, - "args": [], + "name": "linked_product_type", + "description": "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The position within the list of product links.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The identifier of the linked product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "description": "Contains information about linked products, including the link type and product type of each item.", + "fields": [ + { + "name": "link_type", + "description": "One of related, associated, upsell, or crosssell.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "linked_product_sku", + "description": "The SKU of the linked product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "linked_product_type", + "description": "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The position within the list of product links.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The identifier of the linked product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ProductLinks", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "ProductInterface", + "description": "Contains fields that are common to all types of products.", + "fields": [ + { + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categories", + "description": "The categories assigned to a product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "color", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the product was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "crosssell_products", + "description": "An array of cross-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributesV2", + "description": "Product custom attributes.", + "args": [ + { + "name": "filters", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID number assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `uid` field instead." + }, + { + "name": "image", + "description": "The relative path to the main image on the product page.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, @@ -13479,18 +14081,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "new", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "new_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", @@ -13539,30 +14129,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "pattern", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "price", "description": "Indicates the price of an item.", @@ -13623,18 +14189,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "purpose", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "quantity", "description": "Amount of available stock", @@ -13732,34 +14286,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "rules", - "description": "Provides applied catalog rules in the current active cart", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CatalogRule", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", @@ -13772,18 +14298,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "size", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", @@ -13796,18 +14310,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", @@ -13884,54 +14386,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "swatch_image", "description": "The file name of a swatch image.", @@ -14130,12 +14584,12 @@ }, { "kind": "OBJECT", - "name": "BundleProduct", + "name": "DownloadableProduct", "ofType": null }, { "kind": "OBJECT", - "name": "DownloadableProduct", + "name": "BundleProduct", "ofType": null }, { @@ -14150,125 +14604,111 @@ } ] }, - { - "kind": "ENUM", - "name": "ProductStockStatus", - "description": "This enumeration states whether a product stock status is in stock or out of stock", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "IN_STOCK", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "OUT_OF_STOCK", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, { "kind": "INTERFACE", - "name": "CartItemInterface", - "description": "An interface for products in a cart.", + "name": "PhysicalProductInterface", + "description": "Contains attributes specific to tangible products.", "fields": [ { - "name": "discount", - "description": "Contains discount for quote line item.", + "name": "weight", + "description": "The weight of the item, in units defined by the store.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SimpleProduct", + "ofType": null }, { - "name": "errors", - "description": "An array of errors encountered while loading the cart item", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartItemError", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null + "kind": "OBJECT", + "name": "ConfigurableProduct", + "ofType": null }, { - "name": "id", - "description": null, + "kind": "OBJECT", + "name": "BundleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GroupedProduct", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CustomizableAreaOption", + "description": "Contains information about a text area that is defined as part of a customizable option.", + "fields": [ + { + "name": "option_id", + "description": "Option ID.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `uid` instead." + "deprecationReason": "Use `uid` instead" }, { - "name": "is_available", - "description": "True if requested quantity is less than available stock, false otherwise.", + "name": "product_sku", + "description": "The Stock Keeping Unit of the base product.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "max_qty", - "description": "Line item max qty in quote template", + "name": "required", + "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "min_qty", - "description": "Line item min qty in quote template", + "name": "sort_order", + "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "not_available_message", - "description": "Message to display when the product is not available with this selected option.", + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", @@ -14279,15 +14719,15 @@ "deprecationReason": null }, { - "name": "note_from_buyer", - "description": "The buyer's quote line item note.", + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "ItemNote", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, @@ -14295,68 +14735,85 @@ "deprecationReason": null }, { - "name": "note_from_seller", - "description": "The seller's quote line item note.", + "name": "value", + "description": "An object that defines a text area.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } + "kind": "OBJECT", + "name": "CustomizableAreaValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableAreaValue", + "description": "Defines the price and sku of a product whose page contains a customized text area.", + "fields": [ + { + "name": "max_characters", + "description": "The maximum number of characters that can be entered for this customizable option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", + "name": "price", + "description": "The price assigned to this option.", "args": [], "type": { - "kind": "OBJECT", - "name": "CartItemPrices", + "kind": "SCALAR", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "product", - "description": "Details about an item in the cart.", + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } + "kind": "ENUM", + "name": "PriceTypeEnum", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "quantity", - "description": "The quantity of this item in the cart.", + "name": "sku", + "description": "The Stock Keeping Unit for this option.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", + "description": "The unique ID for a `CustomizableAreaValue` object.", "args": [], "type": { "kind": "NON_NULL", @@ -14374,50 +14831,31 @@ "inputFields": null, "interfaces": [], "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "SimpleCartItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "VirtualCartItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableCartItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleCartItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "DownloadableCartItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardCartItem", - "ofType": null - } - ] + "possibleTypes": null }, { "kind": "OBJECT", - "name": "CatalogRule", - "description": "", + "name": "CategoryTree", + "description": "Contains the hierarchy of categories.", "fields": [ { - "name": "name", - "description": "Name of the catalog rule", + "name": "automatic_sorting", + "description": null, "args": [], "type": { - "kind": "NON_NULL", + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available_sort_by", + "description": null, + "args": [], + "type": { + "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", @@ -14427,409 +14865,282 @@ }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Price", - "description": "Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments.", - "fields": [ + }, { - "name": "adjustments", - "description": "An array that provides information about tax, weee, or weee_tax adjustments.", + "name": "breadcrumbs", + "description": "An array of breadcrumb items.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "PriceAdjustment", + "name": "Breadcrumb", "ofType": null } }, - "isDeprecated": true, - "deprecationReason": "Use `ProductPrice` instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "amount", - "description": "The price of a product plus a three-letter currency code.", + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `ProductPrice` instead." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PriceAdjustment", - "description": "Deprecated. Taxes will be included or excluded in the price. Defines the amount of money to apply as an adjustment, the type of adjustment to apply, and whether the item is included or excluded from the adjustment.", - "fields": [ + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "amount", - "description": "The amount of the price adjustment and its currency code.", + "name": "children", + "description": "A tree of child categories.", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryTree", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "code", - "description": "Indicates whether the adjustment involves tax, weee, or weee_tax.", + "name": "children_count", + "description": null, "args": [], "type": { - "kind": "ENUM", - "name": "PriceAdjustmentCodesEnum", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "`PriceAdjustment` is deprecated." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "description", - "description": "Indicates whether the entity described by the code attribute is included or excluded from the adjustment.", + "name": "cms_block", + "description": "Contains a category CMS block.", "args": [], "type": { - "kind": "ENUM", - "name": "PriceAdjustmentDescriptionEnum", + "kind": "OBJECT", + "name": "CmsBlock", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "`PriceAdjustment` is deprecated." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PriceAdjustmentCodesEnum", - "description": "`PriceAdjustment.code` is deprecated.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "TAX", - "description": "", - "isDeprecated": true, - "deprecationReason": "`PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "WEEE", - "description": "", + "name": "created_at", + "description": "The timestamp indicating when the category was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, "isDeprecated": true, - "deprecationReason": "WEEE code is deprecated. Use `fixed_product_taxes.label` instead." + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "WEEE_TAX", - "description": "", - "isDeprecated": true, - "deprecationReason": "Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog." - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PriceAdjustmentDescriptionEnum", - "description": "`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "INCLUDED", - "description": "", + "name": "custom_layout_update_file", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "EXCLUDED", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PriceTypeEnum", - "description": "Defines the price type.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "FIXED", - "description": "", + "name": "default_sort_by", + "description": "The attribute to use for sorting.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "PERCENT", - "description": "", + "name": "description", + "description": "An optional description of the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "DYNAMIC", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CustomizableDateTypeEnum", - "description": "Defines the customizable date type.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "DATE", - "description": "", + "name": "display_mode", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "DATE_TIME", - "description": "", + "name": "filter_price_range", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "TIME", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductPrices", - "description": "Deprecated. Use `PriceRange` instead. Contains the regular price of an item, as well as its minimum and maximum prices. Only composite products, which include bundle, configurable, and grouped products, can contain a minimum and maximum price.", - "fields": [ - { - "name": "maximalPrice", - "description": "The highest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the `to` value.", + "name": "id", + "description": "An ID that uniquely identifies the category.", "args": [], "type": { - "kind": "OBJECT", - "name": "Price", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `PriceRange.maximum_price` instead." + "deprecationReason": "Use `uid` instead." }, { - "name": "minimalPrice", - "description": "The lowest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the `from` value.", + "name": "image", + "description": null, "args": [], "type": { - "kind": "OBJECT", - "name": "Price", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `PriceRange.minimum_price` instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "regularPrice", - "description": "The base price of a product.", + "name": "include_in_menu", + "description": null, "args": [], "type": { - "kind": "OBJECT", - "name": "Price", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PriceRange", - "description": "Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same.", - "fields": [ + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "maximum_price", - "description": "The highest possible price for the product.", + "name": "is_anchor", + "description": null, "args": [], "type": { - "kind": "OBJECT", - "name": "ProductPrice", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "minimum_price", - "description": "The lowest possible price for the product.", + "name": "landing_page", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductPrice", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductPrice", - "description": "Represents a product price.", - "fields": [ + }, { - "name": "discount", - "description": "The price discount. Represents the difference between the regular and final price.", + "name": "level", + "description": "The depth of the category within the tree.", "args": [], "type": { - "kind": "OBJECT", - "name": "ProductDiscount", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "final_price", - "description": "The final price of the product after applying discounts.", + "name": "meta_description", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "fixed_product_taxes", - "description": "An array of the multiple Fixed Product Taxes that can be applied to a product price.", + "name": "meta_keywords", + "description": null, "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "FixedProductTax", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "regular_price", - "description": "The regular price of the product.", + "name": "meta_title", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductDiscount", - "description": "Contains the discount applied to a product price.", - "fields": [ + }, { - "name": "amount_off", - "description": "The actual value of the discount.", + "name": "name", + "description": "The display name of the category.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "percent_off", - "description": "The discount expressed a percentage.", + "name": "path", + "description": "The full category path.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductLinks", - "description": "An implementation of `ProductLinksInterface`.", - "fields": [ + }, { - "name": "link_type", - "description": "One of related, associated, upsell, or crosssell.", + "name": "path_in_store", + "description": "The category path within the store.", "args": [], "type": { "kind": "SCALAR", @@ -14840,44 +15151,91 @@ "deprecationReason": null }, { - "name": "linked_product_sku", - "description": "The SKU of the linked product.", + "name": "position", + "description": "The position of the category relative to other categories at the same level in tree.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "linked_product_type", - "description": "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).", + "name": "product_count", + "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "position", - "description": "The position within the list of product links.", - "args": [], + "name": "products", + "description": "The list of products assigned to the category.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "sort", + "description": "The attributes to sort on, and whether to return the results in ascending or descending order.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ProductAttributeSortInput", + "ofType": null + }, + "defaultValue": null + } + ], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "CategoryProducts", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The identifier of the linked product.", + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", "args": [], "type": { "kind": "SCALAR", @@ -14886,51 +15244,66 @@ }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ + }, { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "description": "Contains information about linked products, including the link type and product type of each item.", - "fields": [ + "name": "staged", + "description": "Indicates whether the category is staged for a future campaign.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "link_type", - "description": "One of related, associated, upsell, or crosssell.", + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "linked_product_sku", - "description": "The SKU of the linked product.", + "name": "uid", + "description": "The unique ID for a `CategoryInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "The timestamp indicating when the category was updated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "linked_product_type", - "description": "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).", + "name": "url_key", + "description": "The URL key assigned to the category.", "args": [], "type": { "kind": "SCALAR", @@ -14941,20 +15314,20 @@ "deprecationReason": null }, { - "name": "position", - "description": "The position within the list of product links.", + "name": "url_path", + "description": "The URL path assigned to the category.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The identifier of the linked product.", + "name": "url_suffix", + "description": "The part of the category URL that is appended after the url key", "args": [], "type": { "kind": "SCALAR", @@ -14966,28 +15339,61 @@ } ], "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ + "interfaces": [ { - "kind": "OBJECT", - "name": "ProductLinks", + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", "ofType": null } - ] + ], + "enumValues": null, + "possibleTypes": null }, { - "kind": "INTERFACE", - "name": "PhysicalProductInterface", - "description": "Contains attributes specific to tangible products.", + "kind": "OBJECT", + "name": "CategoryResult", + "description": "Contains a collection of `CategoryTree` objects and pagination information.", "fields": [ { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", + "name": "items", + "description": "A list of categories that match the filter criteria.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryTree", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "An object that includes the `page_info` and `currentPage` values specified in the query.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The total number of categories that match the criteria.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Int", "ofType": null }, "isDeprecated": false, @@ -14997,38 +15403,12 @@ "inputFields": null, "interfaces": [], "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "SimpleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GroupedProduct", - "ofType": null - } - ] + "possibleTypes": null }, { "kind": "OBJECT", - "name": "CustomizableAreaOption", - "description": "Contains information about a text area that is defined as part of a customizable option.", + "name": "CustomizableDateOption", + "description": "Contains information about a date picker that is defined as part of a customizable option.", "fields": [ { "name": "option_id", @@ -15108,11 +15488,11 @@ }, { "name": "value", - "description": "An object that defines a text area.", + "description": "An object that defines a date field in a customizable option.", "args": [], "type": { "kind": "OBJECT", - "name": "CustomizableAreaValue", + "name": "CustomizableDateValue", "ofType": null }, "isDeprecated": false, @@ -15132,21 +15512,9 @@ }, { "kind": "OBJECT", - "name": "CustomizableAreaValue", - "description": "Defines the price and sku of a product whose page contains a customized text area.", + "name": "CustomizableDateValue", + "description": "Defines the price and sku of a product whose page contains a customized date picker.", "fields": [ - { - "name": "max_characters", - "description": "The maximum number of characters that can be entered for this customizable option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "price", "description": "The price assigned to this option.", @@ -15183,9 +15551,21 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "type", + "description": "DATE, DATE_TIME or TIME", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomizableDateTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "uid", - "description": "The unique ID for a `CustomizableAreaValue` object.", + "description": "The unique ID for a `CustomizableDateValue` object.", "args": [], "type": { "kind": "NON_NULL", @@ -15207,56 +15587,48 @@ }, { "kind": "OBJECT", - "name": "CategoryTree", - "description": "Contains the hierarchy of categories.", + "name": "CustomizableDropDownOption", + "description": "Contains information about a drop down menu that is defined as part of a customizable option.", "fields": [ { - "name": "automatic_sorting", - "description": null, + "name": "option_id", + "description": "Option ID.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" }, { - "name": "available_sort_by", - "description": null, + "name": "required", + "description": "Indicates whether the option is required.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "breadcrumbs", - "description": "An array of breadcrumb items.", + "name": "sort_order", + "description": "The order in which the option is displayed.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Breadcrumb", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.", + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", @@ -15267,96 +15639,93 @@ "deprecationReason": null }, { - "name": "children", - "description": "A tree of child categories.", + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "An array that defines the set of options for a drop down menu.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "CategoryTree", + "name": "CustomizableDropDownValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [ { - "name": "children_count", - "description": null, + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableDropDownValue", + "description": "Defines the price and sku of a product whose page contains a customized drop down menu.", + "fields": [ + { + "name": "option_type_id", + "description": "The ID assigned to the value.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "cms_block", - "description": "Contains a category CMS block.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CmsBlock", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "The timestamp indicating when the category was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "custom_layout_update_file", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_sort_by", - "description": "The attribute to use for sorting.", + "name": "price", + "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "description", - "description": "An optional description of the category.", + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "ENUM", + "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "display_mode", - "description": null, + "name": "sku", + "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", @@ -15367,32 +15736,20 @@ "deprecationReason": null }, { - "name": "filter_price_range", - "description": null, + "name": "sort_order", + "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "An ID that uniquely identifies the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "image", - "description": null, + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", @@ -15403,44 +15760,59 @@ "deprecationReason": null }, { - "name": "include_in_menu", - "description": null, + "name": "uid", + "description": "The unique ID for a `CustomizableDropDownValue` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableMultipleOption", + "description": "Contains information about a multiselect that is defined as part of a customizable option.", + "fields": [ { - "name": "is_anchor", - "description": null, + "name": "option_id", + "description": "Option ID.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" }, { - "name": "landing_page", - "description": null, + "name": "required", + "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "level", - "description": "The depth of the category within the tree.", + "name": "sort_order", + "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", @@ -15451,68 +15823,8 @@ "deprecationReason": null }, { - "name": "meta_description", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_keywords", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_title", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The display name of the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "path", - "description": "The full category path.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "path_in_store", - "description": "The category path within the store.", + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", @@ -15523,82 +15835,15 @@ "deprecationReason": null }, { - "name": "position", - "description": "The position of the category relative to other categories at the same level in tree.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_count", - "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "products", - "description": "The list of products assigned to the category.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "sort", - "description": "The attributes to sort on, and whether to return the results in ascending or descending order.", - "type": { - "kind": "INPUT_OBJECT", - "name": "ProductAttributeSortInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CategoryProducts", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Int", + "name": "ID", "ofType": null } }, @@ -15606,76 +15851,77 @@ "deprecationReason": null }, { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "staged", - "description": "Indicates whether the category is staged for a future campaign.", + "name": "value", + "description": "An array that defines the set of options for a multiselect.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Boolean", + "kind": "OBJECT", + "name": "CustomizableMultipleValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [ { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableMultipleValue", + "description": "Defines the price and sku of a product whose page contains a customized multiselect.", + "fields": [ + { + "name": "option_type_id", + "description": "The ID assigned to the value.", "args": [], "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CategoryInterface` object.", + "name": "price", + "description": "The price assigned to this option.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "updated_at", - "description": "The timestamp indicating when the category was updated.", + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "ENUM", + "name": "PriceTypeEnum", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "url_key", - "description": "The URL key assigned to the category.", + "name": "sku", + "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", @@ -15686,20 +15932,20 @@ "deprecationReason": null }, { - "name": "url_path", - "description": "The URL path assigned to the category.", + "name": "sort_order", + "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "url_suffix", - "description": "The part of the category URL that is appended after the url key", + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", @@ -15708,68 +15954,22 @@ }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CategoryInterface", - "ofType": null }, { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CategoryResult", - "description": "Contains a collection of `CategoryTree` objects and pagination information.", - "fields": [ - { - "name": "items", - "description": "A list of categories that match the filter criteria.", + "name": "uid", + "description": "The unique ID for a `CustomizableMultipleValue` object.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "CategoryTree", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, - { - "name": "page_info", - "description": "An object that includes the `page_info` and `currentPage` values specified in the query.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The total number of categories that match the criteria.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null } ], "inputFields": null, @@ -15779,8 +15979,8 @@ }, { "kind": "OBJECT", - "name": "CustomizableDateOption", - "description": "Contains information about a date picker that is defined as part of a customizable option.", + "name": "CustomizableFieldOption", + "description": "Contains information about a text field that is defined as part of a customizable option.", "fields": [ { "name": "option_id", @@ -15860,11 +16060,11 @@ }, { "name": "value", - "description": "An object that defines a date field in a customizable option.", + "description": "An object that defines a text field.", "args": [], "type": { "kind": "OBJECT", - "name": "CustomizableDateValue", + "name": "CustomizableFieldValue", "ofType": null }, "isDeprecated": false, @@ -15884,12 +16084,24 @@ }, { "kind": "OBJECT", - "name": "CustomizableDateValue", - "description": "Defines the price and sku of a product whose page contains a customized date picker.", + "name": "CustomizableFieldValue", + "description": "Defines the price and sku of a product whose page contains a customized text field.", "fields": [ + { + "name": "max_characters", + "description": "The maximum number of characters that can be entered for this customizable option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "price", - "description": "The price assigned to this option.", + "description": "The price of the custom value.", "args": [], "type": { "kind": "SCALAR", @@ -15923,21 +16135,9 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "type", - "description": "DATE, DATE_TIME or TIME", - "args": [], - "type": { - "kind": "ENUM", - "name": "CustomizableDateTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "uid", - "description": "The unique ID for a `CustomizableDateValue` object.", + "description": "The unique ID for a `CustomizableFieldValue` object.", "args": [], "type": { "kind": "NON_NULL", @@ -15959,8 +16159,8 @@ }, { "kind": "OBJECT", - "name": "CustomizableDropDownOption", - "description": "Contains information about a drop down menu that is defined as part of a customizable option.", + "name": "CustomizableFileOption", + "description": "Contains information about a file picker that is defined as part of a customizable option.", "fields": [ { "name": "option_id", @@ -15974,6 +16174,18 @@ "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, + { + "name": "product_sku", + "description": "The Stock Keeping Unit of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "required", "description": "Indicates whether the option is required.", @@ -16028,16 +16240,12 @@ }, { "name": "value", - "description": "An array that defines the set of options for a drop down menu.", + "description": "An object that defines a file value.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomizableDropDownValue", - "ofType": null - } + "kind": "OBJECT", + "name": "CustomizableFileValue", + "ofType": null }, "isDeprecated": false, "deprecationReason": null @@ -16056,72 +16264,72 @@ }, { "kind": "OBJECT", - "name": "CustomizableDropDownValue", - "description": "Defines the price and sku of a product whose page contains a customized drop down menu.", + "name": "CustomizableFileValue", + "description": "Defines the price and sku of a product whose page contains a customized file picker.", "fields": [ { - "name": "option_type_id", - "description": "The ID assigned to the value.", + "name": "file_extension", + "description": "The file extension to accept.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price", - "description": "The price assigned to this option.", + "name": "image_size_x", + "description": "The maximum width of an image.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", + "name": "image_size_y", + "description": "The maximum height of an image.", "args": [], "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", + "name": "price", + "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the option is displayed.", + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "ENUM", + "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "sku", + "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", @@ -16133,7 +16341,7 @@ }, { "name": "uid", - "description": "The unique ID for a `CustomizableDropDownValue` object.", + "description": "The unique ID for a `CustomizableFileValue` object.", "args": [], "type": { "kind": "NON_NULL", @@ -16154,25 +16362,13 @@ "possibleTypes": null }, { - "kind": "OBJECT", - "name": "CustomizableMultipleOption", - "description": "Contains information about a multiselect that is defined as part of a customizable option.", + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "description": "Contains basic information about a product image or video.", "fields": [ { - "name": "option_id", - "description": "Option ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "required", - "description": "Indicates whether the option is required.", + "name": "disabled", + "description": "Indicates whether the image is hidden from view.", "args": [], "type": { "kind": "SCALAR", @@ -16183,39 +16379,39 @@ "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the option is displayed.", + "name": "label", + "description": "The label of the product image or video.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "position", + "description": "The media item's position after it has been sorted.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", + "name": "types", + "description": "Array of image types. It can have the following values: image, small_image, thumbnail.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, @@ -16223,77 +16419,94 @@ "deprecationReason": null }, { - "name": "value", - "description": "An array that defines the set of options for a multiselect.", + "name": "url", + "description": "The URL of the product image or video.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomizableMultipleValue", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, - "interfaces": [ + "interfaces": [], + "enumValues": null, + "possibleTypes": [ { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVideo", "ofType": null } - ], - "enumValues": null, - "possibleTypes": null + ] }, { "kind": "OBJECT", - "name": "CustomizableMultipleValue", - "description": "Defines the price and sku of a product whose page contains a customized multiselect.", + "name": "ProductImage", + "description": "Contains product image information, including the image URL and label.", "fields": [ { - "name": "option_type_id", - "description": "The ID assigned to the value.", + "name": "disabled", + "description": "Indicates whether the image is hidden from view.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price", - "description": "The price assigned to this option.", + "name": "label", + "description": "The label of the product image or video.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", + "name": "position", + "description": "The media item's position after it has been sorted.", "args": [], "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", + "name": "types", + "description": "Array of image types. It can have the following values: image, small_image, thumbnail.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL of the product image or video.", "args": [], "type": { "kind": "SCALAR", @@ -16302,22 +16515,39 @@ }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [ { - "name": "sort_order", - "description": "The order in which the option is displayed.", + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVideo", + "description": "Contains information about a product video.", + "fields": [ + { + "name": "disabled", + "description": "Indicates whether the image is hidden from view.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "label", + "description": "The label of the product image or video.", "args": [], "type": { "kind": "SCALAR", @@ -16328,31 +16558,73 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableMultipleValue` object.", + "name": "position", + "description": "The media item's position after it has been sorted.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "types", + "description": "Array of image types. It can have the following values: image, small_image, thumbnail.", + "args": [], + "type": { + "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "url", + "description": "The URL of the product image or video.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "video_content", + "description": "Contains a `ProductMediaGalleryEntriesVideoContent` object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductMediaGalleryEntriesVideoContent", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, - "interfaces": [], + "interfaces": [ + { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } + ], "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "CustomizableFieldOption", - "description": "Contains information about a text field that is defined as part of a customizable option.", + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "description": "Contains basic information about a customizable option. It can be implemented by several types of configurable options.", "fields": [ { "name": "option_id", @@ -16366,18 +16638,6 @@ "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, - { - "name": "product_sku", - "description": "The Stock Keeping Unit of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "required", "description": "Indicates whether the option is required.", @@ -16429,75 +16689,176 @@ }, "isDeprecated": false, "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CustomizableAreaOption", + "ofType": null }, { - "name": "value", - "description": "An object that defines a text field.", + "kind": "OBJECT", + "name": "CustomizableDateOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableDropDownOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableMultipleOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableFieldOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableFileOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableRadioOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableCheckboxOption", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "CustomizableProductInterface", + "description": "Contains information about customizable product options.", + "fields": [ + { + "name": "options", + "description": "An array of options for a customizable product.", "args": [], "type": { - "kind": "OBJECT", - "name": "CustomizableFieldValue", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, - "interfaces": [ + "interfaces": [], + "enumValues": null, + "possibleTypes": [ { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", + "kind": "OBJECT", + "name": "VirtualProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SimpleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DownloadableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardProduct", "ofType": null } - ], - "enumValues": null, - "possibleTypes": null + ] }, { - "kind": "OBJECT", - "name": "CustomizableFieldValue", - "description": "Defines the price and sku of a product whose page contains a customized text field.", + "kind": "INTERFACE", + "name": "CategoryInterface", + "description": "Contains the full set of attributes that can be returned in a category search.", "fields": [ { - "name": "max_characters", - "description": "The maximum number of characters that can be entered for this customizable option.", + "name": "automatic_sorting", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price", - "description": "The price of the custom value.", + "name": "available_sort_by", + "description": null, "args": [], "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", + "name": "breadcrumbs", + "description": "An array of breadcrumb items.", "args": [], "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Breadcrumb", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", + "name": "children_count", + "description": null, "args": [], "type": { "kind": "SCALAR", @@ -16508,47 +16869,32 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableFieldValue` object.", + "name": "cms_block", + "description": "Contains a category CMS block.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "OBJECT", + "name": "CmsBlock", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableFileOption", - "description": "Contains information about a file picker that is defined as part of a customizable option.", - "fields": [ + }, { - "name": "option_id", - "description": "Option ID.", + "name": "created_at", + "description": "The timestamp indicating when the category was created.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `uid` instead" + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "product_sku", - "description": "The Stock Keeping Unit of the base product.", + "name": "custom_layout_update_file", + "description": null, "args": [], "type": { "kind": "SCALAR", @@ -16559,32 +16905,32 @@ "deprecationReason": null }, { - "name": "required", - "description": "Indicates whether the option is required.", + "name": "default_sort_by", + "description": "The attribute to use for sorting.", "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the option is displayed.", + "name": "description", + "description": "An optional description of the category.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "display_mode", + "description": null, "args": [], "type": { "kind": "SCALAR", @@ -16595,53 +16941,32 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", + "name": "filter_price_range", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "value", - "description": "An object that defines a file value.", + "name": "id", + "description": "An ID that uniquely identifies the category.", "args": [], "type": { - "kind": "OBJECT", - "name": "CustomizableFileValue", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableFileValue", - "description": "Defines the price and sku of a product whose page contains a customized file picker.", - "fields": [ + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, { - "name": "file_extension", - "description": "The file extension to accept.", + "name": "image", + "description": null, "args": [], "type": { "kind": "SCALAR", @@ -16652,8 +16977,8 @@ "deprecationReason": null }, { - "name": "image_size_x", - "description": "The maximum width of an image.", + "name": "include_in_menu", + "description": null, "args": [], "type": { "kind": "SCALAR", @@ -16664,8 +16989,8 @@ "deprecationReason": null }, { - "name": "image_size_y", - "description": "The maximum height of an image.", + "name": "is_anchor", + "description": null, "args": [], "type": { "kind": "SCALAR", @@ -16676,32 +17001,32 @@ "deprecationReason": null }, { - "name": "price", - "description": "The price assigned to this option.", + "name": "landing_page", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", + "name": "level", + "description": "The depth of the category within the tree.", "args": [], "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", + "name": "meta_description", + "description": null, "args": [], "type": { "kind": "SCALAR", @@ -16712,47 +17037,32 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableFileValue` object.", + "name": "meta_keywords", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "description": "Contains basic information about a product image or video.", - "fields": [ + }, { - "name": "disabled", - "description": "Indicates whether the image is hidden from view.", + "name": "meta_title", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "label", - "description": "The label of the product image or video.", + "name": "name", + "description": "The display name of the category.", "args": [], "type": { "kind": "SCALAR", @@ -16763,20 +17073,20 @@ "deprecationReason": null }, { - "name": "position", - "description": "The media item's position after it has been sorted.", + "name": "path", + "description": "The full category path.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "url", - "description": "The URL of the product image or video.", + "name": "path_in_store", + "description": "The category path within the store.", "args": [], "type": { "kind": "SCALAR", @@ -16785,44 +17095,121 @@ }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null }, { - "kind": "OBJECT", - "name": "ProductVideo", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "ProductImage", - "description": "Contains product image information, including the image URL and label.", - "fields": [ + "name": "position", + "description": "The position of the category relative to other categories at the same level in tree.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "disabled", - "description": "Indicates whether the image is hidden from view.", + "name": "product_count", + "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "label", - "description": "The label of the product image or video.", + "name": "products", + "description": "The list of products assigned to the category.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "sort", + "description": "The attributes to sort on, and whether to return the results in ascending or descending order.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ProductAttributeSortInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CategoryProducts", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staged", + "description": "Indicates whether the category is staged for a future campaign.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CategoryInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "The timestamp indicating when the category was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "url_key", + "description": "The URL key assigned to the category.", "args": [], "type": { "kind": "SCALAR", @@ -16833,20 +17220,20 @@ "deprecationReason": null }, { - "name": "position", - "description": "The media item's position after it has been sorted.", + "name": "url_path", + "description": "The URL path assigned to the category.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "url", - "description": "The URL of the product image or video.", + "name": "url_suffix", + "description": "The part of the category URL that is appended after the url key", "args": [], "type": { "kind": "SCALAR", @@ -16858,36 +17245,48 @@ } ], "inputFields": null, - "interfaces": [ + "interfaces": [], + "enumValues": null, + "possibleTypes": [ { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", + "kind": "OBJECT", + "name": "CategoryTree", "ofType": null } - ], - "enumValues": null, - "possibleTypes": null + ] }, { "kind": "OBJECT", - "name": "ProductVideo", - "description": "Contains information about a product video.", + "name": "Breadcrumb", + "description": "Contains details about an individual category that comprises a breadcrumb.", "fields": [ { - "name": "disabled", - "description": "Indicates whether the image is hidden from view.", + "name": "category_id", + "description": "The ID of the category.", "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `category_uid` instead." + }, + { + "name": "category_level", + "description": "The category level.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "label", - "description": "The label of the product image or video.", + "name": "category_name", + "description": "The display name of the category.", "args": [], "type": { "kind": "SCALAR", @@ -16898,20 +17297,24 @@ "deprecationReason": null }, { - "name": "position", - "description": "The media item's position after it has been sorted.", + "name": "category_uid", + "description": "The unique ID for a `Breadcrumb` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "url", - "description": "The URL of the product image or video.", + "name": "category_url_key", + "description": "The URL key of the category.", "args": [], "type": { "kind": "SCALAR", @@ -16922,12 +17325,12 @@ "deprecationReason": null }, { - "name": "video_content", - "description": "Contains a `ProductMediaGalleryEntriesVideoContent` object.", + "name": "category_url_path", + "description": "The URL path of the category.", "args": [], "type": { - "kind": "OBJECT", - "name": "ProductMediaGalleryEntriesVideoContent", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, @@ -16935,20 +17338,14 @@ } ], "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } - ], + "interfaces": [], "enumValues": null, "possibleTypes": null }, { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "description": "Contains basic information about a customizable option. It can be implemented by several types of configurable options.", + "kind": "OBJECT", + "name": "CustomizableRadioOption", + "description": "Contains information about a set of radio buttons that are defined as part of a customizable option.", "fields": [ { "name": "option_id", @@ -17013,69 +17410,17 @@ }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "CustomizableAreaOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableDateOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableDropDownOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableMultipleOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableFieldOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableFileOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableRadioOption", - "ofType": null }, { - "kind": "OBJECT", - "name": "CustomizableCheckboxOption", - "ofType": null - } - ] - }, - { - "kind": "INTERFACE", - "name": "CustomizableProductInterface", - "description": "Contains information about customizable product options.", - "fields": [ - { - "name": "options", - "description": "An array of options for a customizable product.", + "name": "value", + "description": "An array that defines a set of radio buttons.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", + "kind": "OBJECT", + "name": "CustomizableRadioValue", "ofType": null } }, @@ -17084,93 +17429,60 @@ } ], "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "VirtualProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "SimpleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "DownloadableProduct", - "ofType": null - }, + "interfaces": [ { - "kind": "OBJECT", - "name": "GiftCardProduct", + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", "ofType": null } - ] + ], + "enumValues": null, + "possibleTypes": null }, { - "kind": "INTERFACE", - "name": "CategoryInterface", - "description": "Contains the full set of attributes that can be returned in a category search.", + "kind": "OBJECT", + "name": "CustomizableRadioValue", + "description": "Defines the price and sku of a product whose page contains a customized set of radio buttons.", "fields": [ { - "name": "automatic_sorting", - "description": null, + "name": "option_type_id", + "description": "The ID assigned to the value.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "available_sort_by", - "description": null, + "name": "price", + "description": "The price assigned to this option.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "breadcrumbs", - "description": "An array of breadcrumb items.", + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Breadcrumb", - "ofType": null - } + "kind": "ENUM", + "name": "PriceTypeEnum", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.", + "name": "sku", + "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", @@ -17181,80 +17493,95 @@ "deprecationReason": null }, { - "name": "children_count", - "description": null, + "name": "sort_order", + "description": "The order in which the radio button is displayed.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "cms_block", - "description": "Contains a category CMS block.", + "name": "title", + "description": "The display name for this option.", "args": [], "type": { - "kind": "OBJECT", - "name": "CmsBlock", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "created_at", - "description": "The timestamp indicating when the category was created.", + "name": "uid", + "description": "The unique ID for a `CustomizableRadioValue` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableCheckboxOption", + "description": "Contains information about a set of checkbox values that are defined as part of a customizable option.", + "fields": [ { - "name": "custom_layout_update_file", - "description": null, + "name": "option_id", + "description": "Option ID.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" }, { - "name": "default_sort_by", - "description": "The attribute to use for sorting.", + "name": "required", + "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "description", - "description": "An optional description of the category.", + "name": "sort_order", + "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "display_mode", - "description": null, + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", @@ -17265,44 +17592,57 @@ "deprecationReason": null }, { - "name": "filter_price_range", - "description": null, + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "An ID that uniquely identifies the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "image", - "description": null, + "name": "value", + "description": "An array that defines a set of checkbox values.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomizableCheckboxValue", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, - { - "name": "include_in_menu", - "description": null, + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableCheckboxValue", + "description": "Defines the price and sku of a product whose page contains a customized set of checkbox values.", + "fields": [ + { + "name": "option_type_id", + "description": "The ID assigned to the value.", "args": [], "type": { "kind": "SCALAR", @@ -17313,56 +17653,56 @@ "deprecationReason": null }, { - "name": "is_anchor", - "description": null, + "name": "price", + "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "landing_page", - "description": null, + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "ENUM", + "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "level", - "description": "The depth of the category within the tree.", + "name": "sku", + "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "meta_description", - "description": null, + "name": "sort_order", + "description": "The order in which the checkbox value is displayed.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "meta_keywords", - "description": null, + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", @@ -17373,32 +17713,47 @@ "deprecationReason": null }, { - "name": "meta_title", - "description": null, + "name": "uid", + "description": "The unique ID for a `CustomizableCheckboxValue` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VirtualProduct", + "description": "Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory.", + "fields": [ { - "name": "name", - "description": "The display name of the category.", + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "path", - "description": "The full category path.", + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", "args": [], "type": { "kind": "SCALAR", @@ -17409,71 +17764,83 @@ "deprecationReason": null }, { - "name": "path_in_store", - "description": "The category path within the store.", + "name": "categories", + "description": "The categories assigned to a product.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "position", - "description": "The position of the category relative to other categories at the same level in tree.", + "name": "color", + "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "product_count", - "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", + "name": "created_at", + "description": "Timestamp indicating when the product was created.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "crosssell_products", + "description": "An array of cross-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "products", - "description": "The list of products assigned to the category.", + "name": "custom_attributesV2", + "description": "Product custom attributes.", "args": [ { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "sort", - "description": "The attributes to sort on, and whether to return the results in ascending or descending order.", + "name": "filters", + "description": "", "type": { "kind": "INPUT_OBJECT", - "name": "ProductAttributeSortInput", + "name": "AttributeFilterInput", "ofType": null }, "defaultValue": null @@ -17481,15 +17848,27 @@ ], "type": { "kind": "OBJECT", - "name": "CategoryProducts", + "name": "ProductCustomAttributes", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "staged", - "description": "Indicates whether the category is staged for a future campaign.", + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", "args": [], "type": { "kind": "NON_NULL", @@ -17504,15 +17883,15 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CategoryInterface` object.", + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "Boolean", "ofType": null } }, @@ -17520,44 +17899,44 @@ "deprecationReason": null }, { - "name": "updated_at", - "description": "The timestamp indicating when the category was updated.", + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "Money", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "url_key", - "description": "The URL key assigned to the category.", + "name": "id", + "description": "The ID number assigned to the product.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `uid` field instead." }, { - "name": "url_path", - "description": "The URL path assigned to the category.", + "name": "image", + "description": "The relative path to the main image on the product page.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "url_suffix", - "description": "The part of the category URL that is appended after the url key", + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", "args": [], "type": { "kind": "SCALAR", @@ -17566,27 +17945,10 @@ }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "CategoryTree", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "Breadcrumb", - "description": "Contains details about an individual category that comprises a breadcrumb.", - "fields": [ + }, { - "name": "category_id", - "description": "The ID of the category.", + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", "args": [], "type": { "kind": "SCALAR", @@ -17594,51 +17956,67 @@ "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `category_uid` instead." + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "category_level", - "description": "The category level.", + "name": "max_sale_qty", + "description": "Maximum Qty Allowed in Shopping Cart", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "category_name", - "description": "The display name of the category.", + "name": "media_gallery", + "description": "An array of media gallery objects.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "category_uid", - "description": "The unique ID for a `Breadcrumb` object.", + "name": "media_gallery_entries", + "description": "An array of MediaGalleryEntry objects.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "OBJECT", + "name": "MediaGalleryEntry", "ofType": null } }, + "isDeprecated": true, + "deprecationReason": "Use `media_gallery` instead." + }, + { + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "category_url_key", - "description": "The URL key of the category.", + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", "args": [], "type": { "kind": "SCALAR", @@ -17649,8 +18027,8 @@ "deprecationReason": null }, { - "name": "category_url_path", - "description": "The URL path of the category.", + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "args": [], "type": { "kind": "SCALAR", @@ -17659,57 +18037,46 @@ }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableRadioOption", - "description": "Contains information about a set of radio buttons that are defined as part of a customizable option.", - "fields": [ + }, { - "name": "option_id", - "description": "Option ID.", + "name": "min_sale_qty", + "description": "Minimum Qty Allowed in Shopping Cart", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" + "isDeprecated": false, + "deprecationReason": null }, { - "name": "required", - "description": "Indicates whether the option is required.", + "name": "name", + "description": "The product name. Customers use this name to identify the product.", "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the option is displayed.", + "name": "new_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "new_to_date", + "description": "The end date for new product listings.", "args": [], "type": { "kind": "SCALAR", @@ -17720,61 +18087,40 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", + "name": "only_x_left_in_stock", + "description": "Product stock only x left count", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "value", - "description": "An array that defines a set of radio buttons.", + "name": "options", + "description": "An array of options for a customizable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "CustomizableRadioValue", + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableRadioValue", - "description": "Defines the price and sku of a product whose page contains a customized set of radio buttons.", - "fields": [ + }, { - "name": "option_type_id", - "description": "The ID assigned to the value.", + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, @@ -17782,130 +18128,127 @@ }, { "name": "price", - "description": "The price assigned to this option.", + "description": "Indicates the price of an item.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "OBJECT", + "name": "ProductPrices", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `price_range` for product price information." }, { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", + "name": "price_range", + "description": "The range of prices for the product", "args": [], "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRange", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", + "name": "price_tiers", + "description": "An array of `TierPrice` objects.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TierPrice", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the radio button is displayed.", + "name": "product_links", + "description": "An array of `ProductLinks` objects.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "quantity", + "description": "Amount of available stock", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableRadioValue` object.", + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableCheckboxOption", - "description": "Contains information about a set of checkbox values that are defined as part of a customizable option.", - "fields": [ - { - "name": "option_id", - "description": "Option ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" }, { - "name": "required", - "description": "Indicates whether the option is required.", + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the option is displayed.", + "name": "related_products", + "description": "An array of related products.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", "args": [], "type": { "kind": "SCALAR", @@ -17916,15 +18259,15 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", + "name": "review_count", + "description": "The total count of all the reviews given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "Int", "ofType": null } }, @@ -17932,53 +18275,93 @@ "deprecationReason": null }, { - "name": "value", - "description": "An array that defines a set of checkbox values.", - "args": [], + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", - "name": "CustomizableCheckboxValue", + "name": "ProductReviews", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ + }, { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableCheckboxValue", - "description": "Defines the price and sku of a product whose page contains a customized set of checkbox values.", - "fields": [ + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "option_type_id", - "description": "The ID assigned to the value.", + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price", - "description": "The price assigned to this option.", + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "special_price", + "description": "The discounted price of the product.", "args": [], "type": { "kind": "SCALAR", @@ -17989,20 +18372,48 @@ "deprecationReason": null }, { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", + "name": "special_to_date", + "description": "The end date for a product with a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staged", + "description": "Indicates whether the product is staged for a future campaign.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stock_status", + "description": "Stock status of the product", "args": [], "type": { "kind": "ENUM", - "name": "PriceTypeEnum", + "name": "ProductStockStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", + "name": "swatch_image", + "description": "The file name of a swatch image.", "args": [], "type": { "kind": "SCALAR", @@ -18013,32 +18424,72 @@ "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the checkbox value is displayed.", + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "tier_prices", + "description": "An array of ProductTierPrices objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductTierPrices", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, + { + "name": "type_id", + "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `__typename` instead." + }, { "name": "uid", - "description": "The unique ID for a `CustomizableCheckboxValue` object.", + "description": "The unique ID for a `ProductInterface` object.", "args": [], "type": { "kind": "NON_NULL", @@ -18051,21 +18502,10 @@ }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "VirtualProduct", - "description": "Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory.", - "fields": [ + }, { - "name": "activity", - "description": null, + "name": "updated_at", + "description": "Timestamp indicating when the product was updated.", "args": [], "type": { "kind": "SCALAR", @@ -18073,23 +18513,27 @@ "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", + "name": "upsell_products", + "description": "An array of up-sell products.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "name": "url_key", + "description": "The part of the URL that identifies the product", "args": [], "type": { "kind": "SCALAR", @@ -18100,15 +18544,27 @@ "deprecationReason": null }, { - "name": "categories", - "description": "The categories assigned to a product.", + "name": "url_path", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use product's `canonical_url` or url rewrites instead" + }, + { + "name": "url_rewrites", + "description": "URL rewrites list", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", + "kind": "OBJECT", + "name": "UrlRewrite", "ofType": null } }, @@ -18116,40 +18572,99 @@ "deprecationReason": null }, { - "name": "category_gear", - "description": null, + "name": "url_suffix", + "description": "The part of the product URL that is appended after the url key", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "websites", + "description": "An array of websites in which the product is available.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Website", + "ofType": null + } + }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "The field should not be used on the storefront." + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null }, { - "name": "climate", - "description": null, + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "CustomizableProductInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SimpleProduct", + "description": "Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities.", + "fields": [ + { + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "collar", - "description": null, + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categories", + "description": "The categories assigned to a product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null }, { "name": "color", @@ -18238,66 +18753,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gender", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "gift_message_available", "description": "Returns a value indicating gift message availability for the product.", @@ -18390,18 +18845,6 @@ "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, - { - "name": "material", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "max_sale_qty", "description": "Maximum Qty Allowed in Shopping Cart", @@ -18506,18 +18949,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "new", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "new_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", @@ -18582,30 +19013,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "pattern", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "price", "description": "Indicates the price of an item.", @@ -18666,18 +19073,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "purpose", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "quantity", "description": "Amount of available stock", @@ -18803,34 +19198,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "rules", - "description": "Provides applied catalog rules in the current active cart", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CatalogRule", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", @@ -18843,18 +19210,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "size", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", @@ -18867,18 +19222,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", @@ -18955,54 +19298,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "swatch_image", "description": "The file name of a swatch image.", @@ -19190,6 +19485,18 @@ }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "weight", + "description": "The weight of the item, in units defined by the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -19204,6 +19511,11 @@ "name": "RoutableInterface", "ofType": null }, + { + "kind": "INTERFACE", + "name": "PhysicalProductInterface", + "ofType": null + }, { "kind": "INTERFACE", "name": "CustomizableProductInterface", @@ -19215,55 +19527,62 @@ }, { "kind": "OBJECT", - "name": "SimpleProduct", - "description": "Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities.", + "name": "Products", + "description": "Contains the results of a `products` query.", "fields": [ { - "name": "activity", - "description": null, - "args": [], + "name": "aggregations", + "description": "A bucket that contains the attribute code and label for each filterable option.", + "args": [ + { + "name": "filter", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AggregationsFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Aggregation", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", + "name": "filters", + "description": "Layered navigation filters array.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LayerFilter", + "ofType": null + } }, "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null + "deprecationReason": "Use `aggregations` instead." }, { - "name": "categories", - "description": "The categories assigned to a product.", + "name": "items", + "description": "An array of products that match the specified search criteria.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", - "name": "CategoryInterface", + "name": "ProductInterface", "ofType": null } }, @@ -19271,80 +19590,113 @@ "deprecationReason": null }, { - "name": "category_gear", - "description": null, + "name": "page_info", + "description": "An object that includes the page_info and currentPage values specified in the query.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "SearchResultPageInfo", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "climate", - "description": null, + "name": "sort_fields", + "description": "An object that includes the default sort field and all available sort fields.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "SortFields", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "collar", - "description": null, + "name": "suggestions", + "description": "An array of search suggestions for case when search query have no results.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchSuggestion", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "color", - "description": null, + "name": "total_count", + "description": "The number of products that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AggregationsFilterInput", + "description": "An input object that specifies the filters used in product aggregations.", + "fields": null, + "inputFields": [ { - "name": "country_of_manufacture", - "description": "The product's country of origin.", - "args": [], + "name": "category", + "description": "Filter category aggregations in layered navigation.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "AggregationsCategoryFilterInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AggregationsCategoryFilterInput", + "description": "Filter category aggregations in layered navigation.", + "fields": null, + "inputFields": [ { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", - "args": [], + "name": "includeDirectChildrenOnly", + "description": "Indicates whether to include only direct subcategories or all children categories at all levels.", "type": { "kind": "SCALAR", - "name": "String", + "name": "Boolean", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CategoryProducts", + "description": "Contains details about the products assigned to a category.", + "fields": [ { - "name": "crosssell_products", - "description": "An array of cross-sell products.", + "name": "items", + "description": "An array of products that are assigned to the category.", "args": [], "type": { "kind": "LIST", @@ -19359,968 +19711,638 @@ "deprecationReason": null }, { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], + "name": "page_info", + "description": "Pagination metadata.", + "args": [], "type": { "kind": "OBJECT", - "name": "ProductCustomAttributes", + "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", + "name": "total_count", + "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", "args": [], "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductAttributeFilterInput", + "description": "Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", + "fields": null, + "inputFields": [ { - "name": "eco_collection", - "description": null, - "args": [], + "name": "category_id", + "description": "Deprecated: use `category_uid` to filter product by category ID.", "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "erin_recommends", - "description": null, - "args": [], + "name": "category_uid", + "description": "Filter product by the unique ID for a `CategoryInterface` object.", "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "features_bags", - "description": null, - "args": [], + "name": "category_url_path", + "description": "Filter product by category URL path.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "format", - "description": null, - "args": [], + "name": "description", + "description": "Attribute label: Description", "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "INPUT_OBJECT", + "name": "FilterMatchTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "gender", - "description": null, - "args": [], + "name": "name", + "description": "Attribute label: Product Name", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterMatchTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "gift_message_available", - "description": "Returns a value indicating gift message availability for the product.", - "args": [], + "name": "price", + "description": "Attribute label: Price", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "FilterRangeTypeInput", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "gift_wrapping_available", - "description": "Returns a value indicating gift wrapping availability for the product.", - "args": [], + "name": "short_description", + "description": "Attribute label: Short Description", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "FilterMatchTypeInput", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "gift_wrapping_price", - "description": "Returns value and currency indicating gift wrapping price for the product.", - "args": [], + "name": "sku", + "description": "Attribute label: SKU", "type": { - "kind": "OBJECT", - "name": "Money", + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "id", - "description": "The ID number assigned to the product.", - "args": [], + "name": "url_key", + "description": "The part of the URL that identifies the product", "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CategoryFilterInput", + "description": "Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", + "fields": null, + "inputFields": [ { - "name": "image", - "description": "The relative path to the main image on the product page.", - "args": [], + "name": "category_uid", + "description": "Filter by the unique category ID for a `CategoryInterface` object.", "type": { - "kind": "OBJECT", - "name": "ProductImage", + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", - "args": [], + "name": "ids", + "description": "Deprecated: use 'category_uid' to filter uniquely identifiers of categories.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", - "args": [], + "name": "name", + "description": "Filter by the display name of the category.", "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "INPUT_OBJECT", + "name": "FilterMatchTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "material", - "description": null, - "args": [], + "name": "parent_category_uid", + "description": "Filter by the unique parent category ID for a `CategoryInterface` object.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "max_sale_qty", - "description": "Maximum Qty Allowed in Shopping Cart", - "args": [], + "name": "parent_id", + "description": "Filter by the unique parent category ID for a `CategoryInterface` object.", "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "media_gallery", - "description": "An array of media gallery objects.", - "args": [], + "name": "url_key", + "description": "Filter by the part of the URL that identifies the category.", "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "media_gallery_entries", - "description": "An array of MediaGalleryEntry objects.", - "args": [], + "name": "url_path", + "description": "Filter by the URL path for the category.", "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "MediaGalleryEntry", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `media_gallery` instead." - }, - { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductFilterInput", + "description": "ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", + "fields": null, + "inputFields": [ { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", - "args": [], + "name": "category_id", + "description": "The category ID the product belongs to.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", - "args": [], + "name": "country_of_manufacture", + "description": "The product's country of origin.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "min_sale_qty", - "description": "Minimum Qty Allowed in Shopping Cart", - "args": [], + "name": "created_at", + "description": "The timestamp indicating when the product was created.", "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", - "args": [], + "name": "custom_layout", + "description": "The name of a custom layout.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "new", - "description": null, - "args": [], + "name": "custom_layout_update", + "description": "XML code that is applied as a layout update to the product page.", "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "new_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", - "args": [], + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "new_to_date", - "description": "The end date for new product listings.", - "args": [], + "name": "gift_message_available", + "description": "Indicates whether a gift message is available.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "only_x_left_in_stock", - "description": "Product stock only x left count", - "args": [], + "name": "has_options", + "description": "Indicates whether additional attributes have been created for the product.", "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "An array of options for a customizable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "args": [], + "name": "image", + "description": "The relative path to the main image on the product page.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "pattern", - "description": null, - "args": [], + "name": "image_label", + "description": "The label assigned to a product image.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "performance_fabric", - "description": null, - "args": [], + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "price", - "description": "Indicates the price of an item.", - "args": [], + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", "type": { - "kind": "OBJECT", - "name": "ProductPrices", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `price_range` for product price information." - }, - { - "name": "price_range", - "description": "The range of prices for the product", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PriceRange", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "price_tiers", - "description": "An array of `TierPrice` objects.", - "args": [], + "name": "max_price", + "description": "The numeric maximal price of the product. Do not include the currency code.", "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TierPrice", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "product_links", - "description": "An array of `ProductLinks` objects.", - "args": [], + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "purpose", - "description": null, - "args": [], + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "quantity", - "description": "Amount of available stock", - "args": [], + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "rating_summary", - "description": "The average of all the ratings given to the product.", - "args": [], + "name": "min_price", + "description": "The numeric minimal price of the product. Do not include the currency code.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], + "name": "name", + "description": "The product name. Customers use this name to identify the product.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "related_products", - "description": "An array of related products.", - "args": [], + "name": "news_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], + "name": "news_to_date", + "description": "The end date for new product listings.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "review_count", - "description": "The total count of all the reviews given to the product.", - "args": [], + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "reviews", - "description": "The list of products reviews.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], + "name": "or", + "description": "The keyword required to perform a logical OR comparison.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviews", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "ProductFilterInput", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "rules", - "description": "Provides applied catalog rules in the current active cart", - "args": [], + "name": "price", + "description": "The price of an item.", "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CatalogRule", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "sale", - "description": null, - "args": [], + "name": "required_options", + "description": "Indicates whether the product has required options.", "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "size", - "description": null, - "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", - "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "sleeve", - "description": null, - "args": [], + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", - "args": [], + "name": "small_image_label", + "description": "The label assigned to a product's small image.", "type": { - "kind": "OBJECT", - "name": "ProductImage", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { "name": "special_from_date", "description": "The beginning date that a product has a special price.", - "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "defaultValue": null }, { "name": "special_price", - "description": "The discounted price of the product.", - "args": [], + "description": "The discounted price of the product. Do not include the currency code.", "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { "name": "special_to_date", - "description": "The end date for a product with a special price.", - "args": [], + "description": "The end date that a product has a special price.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "staged", - "description": "Indicates whether the product is staged for a future campaign.", - "args": [], + "name": "swatch_image", + "description": "The file name of a swatch image.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "stock_status", - "description": "Stock status of the product", - "args": [], + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", "type": { - "kind": "ENUM", - "name": "ProductStockStatus", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "swatch_image", - "description": "The file name of a swatch image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", - "args": [], + "name": "thumbnail_label", + "description": "The label assigned to a product's thumbnail image.", "type": { - "kind": "OBJECT", - "name": "ProductImage", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { "name": "tier_price", "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", - "args": [], "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "tier_prices", - "description": "An array of ProductTierPrices objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductTierPrices", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." + "defaultValue": null }, { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], + "name": "updated_at", + "description": "The timestamp indicating when the product was updated.", "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "type_id", - "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", - "args": [], + "name": "url_key", + "description": "The part of the URL that identifies the product", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `__typename` instead." - }, - { - "name": "uid", - "description": "The unique ID for a `ProductInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "updated_at", - "description": "Timestamp indicating when the product was updated.", - "args": [], + "name": "url_path", + "description": "", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "upsell_products", - "description": "An array of up-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "url_key", - "description": "The part of the URL that identifies the product", - "args": [], + "name": "weight", + "description": "The weight of the item, in units defined by the store.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductMediaGalleryEntriesContent", + "description": "Contains an image in base64 format and basic information about the image.", + "fields": [ { - "name": "url_path", - "description": null, + "name": "base64_encoded_data", + "description": "The image in base64 format.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use product's `canonical_url` or url rewrites instead" - }, - { - "name": "url_rewrites", - "description": "URL rewrites list", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "UrlRewrite", - "ofType": null - } - }, "isDeprecated": false, "deprecationReason": null }, { - "name": "url_suffix", - "description": "The part of the product URL that is appended after the url key", + "name": "name", + "description": "The file name of the image.", "args": [], "type": { "kind": "SCALAR", @@ -20331,28 +20353,12 @@ "deprecationReason": null }, { - "name": "websites", - "description": "An array of websites in which the product is available.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Website", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", + "name": "type", + "description": "The MIME type of the file, such as image/png.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, @@ -20360,142 +20366,82 @@ } ], "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "PhysicalProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "CustomizableProductInterface", - "ofType": null - } - ], + "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "Products", - "description": "Contains the results of a `products` query.", + "name": "ProductMediaGalleryEntriesVideoContent", + "description": "Contains a link to a video file and basic information about the video.", "fields": [ { - "name": "aggregations", - "description": "A bucket that contains the attribute code and label for each filterable option.", - "args": [ - { - "name": "filter", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AggregationsFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], + "name": "media_type", + "description": "Must be external-video.", + "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Aggregation", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "filters", - "description": "Layered navigation filters array.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "LayerFilter", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `aggregations` instead." - }, - { - "name": "items", - "description": "An array of products that match the specified search criteria.", + "name": "video_description", + "description": "A description of the video.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "page_info", - "description": "An object that includes the page_info and currentPage values specified in the query.", + "name": "video_metadata", + "description": "Optional data about the video.", "args": [], "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sort_fields", - "description": "An object that includes the default sort field and all available sort fields.", + "name": "video_provider", + "description": "Describes the video source.", "args": [], "type": { - "kind": "OBJECT", - "name": "SortFields", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "suggestions", - "description": "An array of search suggestions for case when search query have no results.", + "name": "video_title", + "description": "The title of the video.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SearchSuggestion", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "total_count", - "description": "The number of products that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", + "name": "video_url", + "description": "The URL to the video.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, @@ -20509,409 +20455,356 @@ }, { "kind": "INPUT_OBJECT", - "name": "AggregationsFilterInput", - "description": "An input object that specifies the filters used in product aggregations.", + "name": "ProductSortInput", + "description": "Deprecated. Use `ProductAttributeSortInput` instead. Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.", "fields": null, "inputFields": [ { - "name": "category", - "description": "Filter category aggregations in layered navigation.", + "name": "country_of_manufacture", + "description": "The product's country of origin.", "type": { - "kind": "INPUT_OBJECT", - "name": "AggregationsCategoryFilterInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AggregationsCategoryFilterInput", - "description": "Filter category aggregations in layered navigation.", - "fields": null, - "inputFields": [ + }, { - "name": "includeDirectChildrenOnly", - "description": "Indicates whether to include only direct subcategories or all children categories at all levels.", + "name": "created_at", + "description": "The timestamp indicating when the product was created.", "type": { - "kind": "SCALAR", - "name": "Boolean", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CategoryProducts", - "description": "Contains details about the products assigned to a category.", - "fields": [ - { - "name": "items", - "description": "An array of products that are assigned to the category.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null }, { - "name": "page_info", - "description": "Pagination metadata.", - "args": [], + "name": "custom_layout", + "description": "The name of a custom layout.", "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "total_count", - "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", - "args": [], + "name": "custom_layout_update", + "description": "XML code that is applied as a layout update to the product page.", "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ProductAttributeFilterInput", - "description": "Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", - "fields": null, - "inputFields": [ + "defaultValue": null + }, { - "name": "activity", - "description": "Attribute label: Activity", + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "category_gear", - "description": "Attribute label: Category Gear", + "name": "gift_message_available", + "description": "Indicates whether a gift message is available.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "category_id", - "description": "Deprecated: use `category_uid` to filter product by category ID.", + "name": "has_options", + "description": "Indicates whether additional attributes have been created for the product.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "category_uid", - "description": "Filter product by the unique ID for a `CategoryInterface` object.", + "name": "image", + "description": "The relative path to the main image on the product page.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "category_url_path", - "description": "Filter product by category URL path.", + "name": "image_label", + "description": "The label assigned to a product image.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "climate", - "description": "Attribute label: Climate", + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "collar", - "description": "Attribute label: Collar", + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "color", - "description": "Attribute label: Color", + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "description", - "description": "Attribute label: Description", + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "eco_collection", - "description": "Attribute label: Eco Collection", + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "erin_recommends", - "description": "Attribute label: Erin Recommends", + "name": "name", + "description": "The product name. Customers use this name to identify the product.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "features_bags", - "description": "Attribute label: Features", + "name": "news_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "format", - "description": "Attribute label: Format", + "name": "news_to_date", + "description": "The end date for new product listings.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "gender", - "description": "Attribute label: Gender", + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "material", - "description": "Attribute label: Material", + "name": "price", + "description": "The price of the item.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "name", - "description": "Attribute label: Product Name", + "name": "required_options", + "description": "Indicates whether the product has required options.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "new", - "description": "Attribute label: New", + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "pattern", - "description": "Attribute label: Pattern", + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "performance_fabric", - "description": "Attribute label: Performance Fabric", + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "price", - "description": "Attribute label: Price", + "name": "small_image_label", + "description": "The label assigned to a product's small image.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterRangeTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "purpose", - "description": "Attribute label: Purpose", + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "sale", - "description": "Attribute label: Sale", + "name": "special_price", + "description": "The discounted price of the product.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "short_description", - "description": "Attribute label: Short Description", + "name": "special_to_date", + "description": "The end date that a product has a special price.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "size", - "description": "Attribute label: Size", + "name": "swatch_image", + "description": "Indicates the criteria to sort swatches.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "sku", - "description": "Attribute label: SKU", + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "sleeve", - "description": "Attribute label: Sleeve", + "name": "thumbnail_label", + "description": "The label assigned to a product's thumbnail image.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "strap_bags", - "description": "Attribute label: Strap/Handle", + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "style_bags", - "description": "Attribute label: Style Bags", + "name": "updated_at", + "description": "The timestamp indicating when the product was updated.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "style_bottom", - "description": "Attribute label: Style Bottom", + "name": "url_key", + "description": "The part of the URL that identifies the product", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "style_general", - "description": "Attribute label: Style General", + "name": "url_path", + "description": "", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "url_key", - "description": "The part of the URL that identifies the product", + "name": "weight", + "description": "The weight of the item, in units defined by the store.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null @@ -20923,76 +20816,46 @@ }, { "kind": "INPUT_OBJECT", - "name": "CategoryFilterInput", - "description": "Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", + "name": "ProductAttributeSortInput", + "description": "Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. It's possible to sort products using searchable attributes with enabled 'Use in Filter Options' option", "fields": null, "inputFields": [ - { - "name": "category_uid", - "description": "Filter by the unique category ID for a `CategoryInterface` object.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "ids", - "description": "Deprecated: use 'category_uid' to filter uniquely identifiers of categories.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, { "name": "name", - "description": "Filter by the display name of the category.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "parent_category_uid", - "description": "Filter by the unique parent category ID for a `CategoryInterface` object.", + "description": "Attribute label: Product Name", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "parent_id", - "description": "Filter by the unique parent category ID for a `CategoryInterface` object.", + "name": "position", + "description": "Sort by the position assigned to each product.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "url_key", - "description": "Filter by the part of the URL that identifies the category.", + "name": "price", + "description": "Attribute label: Price", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null }, { - "name": "url_path", - "description": "Filter by the URL path for the category.", + "name": "relevance", + "description": "Sort by the search relevance score (default).", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "SortEnum", "ofType": null }, "defaultValue": null @@ -21003,414 +20866,546 @@ "possibleTypes": null }, { - "kind": "INPUT_OBJECT", - "name": "ProductFilterInput", - "description": "ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", - "fields": null, - "inputFields": [ + "kind": "OBJECT", + "name": "MediaGalleryEntry", + "description": "Defines characteristics about images and videos associated with a specific product.", + "fields": [ { - "name": "category_id", - "description": "The category ID the product belongs to.", + "name": "content", + "description": "Details about the content of the media gallery item.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "OBJECT", + "name": "ProductMediaGalleryEntriesContent", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "country_of_manufacture", - "description": "The product's country of origin.", + "name": "disabled", + "description": "Indicates whether the image is hidden from view.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "created_at", - "description": "The timestamp indicating when the product was created.", + "name": "file", + "description": "The path of the image on the server.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "custom_layout", - "description": "The name of a custom layout.", + "name": "id", + "description": "The identifier assigned to the object.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." }, { - "name": "custom_layout_update", - "description": "XML code that is applied as a layout update to the product page.", + "name": "label", + "description": "The alt text displayed on the storefront when the user points to the image.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", + "name": "media_type", + "description": "Either `image` or `video`.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "gift_message_available", - "description": "Indicates whether a gift message is available.", + "name": "position", + "description": "The media item's position after it has been sorted.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "has_options", - "description": "Indicates whether additional attributes have been created for the product.", + "name": "types", + "description": "Array of image types. It can have the following values: image, small_image, thumbnail.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "image", - "description": "The relative path to the main image on the product page.", + "name": "uid", + "description": "The unique ID for a `MediaGalleryEntry` object.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "image_label", - "description": "The label assigned to a product image.", + "name": "video_content", + "description": "Details about the content of a video item.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "OBJECT", + "name": "ProductMediaGalleryEntriesVideoContent", "ofType": null }, - "defaultValue": null - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LayerFilter", + "description": "Contains information for rendering layered navigation.", + "fields": [ { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", + "name": "filter_items", + "description": "An array of filter items.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "LayerFilterItemInterface", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `Aggregation.options` instead." }, { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", + "name": "filter_items_count", + "description": "The count of filter items in filter group.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `Aggregation.count` instead." }, { - "name": "max_price", - "description": "The numeric maximal price of the product. Do not include the currency code.", + "name": "name", + "description": "The name of a layered navigation filter.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `Aggregation.label` instead." }, { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "name": "request_var", + "description": "The request variable name for a filter query.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null - }, + "isDeprecated": true, + "deprecationReason": "Use `Aggregation.attribute_code` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "LayerFilterItemInterface", + "description": "", + "fields": [ { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", + "name": "items_count", + "description": "The count of items per filter.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.count` instead." }, { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "name": "label", + "description": "The label for a filter.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.label` instead." }, { - "name": "min_price", - "description": "The numeric minimal price of the product. Do not include the currency code.", + "name": "value_string", + "description": "The value of a filter request variable to be used in query.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.value` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "LayerFilterItem", + "ofType": null }, { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", + "kind": "OBJECT", + "name": "SwatchLayerFilterItem", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "LayerFilterItem", + "description": "", + "fields": [ + { + "name": "items_count", + "description": "The count of items per filter.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.count` instead." }, { - "name": "news_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "name": "label", + "description": "The label for a filter.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.label` instead." }, { - "name": "news_to_date", - "description": "The end date for new product listings.", + "name": "value_string", + "description": "The value of a filter request variable to be used in query.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "or", - "description": "The keyword required to perform a logical OR comparison.", - "type": { - "kind": "INPUT_OBJECT", - "name": "ProductFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "price", - "description": "The price of an item.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "required_options", - "description": "Indicates whether the product has required options.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null - }, + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.value` instead." + } + ], + "inputFields": null, + "interfaces": [ { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, + "kind": "INTERFACE", + "name": "LayerFilterItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Aggregation", + "description": "Contains information for each filterable option (such as price, category `UID`, and custom attributes).", + "fields": [ { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "name": "attribute_code", + "description": "Attribute code of the aggregation group.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", + "name": "count", + "description": "The number of options in the aggregation group.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "small_image_label", - "description": "The label assigned to a product's small image.", + "name": "label", + "description": "The aggregation display name.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", + "name": "options", + "description": "Array of options for the aggregation.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AggregationOption", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "special_price", - "description": "The discounted price of the product. Do not include the currency code.", + "name": "position", + "description": "The relative position of the attribute in a layered navigation block.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "defaultValue": null - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SearchSuggestion", + "description": "A string that contains search suggestion", + "fields": [ { - "name": "special_to_date", - "description": "The end date that a product has a special price.", + "name": "search", + "description": "The search suggestion of existing product.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "defaultValue": null - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "AggregationOptionInterface", + "description": "Defines aggregation option fields.", + "fields": [ { - "name": "swatch_image", - "description": "The file name of a swatch image.", + "name": "count", + "description": "The number of items that match the aggregation option.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", + "name": "label", + "description": "The display label for an aggregation option.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "thumbnail_label", - "description": "The label assigned to a product's thumbnail image.", + "name": "value", + "description": "The internal ID that represents the value of the option.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "defaultValue": null - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, + "kind": "OBJECT", + "name": "AggregationOption", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "AggregationOption", + "description": "An implementation of `AggregationOptionInterface`.", + "fields": [ { - "name": "updated_at", - "description": "The timestamp indicating when the product was updated.", + "name": "count", + "description": "The number of items that match the aggregation option.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "url_key", - "description": "The part of the URL that identifies the product", + "name": "label", + "description": "The display label for an aggregation option.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "url_path", - "description": "", + "name": "value", + "description": "The internal ID that represents the value of the option.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "defaultValue": null - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null + "kind": "INTERFACE", + "name": "AggregationOptionInterface", + "ofType": null } ], - "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "ProductMediaGalleryEntriesContent", - "description": "Contains an image in base64 format and basic information about the image.", + "name": "SortField", + "description": "Defines a possible sort field.", "fields": [ { - "name": "base64_encoded_data", - "description": "The image in base64 format.", + "name": "label", + "description": "The label of the sort field.", "args": [], "type": { "kind": "SCALAR", @@ -21421,8 +21416,8 @@ "deprecationReason": null }, { - "name": "name", - "description": "The file name of the image.", + "name": "value", + "description": "The attribute code of the sort field.", "args": [], "type": { "kind": "SCALAR", @@ -21431,10 +21426,21 @@ }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SortFields", + "description": "Contains a default value for sort fields and all available sort fields.", + "fields": [ { - "name": "type", - "description": "The MIME type of the file, such as image/png.", + "name": "default", + "description": "The default sort field value.", "args": [], "type": { "kind": "SCALAR", @@ -21443,6 +21449,22 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "options", + "description": "An array of possible sort fields.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SortField", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -21452,36 +21474,48 @@ }, { "kind": "OBJECT", - "name": "ProductMediaGalleryEntriesVideoContent", - "description": "Contains a link to a video file and basic information about the video.", + "name": "SimpleWishlistItem", + "description": "Contains a simple product wish list item.", "fields": [ { - "name": "media_type", - "description": "Must be external-video.", + "name": "added_at", + "description": "The date and time the item was added to the wish list.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "video_description", - "description": "A description of the video.", + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "video_metadata", - "description": "Optional data about the video.", + "name": "description", + "description": "The description of the item.", "args": [], "type": { "kind": "SCALAR", @@ -21492,558 +21526,745 @@ "deprecationReason": null }, { - "name": "video_provider", - "description": "Describes the video source.", + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "video_title", - "description": "The title of the video.", + "name": "product", + "description": "Product details of the wish list item.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "video_url", - "description": "The URL to the video.", + "name": "quantity", + "description": "The quantity of this wish list item.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, - "interfaces": [], + "interfaces": [ + { + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null + } + ], "enumValues": null, "possibleTypes": null }, { - "kind": "INPUT_OBJECT", - "name": "ProductSortInput", - "description": "Deprecated. Use `ProductAttributeSortInput` instead. Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.", - "fields": null, - "inputFields": [ + "kind": "OBJECT", + "name": "VirtualWishlistItem", + "description": "Contains a virtual product wish list item.", + "fields": [ { - "name": "country_of_manufacture", - "description": "The product's country of origin.", + "name": "added_at", + "description": "The date and time the item was added to the wish list.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "created_at", - "description": "The timestamp indicating when the product was created.", + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "custom_layout", - "description": "The name of a custom layout.", + "name": "description", + "description": "The description of the item.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "custom_layout_update", - "description": "XML code that is applied as a layout update to the product page.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", + "name": "product", + "description": "Product details of the wish list item.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "gift_message_available", - "description": "Indicates whether a gift message is available.", + "name": "quantity", + "description": "The quantity of this wish list item.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } }, - "defaultValue": null - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ { - "name": "has_options", - "description": "Indicates whether additional attributes have been created for the product.", + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CatalogAttributeMetadata", + "description": "Swatch attribute metadata.", + "fields": [ + { + "name": "apply_to", + "description": "To which catalog types an attribute can be applied.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CatalogAttributeApplyToEnum", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "image", - "description": "The relative path to the main image on the product page.", + "name": "code", + "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "image_label", - "description": "The label assigned to a product image.", + "name": "default_value", + "description": "Default attribute value.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", + "name": "entity_type", + "description": "The type of entity that defines the attribute.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AttributeEntityTypeEnum", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", + "name": "frontend_class", + "description": "The frontend class of the attribute.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "name": "frontend_input", + "description": "The frontend input type of the attribute.", + "args": [], "type": { "kind": "ENUM", - "name": "SortEnum", + "name": "AttributeFrontendInputEnum", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", + "name": "is_comparable", + "description": "Whether a product or category attribute can be compared against another or not.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "name": "is_filterable", + "description": "Whether a product or category attribute can be filtered or not.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", + "name": "is_filterable_in_search", + "description": "Whether a product or category attribute can be filtered in search or not.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "news_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "name": "is_html_allowed_on_front", + "description": "Whether a product or category attribute can use HTML on front or not.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "news_to_date", - "description": "The end date for new product listings.", + "name": "is_required", + "description": "Whether the attribute value is required.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", + "name": "is_searchable", + "description": "Whether a product or category attribute can be searched or not.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "price", - "description": "The price of the item.", + "name": "is_unique", + "description": "Whether the attribute value must be unique.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "required_options", - "description": "Indicates whether the product has required options.", + "name": "is_used_for_price_rules", + "description": "Whether a product or category attribute can be used for price rules or not.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", + "name": "is_used_for_promo_rules", + "description": "Whether a product or category attribute is used for promo rules or not.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "name": "is_visible_in_advanced_search", + "description": "Whether a product or category attribute is visible in advanced search or not.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", + "name": "is_visible_on_front", + "description": "Whether a product or category attribute is visible on front or not.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "small_image_label", - "description": "The label assigned to a product's small image.", + "name": "is_wysiwyg_enabled", + "description": "Whether a product or category attribute has WYSIWYG enabled or not.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", + "name": "label", + "description": "The label assigned to the attribute.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "special_price", - "description": "The discounted price of the product.", + "name": "options", + "description": "Attribute options.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomAttributeOptionInterface", + "ofType": null + } + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "special_to_date", - "description": "The end date that a product has a special price.", + "name": "swatch_input_type", + "description": "Input type of the swatch attribute option.", + "args": [], "type": { "kind": "ENUM", - "name": "SortEnum", + "name": "SwatchInputTypeEnum", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "swatch_image", - "description": "Indicates the criteria to sort swatches.", + "name": "update_product_preview_image", + "description": "Whether update product preview image or not.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", + "name": "use_product_image_for_swatch", + "description": "Whether use product image for swatch or not.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "thumbnail_label", - "description": "The label assigned to a product's thumbnail image.", + "name": "used_in_product_listing", + "description": "Whether a product or category attribute is used in product listing or not.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomAttributeMetadataInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CatalogAttributeApplyToEnum", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SIMPLE", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null + "name": "VIRTUAL", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "name": "updated_at", - "description": "The timestamp indicating when the product was updated.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null + "name": "BUNDLE", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "name": "url_key", - "description": "The part of the URL that identifies the product", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null + "name": "DOWNLOADABLE", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "name": "url_path", + "name": "CONFIGURABLE", "description": "", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null + "name": "GROUPED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATEGORY", + "description": "", + "isDeprecated": false, + "deprecationReason": null } ], - "interfaces": null, - "enumValues": null, "possibleTypes": null }, { - "kind": "INPUT_OBJECT", - "name": "ProductAttributeSortInput", - "description": "Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. It's possible to sort products using searchable attributes with enabled 'Use in Filter Options' option", - "fields": null, - "inputFields": [ + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "description": "Product custom attributes", + "fields": [ { - "name": "name", - "description": "Attribute label: Product Name", + "name": "errors", + "description": "Errors when retrieving custom attributes metadata.", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AttributeMetadataError", + "ofType": null + } + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "position", - "description": "Sort by the position assigned to each product.", + "name": "items", + "description": "Requested custom attributes", + "args": [], "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + } }, - "defaultValue": null - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductStockStatus", + "description": "This enumeration states whether a product stock status is in stock or out of stock", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ { - "name": "price", - "description": "Attribute label: Price", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null + "name": "IN_STOCK", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "name": "relevance", - "description": "Sort by the search relevance score (default).", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null + "name": "OUT_OF_STOCK", + "description": "", + "isDeprecated": false, + "deprecationReason": null } ], - "interfaces": null, - "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "MediaGalleryEntry", - "description": "Defines characteristics about images and videos associated with a specific product.", + "kind": "INTERFACE", + "name": "CartItemInterface", + "description": "An interface for products in a cart.", "fields": [ { - "name": "content", - "description": "Details about the content of the media gallery item.", + "name": "discount", + "description": "Contains discount for quote line item.", "args": [], "type": { - "kind": "OBJECT", - "name": "ProductMediaGalleryEntriesContent", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "disabled", - "description": "Indicates whether the image is hidden from view.", + "name": "errors", + "description": "An array of errors encountered while loading the cart item", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartItemError", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "file", - "description": "The path of the image on the server.", + "name": "id", + "description": null, "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." }, { - "name": "id", - "description": "The identifier assigned to the object.", + "name": "is_available", + "description": "True if requested quantity is less than available stock, false otherwise.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "label", - "description": "The alt text displayed on the storefront when the user points to the image.", + "name": "max_qty", + "description": "Line item max qty in quote template", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "media_type", - "description": "Either `image` or `video`.", + "name": "min_qty", + "description": "Line item min qty in quote template", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "position", - "description": "The media item's position after it has been sorted.", + "name": "not_available_message", + "description": "Message to display when the product is not available with this selected option.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "types", - "description": "Array of image types. It can have the following values: image, small_image, thumbnail.", + "name": "note_from_buyer", + "description": "The buyer's quote line item note.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "ItemNote", "ofType": null } }, @@ -22051,15 +22272,15 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `MediaGalleryEntry` object.", + "name": "note_from_seller", + "description": "The seller's quote line item note.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "OBJECT", + "name": "ItemNote", "ofType": null } }, @@ -22067,252 +22288,229 @@ "deprecationReason": null }, { - "name": "video_content", - "description": "Details about the content of a video item.", + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", "args": [], "type": { "kind": "OBJECT", - "name": "ProductMediaGalleryEntriesVideoContent", + "name": "CartItemPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "LayerFilter", - "description": "Contains information for rendering layered navigation.", - "fields": [ + }, { - "name": "filter_items", - "description": "An array of filter items.", + "name": "product", + "description": "Details about an item in the cart.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", - "name": "LayerFilterItemInterface", + "name": "ProductInterface", "ofType": null } }, - "isDeprecated": true, - "deprecationReason": "Use `Aggregation.options` instead." - }, - { - "name": "filter_items_count", - "description": "The count of filter items in filter group.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `Aggregation.count` instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "name", - "description": "The name of a layered navigation filter.", + "name": "quantity", + "description": "The quantity of this item in the cart.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use `Aggregation.label` instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "request_var", - "description": "The request variable name for a filter query.", + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use `Aggregation.attribute_code` instead." + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, - "possibleTypes": null + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SimpleCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VirtualCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DownloadableCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardCartItem", + "ofType": null + } + ] }, { - "kind": "INTERFACE", - "name": "LayerFilterItemInterface", - "description": "", + "kind": "OBJECT", + "name": "EntityUrl", + "description": "Contains the `uid`, `relative_url`, and `type` attributes.", "fields": [ { - "name": "items_count", - "description": "The count of items per filter.", + "name": "canonical_url", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.count` instead." + "deprecationReason": "Use `relative_url` instead." }, { - "name": "label", - "description": "The label for a filter.", + "name": "entity_uid", + "description": "The unique ID for a `ProductInterface`, `CategoryInterface`, `CmsPage`, or similar object associated with the specified URL. This could be a product, category, or CMS page UID.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.label` instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "value_string", - "description": "The value of a filter request variable to be used in query.", + "name": "id", + "description": "The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.value` instead." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "LayerFilterItem", - "ofType": null + "deprecationReason": "Use `entity_uid` instead." }, { - "kind": "OBJECT", - "name": "SwatchLayerFilterItem", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "LayerFilterItem", - "description": "", - "fields": [ - { - "name": "items_count", - "description": "The count of items per filter.", + "name": "redirectCode", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.count` instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "label", - "description": "The label for a filter.", + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.label` instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "value_string", - "description": "The value of a filter request variable to be used in query.", + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.value` instead." + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "LayerFilterItemInterface", - "ofType": null - } - ], + "interfaces": [], "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "Aggregation", - "description": "Contains information for each filterable option (such as price, category `UID`, and custom attributes).", - "fields": [ + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "description": "This enumeration defines the entity type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ { - "name": "attribute_code", - "description": "Attribute code of the aggregation group.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, + "name": "CMS_PAGE", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "count", - "description": "The number of options in the aggregation group.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, + "name": "PRODUCT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "label", - "description": "The aggregation display name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "CATEGORY", + "description": "", "isDeprecated": false, "deprecationReason": null - }, + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRewrite", + "description": "Contains URL rewrite details.", + "fields": [ { - "name": "options", - "description": "Array of options for the aggregation.", + "name": "parameters", + "description": "An array of request parameters.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "AggregationOption", + "name": "HttpQueryParameter", "ofType": null } }, @@ -22320,12 +22518,12 @@ "deprecationReason": null }, { - "name": "position", - "description": "The relative position of the attribute in a layered navigation block.", + "name": "url", + "description": "The request URL.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, @@ -22339,21 +22537,29 @@ }, { "kind": "OBJECT", - "name": "SearchSuggestion", - "description": "A string that contains search suggestion", + "name": "HttpQueryParameter", + "description": "Contains target path parameters.", "fields": [ { - "name": "search", - "description": "The search suggestion of existing product.", + "name": "name", + "description": "A parameter name.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "A parameter value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null @@ -22365,25 +22571,29 @@ "possibleTypes": null }, { - "kind": "INTERFACE", - "name": "AggregationOptionInterface", - "description": "Defines aggregation option fields.", + "kind": "OBJECT", + "name": "RoutableUrl", + "description": "Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity.", "fields": [ { - "name": "count", - "description": "The number of items that match the aggregation option.", + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "label", - "description": "The display label for an aggregation option.", + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", "args": [], "type": { "kind": "SCALAR", @@ -22394,53 +22604,53 @@ "deprecationReason": null }, { - "name": "value", - "description": "The internal ID that represents the value of the option.", + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ + "interfaces": [ { - "kind": "OBJECT", - "name": "AggregationOption", + "kind": "INTERFACE", + "name": "RoutableInterface", "ofType": null } - ] + ], + "enumValues": null, + "possibleTypes": null }, { - "kind": "OBJECT", - "name": "AggregationOption", - "description": "An implementation of `AggregationOptionInterface`.", + "kind": "INTERFACE", + "name": "RoutableInterface", + "description": "Routable entities serve as the model for a rendered page.", "fields": [ { - "name": "count", - "description": "The number of items that match the aggregation option.", + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "label", - "description": "The display label for an aggregation option.", + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", "args": [], "type": { "kind": "SCALAR", @@ -22451,116 +22661,125 @@ "deprecationReason": null }, { - "name": "value", - "description": "The internal ID that represents the value of the option.", + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, - "interfaces": [ + "interfaces": [], + "enumValues": null, + "possibleTypes": [ { - "kind": "INTERFACE", - "name": "AggregationOptionInterface", + "kind": "OBJECT", + "name": "CmsPage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CategoryTree", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VirtualProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SimpleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "RoutableUrl", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DownloadableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GroupedProduct", "ofType": null } - ], - "enumValues": null, - "possibleTypes": null + ] }, { - "kind": "OBJECT", - "name": "SortField", - "description": "Defines a possible sort field.", - "fields": [ - { - "name": "label", - "description": "The label of the sort field.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, + "kind": "INPUT_OBJECT", + "name": "CreateGuestCartInput", + "description": "", + "fields": null, + "inputFields": [ { - "name": "value", - "description": "The attribute code of the sort field.", - "args": [], + "name": "cart_uid", + "description": "Optional client-generated ID", "type": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null } ], - "inputFields": null, - "interfaces": [], + "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "SortFields", - "description": "Contains a default value for sort fields and all available sort fields.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "createEmptyCartInput", + "description": "Assigns a specific `cart_id` to the empty cart.", + "fields": null, + "inputFields": [ { - "name": "default", - "description": "The default sort field value.", - "args": [], + "name": "cart_id", + "description": "The ID to assign to the cart.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "An array of possible sort fields.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SortField", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null } ], - "inputFields": null, - "interfaces": [], + "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "SimpleWishlistItem", - "description": "Contains a simple product wish list item.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "AddSimpleProductsToCartInput", + "description": "Defines the simple and group products to add to the cart.", + "fields": null, + "inputFields": [ { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", - "args": [], + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", "type": { "kind": "NON_NULL", "name": null, @@ -22570,13 +22789,11 @@ "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", - "args": [], + "name": "cart_items", + "description": "An array of simple and group items to add.", "type": { "kind": "NON_NULL", "name": null, @@ -22584,92 +22801,67 @@ "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", + "kind": "INPUT_OBJECT", + "name": "SimpleProductCartItemInput", "ofType": null } } }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "The description of the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SimpleProductCartItemInput", + "description": "Defines a single product to add to the cart.", + "fields": null, + "inputFields": [ { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", - "args": [], + "name": "customizable_options", + "description": "An array that defines customizable options for the product.", "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Product details of the wish list item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "quantity", - "description": "The quantity of this wish list item.", - "args": [], + "name": "data", + "description": "An object containing the `sku`, `quantity`, and other relevant information about the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Float", + "kind": "INPUT_OBJECT", + "name": "CartItemInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null + "defaultValue": null } ], + "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "VirtualWishlistItem", - "description": "Contains a virtual product wish list item.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "AddVirtualProductsToCartInput", + "description": "Defines the virtual products to add to the cart.", + "fields": null, + "inputFields": [ { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", - "args": [], + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", "type": { "kind": "NON_NULL", "name": null, @@ -22679,13 +22871,11 @@ "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", - "args": [], + "name": "cart_items", + "description": "An array of virtual products to add.", "type": { "kind": "NON_NULL", "name": null, @@ -22693,462 +22883,337 @@ "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", + "kind": "INPUT_OBJECT", + "name": "VirtualProductCartItemInput", "ofType": null } } }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "The description of the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "VirtualProductCartItemInput", + "description": "Defines a single product to add to the cart.", + "fields": null, + "inputFields": [ { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", - "args": [], + "name": "customizable_options", + "description": "An array that defines customizable options for the product.", "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Product details of the wish list item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "quantity", - "description": "The quantity of this wish list item.", - "args": [], + "name": "data", + "description": "An object containing the `sku`, `quantity`, and other relevant information about the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Float", + "kind": "INPUT_OBJECT", + "name": "CartItemInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null + "defaultValue": null } ], + "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "CatalogAttributeMetadata", - "description": "Swatch attribute metadata.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "description": "Defines an item to be added to the cart.", + "fields": null, + "inputFields": [ { - "name": "apply_to", - "description": "To which catalog types an attribute can be applied.", - "args": [], + "name": "entered_options", + "description": "An array of entered options for the base product, such as personalization text.", "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "ENUM", - "name": "CatalogAttributeApplyToEnum", + "kind": "INPUT_OBJECT", + "name": "EnteredOptionInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "code", - "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", - "args": [], + "name": "parent_sku", + "description": "For a child product, the SKU of its parent product.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The amount or number of an item to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "Float", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "default_value", - "description": "Default attribute value.", - "args": [], + "name": "selected_options", + "description": "The selected options for the base product, such as color or size, using the unique ID for an object such as `CustomizableRadioOption`, `CustomizableDropDownOption`, or `ConfigurableProductOptionsValues`.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "entity_type", - "description": "The type of entity that defines the attribute.", - "args": [], + "name": "sku", + "description": "The SKU of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "ENUM", - "name": "AttributeEntityTypeEnum", + "kind": "SCALAR", + "name": "String", "ofType": null } }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SortQuoteItemsEnum", + "description": "Specifies the field to use for sorting quote items", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ITEM_ID", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "frontend_class", - "description": "The frontend class of the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "CREATED_AT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "frontend_input", - "description": "The frontend input type of the attribute.", - "args": [], - "type": { - "kind": "ENUM", - "name": "AttributeFrontendInputEnum", - "ofType": null - }, + "name": "UPDATED_AT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "is_comparable", - "description": "Whether a product or category attribute can be compared against another or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, + "name": "PRODUCT_ID", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "is_filterable", - "description": "Whether a product or category attribute can be filtered or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, + "name": "SKU", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "is_filterable_in_search", - "description": "Whether a product or category attribute can be filtered in search or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, + "name": "NAME", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "is_html_allowed_on_front", - "description": "Whether a product or category attribute can use HTML on front or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, + "name": "DESCRIPTION", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "is_required", - "description": "Whether the attribute value is required.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, + "name": "WEIGHT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "is_searchable", - "description": "Whether a product or category attribute can be searched or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, + "name": "QTY", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "is_unique", - "description": "Whether the attribute value must be unique.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, + "name": "PRICE", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "is_used_for_price_rules", - "description": "Whether a product or category attribute can be used for price rules or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, + "name": "BASE_PRICE", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "is_used_for_promo_rules", - "description": "Whether a product or category attribute is used for promo rules or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, + "name": "CUSTOM_PRICE", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "is_visible_in_advanced_search", - "description": "Whether a product or category attribute is visible in advanced search or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, + "name": "DISCOUNT_PERCENT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "is_visible_on_front", - "description": "Whether a product or category attribute is visible on front or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, + "name": "DISCOUNT_AMOUNT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "is_wysiwyg_enabled", - "description": "Whether a product or category attribute has WYSIWYG enabled or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, + "name": "BASE_DISCOUNT_AMOUNT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "label", - "description": "The label assigned to the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "TAX_PERCENT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "options", - "description": "Attribute options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomAttributeOptionInterface", - "ofType": null - } - } - }, + "name": "TAX_AMOUNT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "swatch_input_type", - "description": "Input type of the swatch attribute option.", - "args": [], - "type": { - "kind": "ENUM", - "name": "SwatchInputTypeEnum", - "ofType": null - }, + "name": "BASE_TAX_AMOUNT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "update_product_preview_image", - "description": "Whether update product preview image or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, + "name": "ROW_TOTAL", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "use_product_image_for_swatch", - "description": "Whether use product image for swatch or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, + "name": "BASE_ROW_TOTAL", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "used_in_product_listing", - "description": "Whether a product or category attribute is used in product listing or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, + "name": "ROW_TOTAL_WITH_DISCOUNT", + "description": "", "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ + }, { - "kind": "INTERFACE", - "name": "CustomAttributeMetadataInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CatalogAttributeApplyToEnum", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ + "name": "ROW_WEIGHT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "SIMPLE", + "name": "PRODUCT_TYPE", "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "VIRTUAL", + "name": "BASE_TAX_BEFORE_DISCOUNT", "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "BUNDLE", + "name": "TAX_BEFORE_DISCOUNT", "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "DOWNLOADABLE", + "name": "ORIGINAL_CUSTOM_PRICE", "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "CONFIGURABLE", + "name": "PRICE_INC_TAX", "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "GROUPED", + "name": "BASE_PRICE_INC_TAX", "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "CATEGORY", + "name": "ROW_TOTAL_INC_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_ROW_TOTAL_INC_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_TAX_COMPENSATION_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FREE_SHIPPING", "description": "", "isDeprecated": false, "deprecationReason": null @@ -23157,107 +23222,73 @@ "possibleTypes": null }, { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "description": "Product custom attributes", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "QuoteItemsSortInput", + "description": "Specifies the field to use for sorting quote items", + "fields": null, + "inputFields": [ { - "name": "errors", - "description": "Errors when retrieving custom attributes metadata.", - "args": [], + "name": "field", + "description": "Specifies the quote items field to sort by", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AttributeMetadataError", - "ofType": null - } + "kind": "ENUM", + "name": "SortQuoteItemsEnum", + "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "items", - "description": "Requested custom attributes", - "args": [], + "name": "order", + "description": "Specifies the order of quote items' sorting", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "AttributeValueInterface", - "ofType": null - } + "kind": "ENUM", + "name": "SortEnum", + "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null } ], - "inputFields": null, - "interfaces": [], + "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", - "name": "CreateGuestCartInput", - "description": "", + "name": "CustomizableOptionInput", + "description": "Defines a customizable option.", "fields": null, "inputFields": [ { - "name": "cart_uid", - "description": "Optional client-generated ID", + "name": "id", + "description": "The customizable option ID of the product.", "type": { "kind": "SCALAR", - "name": "ID", + "name": "Int", "ofType": null }, "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "createEmptyCartInput", - "description": "Assigns a specific `cart_id` to the empty cart.", - "fields": null, - "inputFields": [ + }, { - "name": "cart_id", - "description": "The ID to assign to the cart.", + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", "type": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null }, "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddSimpleProductsToCartInput", - "description": "Defines the simple and group products to add to the cart.", - "fields": null, - "inputFields": [ + }, { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", + "name": "value_string", + "description": "The string value of the option.", "type": { "kind": "NON_NULL", "name": null, @@ -23268,24 +23299,6 @@ } }, "defaultValue": null - }, - { - "name": "cart_items", - "description": "An array of simple and group items to add.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "SimpleProductCartItemInput", - "ofType": null - } - } - }, - "defaultValue": null } ], "interfaces": null, @@ -23294,33 +23307,33 @@ }, { "kind": "INPUT_OBJECT", - "name": "SimpleProductCartItemInput", - "description": "Defines a single product to add to the cart.", + "name": "ApplyCouponToCartInput", + "description": "Specifies the coupon code to apply to the cart.", "fields": null, "inputFields": [ { - "name": "customizable_options", - "description": "An array that defines customizable options for the product.", + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", + "kind": "SCALAR", + "name": "String", "ofType": null } }, "defaultValue": null }, { - "name": "data", - "description": "An object containing the `sku`, `quantity`, and other relevant information about the product.", + "name": "coupon_code", + "description": "A valid coupon code.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", + "kind": "SCALAR", + "name": "String", "ofType": null } }, @@ -23333,8 +23346,8 @@ }, { "kind": "INPUT_OBJECT", - "name": "AddVirtualProductsToCartInput", - "description": "Defines the virtual products to add to the cart.", + "name": "UpdateCartItemsInput", + "description": "Modifies the specified items in the cart.", "fields": null, "inputFields": [ { @@ -23353,7 +23366,7 @@ }, { "name": "cart_items", - "description": "An array of virtual products to add.", + "description": "An array of items to be updated.", "type": { "kind": "NON_NULL", "name": null, @@ -23362,7 +23375,7 @@ "name": null, "ofType": { "kind": "INPUT_OBJECT", - "name": "VirtualProductCartItemInput", + "name": "CartItemUpdateInput", "ofType": null } } @@ -23376,10 +23389,30 @@ }, { "kind": "INPUT_OBJECT", - "name": "VirtualProductCartItemInput", - "description": "Defines a single product to add to the cart.", + "name": "CartItemUpdateInput", + "description": "A single item to be updated.", "fields": null, "inputFields": [ + { + "name": "cart_item_id", + "description": "Deprecated. Use `cart_item_uid` instead.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cart_item_uid", + "description": "The unique ID for a `CartItemInterface` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, { "name": "customizable_options", "description": "An array that defines customizable options for the product.", @@ -23395,16 +23428,32 @@ "defaultValue": null }, { - "name": "data", - "description": "An object containing the `sku`, `quantity`, and other relevant information about the product.", + "name": "gift_message", + "description": "Gift message details for the cart item", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "GiftMessageInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gift_wrapping_id", + "description": "The unique ID for a `GiftWrapping` object to be used for the cart item.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The new quantity of the item.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "defaultValue": null } @@ -23415,72 +23464,83 @@ }, { "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "description": "Defines an item to be added to the cart.", + "name": "RemoveItemFromCartInput", + "description": "Specifies which items to remove from the cart.", "fields": null, "inputFields": [ { - "name": "entered_options", - "description": "An array of entered options for the base product, such as personalization text.", + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "EnteredOptionInput", + "kind": "SCALAR", + "name": "String", "ofType": null } }, "defaultValue": null }, { - "name": "parent_sku", - "description": "For a child product, the SKU of its parent product.", + "name": "cart_item_id", + "description": "Deprecated. Use `cart_item_uid` instead.", "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "defaultValue": null }, { - "name": "quantity", - "description": "The amount or number of an item to add.", + "name": "cart_item_uid", + "description": "Required field. The unique ID for a `CartItemInterface` object.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "SCALAR", + "name": "ID", + "ofType": null }, "defaultValue": null - }, + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SetShippingAddressesOnCartInput", + "description": "Specifies an array of addresses to use for shipping.", + "fields": null, + "inputFields": [ { - "name": "selected_options", - "description": "The selected options for the base product, such as color or size, using the unique ID for an object such as `CustomizableRadioOption`, `CustomizableDropDownOption`, or `ConfigurableProductOptionsValues`.", + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, "defaultValue": null }, { - "name": "sku", - "description": "The SKU of the product.", + "name": "shipping_addresses", + "description": "An array of shipping addresses.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ShippingAddressInput", + "ofType": null + } } }, "defaultValue": null @@ -23491,243 +23551,95 @@ "possibleTypes": null }, { - "kind": "ENUM", - "name": "SortQuoteItemsEnum", - "description": "Specifies the field to use for sorting quote items", + "kind": "INPUT_OBJECT", + "name": "ShippingAddressInput", + "description": "Defines a single shipping address.", "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ + "inputFields": [ { - "name": "ITEM_ID", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "CREATED_AT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "UPDATED_AT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "PRODUCT_ID", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "SKU", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "NAME", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "DESCRIPTION", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "WEIGHT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "QTY", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "PRICE", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "BASE_PRICE", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "CUSTOM_PRICE", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "DISCOUNT_PERCENT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "DISCOUNT_AMOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "BASE_DISCOUNT_AMOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "TAX_PERCENT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "TAX_AMOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "BASE_TAX_AMOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ROW_TOTAL", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "BASE_ROW_TOTAL", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ROW_TOTAL_WITH_DISCOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ROW_WEIGHT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "PRODUCT_TYPE", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "BASE_TAX_BEFORE_DISCOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "TAX_BEFORE_DISCOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ORIGINAL_CUSTOM_PRICE", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "PRICE_INC_TAX", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "BASE_PRICE_INC_TAX", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ROW_TOTAL_INC_TAX", - "description": "", - "isDeprecated": false, - "deprecationReason": null + "name": "address", + "description": "Defines a shipping address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CartAddressInput", + "ofType": null + }, + "defaultValue": null }, { - "name": "BASE_ROW_TOTAL_INC_TAX", - "description": "", - "isDeprecated": false, - "deprecationReason": null + "name": "customer_address_id", + "description": "An ID from the customer's address book that uniquely identifies the address to be used for shipping.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null }, { - "name": "DISCOUNT_TAX_COMPENSATION_AMOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address to be used for shipping.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null }, { - "name": "BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null + "name": "customer_notes", + "description": "Text provided by the shopper.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null }, { - "name": "FREE_SHIPPING", - "description": "", - "isDeprecated": false, - "deprecationReason": null + "name": "pickup_location_code", + "description": "The code of Pickup Location which will be used for In-Store Pickup.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null } ], + "interfaces": null, + "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", - "name": "QuoteItemsSortInput", - "description": "Specifies the field to use for sorting quote items", + "name": "SetBillingAddressOnCartInput", + "description": "Sets the billing address.", "fields": null, "inputFields": [ { - "name": "field", - "description": "Specifies the quote items field to sort by", + "name": "billing_address", + "description": "The billing address.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "ENUM", - "name": "SortQuoteItemsEnum", + "kind": "INPUT_OBJECT", + "name": "BillingAddressInput", "ofType": null } }, "defaultValue": null }, { - "name": "order", - "description": "Specifies the order of quote items' sorting", + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "SCALAR", + "name": "String", "ofType": null } }, @@ -23740,13 +23652,23 @@ }, { "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", - "description": "Defines a customizable option.", + "name": "BillingAddressInput", + "description": "Defines the billing address.", "fields": null, "inputFields": [ { - "name": "id", - "description": "The customizable option ID of the product.", + "name": "address", + "description": "Defines a billing address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CartAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customer_address_id", + "description": "An ID from the customer's address book that uniquely identifies the address to be used for billing.", "type": { "kind": "SCALAR", "name": "Int", @@ -23755,8 +23677,8 @@ "defaultValue": null }, { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address to be used for billing.", "type": { "kind": "SCALAR", "name": "ID", @@ -23765,16 +23687,22 @@ "defaultValue": null }, { - "name": "value_string", - "description": "The string value of the option.", + "name": "same_as_shipping", + "description": "Indicates whether to set the billing address to be the same as the existing shipping address on the cart.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "use_for_shipping", + "description": "Indicates whether to set the shipping address to be the same as this billing address.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "defaultValue": null } @@ -23785,13 +23713,13 @@ }, { "kind": "INPUT_OBJECT", - "name": "ApplyCouponToCartInput", - "description": "Specifies the coupon code to apply to the cart.", + "name": "CartAddressInput", + "description": "Defines the billing or shipping address to be applied to the cart.", "fields": null, "inputFields": [ { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", + "name": "city", + "description": "The city specified for the billing or shipping address.", "type": { "kind": "NON_NULL", "name": null, @@ -23804,8 +23732,18 @@ "defaultValue": null }, { - "name": "coupon_code", - "description": "A valid coupon code.", + "name": "company", + "description": "The company specified for the billing or shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country_code", + "description": "The country code and label for the billing or shipping address.", "type": { "kind": "NON_NULL", "name": null, @@ -23816,21 +23754,34 @@ } }, "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "UpdateCartItemsInput", - "description": "Modifies the specified items in the cart.", - "fields": null, - "inputFields": [ + }, { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", + "name": "custom_attributes", + "description": "The custom attribute values of the billing or shipping address.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeValueInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "fax", + "description": "The customer's fax number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "firstname", + "description": "The first name of the customer or guest.", "type": { "kind": "NON_NULL", "name": null, @@ -23843,139 +23794,127 @@ "defaultValue": null }, { - "name": "cart_items", - "description": "An array of items to be updated.", + "name": "lastname", + "description": "The last name of the customer or guest.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemUpdateInput", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null } }, "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CartItemUpdateInput", - "description": "A single item to be updated.", - "fields": null, - "inputFields": [ + }, { - "name": "cart_item_id", - "description": "Deprecated. Use `cart_item_uid` instead.", + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "defaultValue": null }, { - "name": "cart_item_uid", - "description": "The unique ID for a `CartItemInterface` object.", + "name": "postcode", + "description": "The ZIP or postal code of the billing or shipping address.", "type": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null }, "defaultValue": null }, { - "name": "customizable_options", - "description": "An array that defines customizable options for the product.", + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "defaultValue": null }, { - "name": "gift_message", - "description": "Gift message details for the cart item", + "name": "region", + "description": "A string that defines the state or province of the billing or shipping address.", "type": { - "kind": "INPUT_OBJECT", - "name": "GiftMessageInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, "defaultValue": null }, { - "name": "gift_wrapping_id", - "description": "The unique ID for a `GiftWrapping` object to be used for the cart item.", + "name": "region_id", + "description": "An integer that defines the state or province of the billing or shipping address.", "type": { "kind": "SCALAR", - "name": "ID", + "name": "Int", "ofType": null }, "defaultValue": null }, { - "name": "quantity", - "description": "The new quantity of the item.", + "name": "save_in_address_book", + "description": "Determines whether to save the address in the customer's address book. The default value is true.", "type": { "kind": "SCALAR", - "name": "Float", + "name": "Boolean", "ofType": null }, "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RemoveItemFromCartInput", - "description": "Specifies which items to remove from the cart.", - "fields": null, - "inputFields": [ + }, { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", + "name": "street", + "description": "An array containing the street for the billing or shipping address.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } } }, "defaultValue": null }, { - "name": "cart_item_id", - "description": "Deprecated. Use `cart_item_uid` instead.", + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "defaultValue": null }, { - "name": "cart_item_uid", - "description": "Required field. The unique ID for a `CartItemInterface` object.", + "name": "telephone", + "description": "The telephone number for the billing or shipping address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "vat_id", + "description": "The VAT company number for billing or shipping address.", "type": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null }, "defaultValue": null @@ -23987,8 +23926,8 @@ }, { "kind": "INPUT_OBJECT", - "name": "SetShippingAddressesOnCartInput", - "description": "Specifies an array of addresses to use for shipping.", + "name": "SetShippingMethodsOnCartInput", + "description": "Applies one or shipping methods to the cart.", "fields": null, "inputFields": [ { @@ -24006,8 +23945,8 @@ "defaultValue": null }, { - "name": "shipping_addresses", - "description": "An array of shipping addresses.", + "name": "shipping_methods", + "description": "An array of shipping methods.", "type": { "kind": "NON_NULL", "name": null, @@ -24016,7 +23955,7 @@ "name": null, "ofType": { "kind": "INPUT_OBJECT", - "name": "ShippingAddressInput", + "name": "ShippingMethodInput", "ofType": null } } @@ -24030,420 +23969,27 @@ }, { "kind": "INPUT_OBJECT", - "name": "ShippingAddressInput", - "description": "Defines a single shipping address.", + "name": "ShippingMethodInput", + "description": "Defines the shipping carrier and method.", "fields": null, "inputFields": [ { - "name": "address", - "description": "Defines a shipping address.", + "name": "carrier_code", + "description": "A string that identifies a commercial carrier or an offline delivery method.", "type": { - "kind": "INPUT_OBJECT", - "name": "CartAddressInput", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "defaultValue": null }, { - "name": "customer_address_id", - "description": "An ID from the customer's address book that uniquely identifies the address to be used for shipping.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "customer_notes", - "description": "Text provided by the shopper.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pickup_location_code", - "description": "The code of Pickup Location which will be used for In-Store Pickup.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SetBillingAddressOnCartInput", - "description": "Sets the billing address.", - "fields": null, - "inputFields": [ - { - "name": "billing_address", - "description": "The billing address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "BillingAddressInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "BillingAddressInput", - "description": "Defines the billing address.", - "fields": null, - "inputFields": [ - { - "name": "address", - "description": "Defines a billing address.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CartAddressInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "customer_address_id", - "description": "An ID from the customer's address book that uniquely identifies the address to be used for billing.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "same_as_shipping", - "description": "Indicates whether to set the billing address to be the same as the existing shipping address on the cart.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "use_for_shipping", - "description": "Indicates whether to set the shipping address to be the same as this billing address.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CartAddressInput", - "description": "Defines the billing or shipping address to be applied to the cart.", - "fields": null, - "inputFields": [ - { - "name": "city", - "description": "The city specified for the billing or shipping address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "company", - "description": "The company specified for the billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "country_code", - "description": "The country code and label for the billing or shipping address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "custom_attributes", - "description": "The custom attribute values of the billing or shipping address.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "AttributeValueInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "fax", - "description": "The customer's fax number.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "firstname", - "description": "The first name of the customer or guest.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "lastname", - "description": "The last name of the customer or guest.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "middlename", - "description": "The middle name of the person associated with the billing/shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "postcode", - "description": "The ZIP or postal code of the billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "prefix", - "description": "An honorific, such as Dr., Mr., or Mrs.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "region", - "description": "A string that defines the state or province of the billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "region_id", - "description": "An integer that defines the state or province of the billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "save_in_address_book", - "description": "Determines whether to save the address in the customer's address book. The default value is true.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "street", - "description": "An array containing the street for the billing or shipping address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "suffix", - "description": "A value such as Sr., Jr., or III.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "telephone", - "description": "The telephone number for the billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "vat_id", - "description": "The VAT company number for billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SetShippingMethodsOnCartInput", - "description": "Applies one or shipping methods to the cart.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "shipping_methods", - "description": "An array of shipping methods.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "ShippingMethodInput", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ShippingMethodInput", - "description": "Defines the shipping carrier and method.", - "fields": null, - "inputFields": [ - { - "name": "carrier_code", - "description": "A string that identifies a commercial carrier or an offline delivery method.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "method_code", - "description": "A string that indicates which service a commercial carrier will use to ship items. For offline delivery methods, this value is similar to the label displayed on the checkout page.", + "name": "method_code", + "description": "A string that indicates which service a commercial carrier will use to ship items. For offline delivery methods, this value is similar to the label displayed on the checkout page.", "type": { "kind": "NON_NULL", "name": null, @@ -24723,6 +24269,16 @@ }, "defaultValue": null }, + { + "name": "payment_services_paypal_fastlane", + "description": "Required input for fastlane", + "type": { + "kind": "INPUT_OBJECT", + "name": "FastlaneMethodInput", + "ofType": null + }, + "defaultValue": null + }, { "name": "payment_services_paypal_google_pay", "description": "Required input for Google Pay button", @@ -25212,16 +24768,12 @@ "description": "An array of place order errors.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PlaceOrderError", - "ofType": null - } + "kind": "OBJECT", + "name": "PlaceOrderError", + "ofType": null } }, "isDeprecated": false, @@ -25300,6 +24852,47 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "ENUM", + "name": "PlaceOrderErrorCodes", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CART_NOT_FOUND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CART_NOT_ACTIVE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GUEST_EMAIL_MISSING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNABLE_TO_PLACE_ORDER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "OBJECT", "name": "Cart", @@ -25601,7 +25194,7 @@ "name": null, "ofType": { "kind": "OBJECT", - "name": "CartRule", + "name": "CartRuleStorefront", "ofType": null } }, @@ -25790,6 +25383,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "fax", "description": "The customer's fax number.", @@ -25827,8 +25432,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `customer_address_uid` instead." }, { "name": "lastname", @@ -25940,14 +25545,14 @@ }, { "name": "uid", - "description": "The unique id of the customer address.", + "description": "The unique id of the customer cart address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -26100,6 +25705,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "customer_notes", "description": "Text provided by the shopper.", @@ -26149,8 +25766,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `customer_address_uid` instead." }, { "name": "items_weight", @@ -26314,14 +25931,14 @@ }, { "name": "uid", - "description": "The unique id of the customer address.", + "description": "The unique id of the customer cart address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -26421,6 +26038,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "customer_notes", "description": null, @@ -26470,8 +26099,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `customer_address_uid` instead." }, { "name": "lastname", @@ -26583,14 +26212,14 @@ }, { "name": "uid", - "description": "The unique id of the customer address.", + "description": "The unique id of the customer cart address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -28853,47 +28482,6 @@ ], "possibleTypes": null }, - { - "kind": "ENUM", - "name": "PlaceOrderErrorCodes", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "CART_NOT_FOUND", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "CART_NOT_ACTIVE", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "GUEST_EMAIL_MISSING", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "UNABLE_TO_PLACE_ORDER", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "UNDEFINED", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, { "kind": "ENUM", "name": "ProductImageThumbnail", @@ -29176,35 +28764,6 @@ ], "possibleTypes": null }, - { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "description": "This enumeration defines the entity type.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "CMS_PAGE", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "PRODUCT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "CATEGORY", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, { "kind": "INPUT_OBJECT", "name": "ConfirmEmailInput", @@ -30348,11 +29907,11 @@ }, { "name": "group", - "description": "Name of the customer group assigned to the customer", + "description": "Customer group assigned to the customer", "args": [], "type": { "kind": "OBJECT", - "name": "CustomerGroup", + "name": "CustomerGroupStorefront", "ofType": null }, "isDeprecated": false, @@ -30372,15 +29931,19 @@ }, { "name": "id", - "description": "The ID assigned to the customer.", + "description": "The unique ID assigned to the customer.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "`id` is not needed as part of `Customer`, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side." + "isDeprecated": false, + "deprecationReason": null }, { "name": "is_subscribed", @@ -30836,7 +30399,7 @@ "name": null, "ofType": { "kind": "OBJECT", - "name": "CustomerSegment", + "name": "CustomerSegmentStorefront", "ofType": null } }, @@ -31265,8 +30828,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." }, { "name": "lastname", @@ -31380,6 +30943,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "uid", + "description": "The unique ID for a `CustomerAddress` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "vat_id", "description": "The customer's Value-added tax (VAT) number (for corporate customers).", @@ -33351,17 +32926,21 @@ }, { "kind": "OBJECT", - "name": "CustomerGroup", + "name": "CustomerGroupStorefront", "description": "Data of customer group.", "fields": [ { - "name": "name", - "description": "The name of customer group.", + "name": "uid", + "description": "The unique ID for a `CustomerGroup` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null @@ -37263,18 +36842,6 @@ "name": "ConfigurableProduct", "description": "Defines basic features of a configurable product and its simple product variants.", "fields": [ - { - "name": "activity", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "attribute_set_id", "description": "The attribute set assigned to the product.", @@ -37315,42 +36882,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "category_gear", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "climate", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "collar", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "color", "description": null, @@ -37485,66 +37016,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gender", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "gift_message_available", "description": "Returns a value indicating gift message availability for the product.", @@ -37637,18 +37108,6 @@ "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, - { - "name": "material", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "max_sale_qty", "description": "Maximum Qty Allowed in Shopping Cart", @@ -37753,18 +37212,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "new", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "new_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", @@ -37829,30 +37276,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "pattern", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "price", "description": "Indicates the price of an item.", @@ -37913,18 +37336,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "purpose", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "quantity", "description": "Amount of available stock", @@ -38050,34 +37461,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "rules", - "description": "Provides applied catalog rules in the current active cart", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CatalogRule", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", @@ -38090,18 +37473,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "size", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", @@ -38114,18 +37485,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", @@ -38202,54 +37561,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "swatch_image", "description": "The file name of a swatch image.", @@ -40238,8 +39549,8 @@ "name": "RequistionListItems", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Deprecated. Use requisition_list_items instead. Will be removed in a future release." }, { "name": "items_count", @@ -40273,6 +39584,39 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "requisition_list_items", + "description": "An array of products added to the requisition list.", + "args": [ + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "pageSize", + "description": "The maximum number of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + } + ], + "type": { + "kind": "OBJECT", + "name": "RequisitionListItems", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "uid", "description": "The unique requisition list ID.", @@ -40310,7 +39654,7 @@ { "kind": "OBJECT", "name": "RequistionListItems", - "description": "Contains an array of items added to a requisition list.", + "description": "Deprecated. Use RequisitionListItems via requisition_list_items. Will be removed in a future release.", "fields": [ { "name": "items", @@ -40367,13 +39711,13 @@ "possibleTypes": null }, { - "kind": "INTERFACE", - "name": "RequisitionListItemInterface", - "description": "The interface for requisition list items.", + "kind": "OBJECT", + "name": "RequisitionListItems", + "description": "Contains an array of items added to a requisition list.", "fields": [ { - "name": "customizable_options", - "description": "Selected custom options for an item in the requisition list.", + "name": "items", + "description": "An array of items in the requisition list.", "args": [], "type": { "kind": "NON_NULL", @@ -40382,8 +39726,8 @@ "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", + "kind": "INTERFACE", + "name": "RequisitionListItemInterface", "ofType": null } } @@ -40392,47 +39736,27 @@ "deprecationReason": null }, { - "name": "product", - "description": "Details about a requisition list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The amount added.", + "name": "page_info", + "description": "Pagination metadata.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for the requisition list item.", + "name": "total_pages", + "description": "The number of pages returned.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "Int", "ofType": null } }, @@ -40443,43 +39767,122 @@ "inputFields": null, "interfaces": [], "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "SimpleRequisitionListItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "VirtualRequisitionListItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "DownloadableRequisitionListItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleRequisitionListItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableRequisitionListItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardRequisitionListItem", - "ofType": null - } - ] + "possibleTypes": null }, { - "kind": "OBJECT", - "name": "SimpleRequisitionListItem", - "description": "Contains details about simple products added to a requisition list.", + "kind": "INTERFACE", + "name": "RequisitionListItemInterface", + "description": "The interface for requisition list items.", + "fields": [ + { + "name": "customizable_options", + "description": "Selected custom options for an item in the requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about a requisition list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The amount added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for the requisition list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SimpleRequisitionListItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VirtualRequisitionListItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DownloadableRequisitionListItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleRequisitionListItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableRequisitionListItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardRequisitionListItem", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "SimpleRequisitionListItem", + "description": "Contains details about simple products added to a requisition list.", "fields": [ { "name": "customizable_options", @@ -41421,13 +40824,13 @@ }, { "kind": "INPUT_OBJECT", - "name": "AddBundleProductsToCartInput", - "description": "Defines the bundle products to add to the cart.", + "name": "ApplyStoreCreditToCartInput", + "description": "Defines the input required to run the `applyStoreCreditToCart` mutation.", "fields": null, "inputFields": [ { "name": "cart_id", - "description": "The ID of the cart.", + "description": "The unique ID that identifies the customer's cart.", "type": { "kind": "NON_NULL", "name": null, @@ -41438,24 +40841,6 @@ } }, "defaultValue": null - }, - { - "name": "cart_items", - "description": "An array of bundle products to add.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "BundleProductCartItemInput", - "ofType": null - } - } - }, - "defaultValue": null } ], "interfaces": null, @@ -41463,113 +40848,51 @@ "possibleTypes": null }, { - "kind": "INPUT_OBJECT", - "name": "BundleProductCartItemInput", - "description": "Defines a single bundle product.", - "fields": null, - "inputFields": [ - { - "name": "bundle_options", - "description": "A mandatory array of options for the bundle product, including each chosen option and specified quantity.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "BundleOptionInput", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "customizable_options", - "description": "The ID and value of the option.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", - "ofType": null - } - }, - "defaultValue": null - }, + "kind": "OBJECT", + "name": "ApplyStoreCreditToCartOutput", + "description": "Defines the possible output for the `applyStoreCreditToCart` mutation.", + "fields": [ { - "name": "data", - "description": "The quantity and SKU of the bundle product.", + "name": "cart", + "description": "The contents of the specified shopping cart.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", + "kind": "OBJECT", + "name": "Cart", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null } ], - "interfaces": null, + "inputFields": null, + "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", - "name": "BundleOptionInput", - "description": "Defines the input for a bundle option.", + "name": "RemoveStoreCreditFromCartInput", + "description": "Defines the input required to run the `removeStoreCreditFromCart` mutation.", "fields": null, "inputFields": [ { - "name": "id", - "description": "The ID of the option.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "quantity", - "description": "The number of the selected item to add to the cart.", + "name": "cart_id", + "description": "The unique ID that identifies the customer's cart.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null } }, "defaultValue": null - }, - { - "name": "value", - "description": "An array with the chosen value of the option.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "defaultValue": null } ], "interfaces": null, @@ -41578,12 +40901,12 @@ }, { "kind": "OBJECT", - "name": "AddBundleProductsToCartOutput", - "description": "Contains details about the cart after adding bundle products.", + "name": "RemoveStoreCreditFromCartOutput", + "description": "Defines the possible output for the `removeStoreCreditFromCart` mutation.", "fields": [ { "name": "cart", - "description": "The cart after adding products.", + "description": "The contents of the specified shopping cart.", "args": [], "type": { "kind": "NON_NULL", @@ -41605,95 +40928,134 @@ }, { "kind": "OBJECT", - "name": "BundleCartItem", - "description": "An implementation for bundle product cart items.", + "name": "AppliedStoreCredit", + "description": "Contains the applied and current balances.", "fields": [ { - "name": "available_gift_wrapping", - "description": "The list of available gift wrapping options for the cart item.", + "name": "applied_balance", + "description": "The applied store credit balance to the current cart.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - } - } + "kind": "OBJECT", + "name": "Money", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "bundle_options", - "description": "An array containing the bundle options the shopper selected.", + "name": "current_balance", + "description": "The current balance remaining on store credit.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedBundleOption", - "ofType": null - } - } + "kind": "OBJECT", + "name": "Money", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "customizable_options", - "description": "An array containing the customizable options the shopper selected.", + "name": "enabled", + "description": "Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerStoreCredit", + "description": "Contains store credit information with balance and history.", + "fields": [ + { + "name": "balance_history", + "description": "Contains the customer's store credit balance history. If the history or store credit feature is disabled, then a null value will be returned.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", "ofType": null - } + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. This value is optional. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerStoreCreditHistory", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "discount", - "description": "Contains discount for quote line item.", + "name": "current_balance", + "description": "The current balance of store credit.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } + "kind": "OBJECT", + "name": "Money", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "errors", - "description": "An array of errors encountered while loading the cart item", + "name": "enabled", + "description": "Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerStoreCreditHistory", + "description": "Lists changes to the amount of store credit available to the customer.", + "fields": [ + { + "name": "items", + "description": "An array containing information about changes to the store credit available to the customer.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "CartItemError", + "name": "CustomerStoreCreditHistoryItem", "ofType": null } }, @@ -41701,88 +41063,79 @@ "deprecationReason": null }, { - "name": "gift_message", - "description": "The entered gift message for the cart item", + "name": "page_info", + "description": "Metadata for pagination rendering.", "args": [], "type": { "kind": "OBJECT", - "name": "GiftMessage", + "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "gift_wrapping", - "description": "The selected gift wrapping for the cart item.", + "name": "total_count", + "description": "The number of items returned.", "args": [], "type": { - "kind": "OBJECT", - "name": "GiftWrapping", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerStoreCreditHistoryItem", + "description": "Contains store credit history information.", + "fields": [ { - "name": "is_available", - "description": "True if requested quantity is less than available stock, false otherwise.", + "name": "action", + "description": "The action that was made on the store credit.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "max_qty", - "description": "Line item max qty in quote template", + "name": "actual_balance", + "description": "The store credit available to the customer as a result of this action. ", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "OBJECT", + "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "min_qty", - "description": "Line item min qty in quote template", + "name": "balance_change", + "description": "The amount added to or subtracted from the store credit as a result of this action.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "OBJECT", + "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "not_available_message", - "description": "Message to display when the product is not available with this selected option.", + "name": "date_time_changed", + "description": "The date and time when the store credit change was made.", "args": [], "type": { "kind": "SCALAR", @@ -41791,17 +41144,28 @@ }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderTotal", + "description": "Contains details about the sales total amounts used to calculate the final price.", + "fields": [ { - "name": "note_from_buyer", - "description": "The buyer's quote line item note.", + "name": "base_grand_total", + "description": "The final base grand total amount in the base currency.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", - "name": "ItemNote", + "name": "Money", "ofType": null } }, @@ -41809,15 +41173,15 @@ "deprecationReason": null }, { - "name": "note_from_seller", - "description": "The seller's quote line item note.", + "name": "discounts", + "description": "The applied discounts to the order.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "ItemNote", + "name": "Discount", "ofType": null } }, @@ -41825,27 +41189,27 @@ "deprecationReason": null }, { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", + "name": "gift_options", + "description": null, "args": [], "type": { "kind": "OBJECT", - "name": "CartItemPrices", + "name": "GiftOptionsPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "product", - "description": "Details about an item in the cart.", + "name": "grand_total", + "description": "The final total amount, including shipping, discounts, and taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "OBJECT", + "name": "Money", "ofType": null } }, @@ -41853,15 +41217,15 @@ "deprecationReason": null }, { - "name": "quantity", - "description": "The quantity of this item in the cart.", + "name": "grand_total_excl_tax", + "description": "The grand total of the order, excluding taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Float", + "kind": "OBJECT", + "name": "Money", "ofType": null } }, @@ -41869,80 +41233,43 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", + "name": "shipping_handling", + "description": "Details about the shipping and handling costs for the order.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "OBJECT", + "name": "ShippingHandling", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CartItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SelectedBundleOption", - "description": "Contains details about a selected bundle option.", - "fields": [ - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" }, { - "name": "label", - "description": "The display name of the selected bundle product option.", + "name": "subtotal", + "description": "The subtotal of the order, excluding shipping, discounts, and taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "Money", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use subtotal_excl_tax field instead" }, { - "name": "type", - "description": "The type of selected bundle product option.", + "name": "subtotal_excl_tax", + "description": "The subtotal of the order, excluding taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "Money", "ofType": null } }, @@ -41950,15 +41277,15 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `SelectedBundleOption` object", + "name": "subtotal_incl_tax", + "description": "The subtotal of the order, including taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "OBJECT", + "name": "Money", "ofType": null } }, @@ -41966,46 +41293,15 @@ "deprecationReason": null }, { - "name": "values", - "description": "An array of selected bundle option values.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedBundleOptionValue", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SelectedBundleOptionValue", - "description": "Contains details about a value for a selected bundle option.", - "fields": [ - { - "name": "id", - "description": "Use `uid` instead", + "name": "taxes", + "description": "The order tax details.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "TaxItem", "ofType": null } }, @@ -42013,56 +41309,32 @@ "deprecationReason": null }, { - "name": "label", - "description": "The display name of the value for the selected bundle product option.", + "name": "total_giftcard", + "description": "The gift card balance applied to the order.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "OBJECT", + "name": "Money", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "original_price", - "description": "The original price of the value for the selected bundle product option.", + "name": "total_reward_points", + "description": "The total reward points applied to the order.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } + "kind": "OBJECT", + "name": "Money", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price", - "description": "The price of the value for the selected bundle product option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use priceV2 instead." - }, - { - "name": "priceV2", - "description": "The price of the value for the selected bundle product option.", + "name": "total_shipping", + "description": "The shipping amount for the order.", "args": [], "type": { "kind": "NON_NULL", @@ -42077,31 +41349,27 @@ "deprecationReason": null }, { - "name": "quantity", - "description": "The quantity of the value for the selected bundle product option.", + "name": "total_store_credit", + "description": "The total store credit applied to the order.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "OBJECT", + "name": "Money", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `SelectedBundleOptionValue` object", + "name": "total_tax", + "description": "The amount of tax applied to the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "OBJECT", + "name": "Money", "ofType": null } }, @@ -42116,106 +41384,110 @@ }, { "kind": "OBJECT", - "name": "PriceDetails", - "description": "Can be used to retrieve the main price details in case of bundle product", + "name": "OrderAddress", + "description": "Contains detailed information about an order's billing and shipping addresses.", "fields": [ { - "name": "discount_percentage", - "description": "The percentage of discount applied to the main product price", + "name": "city", + "description": "The city or town.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "main_final_price", - "description": "The final price after applying the discount to the main product", + "name": "company", + "description": "The customer's company.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "main_price", - "description": "The regular price of the main product", + "name": "country_code", + "description": "The customer's country.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "ENUM", + "name": "CountryCodeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleItem", - "description": "Defines an individual item within a bundle product.", - "fields": [ - { - "name": "option_id", - "description": "An ID assigned to each type of item in a bundle product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" }, { - "name": "options", - "description": "An array of additional options for this bundle item.", - "args": [], + "name": "custom_attributesV2", + "description": "Custom attributes assigned to the customer address.", + "args": [ + { + "name": "attributeCodes", + "description": "", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "BundleItemOption", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "position", - "description": "A number indicating the sequence order of this item compared to the other bundle items.", + "name": "fax", + "description": "The fax number.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price_range", - "description": "The range of prices for the product", + "name": "firstname", + "description": "The first name of the person associated with the shipping/billing address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "PriceRange", + "kind": "SCALAR", + "name": "String", "ofType": null } }, @@ -42223,20 +41495,24 @@ "deprecationReason": null }, { - "name": "required", - "description": "Indicates whether the item must be included in the bundle.", + "name": "lastname", + "description": "The family name of the person associated with the shipping/billing address.", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The SKU of the bundle product.", + "name": "middlename", + "description": "The middle name of the person associated with the shipping/billing address.", "args": [], "type": { "kind": "SCALAR", @@ -42247,8 +41523,8 @@ "deprecationReason": null }, { - "name": "title", - "description": "The display name of the item.", + "name": "postcode", + "description": "The customer's ZIP or postal code.", "args": [], "type": { "kind": "SCALAR", @@ -42259,8 +41535,8 @@ "deprecationReason": null }, { - "name": "type", - "description": "The input type that the customer uses to select the item. Examples include radio button and checkbox.", + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", "args": [], "type": { "kind": "SCALAR", @@ -42271,67 +41547,52 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `BundleItem` object.", + "name": "region", + "description": "The state or province name.", "args": [], "type": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleItemOption", - "description": "Defines the characteristics that comprise a specific bundle item and its options.", - "fields": [ + }, { - "name": "can_change_quantity", - "description": "Indicates whether the customer can change the number of items for this option.", + "name": "region_id", + "description": "The unique ID for a `Region` object of a pre-defined region.", "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The ID assigned to the bundled item option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "is_default", - "description": "Indicates whether this option is the default option.", + "name": "street", + "description": "An array of strings that define the street number and name.", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "label", - "description": "The text that identifies the bundled item option.", + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", "args": [], "type": { "kind": "SCALAR", @@ -42342,150 +41603,234 @@ "deprecationReason": null }, { - "name": "position", - "description": "When a bundle item contains multiple options, the relative position of this option compared to the other options.", + "name": "telephone", + "description": "The telephone number.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price", - "description": "The price of the selected option.", + "name": "vat_id", + "description": "The customer's Value-added tax (VAT) number (for corporate customers).", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddDownloadableProductsToCartInput", + "description": "", + "fields": null, + "inputFields": [ { - "name": "price_type", - "description": "One of FIXED, PERCENT, or DYNAMIC.", - "args": [], + "name": "cart_id", + "description": "The ID of the cart.", "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "product", - "description": "Contains details about this product option.", - "args": [], + "name": "cart_items", + "description": "An array of downloadable products to add.", "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DownloadableProductCartItemInput", + "ofType": null + } + } }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DownloadableProductCartItemInput", + "description": "Defines a single downloadable product.", + "fields": null, + "inputFields": [ { - "name": "qty", - "description": "Indicates the quantity of this specific bundle item.", - "args": [], + "name": "customizable_options", + "description": "The ID and value of the option.", "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use `quantity` instead." + "defaultValue": null }, { - "name": "quantity", - "description": "The quantity of this specific bundle item.", - "args": [], + "name": "data", + "description": "The quantity and SKU of the downloadable product.", "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "uid", - "description": "The unique ID for a `BundleItemOption` object.", - "args": [], + "name": "downloadable_product_links", + "description": "An array of objects containing the link_id of the downloadable product link.", "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "INPUT_OBJECT", + "name": "DownloadableProductLinksInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null } ], - "inputFields": null, - "interfaces": [], + "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "BundleProduct", - "description": "Defines basic features of a bundle product and contains multiple BundleItems.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "DownloadableProductLinksInput", + "description": "Contains the link ID for the downloadable product.", + "fields": null, + "inputFields": [ { - "name": "activity", - "description": null, - "args": [], + "name": "link_id", + "description": "The unique ID of the downloadable product link.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddDownloadableProductsToCartOutput", + "description": "Contains details about the cart after adding downloadable products.", + "fields": [ { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", + "name": "cart", + "description": "The cart after adding products.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableCartItem", + "description": "An implementation for downloadable product cart items.", + "fields": [ + { + "name": "customizable_options", + "description": "An array containing the customizable options the shopper selected.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null }, { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "name": "discount", + "description": "Contains discount for quote line item.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "categories", - "description": "The categories assigned to a product.", + "name": "errors", + "description": "An array of errors encountered while loading the cart item", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", + "kind": "OBJECT", + "name": "CartItemError", "ofType": null } }, @@ -42493,87 +41838,99 @@ "deprecationReason": null }, { - "name": "category_gear", + "name": "id", "description": null, "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "Use `uid` instead." }, { - "name": "climate", - "description": null, + "name": "is_available", + "description": "True if requested quantity is less than available stock, false otherwise.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "collar", - "description": null, + "name": "links", + "description": "An array containing information about the links for the downloadable product added to the cart.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductLinks", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "color", - "description": null, + "name": "max_qty", + "description": "Line item max qty in quote template", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "country_of_manufacture", - "description": "The product's country of origin.", + "name": "min_qty", + "description": "Line item min qty in quote template", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", + "name": "not_available_message", + "description": "Message to display when the product is not available with this selected option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "crosssell_products", - "description": "An array of cross-sell products.", + "name": "note_from_buyer", + "description": "The buyer's quote line item note.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "OBJECT", + "name": "ItemNote", "ofType": null } }, @@ -42581,79 +41938,117 @@ "deprecationReason": null }, { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], + "name": "note_from_seller", + "description": "The seller's quote line item note.", + "args": [], "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", "args": [], "type": { "kind": "OBJECT", - "name": "ComplexTextValue", + "name": "CartItemPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "dynamic_price", - "description": "Indicates whether the bundle product has a dynamic price.", + "name": "product", + "description": "Details about an item in the cart.", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "dynamic_sku", - "description": "Indicates whether the bundle product has a dynamic SKU.", + "name": "quantity", + "description": "The quantity of this item in the cart.", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "dynamic_weight", - "description": "Indicates whether the bundle product has a dynamically calculated weight.", + "name": "samples", + "description": "An array containing information about samples of the selected downloadable product.", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductSamples", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "eco_collection", - "description": null, + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableProduct", + "description": "Defines a product that the shopper downloads.", + "fields": [ + { + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", "args": [], "type": { "kind": "SCALAR", @@ -42661,47 +42056,63 @@ "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "erin_recommends", - "description": null, + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categories", + "description": "The categories assigned to a product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null }, { - "name": "features_bags", + "name": "color", "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "format", - "description": null, + "name": "country_of_manufacture", + "description": "The product's country of origin.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "gender", - "description": null, + "name": "created_at", + "description": "Timestamp indicating when the product was created.", "args": [], "type": { "kind": "SCALAR", @@ -42709,7 +42120,90 @@ "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "crosssell_products", + "description": "An array of cross-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributesV2", + "description": "Product custom attributes.", + "args": [ + { + "name": "filters", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "downloadable_product_links", + "description": "An array containing information about the links for this downloadable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductLinks", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "downloadable_product_samples", + "description": "An array containing information about samples of this downloadable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductSamples", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null }, { "name": "gift_message_available", @@ -42792,40 +42286,36 @@ "deprecationReason": null }, { - "name": "items", - "description": "An array containing information about individual bundle items.", + "name": "links_purchased_separately", + "description": "A value of 1 indicates that each link in the array must be purchased separately.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "BundleItem", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", + "name": "links_title", + "description": "The heading above the list of downloadable products.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "material", - "description": null, + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": true, @@ -42935,18 +42425,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "new", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "new_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", @@ -43011,30 +42489,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "pattern", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "price", "description": "Indicates the price of an item.", @@ -43047,18 +42501,6 @@ "isDeprecated": true, "deprecationReason": "Use `price_range` for product price information." }, - { - "name": "price_details", - "description": "The price details of the main product", - "args": [], - "type": { - "kind": "OBJECT", - "name": "PriceDetails", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "price_range", "description": "The range of prices for the product", @@ -43091,18 +42533,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "price_view", - "description": "One of PRICE_RANGE or AS_LOW_AS.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PriceViewEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "product_links", "description": "An array of `ProductLinks` objects.", @@ -43120,28 +42550,16 @@ "deprecationReason": null }, { - "name": "purpose", - "description": null, + "name": "quantity", + "description": "Amount of available stock", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "quantity", - "description": "Amount of available stock", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": false, + "deprecationReason": null }, { "name": "rating_summary", @@ -43256,46 +42674,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "rules", - "description": "Provides applied catalog rules in the current active cart", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CatalogRule", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "ship_bundle_items", - "description": "Indicates whether to ship bundle items together or individually.", - "args": [], - "type": { - "kind": "ENUM", - "name": "ShipBundleItemsEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", @@ -43308,18 +42686,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "size", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", @@ -43332,18 +42698,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", @@ -43420,54 +42774,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "swatch_image", "description": "The file name of a swatch image.", @@ -43655,18 +42961,6 @@ }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null } ], "inputFields": null, @@ -43681,11 +42975,6 @@ "name": "RoutableInterface", "ofType": null }, - { - "kind": "INTERFACE", - "name": "PhysicalProductInterface", - "ofType": null - }, { "kind": "INTERFACE", "name": "CustomizableProductInterface", @@ -43697,65 +42986,272 @@ }, { "kind": "ENUM", - "name": "PriceViewEnum", - "description": "Defines whether a bundle product's price is displayed as the lowest possible value or as a range.", + "name": "DownloadableFileTypeEnum", + "description": "", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { - "name": "PRICE_RANGE", + "name": "FILE", "description": "", + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "URL", + "description": "", + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableProductLinks", + "description": "Defines characteristics of a downloadable product.", + "fields": [ + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This information should not be exposed on frontend." + }, + { + "name": "is_shareable", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This information should not be exposed on frontend." + }, + { + "name": "link_type", + "description": null, + "args": [], + "type": { + "kind": "ENUM", + "name": "DownloadableFileTypeEnum", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "number_of_downloads", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This information should not be exposed on frontend." + }, + { + "name": "price", + "description": "The price of the downloadable product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "AS_LOW_AS", - "description": "", + "name": "sample_file", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "sample_type", + "description": null, + "args": [], + "type": { + "kind": "ENUM", + "name": "DownloadableFileTypeEnum", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "sample_url", + "description": "The full URL to the downloadable sample.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "A number indicating the sort order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name of the link.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `DownloadableProductLinks` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null } ], + "inputFields": null, + "interfaces": [], + "enumValues": null, "possibleTypes": null }, { - "kind": "ENUM", - "name": "ShipBundleItemsEnum", - "description": "Defines whether bundle items must be shipped together.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ + "kind": "OBJECT", + "name": "DownloadableProductSamples", + "description": "Defines characteristics of a downloadable product.", + "fields": [ { - "name": "TOGETHER", - "description": "", + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This information should not be exposed on frontend." + }, + { + "name": "sample_file", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "sample_type", + "description": null, + "args": [], + "type": { + "kind": "ENUM", + "name": "DownloadableFileTypeEnum", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "sample_url", + "description": "The full URL to the downloadable sample.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "SEPARATELY", - "description": "", + "name": "sort_order", + "description": "A number indicating the sort order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name of the sample.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null } ], + "inputFields": null, + "interfaces": [], + "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "BundleOrderItem", - "description": "Defines bundle product options for `OrderItemInterface`.", + "name": "DownloadableOrderItem", + "description": "Defines downloadable product options for `OrderItemInterface`.", "fields": [ { - "name": "bundle_options", - "description": "A list of bundle options that are assigned to the bundle product.", + "name": "discounts", + "description": "The final discount information for the product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "ItemSelectedBundleOption", + "name": "Discount", "ofType": null } }, @@ -43763,15 +43259,15 @@ "deprecationReason": null }, { - "name": "discounts", - "description": "The final discount information for the product.", + "name": "downloadable_links", + "description": "A list of downloadable links that are ordered from the downloadable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "Discount", + "name": "DownloadableItemsLinks", "ofType": null } }, @@ -43846,18 +43342,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "parent_sku", - "description": "The SKU of parent product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "prices", "description": "Contains details about the price of the item, including taxes and discounts.", @@ -44076,19 +43560,19 @@ }, { "kind": "OBJECT", - "name": "BundleInvoiceItem", - "description": "Defines bundle product options for `InvoiceItemInterface`.", + "name": "DownloadableInvoiceItem", + "description": "Defines downloadable product options for `InvoiceItemInterface`.", "fields": [ { - "name": "bundle_options", - "description": "A list of bundle options that are assigned to an invoiced bundle product.", + "name": "discounts", + "description": "Information about the final discount amount for the base product, including discounts on options.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "ItemSelectedBundleOption", + "name": "Discount", "ofType": null } }, @@ -44096,15 +43580,15 @@ "deprecationReason": null }, { - "name": "discounts", - "description": "Information about the final discount amount for the base product, including discounts on options.", + "name": "downloadable_links", + "description": "A list of downloadable links that are invoiced from the downloadable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "Discount", + "name": "DownloadableItemsLinks", "ofType": null } }, @@ -44209,19 +43693,35 @@ }, { "kind": "OBJECT", - "name": "BundleShipmentItem", - "description": "Defines bundle product options for `ShipmentItemInterface`.", + "name": "DownloadableCreditMemoItem", + "description": "Defines downloadable product options for `CreditMemoItemInterface`.", "fields": [ { - "name": "bundle_options", - "description": "A list of bundle options that are assigned to a shipped product.", + "name": "discounts", + "description": "Details about the final discount amount for the base product, including discounts on options.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "ItemSelectedBundleOption", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "downloadable_links", + "description": "A list of downloadable links that are refunded from the downloadable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableItemsLinks", "ofType": null } }, @@ -44230,7 +43730,7 @@ }, { "name": "id", - "description": "The unique ID for a `ShipmentItemInterface` object.", + "description": "The unique ID for a `CreditMemoItemInterface` object.", "args": [], "type": { "kind": "NON_NULL", @@ -44246,7 +43746,7 @@ }, { "name": "order_item", - "description": "The order item associated with the shipment item.", + "description": "The order item the credit memo is applied to.", "args": [], "type": { "kind": "INTERFACE", @@ -44270,7 +43770,7 @@ }, { "name": "product_sale_price", - "description": "The sale price for the base product.", + "description": "The sale price for the base product, including selected options.", "args": [], "type": { "kind": "NON_NULL", @@ -44301,17 +43801,13 @@ "deprecationReason": null }, { - "name": "quantity_shipped", - "description": "The number of shipped items.", + "name": "quantity_refunded", + "description": "The number of refunded items.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null @@ -44321,7 +43817,7 @@ "interfaces": [ { "kind": "INTERFACE", - "name": "ShipmentItemInterface", + "name": "CreditMemoItemInterface", "ofType": null } ], @@ -44330,44 +43826,36 @@ }, { "kind": "OBJECT", - "name": "BundleCreditMemoItem", - "description": "Defines bundle product options for `CreditMemoItemInterface`.", + "name": "DownloadableItemsLinks", + "description": "Defines characteristics of the links for downloadable product.", "fields": [ { - "name": "bundle_options", - "description": "A list of bundle options that are assigned to a bundle product that is part of a credit memo.", + "name": "sort_order", + "description": "A number indicating the sort order.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemSelectedBundleOption", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "discounts", - "description": "Details about the final discount amount for the base product, including discounts on options.", + "name": "title", + "description": "The display name of the link.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The unique ID for a `CreditMemoItemInterface` object.", + "name": "uid", + "description": "The unique ID for a `DownloadableItemsLinks` object.", "args": [], "type": { "kind": "NON_NULL", @@ -44380,41 +43868,28 @@ }, "isDeprecated": false, "deprecationReason": null - }, - { - "name": "order_item", - "description": "The order item the credit memo is applied to.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableWishlistItem", + "description": "A downloadable product wish list item.", + "fields": [ { - "name": "product_sale_price", - "description": "The sale price for the base product, including selected options.", + "name": "added_at", + "description": "The date and time the item was added to the wish list.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "String", "ofType": null } }, @@ -44422,53 +43897,40 @@ "deprecationReason": null }, { - "name": "product_sku", - "description": "The SKU of the base product.", + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "quantity_refunded", - "description": "The number of refunded items.", + "name": "description", + "description": "The description of the item.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CreditMemoItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ItemSelectedBundleOption", - "description": "A list of options of the selected bundle product.", - "fields": [ + }, { "name": "id", - "description": "The unique ID for a `ItemSelectedBundleOption` object.", + "description": "The unique ID for a `WishlistItemInterface` object.", "args": [], "type": { "kind": "NON_NULL", @@ -44479,19 +43941,19 @@ "ofType": null } }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "label", - "description": "The label of the option.", + "name": "links_v2", + "description": "An array containing information about the selected links.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "DownloadableProductLinks", "ofType": null } }, @@ -44499,15 +43961,27 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `ItemSelectedBundleOption` object.", + "name": "product", + "description": "Product details of the wish list item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this wish list item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "Float", "ofType": null } }, @@ -44515,15 +43989,15 @@ "deprecationReason": null }, { - "name": "values", - "description": "A list of products that represent the values of the parent option.", + "name": "samples", + "description": "An array containing information about the selected samples.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "ItemSelectedBundleOptionValue", + "name": "DownloadableProductSamples", "ofType": null } }, @@ -44532,41 +44006,31 @@ } ], "inputFields": null, - "interfaces": [], + "interfaces": [ + { + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null + } + ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "ItemSelectedBundleOptionValue", - "description": "A list of values for the selected bundle product.", + "name": "Company", + "description": "Contains the output schema for a company.", "fields": [ { - "name": "id", - "description": "The unique ID for a `ItemSelectedBundleOptionValue` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "price", - "description": "The price of the child bundle product.", + "name": "acl_resources", + "description": "The list of all resources defined within the company.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "Money", + "name": "CompanyAclResource", "ofType": null } }, @@ -44574,31 +44038,27 @@ "deprecationReason": null }, { - "name": "product_name", - "description": "The name of the child bundle product.", + "name": "company_admin", + "description": "An object containing information about the company administrator.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "OBJECT", + "name": "Customer", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "product_sku", - "description": "The SKU of the child bundle product.", + "name": "credit", + "description": "Company credit balances and limits.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "CompanyCredit", "ofType": null } }, @@ -44606,15 +44066,46 @@ "deprecationReason": null }, { - "name": "quantity", - "description": "The number of this bundle product that were ordered.", - "args": [], + "name": "credit_history", + "description": "Details about the history of company credit operations.", + "args": [ + { + "name": "filter", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompanyCreditHistoryFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Float", + "kind": "OBJECT", + "name": "CompanyCreditHistory", "ofType": null } }, @@ -44622,42 +44113,27 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `ItemSelectedBundleOptionValue` object.", + "name": "email", + "description": "The email address of the company contact.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleWishlistItem", - "description": "Defines bundle product options for `WishlistItemInterface`.", - "fields": [ + }, { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", + "name": "id", + "description": "The unique ID of a `Company` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -44665,44 +44141,32 @@ "deprecationReason": null }, { - "name": "bundle_options", - "description": "An array containing information about the selected bundle items.", + "name": "legal_address", + "description": "The address where the company is registered to conduct business.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedBundleOption", - "ofType": null - } + "kind": "OBJECT", + "name": "CompanyLegalAddress", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", + "name": "legal_name", + "description": "The full legal name of the company.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "description", - "description": "The description of the item.", + "name": "name", + "description": "The name of the company.", "args": [], "type": { "kind": "SCALAR", @@ -44713,15 +44177,15 @@ "deprecationReason": null }, { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", + "name": "payment_methods", + "description": "The list of payment methods available to a company.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, @@ -44729,208 +44193,197 @@ "deprecationReason": null }, { - "name": "product", - "description": "Product details of the wish list item.", + "name": "reseller_id", + "description": "The resale number that is assigned to the company for tax reporting purposes.", "args": [], "type": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "quantity", - "description": "The quantity of this wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "name": "role", + "description": "A company role filtered by the unique ID of a `CompanyRole` object.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyRole", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ApplyStoreCreditToCartInput", - "description": "Defines the input required to run the `applyStoreCreditToCart` mutation.", - "fields": null, - "inputFields": [ + }, { - "name": "cart_id", - "description": "The unique ID that identifies the customer's cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "name": "roles", + "description": "An object that contains a list of company roles.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ApplyStoreCreditToCartOutput", - "description": "Defines the possible output for the `applyStoreCreditToCart` mutation.", - "fields": [ - { - "name": "cart", - "description": "The contents of the specified shopping cart.", - "args": [], + ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", - "name": "Cart", + "name": "CompanyRoles", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RemoveStoreCreditFromCartInput", - "description": "Defines the input required to run the `removeStoreCreditFromCart` mutation.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID that identifies the customer's cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RemoveStoreCreditFromCartOutput", - "description": "Defines the possible output for the `removeStoreCreditFromCart` mutation.", - "fields": [ + }, { - "name": "cart", - "description": "The contents of the specified shopping cart.", + "name": "sales_representative", + "description": "An object containing information about the company sales representative.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } + "kind": "OBJECT", + "name": "CompanySalesRepresentative", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AppliedStoreCredit", - "description": "Contains the applied and current balances.", - "fields": [ + }, { - "name": "applied_balance", - "description": "The applied store credit balance to the current cart.", - "args": [], + "name": "structure", + "description": "The company structure of teams and customers in depth-first order.", + "args": [ + { + "name": "rootId", + "description": "The ID of the node in the company structure that serves as the root for the query.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "depth", + "description": "The maximum depth that can be reached when listing structure nodes.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "10" + } + ], "type": { "kind": "OBJECT", - "name": "Money", + "name": "CompanyStructure", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "current_balance", - "description": "The current balance remaining on store credit.", - "args": [], + "name": "team", + "description": "The company team data filtered by the unique ID for a `CompanyTeam` object.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], "type": { "kind": "OBJECT", - "name": "Money", + "name": "CompanyTeam", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "enabled", - "description": "Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned.", - "args": [], + "name": "user", + "description": "A company user filtered by the unique ID of a `Customer` object.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], "type": { - "kind": "SCALAR", - "name": "Boolean", + "kind": "OBJECT", + "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerStoreCredit", - "description": "Contains store credit information with balance and history.", - "fields": [ + }, { - "name": "balance_history", - "description": "Contains the customer's store credit balance history. If the history or store credit feature is disabled, then a null value will be returned.", + "name": "users", + "description": "An object that contains a list of company users based on activity status.", "args": [ + { + "name": "filter", + "description": "The type of company users to return.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompanyUsersFilterInput", + "ofType": null + }, + "defaultValue": null + }, { "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", + "description": "The maximum number of results to return at once. The default value is 20.", "type": { "kind": "SCALAR", "name": "Int", @@ -44940,7 +44393,7 @@ }, { "name": "currentPage", - "description": "The page of results to return. This value is optional. The default is 1.", + "description": "The page of results to return. The default value is 1.", "type": { "kind": "SCALAR", "name": "Int", @@ -44951,31 +44404,19 @@ ], "type": { "kind": "OBJECT", - "name": "CustomerStoreCreditHistory", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "current_balance", - "description": "The current balance of store credit.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", + "name": "CompanyUsers", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "enabled", - "description": "Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned.", + "name": "vat_tax_id", + "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "String", "ofType": null }, "isDeprecated": false, @@ -44989,63 +44430,36 @@ }, { "kind": "OBJECT", - "name": "CustomerStoreCreditHistory", - "description": "Lists changes to the amount of store credit available to the customer.", + "name": "CompanyLegalAddress", + "description": "Contains details about the address where the company is registered to conduct business.", "fields": [ { - "name": "items", - "description": "An array containing information about changes to the store credit available to the customer.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomerStoreCreditHistoryItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Metadata for pagination rendering.", + "name": "city", + "description": "The city where the company is registered to conduct business.", "args": [], "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "total_count", - "description": "The number of items returned.", + "name": "country_code", + "description": "The country code of the company's legal address.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "ENUM", + "name": "CountryCodeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerStoreCreditHistoryItem", - "description": "Contains store credit history information.", - "fields": [ + }, { - "name": "action", - "description": "The action that was made on the store credit.", + "name": "postcode", + "description": "The company's postal code.", "args": [], "type": { "kind": "SCALAR", @@ -45056,32 +44470,36 @@ "deprecationReason": null }, { - "name": "actual_balance", - "description": "The store credit available to the customer as a result of this action. ", + "name": "region", + "description": "An object containing region data for the company.", "args": [], "type": { "kind": "OBJECT", - "name": "Money", + "name": "CustomerAddressRegion", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "balance_change", - "description": "The amount added to or subtracted from the store credit as a result of this action.", + "name": "street", + "description": "An array of strings that define the company's street address.", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "date_time_changed", - "description": "The date and time when the store credit change was made.", + "name": "telephone", + "description": "The company's phone number.", "args": [], "type": { "kind": "SCALAR", @@ -45099,63 +44517,55 @@ }, { "kind": "OBJECT", - "name": "OrderTotal", - "description": "Contains details about the sales total amounts used to calculate the final price.", + "name": "CompanyAdmin", + "description": "Contains details about the company administrator.", "fields": [ { - "name": "base_grand_total", - "description": "The final base grand total amount in the base currency.", + "name": "email", + "description": "The email address of the company administrator.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "discounts", - "description": "The applied discounts to the order.", + "name": "firstname", + "description": "The company administrator's first name.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "gift_options", - "description": null, + "name": "gender", + "description": "The company administrator's gender (Male - 1, Female - 2, Not Specified - 3).", "args": [], "type": { - "kind": "OBJECT", - "name": "GiftOptionsPrices", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "grand_total", - "description": "The final total amount, including shipping, discounts, and taxes.", + "name": "id", + "description": "The unique ID for a `CompanyAdmin` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, @@ -45163,143 +44573,188 @@ "deprecationReason": null }, { - "name": "shipping_handling", - "description": "Details about the shipping and handling costs for the order.", + "name": "job_title", + "description": "The job title of the company administrator.", "args": [], "type": { - "kind": "OBJECT", - "name": "ShippingHandling", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "subtotal", - "description": "The subtotal of the order, excluding shipping, discounts, and taxes.", + "name": "lastname", + "description": "The company administrator's last name.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use subtotal_excl_tax field instead" - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanySalesRepresentative", + "description": "Contains details about a company sales representative.", + "fields": [ { - "name": "subtotal_excl_tax", - "description": "The subtotal of the order, excluding taxes.", + "name": "email", + "description": "The email address of the company sales representative.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "subtotal_incl_tax", - "description": "The subtotal of the order, including taxes.", + "name": "firstname", + "description": "The company sales representative's first name.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "taxes", - "description": "The order tax details.", + "name": "lastname", + "description": "The company sales representative's last name.", "args": [], "type": { - "kind": "LIST", + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyUsers", + "description": "Contains details about company users.", + "fields": [ + { + "name": "items", + "description": "An array of `CompanyUser` objects that match the specified filter criteria.", + "args": [], + "type": { + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "TaxItem", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "total_giftcard", - "description": "The gift card balance applied to the order.", + "name": "page_info", + "description": "Pagination metadata.", "args": [], "type": { "kind": "OBJECT", - "name": "Money", + "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "total_reward_points", - "description": "The total reward points applied to the order.", + "name": "total_count", + "description": "The number of objects returned.", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyRoles", + "description": "Contains an array of roles.", + "fields": [ { - "name": "total_shipping", - "description": "The shipping amount for the order.", + "name": "items", + "description": "A list of company roles that match the specified filter criteria.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyRole", + "ofType": null + } } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "total_store_credit", - "description": "The total store credit applied to the order.", + "name": "page_info", + "description": "Pagination metadata.", "args": [], "type": { "kind": "OBJECT", - "name": "Money", + "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "total_tax", - "description": "The amount of tax applied to the order.", + "name": "total_count", + "description": "The total number of objects matching the specified filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "Int", "ofType": null } }, @@ -45314,19 +44769,19 @@ }, { "kind": "OBJECT", - "name": "OrderAddress", - "description": "Contains detailed information about an order's billing and shipping addresses.", + "name": "CompanyRole", + "description": "Contails details about a single role.", "fields": [ { - "name": "city", - "description": "The city or town.", + "name": "id", + "description": "The unique ID for a `CompanyRole` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -45334,8 +44789,8 @@ "deprecationReason": null }, { - "name": "company", - "description": "The customer's company.", + "name": "name", + "description": "The name assigned to the role.", "args": [], "type": { "kind": "SCALAR", @@ -45346,78 +44801,54 @@ "deprecationReason": null }, { - "name": "country_code", - "description": "The customer's country.", + "name": "permissions", + "description": "A list of permission resources defined for a role.", "args": [], "type": { - "kind": "ENUM", - "name": "CountryCodeEnum", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyAclResource", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "custom_attributesV2", - "description": "Custom attributes assigned to the customer address.", - "args": [ - { - "name": "attributeCodes", - "description": "", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "AttributeValueInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "fax", - "description": "The fax number.", + "name": "users_count", + "description": "The total number of users assigned the specified role.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyAclResource", + "description": "Contains details about the access control list settings of a resource.", + "fields": [ { - "name": "firstname", - "description": "The first name of the person associated with the shipping/billing address.", + "name": "children", + "description": "An array of sub-resources.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "CompanyAclResource", "ofType": null } }, @@ -45425,15 +44856,15 @@ "deprecationReason": null }, { - "name": "lastname", - "description": "The family name of the person associated with the shipping/billing address.", + "name": "id", + "description": "The unique ID for a `CompanyAclResource` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -45441,20 +44872,20 @@ "deprecationReason": null }, { - "name": "middlename", - "description": "The middle name of the person associated with the shipping/billing address.", + "name": "sort_order", + "description": "The sort order of an ACL resource.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "postcode", - "description": "The customer's ZIP or postal code.", + "name": "text", + "description": "The label assigned to the ACL resource.", "args": [], "type": { "kind": "SCALAR", @@ -45463,66 +44894,177 @@ }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "IsCompanyRoleNameAvailableOutput", + "description": "Contains the response of a role name validation query.", + "fields": [ { - "name": "prefix", - "description": "An honorific, such as Dr., Mr., or Mrs.", + "name": "is_role_name_available", + "description": "Indicates whether the specified company role name is available.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "IsCompanyUserEmailAvailableOutput", + "description": "Contains the response of a company user email validation query.", + "fields": [ { - "name": "region", - "description": "The state or province name.", + "name": "is_email_available", + "description": "Indicates whether the specified email address can be used to create a company user.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "IsCompanyAdminEmailAvailableOutput", + "description": "Contains the response of a company admin email validation query.", + "fields": [ { - "name": "region_id", - "description": "The unique ID for a `Region` object of a pre-defined region.", + "name": "is_email_available", + "description": "Indicates whether the specified email address can be used to create a company administrator.", "args": [], "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "IsCompanyEmailAvailableOutput", + "description": "Contains the response of a company email validation query.", + "fields": [ { - "name": "street", - "description": "An array of strings that define the street number and name.", + "name": "is_email_available", + "description": "Indicates whether the specified email address can be used to create a company.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null } }, "isDeprecated": false, "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "CompanyStructureEntity", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CompanyTeam", + "ofType": null }, { - "name": "suffix", - "description": "A value such as Sr., Jr., or III.", + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CompanyStructure", + "description": "Contains an array of the individual nodes that comprise the company structure.", + "fields": [ + { + "name": "items", + "description": "An array of elements in a company structure.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyStructureItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyTeam", + "description": "Describes a company team.", + "fields": [ + { + "name": "description", + "description": "An optional description of the team.", "args": [], "type": { "kind": "SCALAR", @@ -45533,20 +45075,20 @@ "deprecationReason": null }, { - "name": "telephone", - "description": "The telephone number.", + "name": "id", + "description": "The unique ID for a `CompanyTeam` object.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "vat_id", - "description": "The customer's Value-added tax (VAT) number (for corporate customers).", + "name": "name", + "description": "The display name of the team.", "args": [], "type": { "kind": "SCALAR", @@ -45555,6 +45097,22 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "structure_id", + "description": "ID of the company structure", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -45564,92 +45122,166 @@ }, { "kind": "INPUT_OBJECT", - "name": "AddDownloadableProductsToCartInput", - "description": "", + "name": "CompanyUsersFilterInput", + "description": "Defines the filter for returning a list of company users.", "fields": null, "inputFields": [ { - "name": "cart_id", - "description": "The ID of the cart.", + "name": "status", + "description": "The activity status to filter on.", + "type": { + "kind": "ENUM", + "name": "CompanyUserStatusEnum", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompanyUserStatusEnum", + "description": "Defines the list of company user status values.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACTIVE", + "description": "Only active users.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INACTIVE", + "description": "Only inactive users.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateCompanyTeamOutput", + "description": "Contains the response to the request to create a company team.", + "fields": [ + { + "name": "team", + "description": "The new company team instance.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "CompanyTeam", "ofType": null } }, - "defaultValue": null - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCompanyTeamOutput", + "description": "Contains the response to the request to update a company team.", + "fields": [ { - "name": "cart_items", - "description": "An array of downloadable products to add.", + "name": "team", + "description": "The updated company team instance.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "DownloadableProductCartItemInput", - "ofType": null - } + "kind": "OBJECT", + "name": "CompanyTeam", + "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null } ], - "interfaces": null, + "inputFields": null, + "interfaces": [], "enumValues": null, "possibleTypes": null }, { - "kind": "INPUT_OBJECT", - "name": "DownloadableProductCartItemInput", - "description": "Defines a single downloadable product.", - "fields": null, - "inputFields": [ + "kind": "OBJECT", + "name": "DeleteCompanyTeamOutput", + "description": "Contains the status of the request to delete a company team.", + "fields": [ { - "name": "customizable_options", - "description": "The ID and value of the option.", + "name": "success", + "description": "Indicates whether the delete operation succeeded.", + "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", + "kind": "SCALAR", + "name": "Boolean", "ofType": null } }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyTeamCreateInput", + "description": "Defines the input schema for creating a company team.", + "fields": null, + "inputFields": [ + { + "name": "description", + "description": "An optional description of the team.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, "defaultValue": null }, { - "name": "data", - "description": "The quantity and SKU of the downloadable product.", + "name": "name", + "description": "The display name of the team.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", + "kind": "SCALAR", + "name": "String", "ofType": null } }, "defaultValue": null }, { - "name": "downloadable_product_links", - "description": "An array of objects containing the link_id of the downloadable product link.", + "name": "target_id", + "description": "The ID of a node within a company's structure. This ID will be the parent of the created team.", "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "DownloadableProductLinksInput", - "ofType": null - } + "kind": "SCALAR", + "name": "ID", + "ofType": null }, "defaultValue": null } @@ -45660,23 +45292,43 @@ }, { "kind": "INPUT_OBJECT", - "name": "DownloadableProductLinksInput", - "description": "Contains the link ID for the downloadable product.", + "name": "CompanyTeamUpdateInput", + "description": "Defines the input schema for updating a company team.", "fields": null, "inputFields": [ { - "name": "link_id", - "description": "The unique ID of the downloadable product link.", + "name": "description", + "description": "An optional description of the team.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "id", + "description": "The unique ID of the `CompanyTeam` object to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Int", + "name": "ID", "ofType": null } }, "defaultValue": null + }, + { + "name": "name", + "description": "The display name of the team.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null } ], "interfaces": null, @@ -45685,19 +45337,19 @@ }, { "kind": "OBJECT", - "name": "AddDownloadableProductsToCartOutput", - "description": "Contains details about the cart after adding downloadable products.", + "name": "UpdateCompanyStructureOutput", + "description": "Contains the response to the request to update the company structure.", "fields": [ { - "name": "cart", - "description": "The cart after adding products.", + "name": "company", + "description": "The updated company instance.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", - "name": "Cart", + "name": "Company", "ofType": null } }, @@ -45711,1077 +45363,1168 @@ "possibleTypes": null }, { - "kind": "OBJECT", - "name": "DownloadableCartItem", - "description": "An implementation for downloadable product cart items.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "CompanyStructureUpdateInput", + "description": "Defines the input schema for updating the company structure.", + "fields": null, + "inputFields": [ { - "name": "customizable_options", - "description": "An array containing the customizable options the shopper selected.", - "args": [], + "name": "parent_tree_id", + "description": "The ID of a company that will be the new parent.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } + "kind": "SCALAR", + "name": "ID", + "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "discount", - "description": "Contains discount for quote line item.", - "args": [], + "name": "tree_id", + "description": "The ID of the company team that is being moved to another parent.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Discount", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateCompanyOutput", + "description": "Contains the response to the request to create a company.", + "fields": [ { - "name": "errors", - "description": "An array of errors encountered while loading the cart item", + "name": "company", + "description": "The new company instance.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", - "name": "CartItemError", + "name": "Company", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCompanyOutput", + "description": "Contains the response to the request to update the company.", + "fields": [ { - "name": "id", - "description": null, + "name": "company", + "description": "The updated company instance.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "Company", "ofType": null } }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateCompanyUserOutput", + "description": "Contains the response to the request to create a company user.", + "fields": [ { - "name": "is_available", - "description": "True if requested quantity is less than available stock, false otherwise.", + "name": "user", + "description": "The new company user instance.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Boolean", + "kind": "OBJECT", + "name": "Customer", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCompanyUserOutput", + "description": "Contains the response to the request to update the company user.", + "fields": [ { - "name": "links", - "description": "An array containing information about the links for the downloadable product added to the cart.", + "name": "user", + "description": "The updated company user instance.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", - "name": "DownloadableProductLinks", + "name": "Customer", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, - { - "name": "max_qty", - "description": "Line item max qty in quote template", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "min_qty", - "description": "Line item min qty in quote template", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeleteCompanyUserOutput", + "description": "Contains the response to the request to delete the company user.", + "fields": [ { - "name": "not_available_message", - "description": "Message to display when the product is not available with this selected option.", + "name": "success", + "description": "Indicates whether the company user has been deactivated successfully.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateCompanyRoleOutput", + "description": "Contains the response to the request to create a company role.", + "fields": [ { - "name": "note_from_buyer", - "description": "The buyer's quote line item note.", + "name": "role", + "description": "The new company role instance.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", - "name": "ItemNote", + "name": "CompanyRole", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCompanyRoleOutput", + "description": "Contains the response to the request to update the company role.", + "fields": [ { - "name": "note_from_seller", - "description": "The seller's quote line item note.", + "name": "role", + "description": "The updated company role instance.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", - "name": "ItemNote", + "name": "CompanyRole", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeleteCompanyRoleOutput", + "description": "Contains the response to the request to delete the company role.", + "fields": [ { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", + "name": "success", + "description": "SIndicates whether the company role has been deleted successfully.", "args": [], "type": { - "kind": "OBJECT", - "name": "CartItemPrices", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyCreateInput", + "description": "Defines the input schema for creating a new company.", + "fields": null, + "inputFields": [ { - "name": "product", - "description": "Details about an item in the cart.", - "args": [], + "name": "company_admin", + "description": "Defines the company administrator.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "INPUT_OBJECT", + "name": "CompanyAdminInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "quantity", - "description": "The quantity of this item in the cart.", - "args": [], + "name": "company_email", + "description": "The email address of the company contact.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "samples", - "description": "An array containing information about samples of the selected downloadable product.", - "args": [], + "name": "company_name", + "description": "The name of the company to create.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductSamples", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", - "args": [], + "name": "legal_address", + "description": "Defines legal address data of the company.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "INPUT_OBJECT", + "name": "CompanyLegalAddressCreateInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CartItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableProduct", - "description": "Defines a product that the shopper downloads.", - "fields": [ + "defaultValue": null + }, { - "name": "activity", - "description": null, - "args": [], + "name": "legal_name", + "description": "The full legal name of the company.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", - "args": [], + "name": "reseller_id", + "description": "The resale number that is assigned to the company for tax reporting purposes.", "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "defaultValue": null }, { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", - "args": [], + "name": "vat_tax_id", + "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyAdminInput", + "description": "Defines the input schema for creating a company administrator.", + "fields": null, + "inputFields": [ { - "name": "categories", - "description": "The categories assigned to a product.", - "args": [], + "name": "custom_attributes", + "description": "The company administrator's custom attributes.", "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", + "kind": "INPUT_OBJECT", + "name": "AttributeValueInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_gear", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "climate", - "description": null, - "args": [], + "name": "email", + "description": "The email address of the company administrator.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "collar", - "description": null, - "args": [], + "name": "firstname", + "description": "The company administrator's first name.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "color", - "description": null, - "args": [], + "name": "gender", + "description": "The company administrator's gender (Male - 1, Female - 2, Not Specified - 3).", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "country_of_manufacture", - "description": "The product's country of origin.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", - "args": [], + "name": "job_title", + "description": "The job title of the company administrator.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "defaultValue": null }, { - "name": "crosssell_products", - "description": "An array of cross-sell products.", - "args": [], + "name": "lastname", + "description": "The company administrator's last name.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], + "name": "telephone", + "description": "The phone number of the company administrator.", "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyLegalAddressCreateInput", + "description": "Defines the input schema for defining a company's legal address.", + "fields": null, + "inputFields": [ { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", - "args": [], + "name": "city", + "description": "The city where the company is registered to conduct business.", "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "downloadable_product_links", - "description": "An array containing information about the links for this downloadable product.", - "args": [], + "name": "country_id", + "description": "The company's country ID. Use the `countries` query to get this value.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductLinks", + "kind": "ENUM", + "name": "CountryCodeEnum", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "downloadable_product_samples", - "description": "An array containing information about samples of this downloadable product.", - "args": [], + "name": "postcode", + "description": "The postal code of the company.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductSamples", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "gender", - "description": null, - "args": [], + "name": "region", + "description": "An object containing the region name and/or region ID where the company is registered to conduct business.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressRegionInput", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "gift_message_available", - "description": "Returns a value indicating gift message availability for the product.", - "args": [], + "name": "street", + "description": "An array of strings that define the street address where the company is registered to conduct business.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "gift_wrapping_available", - "description": "Returns a value indicating gift wrapping availability for the product.", - "args": [], + "name": "telephone", + "description": "The primary phone number of the company.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Boolean", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyUpdateInput", + "description": "Defines the input schema for updating a company.", + "fields": null, + "inputFields": [ { - "name": "gift_wrapping_price", - "description": "Returns value and currency indicating gift wrapping price for the product.", - "args": [], + "name": "company_email", + "description": "The email address of the company contact.", "type": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "id", - "description": "The ID number assigned to the product.", - "args": [], + "name": "company_name", + "description": "The name of the company to update.", "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." + "defaultValue": null }, { - "name": "image", - "description": "The relative path to the main image on the product page.", - "args": [], + "name": "legal_address", + "description": "The legal address data of the company.", "type": { - "kind": "OBJECT", - "name": "ProductImage", + "kind": "INPUT_OBJECT", + "name": "CompanyLegalAddressUpdateInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", - "args": [], + "name": "legal_name", + "description": "The full legal name of the company.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "links_purchased_separately", - "description": "A value of 1 indicates that each link in the array must be purchased separately.", - "args": [], + "name": "reseller_id", + "description": "The resale number that is assigned to the company for tax reporting purposes.", "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "links_title", - "description": "The heading above the list of downloadable products.", - "args": [], + "name": "vat_tax_id", + "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyLegalAddressUpdateInput", + "description": "Defines the input schema for updating a company's legal address.", + "fields": null, + "inputFields": [ { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", - "args": [], + "name": "city", + "description": "The city where the company is registered to conduct business.", "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "material", - "description": null, - "args": [], + "name": "country_id", + "description": "The unique ID for a `Country` object.", + "type": { + "kind": "ENUM", + "name": "CountryCodeEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "postcode", + "description": "The postal code of the company.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "max_sale_qty", - "description": "Maximum Qty Allowed in Shopping Cart", - "args": [], + "name": "region", + "description": "An object containing the region name and/or region ID where the company is registered to conduct business.", "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "INPUT_OBJECT", + "name": "CustomerAddressRegionInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "media_gallery", - "description": "An array of media gallery objects.", - "args": [], + "name": "street", + "description": "An array of strings that define the street address where the company is registered to conduct business.", "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "media_gallery_entries", - "description": "An array of MediaGalleryEntry objects.", - "args": [], + "name": "telephone", + "description": "The primary phone number of the company.", "type": { - "kind": "LIST", + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyUserCreateInput", + "description": "Defines the input schema for creating a company user.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "The company user's email address", + "type": { + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "MediaGalleryEntry", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "isDeprecated": true, - "deprecationReason": "Use `media_gallery` instead." + "defaultValue": null }, { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", - "args": [], + "name": "firstname", + "description": "The company user's first name.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", - "args": [], + "name": "job_title", + "description": "The company user's job title or function.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", - "args": [], + "name": "lastname", + "description": "The company user's last name.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "min_sale_qty", - "description": "Minimum Qty Allowed in Shopping Cart", - "args": [], + "name": "role_id", + "description": "The unique ID for a `CompanyRole` object.", "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", - "args": [], + "name": "status", + "description": "Indicates whether the company user is ACTIVE or INACTIVE.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CompanyUserStatusEnum", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "new", - "description": null, - "args": [], + "name": "target_id", + "description": "The ID of a node within a company's structure. This ID will be the parent of the created company user.", "type": { "kind": "SCALAR", - "name": "Int", + "name": "ID", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "new_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", - "args": [], + "name": "telephone", + "description": "The company user's phone number.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyUserUpdateInput", + "description": "Defines the input schema for updating a company user.", + "fields": null, + "inputFields": [ { - "name": "new_to_date", - "description": "The end date for new product listings.", - "args": [], + "name": "email", + "description": "The company user's email address.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "only_x_left_in_stock", - "description": "Product stock only x left count", - "args": [], + "name": "firstname", + "description": "The company user's first name.", "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "options", - "description": "An array of options for a customizable product.", - "args": [], + "name": "id", + "description": "The unique ID of a `Customer` object.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "args": [], + "name": "job_title", + "description": "The company user's job title or function.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "pattern", - "description": null, - "args": [], + "name": "lastname", + "description": "The company user's last name.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "performance_fabric", - "description": null, - "args": [], + "name": "role_id", + "description": "The unique ID for a `CompanyRole` object.", "type": { "kind": "SCALAR", - "name": "Int", + "name": "ID", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "price", - "description": "Indicates the price of an item.", - "args": [], + "name": "status", + "description": "Indicates whether the company user is ACTIVE or INACTIVE.", "type": { - "kind": "OBJECT", - "name": "ProductPrices", + "kind": "ENUM", + "name": "CompanyUserStatusEnum", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `price_range` for product price information." + "defaultValue": null }, { - "name": "price_range", - "description": "The range of prices for the product", - "args": [], + "name": "telephone", + "description": "The company user's phone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyRoleCreateInput", + "description": "Defines the input schema for creating a company role.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The name of the role to create.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "PriceRange", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "price_tiers", - "description": "An array of `TierPrice` objects.", - "args": [], + "name": "permissions", + "description": "A list of resources the role can access.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "TierPrice", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_links", - "description": "An array of `ProductLinks` objects.", - "args": [], + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyRoleUpdateInput", + "description": "Defines the input schema for updating a company role.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The unique ID for a `CompanyRole` object.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "ProductLinksInterface", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "purpose", - "description": null, - "args": [], + "name": "name", + "description": "The name of the role to update.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "permissions", + "description": "A list of resources the role can access.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UserCompaniesInput", + "description": "Defines the input for returning matching companies the customer is assigned to.", + "fields": null, + "inputFields": [ + { + "name": "currentPage", + "description": "Specifies which page of results to return. The default value is 1.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "quantity", - "description": "Amount of available stock", - "args": [], + "name": "pageSize", + "description": "Specifies the maximum number of results to return at once. This attribute is optional.", "type": { "kind": "SCALAR", - "name": "Float", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "rating_summary", - "description": "The average of all the ratings given to the product.", - "args": [], + "name": "sort", + "description": "Defines the sorting of the results.", "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Float", + "kind": "INPUT_OBJECT", + "name": "CompaniesSortInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UserCompaniesOutput", + "description": "An object that contains a list of companies customer is assigned to.", + "fields": [ { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "name": "items", + "description": "An array of companies customer is assigned to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyBasicInfo", + "ofType": null + } } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "related_products", - "description": "An array of related products.", + "name": "page_info", + "description": "Provides navigation for the query response.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "OBJECT", + "name": "SearchResultPageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, - { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompaniesSortInput", + "description": "Specifies which field to sort on, and whether to return the results in ascending or descending order.", + "fields": null, + "inputFields": [ { - "name": "review_count", - "description": "The total count of all the reviews given to the product.", - "args": [], + "name": "field", + "description": "The field for sorting the results.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Int", + "kind": "ENUM", + "name": "CompaniesSortFieldEnum", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "reviews", - "description": "The list of products reviews.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], + "name": "order", + "description": "Indicates whether to return results in ascending or descending order.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "ProductReviews", + "kind": "ENUM", + "name": "SortEnum", "ofType": null } }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompaniesSortFieldEnum", + "description": "The fields available for sorting the customer companies.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NAME", + "description": "The name of the company.", "isDeprecated": false, "deprecationReason": null - }, + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyBasicInfo", + "description": "The minimal required information to identify and display the company.", + "fields": [ { - "name": "rules", - "description": "Provides applied catalog rules in the current active cart", + "name": "id", + "description": "The unique ID of a `Company` object.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "CatalogRule", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, @@ -46789,478 +46532,653 @@ "deprecationReason": null }, { - "name": "sale", - "description": null, + "name": "legal_name", + "description": "The full legal name of the company.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "size", - "description": null, + "name": "name", + "description": "The name of the company.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "name": "status", + "description": "The current status of the company.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "ENUM", + "name": "CompanyStatusEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompanyStatusEnum", + "description": "Defines the list of company status values.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PENDING", + "description": "Company is pending approval.", + "isDeprecated": false, + "deprecationReason": null }, { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "name": "APPROVED", + "description": "Company is approved.", + "isDeprecated": false, + "deprecationReason": null }, { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, + "name": "REJECTED", + "description": "Company is rejected.", "isDeprecated": false, "deprecationReason": null }, { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", - "args": [], + "name": "BLOCKED", + "description": "Company is blocked.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyInvitationInput", + "description": "Defines the input schema for accepting the company invitation.", + "fields": null, + "inputFields": [ + { + "name": "code", + "description": "The invitation code.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "defaultValue": null }, { - "name": "special_price", - "description": "The discounted price of the product.", - "args": [], + "name": "role_id", + "description": "The company role id.", "type": { "kind": "SCALAR", - "name": "Float", + "name": "ID", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "special_to_date", - "description": "The end date for a product with a special price.", - "args": [], + "name": "user", + "description": "Company user attributes in the invitation.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyInvitationUserInput", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyInvitationUserInput", + "description": "Company user attributes in the invitation.", + "fields": null, + "inputFields": [ { - "name": "staged", - "description": "Indicates whether the product is staged for a future campaign.", - "args": [], + "name": "company_id", + "description": "The company unique identifier.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Boolean", + "name": "ID", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "stock_status", - "description": "Stock status of the product", - "args": [], + "name": "customer_id", + "description": "The customer unique identifier.", "type": { - "kind": "ENUM", - "name": "ProductStockStatus", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "strap_bags", - "description": null, - "args": [], + "name": "job_title", + "description": "The job title of a company user.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "style_bags", - "description": null, - "args": [], + "name": "status", + "description": "Indicates whether the company user is ACTIVE or INACTIVE.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "ENUM", + "name": "CompanyUserStatusEnum", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "defaultValue": null }, { - "name": "style_bottom", - "description": null, - "args": [], + "name": "telephone", + "description": "The phone number of the company user.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyInvitationOutput", + "description": "The result of accepting the company invitation.", + "fields": [ { - "name": "style_general", - "description": null, + "name": "success", + "description": "Indicates whether the customer was added to the company successfully.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Boolean", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyStructureItem", + "description": "Defines an individual node in the company structure.", + "fields": [ { - "name": "swatch_image", - "description": "The file name of a swatch image.", + "name": "entity", + "description": "A union of `CompanyTeam` and `Customer` objects.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "UNION", + "name": "CompanyStructureEntity", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", + "name": "id", + "description": "The unique ID for a `CompanyStructureItem` object.", "args": [], "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "name": "parent_id", + "description": "The ID of the parent item in the company hierarchy.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "ID", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "tier_prices", - "description": "An array of ProductTierPrices objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductTierPrices", + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerSegmentStorefront", + "description": "Customer segment details", + "fields": [ + { + "name": "uid", + "description": "The unique ID for a `CustomerSegment` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", "ofType": null } }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddBundleProductsToCartInput", + "description": "Defines the bundle products to add to the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null }, { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], + "name": "cart_items", + "description": "An array of bundle products to add.", "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "BundleProductCartItemInput", + "ofType": null + } + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "BundleProductCartItemInput", + "description": "Defines a single bundle product.", + "fields": null, + "inputFields": [ + { + "name": "bundle_options", + "description": "A mandatory array of options for the bundle product, including each chosen option and specified quantity.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "BundleOptionInput", + "ofType": null + } + } + }, + "defaultValue": null }, { - "name": "type_id", - "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", - "args": [], + "name": "customizable_options", + "description": "The ID and value of the option.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use `__typename` instead." + "defaultValue": null }, { - "name": "uid", - "description": "The unique ID for a `ProductInterface` object.", - "args": [], + "name": "data", + "description": "The quantity and SKU of the bundle product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "BundleOptionInput", + "description": "Defines the input for a bundle option.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the option.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "Int", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "updated_at", - "description": "Timestamp indicating when the product was updated.", - "args": [], + "name": "quantity", + "description": "The number of the selected item to add to the cart.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "defaultValue": null }, { - "name": "upsell_products", - "description": "An array of up-sell products.", + "name": "value", + "description": "An array with the chosen value of the option.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddBundleProductsToCartOutput", + "description": "Contains details about the cart after adding bundle products.", + "fields": [ + { + "name": "cart", + "description": "The cart after adding products.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "OBJECT", + "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleCartItem", + "description": "An implementation for bundle product cart items.", + "fields": [ { - "name": "url_key", - "description": "The part of the URL that identifies the product", + "name": "available_gift_wrapping", + "description": "The list of available gift wrapping options for the cart item.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + } + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "url_path", - "description": null, + "name": "bundle_options", + "description": "An array containing the bundle options the shopper selected.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedBundleOption", + "ofType": null + } + } }, - "isDeprecated": true, - "deprecationReason": "Use product's `canonical_url` or url rewrites instead" + "isDeprecated": false, + "deprecationReason": null }, { - "name": "url_rewrites", - "description": "URL rewrites list", + "name": "customizable_options", + "description": "An array containing the customizable options the shopper selected.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "UrlRewrite", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "url_suffix", - "description": "The part of the product URL that is appended after the url key", + "name": "discount", + "description": "Contains discount for quote line item.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "websites", - "description": "An array of websites in which the product is available.", + "name": "errors", + "description": "An array of errors encountered while loading the cart item", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "Website", + "name": "CartItemError", "ofType": null } }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "INTERFACE", - "name": "CustomizableProductInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "DownloadableFileTypeEnum", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "FILE", - "description": "", - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" + "name": "gift_message", + "description": "The entered gift message for the cart item", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftMessage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null }, { - "name": "URL", - "description": "", - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableProductLinks", - "description": "Defines characteristics of a downloadable product.", - "fields": [ - { - "name": "id", - "description": null, + "name": "gift_wrapping", + "description": "The selected gift wrapping for the cart item.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "GiftWrapping", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "This information should not be exposed on frontend." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "is_shareable", + "name": "id", "description": null, "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": true, - "deprecationReason": "This information should not be exposed on frontend." + "deprecationReason": "Use `uid` instead." }, { - "name": "link_type", - "description": null, + "name": "is_available", + "description": "True if requested quantity is less than available stock, false otherwise.", "args": [], "type": { - "kind": "ENUM", - "name": "DownloadableFileTypeEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" + "isDeprecated": false, + "deprecationReason": null }, { - "name": "number_of_downloads", - "description": null, + "name": "max_qty", + "description": "Line item max qty in quote template", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "This information should not be exposed on frontend." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "price", - "description": "The price of the downloadable product.", + "name": "min_qty", + "description": "Line item min qty in quote template", "args": [], "type": { "kind": "SCALAR", @@ -47271,68 +47189,96 @@ "deprecationReason": null }, { - "name": "sample_file", - "description": null, + "name": "not_available_message", + "description": "Message to display when the product is not available with this selected option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" + "isDeprecated": false, + "deprecationReason": null }, { - "name": "sample_type", - "description": null, + "name": "note_from_buyer", + "description": "The buyer's quote line item note.", "args": [], "type": { - "kind": "ENUM", - "name": "DownloadableFileTypeEnum", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" + "isDeprecated": false, + "deprecationReason": null }, { - "name": "sample_url", - "description": "The full URL to the downloadable sample.", + "name": "note_from_seller", + "description": "The seller's quote line item note.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sort_order", - "description": "A number indicating the sort order.", + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "CartItemPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name of the link.", + "name": "product", + "description": "Details about an item in the cart.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", - "description": "The unique ID for a `DownloadableProductLinks` object.", + "description": "The unique ID for a `CartItemInterface` object.", "args": [], "type": { "kind": "NON_NULL", @@ -47348,83 +47294,101 @@ } ], "inputFields": null, - "interfaces": [], + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "DownloadableProductSamples", - "description": "Defines characteristics of a downloadable product.", - "fields": [ + "name": "SelectedBundleOption", + "description": "Contains details about a selected bundle option.", + "fields": [ { "name": "id", "description": null, "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "This information should not be exposed on frontend." - }, - { - "name": "sample_file", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } }, "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" + "deprecationReason": "Use `uid` instead" }, { - "name": "sample_type", - "description": null, + "name": "label", + "description": "The display name of the selected bundle product option.", "args": [], "type": { - "kind": "ENUM", - "name": "DownloadableFileTypeEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" + "isDeprecated": false, + "deprecationReason": null }, { - "name": "sample_url", - "description": "The full URL to the downloadable sample.", + "name": "type", + "description": "The type of selected bundle product option.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sort_order", - "description": "A number indicating the sort order.", + "name": "uid", + "description": "The unique ID for a `SelectedBundleOption` object", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name of the sample.", + "name": "values", + "description": "An array of selected bundle option values.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedBundleOptionValue", + "ofType": null + } + } }, "isDeprecated": false, "deprecationReason": null @@ -47437,19 +47401,19 @@ }, { "kind": "OBJECT", - "name": "DownloadableOrderItem", - "description": "Defines downloadable product options for `OrderItemInterface`.", + "name": "SelectedBundleOptionValue", + "description": "Contains details about a value for a selected bundle option.", "fields": [ { - "name": "discounts", - "description": "The final discount information for the product.", + "name": "id", + "description": "Use `uid` instead", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Discount", + "kind": "SCALAR", + "name": "Int", "ofType": null } }, @@ -47457,15 +47421,15 @@ "deprecationReason": null }, { - "name": "downloadable_links", - "description": "A list of downloadable links that are ordered from the downloadable product.", + "name": "label", + "description": "The display name of the value for the selected bundle product option.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "DownloadableItemsLinks", + "kind": "SCALAR", + "name": "String", "ofType": null } }, @@ -47473,60 +47437,72 @@ "deprecationReason": null }, { - "name": "eligible_for_return", - "description": "Indicates whether the order item is eligible to be in a return request.", + "name": "original_price", + "description": "The original price of the value for the selected bundle product option.", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "entered_options", - "description": "The entered option for the base product, such as a logo or image.", + "name": "price", + "description": "The price of the value for the selected bundle product option.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "OrderItemOption", + "kind": "SCALAR", + "name": "Float", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use priceV2 instead." }, { - "name": "gift_message", - "description": "The selected gift message for the order item", + "name": "priceV2", + "description": "The price of the value for the selected bundle product option.", "args": [], "type": { - "kind": "OBJECT", - "name": "GiftMessage", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "gift_wrapping", - "description": "The selected gift wrapping for the order item.", + "name": "quantity", + "description": "The quantity of the value for the selected bundle product option.", "args": [], "type": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The unique ID for an `OrderItemInterface` object.", + "name": "uid", + "description": "The unique ID for a `SelectedBundleOptionValue` object", "args": [], "type": { "kind": "NON_NULL", @@ -47539,69 +47515,87 @@ }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceDetails", + "description": "Can be used to retrieve the main price details in case of bundle product", + "fields": [ { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", + "name": "discount_percentage", + "description": "The percentage of discount applied to the main product price", "args": [], "type": { - "kind": "OBJECT", - "name": "OrderItemPrices", + "kind": "SCALAR", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "product", - "description": "The ProductInterface object, which contains details about the base product", + "name": "main_final_price", + "description": "The final price after applying the discount to the main product", "args": [], "type": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "SCALAR", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "product_name", - "description": "The name of the base product.", + "name": "main_price", + "description": "The regular price of the main product", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleItem", + "description": "Defines an individual item within a bundle product.", + "fields": [ { - "name": "product_sale_price", - "description": "The sale price of the base product, including selected options.", + "name": "option_id", + "description": "An ID assigned to each type of item in a bundle product.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" }, { - "name": "product_sku", - "description": "The SKU of the base product.", + "name": "options", + "description": "An array of additional options for this bundle item.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "BundleItemOption", "ofType": null } }, @@ -47609,132 +47603,143 @@ "deprecationReason": null }, { - "name": "product_type", - "description": "The type of product, such as simple, configurable, etc.", + "name": "position", + "description": "A number indicating the sequence order of this item compared to the other bundle items.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "product_url_key", - "description": "URL key of the base product.", + "name": "price_range", + "description": "The range of prices for the product", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRange", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "quantity_canceled", - "description": "The number of canceled items.", + "name": "required", + "description": "Indicates whether the item must be included in the bundle.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "quantity_invoiced", - "description": "The number of invoiced items.", + "name": "sku", + "description": "The SKU of the bundle product.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "quantity_ordered", - "description": "The number of units ordered for this item.", + "name": "title", + "description": "The display name of the item.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "quantity_refunded", - "description": "The number of refunded items.", + "name": "type", + "description": "The input type that the customer uses to select the item. Examples include radio button and checkbox.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "quantity_return_requested", - "description": "The requested return quantity of the item.", + "name": "uid", + "description": "The unique ID for a `BundleItem` object.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleItemOption", + "description": "Defines the characteristics that comprise a specific bundle item and its options.", + "fields": [ { - "name": "quantity_returned", - "description": "The number of returned items.", + "name": "can_change_quantity", + "description": "Indicates whether the customer can change the number of items for this option.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "quantity_shipped", - "description": "The number of shipped items.", + "name": "id", + "description": "The ID assigned to the bundled item option.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" }, { - "name": "selected_options", - "description": "The selected options for the base product, such as color or size.", + "name": "is_default", + "description": "Indicates whether this option is the default option.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "OrderItemOption", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "status", - "description": "The status of the order item.", + "name": "label", + "description": "The text that identifies the bundled item option.", "args": [], "type": { "kind": "SCALAR", @@ -47743,199 +47748,140 @@ }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableInvoiceItem", - "description": "Defines downloadable product options for `InvoiceItemInterface`.", - "fields": [ + }, { - "name": "discounts", - "description": "Information about the final discount amount for the base product, including discounts on options.", + "name": "position", + "description": "When a bundle item contains multiple options, the relative position of this option compared to the other options.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "downloadable_links", - "description": "A list of downloadable links that are invoiced from the downloadable product.", + "name": "price", + "description": "The price of the selected option.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableItemsLinks", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The unique ID for an `InvoiceItemInterface` object.", + "name": "price_type", + "description": "One of FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "ENUM", + "name": "PriceTypeEnum", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "order_item", - "description": "Details about an individual order item.", + "name": "product", + "description": "Contains details about this product option.", "args": [], "type": { "kind": "INTERFACE", - "name": "OrderItemInterface", + "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "product_name", - "description": "The name of the base product.", + "name": "qty", + "description": "Indicates the quantity of this specific bundle item.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `quantity` instead." }, { - "name": "product_sale_price", - "description": "The sale price for the base product including selected options.", + "name": "quantity", + "description": "The quantity of this specific bundle item.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "product_sku", - "description": "The SKU of the base product.", + "name": "uid", + "description": "The unique ID for a `BundleItemOption` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, - { - "name": "quantity_invoiced", - "description": "The number of invoiced items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null } ], "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "InvoiceItemInterface", - "ofType": null - } - ], + "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "DownloadableCreditMemoItem", - "description": "Defines downloadable product options for `CreditMemoItemInterface`.", + "name": "BundleProduct", + "description": "Defines basic features of a bundle product and contains multiple BundleItems.", "fields": [ { - "name": "discounts", - "description": "Details about the final discount amount for the base product, including discounts on options.", + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "downloadable_links", - "description": "A list of downloadable links that are refunded from the downloadable product.", + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableItemsLinks", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The unique ID for a `CreditMemoItemInterface` object.", + "name": "categories", + "description": "The categories assigned to a product.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "INTERFACE", + "name": "CategoryInterface", "ofType": null } }, @@ -47943,20 +47889,20 @@ "deprecationReason": null }, { - "name": "order_item", - "description": "The order item the credit memo is applied to.", + "name": "color", + "description": null, "args": [], "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "product_name", - "description": "The name of the base product.", + "name": "country_of_manufacture", + "description": "The product's country of origin.", "args": [], "type": { "kind": "SCALAR", @@ -47967,15 +47913,27 @@ "deprecationReason": null }, { - "name": "product_sale_price", - "description": "The sale price for the base product, including selected options.", + "name": "created_at", + "description": "Timestamp indicating when the product was created.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "crosssell_products", + "description": "An array of cross-sell products.", + "args": [], + "type": { + "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null } }, @@ -47983,111 +47941,102 @@ "deprecationReason": null }, { - "name": "product_sku", - "description": "The SKU of the base product.", + "name": "custom_attributesV2", + "description": "Product custom attributes.", + "args": [ + { + "name": "filters", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "quantity_refunded", - "description": "The number of refunded items.", + "name": "dynamic_price", + "description": "Indicates whether the bundle product has a dynamic price.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CreditMemoItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableItemsLinks", - "description": "Defines characteristics of the links for downloadable product.", - "fields": [ + }, { - "name": "sort_order", - "description": "A number indicating the sort order.", + "name": "dynamic_sku", + "description": "Indicates whether the bundle product has a dynamic SKU.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name of the link.", + "name": "dynamic_weight", + "description": "Indicates whether the bundle product has a dynamically calculated weight.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `DownloadableItemsLinks` object.", + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableWishlistItem", - "description": "A downloadable product wish list item.", - "fields": [ + }, { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "Boolean", "ofType": null } }, @@ -48095,63 +48044,63 @@ "deprecationReason": null }, { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } + "kind": "OBJECT", + "name": "Money", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "description", - "description": "The description of the item.", + "name": "id", + "description": "The ID number assigned to the product.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `uid` field instead." + }, + { + "name": "image", + "description": "The relative path to the main image on the product page.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "links_v2", - "description": "An array containing information about the selected links.", + "name": "items", + "description": "An array containing information about individual bundle items.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "DownloadableProductLinks", + "name": "BundleItem", "ofType": null } }, @@ -48159,200 +48108,136 @@ "deprecationReason": null }, { - "name": "product", - "description": "Product details of the wish list item.", + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", "args": [], "type": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "quantity", - "description": "The quantity of this wish list item.", + "name": "max_sale_qty", + "description": "Maximum Qty Allowed in Shopping Cart", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "samples", - "description": "An array containing information about the selected samples.", + "name": "media_gallery", + "description": "An array of media gallery objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductSamples", + "kind": "INTERFACE", + "name": "MediaGalleryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Company", - "description": "Contains the output schema for a company.", - "fields": [ + }, { - "name": "acl_resources", - "description": "The list of all resources defined within the company.", + "name": "media_gallery_entries", + "description": "An array of MediaGalleryEntry objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "CompanyAclResource", + "name": "MediaGalleryEntry", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `media_gallery` instead." }, { - "name": "company_admin", - "description": "An object containing information about the company administrator.", + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", "args": [], "type": { - "kind": "OBJECT", - "name": "Customer", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "credit", - "description": "Company credit balances and limits.", + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyCredit", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "credit_history", - "description": "Details about the history of company credit operations.", - "args": [ - { - "name": "filter", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "CompanyCreditHistoryFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pageSize", - "description": "", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyCreditHistory", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "email", - "description": "The email address of the company contact.", + "name": "min_sale_qty", + "description": "Minimum Qty Allowed in Shopping Cart", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The unique ID of a `Company` object.", + "name": "name", + "description": "The product name. Customers use this name to identify the product.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "legal_address", - "description": "The address where the company is registered to conduct business.", + "name": "new_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "args": [], "type": { - "kind": "OBJECT", - "name": "CompanyLegalAddress", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "legal_name", - "description": "The full legal name of the company.", + "name": "new_to_date", + "description": "The end date for new product listings.", "args": [], "type": { "kind": "SCALAR", @@ -48363,27 +48248,27 @@ "deprecationReason": null }, { - "name": "name", - "description": "The name of the company.", + "name": "only_x_left_in_stock", + "description": "Product stock only x left count", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "payment_methods", - "description": "The list of payment methods available to a company.", + "name": "options", + "description": "An array of options for a customizable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", "ofType": null } }, @@ -48391,8 +48276,8 @@ "deprecationReason": null }, { - "name": "reseller_id", - "description": "The resale number that is assigned to the company for tax reporting purposes.", + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", "args": [], "type": { "kind": "SCALAR", @@ -48403,63 +48288,39 @@ "deprecationReason": null }, { - "name": "role", - "description": "A company role filtered by the unique ID of a `CompanyRole` object.", - "args": [ - { - "name": "id", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], + "name": "price", + "description": "Indicates the price of an item.", + "args": [], "type": { "kind": "OBJECT", - "name": "CompanyRole", + "name": "ProductPrices", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_range` for product price information." + }, + { + "name": "price_details", + "description": "The price details of the main product", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceDetails", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "roles", - "description": "An object that contains a list of company roles.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], + "name": "price_range", + "description": "The range of prices for the product", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", - "name": "CompanyRoles", + "name": "PriceRange", "ofType": null } }, @@ -48467,228 +48328,87 @@ "deprecationReason": null }, { - "name": "sales_representative", - "description": "An object containing information about the company sales representative.", + "name": "price_tiers", + "description": "An array of `TierPrice` objects.", "args": [], "type": { - "kind": "OBJECT", - "name": "CompanySalesRepresentative", + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TierPrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_view", + "description": "One of PRICE_RANGE or AS_LOW_AS.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceViewEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "structure", - "description": "The company structure of teams and customers in depth-first order.", - "args": [ - { - "name": "rootId", - "description": "The ID of the node in the company structure that serves as the root for the query.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "depth", - "description": "The maximum depth that can be reached when listing structure nodes.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "10" + "name": "product_links", + "description": "An array of `ProductLinks` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "ofType": null } - ], + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "Amount of available stock", + "args": [], "type": { - "kind": "OBJECT", - "name": "CompanyStructure", + "kind": "SCALAR", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "team", - "description": "The company team data filtered by the unique ID for a `CompanyTeam` object.", - "args": [ - { - "name": "id", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CompanyTeam", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "user", - "description": "A company user filtered by the unique ID of a `Customer` object.", - "args": [ - { - "name": "id", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "users", - "description": "An object that contains a list of company users based on activity status.", - "args": [ - { - "name": "filter", - "description": "The type of company users to return.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CompanyUsersFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "OBJECT", - "name": "CompanyUsers", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "vat_tax_id", - "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyLegalAddress", - "description": "Contains details about the address where the company is registered to conduct business.", - "fields": [ - { - "name": "city", - "description": "The city where the company is registered to conduct business.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country_code", - "description": "The country code of the company's legal address.", - "args": [], - "type": { - "kind": "ENUM", - "name": "CountryCodeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "postcode", - "description": "The company's postal code.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region", - "description": "An object containing region data for the company.", + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", "args": [], "type": { - "kind": "OBJECT", - "name": "CustomerAddressRegion", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "street", - "description": "An array of strings that define the company's street address.", + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null } }, @@ -48696,43 +48416,24 @@ "deprecationReason": null }, { - "name": "telephone", - "description": "The company's phone number.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyAdmin", - "description": "Contains details about the company administrator.", - "fields": [ - { - "name": "email", - "description": "The email address of the company administrator.", + "name": "related_products", + "description": "An array of related products.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "firstname", - "description": "The company administrator's first name.", + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", "args": [], "type": { "kind": "SCALAR", @@ -48743,27 +48444,52 @@ "deprecationReason": null }, { - "name": "gender", - "description": "The company administrator's gender (Male - 1, Female - 2, Not Specified - 3).", + "name": "review_count", + "description": "The total count of all the reviews given to the product.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The unique ID for a `CompanyAdmin` object.", - "args": [], + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "OBJECT", + "name": "ProductReviews", "ofType": null } }, @@ -48771,43 +48497,32 @@ "deprecationReason": null }, { - "name": "job_title", - "description": "The job title of the company administrator.", + "name": "ship_bundle_items", + "description": "Indicates whether to ship bundle items together or individually.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "ENUM", + "name": "ShipBundleItemsEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "lastname", - "description": "The company administrator's last name.", + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanySalesRepresentative", - "description": "Contains details about a company sales representative.", - "fields": [ + }, { - "name": "email", - "description": "The email address of the company sales representative.", + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", "args": [], "type": { "kind": "SCALAR", @@ -48818,177 +48533,84 @@ "deprecationReason": null }, { - "name": "firstname", - "description": "The company sales representative's first name.", + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "lastname", - "description": "The company sales representative's last name.", + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyUsers", - "description": "Contains details about company users.", - "fields": [ - { - "name": "items", - "description": "An array of `CompanyUser` objects that match the specified filter criteria.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "page_info", - "description": "Pagination metadata.", + "name": "special_price", + "description": "The discounted price of the product.", "args": [], "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", + "kind": "SCALAR", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "total_count", - "description": "The number of objects returned.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyRoles", - "description": "Contains an array of roles.", - "fields": [ - { - "name": "items", - "description": "A list of company roles that match the specified filter criteria.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Pagination metadata.", + "name": "special_to_date", + "description": "The end date for a product with a special price.", "args": [], "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "total_count", - "description": "The total number of objects matching the specified filter.", + "name": "staged", + "description": "Indicates whether the product is staged for a future campaign.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Int", + "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyRole", - "description": "Contails details about a single role.", - "fields": [ + }, { - "name": "id", - "description": "The unique ID for a `CompanyRole` object.", + "name": "stock_status", + "description": "Stock status of the product", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "ENUM", + "name": "ProductStockStatus", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "name", - "description": "The name assigned to the role.", + "name": "swatch_image", + "description": "The file name of a swatch image.", "args": [], "type": { "kind": "SCALAR", @@ -48999,1103 +48621,439 @@ "deprecationReason": null }, { - "name": "permissions", - "description": "A list of permission resources defined for a role.", + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyAclResource", - "ofType": null - } + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "users_count", - "description": "The total number of users assigned the specified role.", + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyAclResource", - "description": "Contains details about the access control list settings of a resource.", - "fields": [ + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, { - "name": "children", - "description": "An array of sub-resources.", + "name": "tier_prices", + "description": "An array of ProductTierPrices objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "CompanyAclResource", + "name": "ProductTierPrices", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." }, { - "name": "id", - "description": "The unique ID for a `CompanyAclResource` object.", + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sort_order", - "description": "The sort order of an ACL resource.", + "name": "type_id", + "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "text", - "description": "The label assigned to the ACL resource.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "IsCompanyRoleNameAvailableOutput", - "description": "Contains the response of a role name validation query.", - "fields": [ - { - "name": "is_role_name_available", - "description": "Indicates whether the specified company role name is available.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "IsCompanyUserEmailAvailableOutput", - "description": "Contains the response of a company user email validation query.", - "fields": [ - { - "name": "is_email_available", - "description": "Indicates whether the specified email address can be used to create a company user.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "IsCompanyAdminEmailAvailableOutput", - "description": "Contains the response of a company admin email validation query.", - "fields": [ - { - "name": "is_email_available", - "description": "Indicates whether the specified email address can be used to create a company administrator.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "IsCompanyEmailAvailableOutput", - "description": "Contains the response of a company email validation query.", - "fields": [ - { - "name": "is_email_available", - "description": "Indicates whether the specified email address can be used to create a company.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "UNION", - "name": "CompanyStructureEntity", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "CompanyTeam", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "CompanyStructure", - "description": "Contains an array of the individual nodes that comprise the company structure.", - "fields": [ - { - "name": "items", - "description": "An array of elements in a company structure.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyStructureItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyTeam", - "description": "Describes a company team.", - "fields": [ - { - "name": "description", - "description": "An optional description of the team.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `CompanyTeam` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The display name of the team.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "structure_id", - "description": "ID of the company structure", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyUsersFilterInput", - "description": "Defines the filter for returning a list of company users.", - "fields": null, - "inputFields": [ - { - "name": "status", - "description": "The activity status to filter on.", - "type": { - "kind": "ENUM", - "name": "CompanyUserStatusEnum", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CompanyUserStatusEnum", - "description": "Defines the list of company user status values.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "ACTIVE", - "description": "Only active users.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "INACTIVE", - "description": "Only inactive users.", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateCompanyTeamOutput", - "description": "Contains the response to the request to create a company team.", - "fields": [ - { - "name": "team", - "description": "The new company team instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyTeam", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyTeamOutput", - "description": "Contains the response to the request to update a company team.", - "fields": [ - { - "name": "team", - "description": "The updated company team instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyTeam", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeleteCompanyTeamOutput", - "description": "Contains the status of the request to delete a company team.", - "fields": [ - { - "name": "success", - "description": "Indicates whether the delete operation succeeded.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyTeamCreateInput", - "description": "Defines the input schema for creating a company team.", - "fields": null, - "inputFields": [ - { - "name": "description", - "description": "An optional description of the team.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The display name of the team.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "target_id", - "description": "The ID of a node within a company's structure. This ID will be the parent of the created team.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyTeamUpdateInput", - "description": "Defines the input schema for updating a company team.", - "fields": null, - "inputFields": [ - { - "name": "description", - "description": "An optional description of the team.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "id", - "description": "The unique ID of the `CompanyTeam` object to update.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The display name of the team.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyStructureOutput", - "description": "Contains the response to the request to update the company structure.", - "fields": [ - { - "name": "company", - "description": "The updated company instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Company", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyStructureUpdateInput", - "description": "Defines the input schema for updating the company structure.", - "fields": null, - "inputFields": [ - { - "name": "parent_tree_id", - "description": "The ID of a company that will be the new parent.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "tree_id", - "description": "The ID of the company team that is being moved to another parent.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateCompanyOutput", - "description": "Contains the response to the request to create a company.", - "fields": [ - { - "name": "company", - "description": "The new company instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Company", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyOutput", - "description": "Contains the response to the request to update the company.", - "fields": [ - { - "name": "company", - "description": "The updated company instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Company", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateCompanyUserOutput", - "description": "Contains the response to the request to create a company user.", - "fields": [ - { - "name": "user", - "description": "The new company user instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyUserOutput", - "description": "Contains the response to the request to update the company user.", - "fields": [ - { - "name": "user", - "description": "The updated company user instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeleteCompanyUserOutput", - "description": "Contains the response to the request to delete the company user.", - "fields": [ - { - "name": "success", - "description": "Indicates whether the company user has been deactivated successfully.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateCompanyRoleOutput", - "description": "Contains the response to the request to create a company role.", - "fields": [ - { - "name": "role", - "description": "The new company role instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyRoleOutput", - "description": "Contains the response to the request to update the company role.", - "fields": [ - { - "name": "role", - "description": "The updated company role instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeleteCompanyRoleOutput", - "description": "Contains the response to the request to delete the company role.", - "fields": [ - { - "name": "success", - "description": "SIndicates whether the company role has been deleted successfully.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyCreateInput", - "description": "Defines the input schema for creating a new company.", - "fields": null, - "inputFields": [ + "isDeprecated": true, + "deprecationReason": "Use `__typename` instead." + }, { - "name": "company_admin", - "description": "Defines the company administrator.", + "name": "uid", + "description": "The unique ID for a `ProductInterface` object.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyAdminInput", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "company_email", - "description": "The email address of the company contact.", + "name": "updated_at", + "description": "Timestamp indicating when the product was updated.", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "company_name", - "description": "The name of the company to create.", + "name": "upsell_products", + "description": "An array of up-sell products.", + "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "legal_address", - "description": "Defines legal address data of the company.", + "name": "url_key", + "description": "The part of the URL that identifies the product", + "args": [], "type": { - "kind": "NON_NULL", + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_path", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use product's `canonical_url` or url rewrites instead" + }, + { + "name": "url_rewrites", + "description": "URL rewrites list", + "args": [], + "type": { + "kind": "LIST", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyLegalAddressCreateInput", + "kind": "OBJECT", + "name": "UrlRewrite", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "legal_name", - "description": "The full legal name of the company.", + "name": "url_suffix", + "description": "The part of the product URL that is appended after the url key", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "reseller_id", - "description": "The resale number that is assigned to the company for tax reporting purposes.", + "name": "websites", + "description": "An array of websites in which the product is available.", + "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Website", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "vat_tax_id", - "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", + "name": "weight", + "description": "The weight of the item, in units defined by the store.", + "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "PhysicalProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "CustomizableProductInterface", + "ofType": null } ], - "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "INPUT_OBJECT", - "name": "CompanyAdminInput", - "description": "Defines the input schema for creating a company administrator.", + "kind": "ENUM", + "name": "PriceViewEnum", + "description": "Defines whether a bundle product's price is displayed as the lowest possible value or as a range.", "fields": null, - "inputFields": [ + "inputFields": null, + "interfaces": null, + "enumValues": [ { - "name": "custom_attributes", - "description": "The company administrator's custom attributes.", + "name": "PRICE_RANGE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AS_LOW_AS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShipBundleItemsEnum", + "description": "Defines whether bundle items must be shipped together.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TOGETHER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEPARATELY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleOrderItem", + "description": "Defines bundle product options for `OrderItemInterface`.", + "fields": [ + { + "name": "bundle_options", + "description": "A list of bundle options that are assigned to the bundle product.", + "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "AttributeValueInput", + "kind": "OBJECT", + "name": "ItemSelectedBundleOption", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "email", - "description": "The email address of the company administrator.", + "name": "discounts", + "description": "The final discount information for the product.", + "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "Discount", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "firstname", - "description": "The company administrator's first name.", + "name": "eligible_for_return", + "description": "Indicates whether the order item is eligible to be in a return request.", + "args": [], "type": { - "kind": "NON_NULL", + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "entered_options", + "description": "The entered option for the base product, such as a logo or image.", + "args": [], + "type": { + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "OrderItemOption", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "gender", - "description": "The company administrator's gender (Male - 1, Female - 2, Not Specified - 3).", + "name": "gift_message", + "description": "The selected gift message for the order item", + "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "GiftMessage", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "job_title", - "description": "The job title of the company administrator.", + "name": "gift_wrapping", + "description": "The selected gift wrapping for the order item.", + "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "GiftWrapping", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "lastname", - "description": "The company administrator's last name.", + "name": "id", + "description": "The unique ID for an `OrderItemInterface` object.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "telephone", - "description": "The phone number of the company administrator.", + "name": "parent_sku", + "description": "The SKU of parent product.", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyLegalAddressCreateInput", - "description": "Defines the input schema for defining a company's legal address.", - "fields": null, - "inputFields": [ - { - "name": "city", - "description": "The city where the company is registered to conduct business.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "country_id", - "description": "The company's country ID. Use the `countries` query to get this value.", + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CountryCodeEnum", - "ofType": null - } + "kind": "OBJECT", + "name": "OrderItemPrices", + "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "postcode", - "description": "The postal code of the company.", + "name": "product", + "description": "The ProductInterface object, which contains details about the base product", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "region", - "description": "An object containing the region name and/or region ID where the company is registered to conduct business.", + "name": "product_name", + "description": "The name of the base product.", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressRegionInput", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "street", - "description": "An array of strings that define the street address where the company is registered to conduct business.", + "name": "product_sale_price", + "description": "The sale price of the base product, including selected options.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "OBJECT", + "name": "Money", + "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "telephone", - "description": "The primary phone number of the company.", + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], "type": { "kind": "NON_NULL", "name": null, @@ -50105,307 +49063,315 @@ "ofType": null } }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyUpdateInput", - "description": "Defines the input schema for updating a company.", - "fields": null, - "inputFields": [ + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "company_email", - "description": "The email address of the company contact.", + "name": "product_type", + "description": "The type of product, such as simple, configurable, etc.", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "company_name", - "description": "The name of the company to update.", + "name": "product_url_key", + "description": "URL key of the base product.", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null - }, - { - "name": "legal_address", - "description": "The legal address data of the company.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CompanyLegalAddressUpdateInput", - "ofType": null - }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "legal_name", - "description": "The full legal name of the company.", + "name": "quantity_canceled", + "description": "The number of canceled items.", + "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "reseller_id", - "description": "The resale number that is assigned to the company for tax reporting purposes.", + "name": "quantity_invoiced", + "description": "The number of invoiced items.", + "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "vat_tax_id", - "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", + "name": "quantity_ordered", + "description": "The number of units ordered for this item.", + "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyLegalAddressUpdateInput", - "description": "Defines the input schema for updating a company's legal address.", - "fields": null, - "inputFields": [ + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "city", - "description": "The city where the company is registered to conduct business.", + "name": "quantity_refunded", + "description": "The number of refunded items.", + "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "country_id", - "description": "The unique ID for a `Country` object.", + "name": "quantity_return_requested", + "description": "The requested return quantity of the item.", + "args": [], "type": { - "kind": "ENUM", - "name": "CountryCodeEnum", + "kind": "SCALAR", + "name": "Float", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "postcode", - "description": "The postal code of the company.", + "name": "quantity_returned", + "description": "The number of returned items.", + "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "region", - "description": "An object containing the region name and/or region ID where the company is registered to conduct business.", + "name": "quantity_shipped", + "description": "The number of shipped items.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressRegionInput", + "kind": "SCALAR", + "name": "Float", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "street", - "description": "An array of strings that define the street address where the company is registered to conduct business.", + "name": "selected_options", + "description": "The selected options for the base product, such as color or size.", + "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "OrderItemOption", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "telephone", - "description": "The primary phone number of the company.", + "name": "status", + "description": "The status of the order item.", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null } ], - "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "INPUT_OBJECT", - "name": "CompanyUserCreateInput", - "description": "Defines the input schema for creating a company user.", - "fields": null, - "inputFields": [ + "kind": "OBJECT", + "name": "BundleInvoiceItem", + "description": "Defines bundle product options for `InvoiceItemInterface`.", + "fields": [ { - "name": "email", - "description": "The company user's email address", + "name": "bundle_options", + "description": "A list of bundle options that are assigned to an invoiced bundle product.", + "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "ItemSelectedBundleOption", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "firstname", - "description": "The company user's first name.", + "name": "discounts", + "description": "Information about the final discount amount for the base product, including discounts on options.", + "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "Discount", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "job_title", - "description": "The company user's job title or function.", + "name": "id", + "description": "The unique ID for an `InvoiceItemInterface` object.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "lastname", - "description": "The company user's last name.", + "name": "order_item", + "description": "Details about an individual order item.", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "role_id", - "description": "The unique ID for a `CompanyRole` object.", + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product including selected options.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "OBJECT", + "name": "Money", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "status", - "description": "Indicates whether the company user is ACTIVE or INACTIVE.", + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "ENUM", - "name": "CompanyUserStatusEnum", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "target_id", - "description": "The ID of a node within a company's structure. This ID will be the parent of the created company user.", + "name": "quantity_invoiced", + "description": "The number of invoiced items.", + "args": [], "type": { "kind": "SCALAR", - "name": "ID", + "name": "Float", "ofType": null }, - "defaultValue": null - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ { - "name": "telephone", - "description": "The company user's phone number.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null + "kind": "INTERFACE", + "name": "InvoiceItemInterface", + "ofType": null } ], - "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "INPUT_OBJECT", - "name": "CompanyUserUpdateInput", - "description": "Defines the input schema for updating a company user.", - "fields": null, - "inputFields": [ - { - "name": "email", - "description": "The company user's email address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, + "kind": "OBJECT", + "name": "BundleShipmentItem", + "description": "Defines bundle product options for `ShipmentItemInterface`.", + "fields": [ { - "name": "firstname", - "description": "The company user's first name.", + "name": "bundle_options", + "description": "A list of bundle options that are assigned to a shipped product.", + "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemSelectedBundleOption", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { "name": "id", - "description": "The unique ID of a `Customer` object.", + "description": "The unique ID for a `ShipmentItemInterface` object.", + "args": [], "type": { "kind": "NON_NULL", "name": null, @@ -50415,72 +49381,53 @@ "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "job_title", - "description": "The company user's job title or function.", + "name": "order_item", + "description": "The order item associated with the shipment item.", + "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INTERFACE", + "name": "OrderItemInterface", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "lastname", - "description": "The company user's last name.", + "name": "product_name", + "description": "The name of the base product.", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null - }, - { - "name": "role_id", - "description": "The unique ID for a `CompanyRole` object.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "status", - "description": "Indicates whether the company user is ACTIVE or INACTIVE.", + "name": "product_sale_price", + "description": "The sale price for the base product.", + "args": [], "type": { - "kind": "ENUM", - "name": "CompanyUserStatusEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "telephone", - "description": "The company user's phone number.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyRoleCreateInput", - "description": "Defines the input schema for creating a company role.", - "fields": null, - "inputFields": [ - { - "name": "name", - "description": "The name of the role to create.", + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], "type": { "kind": "NON_NULL", "name": null, @@ -50490,236 +49437,178 @@ "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "permissions", - "description": "A list of resources the role can access.", + "name": "quantity_shipped", + "description": "The number of shipped items.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ShipmentItemInterface", + "ofType": null } ], - "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "INPUT_OBJECT", - "name": "CompanyRoleUpdateInput", - "description": "Defines the input schema for updating a company role.", - "fields": null, - "inputFields": [ + "kind": "OBJECT", + "name": "BundleCreditMemoItem", + "description": "Defines bundle product options for `CreditMemoItemInterface`.", + "fields": [ { - "name": "id", - "description": "The unique ID for a `CompanyRole` object.", + "name": "bundle_options", + "description": "A list of bundle options that are assigned to a bundle product that is part of a credit memo.", + "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "OBJECT", + "name": "ItemSelectedBundleOption", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "name", - "description": "The name of the role to update.", + "name": "discounts", + "description": "Details about the final discount amount for the base product, including discounts on options.", + "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "permissions", - "description": "A list of resources the role can access.", + "name": "id", + "description": "The unique ID for a `CreditMemoItemInterface` object.", + "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "UserCompaniesInput", - "description": "Defines the input for returning matching companies the customer is assigned to.", - "fields": null, - "inputFields": [ - { - "name": "currentPage", - "description": "Specifies which page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "pageSize", - "description": "Specifies the maximum number of results to return at once. This attribute is optional.", + "name": "order_item", + "description": "The order item the credit memo is applied to.", + "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "INTERFACE", + "name": "OrderItemInterface", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "sort", - "description": "Defines the sorting of the results.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompaniesSortInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UserCompaniesOutput", - "description": "An object that contains a list of companies customer is assigned to.", - "fields": [ - { - "name": "items", - "description": "An array of companies customer is assigned to.", + "name": "product_name", + "description": "The name of the base product.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyBasicInfo", - "ofType": null - } - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "page_info", - "description": "Provides navigation for the query response.", + "name": "product_sale_price", + "description": "The sale price for the base product, including selected options.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", - "name": "SearchResultPageInfo", + "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompaniesSortInput", - "description": "Specifies which field to sort on, and whether to return the results in ascending or descending order.", - "fields": null, - "inputFields": [ + }, { - "name": "field", - "description": "The field for sorting the results.", + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "ENUM", - "name": "CompaniesSortFieldEnum", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "order", - "description": "Indicates whether to return results in ascending or descending order.", + "name": "quantity_refunded", + "description": "The number of refunded items.", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null } ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CompaniesSortFieldEnum", - "description": "The fields available for sorting the customer companies.", - "fields": null, "inputFields": null, - "interfaces": null, - "enumValues": [ + "interfaces": [ { - "name": "NAME", - "description": "The name of the company.", - "isDeprecated": false, - "deprecationReason": null + "kind": "INTERFACE", + "name": "CreditMemoItemInterface", + "ofType": null } ], + "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "CompanyBasicInfo", - "description": "The minimal required information to identify and display the company.", + "name": "ItemSelectedBundleOption", + "description": "A list of options of the selected bundle product.", "fields": [ { "name": "id", - "description": "The unique ID of a `Company` object.", + "description": "The unique ID for a `ItemSelectedBundleOption` object.", "args": [], "type": { "kind": "NON_NULL", @@ -50730,29 +49619,53 @@ "ofType": null } }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "label", + "description": "The label of the option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "legal_name", - "description": "The full legal name of the company.", + "name": "uid", + "description": "The unique ID for a `ItemSelectedBundleOption` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "name", - "description": "The name of the company.", + "name": "values", + "description": "A list of products that represent the values of the parent option.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemSelectedBundleOptionValue", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null @@ -50764,212 +49677,191 @@ "possibleTypes": null }, { - "kind": "INPUT_OBJECT", - "name": "CompanyInvitationInput", - "description": "Defines the input schema for accepting the company invitation.", - "fields": null, - "inputFields": [ + "kind": "OBJECT", + "name": "ItemSelectedBundleOptionValue", + "description": "A list of values for the selected bundle product.", + "fields": [ { - "name": "code", - "description": "The invitation code.", + "name": "id", + "description": "The unique ID for a `ItemSelectedBundleOptionValue` object.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, - "defaultValue": null - }, - { - "name": "role_id", - "description": "The company role id.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." }, { - "name": "user", - "description": "Company user attributes in the invitation.", + "name": "price", + "description": "The price of the child bundle product.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyInvitationUserInput", + "kind": "OBJECT", + "name": "Money", "ofType": null } }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyInvitationUserInput", - "description": "Company user attributes in the invitation.", - "fields": null, - "inputFields": [ + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "company_id", - "description": "The company unique identifier.", + "name": "product_name", + "description": "The name of the child bundle product.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "customer_id", - "description": "The customer unique identifier.", + "name": "product_sku", + "description": "The SKU of the child bundle product.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, - "defaultValue": null - }, - { - "name": "job_title", - "description": "The job title of a company user.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "status", - "description": "Indicates whether the company user is ACTIVE or INACTIVE.", + "name": "quantity", + "description": "The number of this bundle product that were ordered.", + "args": [], "type": { - "kind": "ENUM", - "name": "CompanyUserStatusEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "telephone", - "description": "The phone number of the company user.", + "name": "uid", + "description": "The unique ID for a `ItemSelectedBundleOptionValue` object.", + "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null } ], - "interfaces": null, + "inputFields": null, + "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "CompanyInvitationOutput", - "description": "The result of accepting the company invitation.", + "name": "BundleWishlistItem", + "description": "Defines bundle product options for `WishlistItemInterface`.", "fields": [ { - "name": "success", - "description": "Indicates whether the customer was added to the company successfully.", + "name": "added_at", + "description": "The date and time the item was added to the wish list.", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyStructureItem", - "description": "Defines an individual node in the company structure.", - "fields": [ + }, { - "name": "entity", - "description": "A union of `CompanyTeam` and `Customer` objects.", + "name": "bundle_options", + "description": "An array containing information about the selected bundle items.", "args": [], "type": { - "kind": "UNION", - "name": "CompanyStructureEntity", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedBundleOption", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The unique ID for a `CompanyStructureItem` object.", + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "parent_id", - "description": "The ID of the parent item in the company hierarchy.", + "name": "description", + "description": "The description of the item.", "args": [], "type": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerSegment", - "description": "Customer segment.", - "fields": [ + }, { - "name": "apply_to", - "description": "Customer segment is applicable to visitor, registered customer or both.", + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "ENUM", - "name": "CustomerSegmentApplyTo", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, @@ -50977,27 +49869,27 @@ "deprecationReason": null }, { - "name": "description", - "description": "Customer segment description.", + "name": "product", + "description": "Product details of the wish list item.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "name", - "description": "Customer segment name.", + "name": "quantity", + "description": "The quantity of this wish list item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null } }, @@ -51006,37 +49898,14 @@ } ], "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CustomerSegmentApplyTo", - "description": "Customer segment is applicable to visitor, registered customers or both.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "BOTH", - "description": "Customer segment is applicable to visitor and registered customers.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "REGISTERED", - "description": "Customer segment is applicable to registered customers.", - "isDeprecated": false, - "deprecationReason": null - }, + "interfaces": [ { - "name": "VISITOR", - "description": "Customer segment is applicable to visitors/guests.", - "isDeprecated": false, - "deprecationReason": null + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null } ], + "enumValues": null, "possibleTypes": null }, { @@ -52913,12 +51782,12 @@ }, { "kind": "OBJECT", - "name": "BundleOrderItem", + "name": "DownloadableOrderItem", "ofType": null }, { "kind": "OBJECT", - "name": "DownloadableOrderItem", + "name": "BundleOrderItem", "ofType": null }, { @@ -53263,12 +52132,12 @@ }, { "kind": "OBJECT", - "name": "BundleWishlistItem", + "name": "DownloadableWishlistItem", "ofType": null }, { "kind": "OBJECT", - "name": "DownloadableWishlistItem", + "name": "BundleWishlistItem", "ofType": null }, { @@ -53549,6 +52418,12 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "REQUIRED_PARAMETER_MISSING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, { "name": "NOT_SALABLE", "description": "", @@ -53932,18 +52807,6 @@ "name": "GiftCardProduct", "description": "Defines properties of a gift card.", "fields": [ - { - "name": "activity", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "allow_message", "description": "Indicates whether the customer can provide a message to accompany the gift card.", @@ -54008,42 +52871,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "category_gear", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "climate", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "collar", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "color", "description": null, @@ -54131,66 +52958,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gender", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "gift_card_options", "description": "An array of customizable gift card options.", @@ -54355,18 +53122,6 @@ "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, - { - "name": "material", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "max_sale_qty", "description": "Maximum Qty Allowed in Shopping Cart", @@ -54483,18 +53238,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "new", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "new_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", @@ -54583,30 +53326,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "pattern", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "price", "description": "Indicates the price of an item.", @@ -54667,18 +53386,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "purpose", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "quantity", "description": "Amount of available stock", @@ -54804,34 +53511,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "rules", - "description": "Provides applied catalog rules in the current active cart", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CatalogRule", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", @@ -54844,18 +53523,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "size", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", @@ -54868,18 +53535,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", @@ -54956,54 +53611,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "swatch_image", "description": "The file name of a swatch image.", @@ -56400,20 +55007,266 @@ "description": "The name of the person receiving the gift card.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sender_email", + "description": "The email address of the sender.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sender_name", + "description": "The name of the sender.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardWishlistItem", + "description": "A single gift card added to a wish list.", + "fields": [ + { + "name": "added_at", + "description": "The date and time the item was added to the wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_card_options", + "description": "Details about a gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftCardOptions", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Product details of the wish list item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardOptions", + "description": "Contains details about the sender, recipient, and amount of a gift card.", + "fields": [ + { + "name": "amount", + "description": "The amount and currency of the gift card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_giftcard_amount", + "description": "The custom amount and currency of the gift card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A message to the recipient.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recipient_email", + "description": "The email address of the person receiving the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recipient_name", + "description": "The name of the person receiving the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sender_email", - "description": "The email address of the sender.", + "description": "The email address of the person sending the gift card.", "args": [], "type": { "kind": "SCALAR", @@ -56425,63 +55278,37 @@ }, { "name": "sender_name", - "description": "The name of the sender.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", + "description": "The name of the person sending the gift card.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CartItemInterface", - "ofType": null - } - ], + "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "GiftCardWishlistItem", - "description": "A single gift card added to a wish list.", + "name": "GiftCartAttributeValue", + "description": "Gift card custom attribute value containing array data.", "fields": [ { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", + "name": "code", + "description": "The attribute code.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -56489,8 +55316,8 @@ "deprecationReason": null }, { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", + "name": "options", + "description": "Array of gift card attribute option values.", "args": [], "type": { "kind": "NON_NULL", @@ -56499,194 +55326,27 @@ "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", + "kind": "SCALAR", + "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null - }, - { - "name": "description", - "description": "The description of the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_card_options", - "description": "Details about a gift card.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftCardOptions", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Product details of the wish list item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", - "name": "WishlistItemInterface", + "name": "AttributeValueInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, - { - "kind": "OBJECT", - "name": "GiftCardOptions", - "description": "Contains details about the sender, recipient, and amount of a gift card.", - "fields": [ - { - "name": "amount", - "description": "The amount and currency of the gift card.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_giftcard_amount", - "description": "The custom amount and currency of the gift card.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "message", - "description": "A message to the recipient.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "recipient_email", - "description": "The email address of the person receiving the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "recipient_name", - "description": "The name of the person receiving the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sender_email", - "description": "The email address of the person sending the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sender_name", - "description": "The name of the person sending the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, { "kind": "OBJECT", "name": "GiftRegistrySearchResult", @@ -57325,6 +55985,16 @@ "ofType": null }, "defaultValue": null + }, + { + "name": "customer_address_uid", + "description": "The unique ID assigned to this customer address.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null } ], "interfaces": null, @@ -59485,18 +58155,6 @@ "name": "GroupedProduct", "description": "Defines a grouped product, which consists of simple standalone products that are presented as a group.", "fields": [ - { - "name": "activity", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "attribute_set_id", "description": "The attribute set assigned to the product.", @@ -59537,42 +58195,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "category_gear", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "climate", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "collar", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "color", "description": null, @@ -59660,66 +58282,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gender", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "gift_message_available", "description": "Returns a value indicating gift message availability for the product.", @@ -59828,18 +58390,6 @@ "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, - { - "name": "material", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "max_sale_qty", "description": "Maximum Qty Allowed in Shopping Cart", @@ -59944,18 +58494,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "new", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "new_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", @@ -60004,30 +58542,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "pattern", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "price", "description": "Indicates the price of an item.", @@ -60088,18 +58602,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "purpose", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "quantity", "description": "Amount of available stock", @@ -60225,34 +58727,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "rules", - "description": "Provides applied catalog rules in the current active cart", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CatalogRule", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", @@ -60265,18 +58739,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "size", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", @@ -60289,18 +58751,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", @@ -60377,54 +58827,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, { "name": "swatch_image", "description": "The file name of a swatch image.", @@ -62696,12 +61098,12 @@ "possibleTypes": [ { "kind": "OBJECT", - "name": "BundleInvoiceItem", + "name": "DownloadableInvoiceItem", "ofType": null }, { "kind": "OBJECT", - "name": "DownloadableInvoiceItem", + "name": "BundleInvoiceItem", "ofType": null }, { @@ -63745,12 +62147,12 @@ "possibleTypes": [ { "kind": "OBJECT", - "name": "BundleCreditMemoItem", + "name": "DownloadableCreditMemoItem", "ofType": null }, { "kind": "OBJECT", - "name": "DownloadableCreditMemoItem", + "name": "BundleCreditMemoItem", "ofType": null }, { @@ -64168,6 +62570,69 @@ "name": "OrderInformationInput", "description": "Input to retrieve an order based on details.", "fields": null, + "inputFields": [ + { + "name": "email", + "description": "Order billing address email.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "Order billing address lastname.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "number", + "description": "Order number.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "postcode", + "description": "Order billing address postcode", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "GuestOrderInformationInput", + "description": "Input to retrieve an order based on details.", + "fields": null, "inputFields": [ { "name": "email", @@ -66496,35 +64961,31 @@ }, { "kind": "OBJECT", - "name": "DynamicBlock", - "description": "Contains a single dynamic block.", + "name": "AddProductsToNewCartOutput", + "description": "Contains details about the cart after adding products to it.", "fields": [ { - "name": "content", - "description": "The renderable HTML code of the dynamic block.", + "name": "cart", + "description": "The cart after products have been added.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - } + "kind": "OBJECT", + "name": "Cart", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID of a `DynamicBlock` object.", + "name": "user_errors", + "description": "Contains errors encountered while adding an item to the cart.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "OBJECT", + "name": "CartUserInputError", "ofType": null } }, @@ -66539,51 +65000,31 @@ }, { "kind": "OBJECT", - "name": "DynamicBlocks", - "description": "Contains an array of dynamic blocks.", + "name": "SetCartAsInactiveOutput", + "description": "Sets the cart as inactive", "fields": [ { - "name": "items", - "description": "An array containing individual dynamic blocks.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DynamicBlock", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Metadata for pagination rendering.", + "name": "error", + "description": "The error message returned after failing to set the cart as inactive", "args": [], "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "total_count", - "description": "The number of returned dynamic blocks.", + "name": "success", + "description": "Indicates whether the cart was set as inactive", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Int", + "name": "Boolean", "ofType": null } }, @@ -66596,129 +65037,6 @@ "enumValues": null, "possibleTypes": null }, - { - "kind": "INPUT_OBJECT", - "name": "DynamicBlocksFilterInput", - "description": "Defines the dynamic block filter. The filter can identify the block type, location and IDs to return.", - "fields": null, - "inputFields": [ - { - "name": "dynamic_block_uids", - "description": "An array of dynamic block UIDs to filter on.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "locations", - "description": "An array indicating the locations the dynamic block can be placed.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "DynamicBlockLocationEnum", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "type", - "description": "A value indicating the type of dynamic block to filter on.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "DynamicBlockTypeEnum", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "DynamicBlockTypeEnum", - "description": "Indicates the selected Dynamic Blocks Rotator inline widget.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "SPECIFIED", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "CART_PRICE_RULE_RELATED", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "CATALOG_PRICE_RULE_RELATED", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "DynamicBlockLocationEnum", - "description": "Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "CONTENT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "HEADER", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "FOOTER", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "LEFT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "RIGHT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, { "kind": "OBJECT", "name": "GetPaymentSDKOutput", @@ -67038,6 +65356,45 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "CompleteOrderInput", + "description": "Update the quote and complete the order", + "fields": null, + "inputFields": [ + { + "name": "cartId", + "description": "The customer cart ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "id", + "description": "PayPal order ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "SyncPaymentOrderInput", @@ -67180,6 +65537,12 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "START_OF_CHECKOUT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, { "name": "ADMIN", "description": "", @@ -67206,6 +65569,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "fastlane", + "description": "Fastlane payment method configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FastlaneConfig", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "google_pay", "description": "GooglePay payment method configuration", @@ -67358,6 +65733,11 @@ "kind": "OBJECT", "name": "GooglePayConfig", "ofType": null + }, + { + "kind": "OBJECT", + "name": "FastlaneConfig", + "ofType": null } ] }, @@ -67653,6 +66033,18 @@ "name": "SmartButtonsConfig", "description": "", "fields": [ + { + "name": "app_switch_when_available", + "description": "Indicated whether to use App Switch on enabled mobile devices", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "button_styles", "description": "The styles for the PayPal Smart Button configuration", @@ -67908,21 +66300,138 @@ }, { "kind": "OBJECT", - "name": "GooglePayConfig", + "name": "GooglePayConfig", + "description": "", + "fields": [ + { + "name": "button_styles", + "description": "The styles for the GooglePay Button configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GooglePayButtonStyles", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The payment method code as defined in the payment gateway", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_visible", + "description": "Indicates whether the payment method is displayed", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_intent", + "description": "Defines the payment intent (Authorize or Capture", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_source", + "description": "The payment source for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sdk_params", + "description": "The PayPal parameters required to load the JS SDK", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SDKParams", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The relative order the payment method is displayed on the checkout page", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "three_ds_mode", + "description": "3DS mode", + "args": [], + "type": { + "kind": "ENUM", + "name": "ThreeDSMode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name displayed for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "PaymentConfigItem", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FastlaneConfig", "description": "", "fields": [ - { - "name": "button_styles", - "description": "The styles for the GooglePay Button configuration", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GooglePayButtonStyles", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "code", "description": "The payment method code as defined in the payment gateway", @@ -68545,6 +67054,37 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "FastlaneMethodInput", + "description": "Fastlane Payment inputs", + "fields": null, + "inputFields": [ + { + "name": "payment_source", + "description": "The payment source for the payment method", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paypal_fastlane_token", + "description": "The single use token from Fastlane", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "CreateVaultCardSetupTokenInput", @@ -75971,19 +74511,244 @@ }, { "kind": "OBJECT", - "name": "CartRule", + "name": "DynamicBlock", + "description": "Contains a single dynamic block.", + "fields": [ + { + "name": "content", + "description": "The renderable HTML code of the dynamic block.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of a `DynamicBlock` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DynamicBlocks", + "description": "Contains an array of dynamic blocks.", + "fields": [ + { + "name": "items", + "description": "An array containing individual dynamic blocks.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DynamicBlock", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Metadata for pagination rendering.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The number of returned dynamic blocks.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DynamicBlocksFilterInput", + "description": "Defines the dynamic block filter. The filter can identify the block type, location and IDs to return.", + "fields": null, + "inputFields": [ + { + "name": "dynamic_block_uids", + "description": "An array of dynamic block UIDs to filter on.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "locations", + "description": "An array indicating the locations the dynamic block can be placed.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DynamicBlockLocationEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "type", + "description": "A value indicating the type of dynamic block to filter on.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DynamicBlockTypeEnum", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DynamicBlockTypeEnum", + "description": "Indicates the selected Dynamic Blocks Rotator inline widget.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SPECIFIED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CART_PRICE_RULE_RELATED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_PRICE_RULE_RELATED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DynamicBlockLocationEnum", + "description": "Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CONTENT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HEADER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FOOTER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LEFT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RIGHT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartRuleStorefront", "description": "", "fields": [ { - "name": "name", - "description": "Name of the cart price rule", + "name": "uid", + "description": "The unique ID for a `CartRule` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -76330,177 +75095,45 @@ "possibleTypes": null }, { - "kind": "OBJECT", - "name": "EntityUrl", - "description": "Contains the `uid`, `relative_url`, and `type` attributes.", - "fields": [ - { - "name": "canonical_url", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `relative_url` instead." - }, - { - "name": "entity_uid", - "description": "The unique ID for a `ProductInterface`, `CategoryInterface`, `CmsPage`, or similar object associated with the specified URL. This could be a product, category, or CMS page UID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `entity_uid` instead." - }, - { - "name": "redirectCode", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UrlRewrite", - "description": "Contains URL rewrite details.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "ExchangeExternalCustomerTokenInput", + "description": "Contains details about external customer.", + "fields": null, + "inputFields": [ { - "name": "parameters", - "description": "An array of request parameters.", - "args": [], + "name": "customer", + "description": "An input object that defines the customer characteristics to update.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "HttpQueryParameter", + "kind": "INPUT_OBJECT", + "name": "CustomerCreateInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url", - "description": "The request URL.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "HttpQueryParameter", - "description": "Contains target path parameters.", - "fields": [ - { - "name": "name", - "description": "A parameter name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "A parameter value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null } ], - "inputFields": null, - "interfaces": [], + "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "RoutableUrl", - "description": "Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity.", + "name": "ExchangeExternalCustomerTokenOutput", + "description": "Contains customer token for external customer.", "fields": [ { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "name": "customer", + "description": "Return detailed information about a customer account.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "Customer", "ofType": null } }, @@ -76508,142 +75141,26 @@ "deprecationReason": null }, { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "description": "Routable entities serve as the model for a rendered page.", - "fields": [ - { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "name": "token", + "description": "The customer authorization token.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, - { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "CmsPage", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CategoryTree", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "VirtualProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "SimpleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "DownloadableProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GroupedProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "RoutableUrl", - "ofType": null - } - ] + "possibleTypes": null }, { "kind": "INTERFACE", @@ -77530,6 +76047,18 @@ "name": "__Schema", "description": "A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.", "fields": [ + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "types", "description": "A list of all types supported by this server.", @@ -77677,9 +76206,13 @@ "name": "includeDeprecated", "description": null, "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "defaultValue": "false" } @@ -77748,9 +76281,13 @@ "name": "includeDeprecated", "description": null, "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "defaultValue": "false" } @@ -77779,9 +76316,13 @@ "name": "includeDeprecated", "description": null, "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "defaultValue": "false" } @@ -77813,6 +76354,18 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "isOneOf", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -77920,9 +76473,13 @@ "name": "includeDeprecated", "description": null, "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "defaultValue": "false" } @@ -78235,7 +76792,22 @@ { "name": "args", "description": null, - "args": [], + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": "false" + } + ], "type": { "kind": "NON_NULL", "name": null, @@ -78460,6 +77032,14 @@ "defaultValue": "\"No longer supported\"" } ] + }, + { + "name": "oneOf", + "description": "Indicates that an Input Object is a OneOf Input Object (and thus requires exactly one of its fields be provided).", + "locations": [ + "INPUT_OBJECT" + ], + "args": [] } ] } diff --git a/spectaql/schema_2.4.9-beta-1.json b/spectaql/schema_2.4.8.json similarity index 98% rename from spectaql/schema_2.4.9-beta-1.json rename to spectaql/schema_2.4.8.json index 092d791f1..2afcfb97c 100644 --- a/spectaql/schema_2.4.9-beta-1.json +++ b/spectaql/schema_2.4.8.json @@ -524,22 +524,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "customerGroup", - "description": "Provides Customer Group assigned to the Customer or Guest.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomerGroupStorefront", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "customerOrders", "description": null, @@ -564,37 +548,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "customerSegments", - "description": "Customer segments associated with the current customer or guest/visitor.", - "args": [ - { - "name": "cartId", - "description": "The unique ID of the cart to query.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomerSegmentStorefront", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "dynamicBlocks", "description": "Return a list of dynamic blocks filtered by type, location, or UIDs.", @@ -1002,7 +955,7 @@ "name": null, "ofType": { "kind": "INPUT_OBJECT", - "name": "GuestOrderInformationInput", + "name": "OrderInformationInput", "ofType": null } }, @@ -1925,41 +1878,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "addProductsToNewCart", - "description": "Creates a new cart and add any type of product to it", - "args": [ - { - "name": "cartItems", - "description": "An array that defines the products to add to the new cart", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddProductsToNewCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "addProductsToRequisitionList", "description": "Add items to the specified requisition list.", @@ -2690,33 +2608,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "clearWishlist", - "description": "Remove all the products from the specified wish list.", - "args": [ - { - "name": "wishlistId", - "description": "The ID of a wish list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RemoveProductsFromWishlistOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "closeNegotiableQuotes", "description": "Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront.", @@ -2744,29 +2635,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "completeOrder", - "description": "Synchronizes order details and place the order", - "args": [ - { - "name": "input", - "description": "Describes the variables needed to complete or place the order", - "type": { - "kind": "INPUT_OBJECT", - "name": "CompleteOrderInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PlaceOrderOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "confirmCancelOrder", "description": "Cancel the specified guest customer order.", @@ -3743,33 +3611,6 @@ "name": "Boolean", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `deleteCustomerAddressV2` instead." - }, - { - "name": "deleteCustomerAddressV2", - "description": "Delete the billing or shipping address of a customer.", - "args": [ - { - "name": "uid", - "description": "The unique ID of the customer address to be deleted.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, "isDeprecated": false, "deprecationReason": null }, @@ -4077,29 +3918,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "exchangeExternalCustomerToken", - "description": "Generate a token for specified customer.", - "args": [ - { - "name": "input", - "description": "Contains details about external customer.", - "type": { - "kind": "INPUT_OBJECT", - "name": "ExchangeExternalCustomerTokenInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ExchangeExternalCustomerTokenOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "generateCustomerToken", "description": "Generate a token for specified customer.", @@ -5433,33 +5251,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "setCartAsInactive", - "description": "Sets the cart as inactive", - "args": [ - { - "name": "cartId", - "description": "The customer cart ID", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SetCartAsInactiveOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "setGiftOptionsOnCart", "description": "Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards.", @@ -5927,6 +5718,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "trackViewedProduct", + "description": "Track that a product was viewed in adobe commerce", + "args": [ + { + "name": "sku", + "description": "The sku for a `ProductInterface` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "updateCartItems", "description": "Modify items in the cart.", @@ -6146,43 +5964,6 @@ "name": "CustomerAddress", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `updateCustomerAddressV2` instead." - }, - { - "name": "updateCustomerAddressV2", - "description": "Update the billing or shipping address of a customer or guest.", - "args": [ - { - "name": "uid", - "description": "The unique ID of the customer address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "input", - "description": "An input object that contains changes to the customer address.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CustomerAddress", - "ofType": null - }, "isDeprecated": false, "deprecationReason": null }, @@ -9469,11 +9250,6 @@ "kind": "OBJECT", "name": "AttributeSelectedOptions", "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCartAttributeValue", - "ofType": null } ] }, @@ -11003,22 +10779,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "cart_merge_preference", - "description": "Configuration data from checkout/cart/cart_merge_preference", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "cart_printed_card", "description": "Indicates if printed card prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).", @@ -11591,14 +11351,34 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "graphql_share_all_customer_groups", + "description": "Configuration data from customer/account_information/graphql_share_all_customer_groups", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "graphql_share_customer_group", "description": "Configuration data from customer/account_information/graphql_share_customer_group", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null @@ -12500,25 +12280,65 @@ "deprecationReason": null }, { - "name": "share_active_segments", - "description": "Configuration data from customer/magento_customersegment/share_active_segments", + "name": "share_all_catalog_rules", + "description": "Configuration data from catalog/rule/share_all_catalog_rules", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "share_applied_cart_rule", - "description": "Configuration data from promo/graphql/share_applied_cart_rule", + "name": "share_all_sales_rule", + "description": "Configuration data from promo/graphql/share_all_sales_rule", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "share_applied_catalog_rules", + "description": "Configuration data from catalog/rule/share_applied_catalog_rules", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "share_applied_sales_rule", + "description": "Configuration data from promo/graphql/share_applied_sales_rule", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null @@ -13212,314 +13032,255 @@ "possibleTypes": null }, { - "kind": "OBJECT", - "name": "Price", - "description": "Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments.", + "kind": "INTERFACE", + "name": "ProductInterface", + "description": "Contains fields that are common to all types of products.", "fields": [ { - "name": "adjustments", - "description": "An array that provides information about tax, weee, or weee_tax adjustments.", + "name": "activity", + "description": null, "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PriceAdjustment", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `ProductPrice` instead." + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "amount", - "description": "The price of a product plus a three-letter currency code.", + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `ProductPrice` instead." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PriceAdjustment", - "description": "Deprecated. Taxes will be included or excluded in the price. Defines the amount of money to apply as an adjustment, the type of adjustment to apply, and whether the item is included or excluded from the adjustment.", - "fields": [ + "deprecationReason": "The field should not be used on the storefront." + }, { - "name": "amount", - "description": "The amount of the price adjustment and its currency code.", + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "code", - "description": "Indicates whether the adjustment involves tax, weee, or weee_tax.", + "name": "categories", + "description": "The categories assigned to a product.", "args": [], "type": { - "kind": "ENUM", - "name": "PriceAdjustmentCodesEnum", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "`PriceAdjustment` is deprecated." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "description", - "description": "Indicates whether the entity described by the code attribute is included or excluded from the adjustment.", + "name": "category_gear", + "description": null, "args": [], "type": { - "kind": "ENUM", - "name": "PriceAdjustmentDescriptionEnum", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": true, - "deprecationReason": "`PriceAdjustment` is deprecated." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PriceAdjustmentCodesEnum", - "description": "`PriceAdjustment.code` is deprecated.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ + "deprecationReason": "Use the `custom_attributes` field instead." + }, { - "name": "TAX", - "description": "", + "name": "climate", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, "isDeprecated": true, - "deprecationReason": "`PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog." + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "WEEE", - "description": "", + "name": "collar", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, "isDeprecated": true, - "deprecationReason": "WEEE code is deprecated. Use `fixed_product_taxes.label` instead." + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "WEEE_TAX", - "description": "", + "name": "color", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, "isDeprecated": true, - "deprecationReason": "Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog." - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PriceAdjustmentDescriptionEnum", - "description": "`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "INCLUDED", - "description": "", - "isDeprecated": false, - "deprecationReason": null + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "EXCLUDED", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PriceTypeEnum", - "description": "Defines the price type.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "FIXED", - "description": "", + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "PERCENT", - "description": "", - "isDeprecated": false, - "deprecationReason": null + "name": "created_at", + "description": "Timestamp indicating when the product was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "DYNAMIC", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CustomizableDateTypeEnum", - "description": "Defines the customizable date type.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "DATE", - "description": "", + "name": "crosssell_products", + "description": "An array of cross-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "DATE_TIME", - "description": "", + "name": "custom_attributesV2", + "description": "Product custom attributes.", + "args": [ + { + "name": "filters", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "TIME", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductPrices", - "description": "Deprecated. Use `PriceRange` instead. Contains the regular price of an item, as well as its minimum and maximum prices. Only composite products, which include bundle, configurable, and grouped products, can contain a minimum and maximum price.", - "fields": [ - { - "name": "maximalPrice", - "description": "The highest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the `to` value.", + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", "args": [], "type": { "kind": "OBJECT", - "name": "Price", + "name": "ComplexTextValue", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `PriceRange.maximum_price` instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "minimalPrice", - "description": "The lowest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the `from` value.", + "name": "eco_collection", + "description": null, "args": [], "type": { - "kind": "OBJECT", - "name": "Price", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `PriceRange.minimum_price` instead." + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "regularPrice", - "description": "The base price of a product.", + "name": "erin_recommends", + "description": null, "args": [], "type": { - "kind": "OBJECT", - "name": "Price", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PriceRange", - "description": "Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same.", - "fields": [ + "deprecationReason": "Use the `custom_attributes` field instead." + }, { - "name": "maximum_price", - "description": "The highest possible price for the product.", + "name": "features_bags", + "description": null, "args": [], "type": { - "kind": "OBJECT", - "name": "ProductPrice", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "minimum_price", - "description": "The lowest possible price for the product.", + "name": "format", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductPrice", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductPrice", - "description": "Represents a product price.", - "fields": [ + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, { - "name": "discount", - "description": "The price discount. Represents the difference between the regular and final price.", + "name": "gender", + "description": null, "args": [], "type": { - "kind": "OBJECT", - "name": "ProductDiscount", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "final_price", - "description": "The final price of the product after applying discounts.", + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "Boolean", "ofType": null } }, @@ -13527,15 +13288,15 @@ "deprecationReason": null }, { - "name": "fixed_product_taxes", - "description": "An array of the multiple Fixed Product Taxes that can be applied to a product price.", + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "FixedProductTax", + "kind": "SCALAR", + "name": "Boolean", "ofType": null } }, @@ -13543,70 +13304,44 @@ "deprecationReason": null }, { - "name": "regular_price", - "description": "The regular price of the product.", + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } + "kind": "OBJECT", + "name": "Money", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductDiscount", - "description": "Contains the discount applied to a product price.", - "fields": [ + }, { - "name": "amount_off", - "description": "The actual value of the discount.", + "name": "id", + "description": "The ID number assigned to the product.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `uid` field instead." }, { - "name": "percent_off", - "description": "The discount expressed a percentage.", + "name": "image", + "description": "The relative path to the main image on the product page.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "OBJECT", + "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductLinks", - "description": "An implementation of `ProductLinksInterface`.", - "fields": [ + }, { - "name": "link_type", - "description": "One of related, associated, upsell, or crosssell.", + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", "args": [], "type": { "kind": "SCALAR", @@ -13617,465 +13352,8 @@ "deprecationReason": null }, { - "name": "linked_product_sku", - "description": "The SKU of the linked product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "linked_product_type", - "description": "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "position", - "description": "The position within the list of product links.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sku", - "description": "The identifier of the linked product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "description": "Contains information about linked products, including the link type and product type of each item.", - "fields": [ - { - "name": "link_type", - "description": "One of related, associated, upsell, or crosssell.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "linked_product_sku", - "description": "The SKU of the linked product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "linked_product_type", - "description": "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "position", - "description": "The position within the list of product links.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sku", - "description": "The identifier of the linked product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "ProductLinks", - "ofType": null - } - ] - }, - { - "kind": "INTERFACE", - "name": "ProductInterface", - "description": "Contains fields that are common to all types of products.", - "fields": [ - { - "name": "activity", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "categories", - "description": "The categories assigned to a product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_gear", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "climate", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "collar", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "color", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "country_of_manufacture", - "description": "The product's country of origin.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "crosssell_products", - "description": "An array of cross-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gender", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gift_message_available", - "description": "Returns a value indicating gift message availability for the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_wrapping_available", - "description": "Returns a value indicating gift wrapping availability for the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_wrapping_price", - "description": "Returns value and currency indicating gift wrapping price for the product.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The ID number assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." - }, - { - "name": "image", - "description": "The relative path to the main image on the product page.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", "args": [], "type": { "kind": "SCALAR", @@ -14454,6 +13732,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "rules", + "description": "Provides applied catalog rules in the current active cart", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CatalogRule", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "sale", "description": null, @@ -14836,12 +14130,12 @@ }, { "kind": "OBJECT", - "name": "DownloadableProduct", + "name": "BundleProduct", "ofType": null }, { "kind": "OBJECT", - "name": "BundleProduct", + "name": "DownloadableProduct", "ofType": null }, { @@ -14857,110 +14151,124 @@ ] }, { - "kind": "INTERFACE", - "name": "PhysicalProductInterface", - "description": "Contains attributes specific to tangible products.", - "fields": [ + "kind": "ENUM", + "name": "ProductStockStatus", + "description": "This enumeration states whether a product stock status is in stock or out of stock", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, + "name": "IN_STOCK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OUT_OF_STOCK", + "description": "", "isDeprecated": false, "deprecationReason": null } ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "CartItemInterface", + "description": "An interface for products in a cart.", + "fields": [ { - "kind": "OBJECT", - "name": "SimpleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleProduct", - "ofType": null + "name": "discount", + "description": "Contains discount for quote line item.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "OBJECT", - "name": "GiftCardProduct", - "ofType": null + "name": "errors", + "description": "An array of errors encountered while loading the cart item", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartItemError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "OBJECT", - "name": "GroupedProduct", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "CustomizableAreaOption", - "description": "Contains information about a text area that is defined as part of a customizable option.", - "fields": [ - { - "name": "option_id", - "description": "Option ID.", + "name": "id", + "description": null, "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": true, - "deprecationReason": "Use `uid` instead" + "deprecationReason": "Use `uid` instead." }, { - "name": "product_sku", - "description": "The Stock Keeping Unit of the base product.", + "name": "is_available", + "description": "True if requested quantity is less than available stock, false otherwise.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "required", - "description": "Indicates whether the option is required.", + "name": "max_qty", + "description": "Line item max qty in quote template", "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the option is displayed.", + "name": "min_qty", + "description": "Line item min qty in quote template", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "not_available_message", + "description": "Message to display when the product is not available with this selected option.", "args": [], "type": { "kind": "SCALAR", @@ -14971,15 +14279,15 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", + "name": "note_from_buyer", + "description": "The buyer's quote line item note.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "OBJECT", + "name": "ItemNote", "ofType": null } }, @@ -14987,85 +14295,68 @@ "deprecationReason": null }, { - "name": "value", - "description": "An object that defines a text area.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomizableAreaValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableAreaValue", - "description": "Defines the price and sku of a product whose page contains a customized text area.", - "fields": [ - { - "name": "max_characters", - "description": "The maximum number of characters that can be entered for this customizable option.", + "name": "note_from_seller", + "description": "The seller's quote line item note.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price", - "description": "The price assigned to this option.", + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "OBJECT", + "name": "CartItemPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", + "name": "product", + "description": "Details about an item in the cart.", "args": [], "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", + "name": "quantity", + "description": "The quantity of this item in the cart.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", - "description": "The unique ID for a `CustomizableAreaValue` object.", + "description": "The unique ID for a `CartItemInterface` object.", "args": [], "type": { "kind": "NON_NULL", @@ -15083,31 +14374,50 @@ "inputFields": null, "interfaces": [], "enumValues": null, - "possibleTypes": null + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SimpleCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VirtualCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DownloadableCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardCartItem", + "ofType": null + } + ] }, { "kind": "OBJECT", - "name": "CategoryTree", - "description": "Contains the hierarchy of categories.", + "name": "CatalogRule", + "description": "", "fields": [ { - "name": "automatic_sorting", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "available_sort_by", - "description": null, + "name": "name", + "description": "Name of the catalog rule", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", @@ -15117,282 +14427,409 @@ }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Price", + "description": "Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments.", + "fields": [ { - "name": "breadcrumbs", - "description": "An array of breadcrumb items.", + "name": "adjustments", + "description": "An array that provides information about tax, weee, or weee_tax adjustments.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "Breadcrumb", + "name": "PriceAdjustment", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `ProductPrice` instead." }, { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.", + "name": "amount", + "description": "The price of a product plus a three-letter currency code.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "Money", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - }, + "isDeprecated": true, + "deprecationReason": "Use `ProductPrice` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceAdjustment", + "description": "Deprecated. Taxes will be included or excluded in the price. Defines the amount of money to apply as an adjustment, the type of adjustment to apply, and whether the item is included or excluded from the adjustment.", + "fields": [ { - "name": "children", - "description": "A tree of child categories.", + "name": "amount", + "description": "The amount of the price adjustment and its currency code.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CategoryTree", - "ofType": null - } + "kind": "OBJECT", + "name": "Money", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "children_count", - "description": null, + "name": "code", + "description": "Indicates whether the adjustment involves tax, weee, or weee_tax.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "ENUM", + "name": "PriceAdjustmentCodesEnum", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "`PriceAdjustment` is deprecated." }, { - "name": "cms_block", - "description": "Contains a category CMS block.", + "name": "description", + "description": "Indicates whether the entity described by the code attribute is included or excluded from the adjustment.", "args": [], "type": { - "kind": "OBJECT", - "name": "CmsBlock", + "kind": "ENUM", + "name": "PriceAdjustmentDescriptionEnum", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "`PriceAdjustment` is deprecated." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceAdjustmentCodesEnum", + "description": "`PriceAdjustment.code` is deprecated.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TAX", + "description": "", + "isDeprecated": true, + "deprecationReason": "`PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog." }, { - "name": "created_at", - "description": "The timestamp indicating when the category was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "WEEE", + "description": "", "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "deprecationReason": "WEEE code is deprecated. Use `fixed_product_taxes.label` instead." }, { - "name": "custom_layout_update_file", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "WEEE_TAX", + "description": "", + "isDeprecated": true, + "deprecationReason": "Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog." + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceAdjustmentDescriptionEnum", + "description": "`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INCLUDED", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "default_sort_by", - "description": "The attribute to use for sorting.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "EXCLUDED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceTypeEnum", + "description": "Defines the price type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FIXED", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "description", - "description": "An optional description of the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "PERCENT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "display_mode", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "DYNAMIC", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomizableDateTypeEnum", + "description": "Defines the customizable date type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DATE", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "filter_price_range", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, + "name": "DATE_TIME", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "An ID that uniquely identifies the category.", + "name": "TIME", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductPrices", + "description": "Deprecated. Use `PriceRange` instead. Contains the regular price of an item, as well as its minimum and maximum prices. Only composite products, which include bundle, configurable, and grouped products, can contain a minimum and maximum price.", + "fields": [ + { + "name": "maximalPrice", + "description": "The highest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the `to` value.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "Price", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `uid` instead." + "deprecationReason": "Use `PriceRange.maximum_price` instead." }, { - "name": "image", - "description": null, + "name": "minimalPrice", + "description": "The lowest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the `from` value.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "Price", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `PriceRange.minimum_price` instead." }, { - "name": "include_in_menu", - "description": null, + "name": "regularPrice", + "description": "The base price of a product.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "Price", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - }, + "isDeprecated": true, + "deprecationReason": "Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRange", + "description": "Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same.", + "fields": [ { - "name": "is_anchor", - "description": null, + "name": "maximum_price", + "description": "The highest possible price for the product.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "ProductPrice", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "landing_page", - "description": null, + "name": "minimum_price", + "description": "The lowest possible price for the product.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPrice", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductPrice", + "description": "Represents a product price.", + "fields": [ { - "name": "level", - "description": "The depth of the category within the tree.", + "name": "discount", + "description": "The price discount. Represents the difference between the regular and final price.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "ProductDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "meta_description", - "description": null, + "name": "final_price", + "description": "The final price of the product after applying discounts.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "meta_keywords", - "description": null, + "name": "fixed_product_taxes", + "description": "An array of the multiple Fixed Product Taxes that can be applied to a product price.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FixedProductTax", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "meta_title", - "description": null, + "name": "regular_price", + "description": "The regular price of the product.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductDiscount", + "description": "Contains the discount applied to a product price.", + "fields": [ { - "name": "name", - "description": "The display name of the category.", + "name": "amount_off", + "description": "The actual value of the discount.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "path", - "description": "The full category path.", + "name": "percent_off", + "description": "The discount expressed a percentage.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductLinks", + "description": "An implementation of `ProductLinksInterface`.", + "fields": [ { - "name": "path_in_store", - "description": "The category path within the store.", + "name": "link_type", + "description": "One of related, associated, upsell, or crosssell.", "args": [], "type": { "kind": "SCALAR", @@ -15403,91 +14840,44 @@ "deprecationReason": null }, { - "name": "position", - "description": "The position of the category relative to other categories at the same level in tree.", + "name": "linked_product_sku", + "description": "The SKU of the linked product.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "product_count", - "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", + "name": "linked_product_type", + "description": "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).", "args": [], "type": { "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "products", - "description": "The list of products assigned to the category.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "sort", - "description": "The attributes to sort on, and whether to return the results in ascending or descending order.", - "type": { - "kind": "INPUT_OBJECT", - "name": "ProductAttributeSortInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CategoryProducts", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "name": "position", + "description": "The position within the list of product links.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "name": "sku", + "description": "The identifier of the linked product.", "args": [], "type": { "kind": "SCALAR", @@ -15496,66 +14886,51 @@ }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [ { - "name": "staged", - "description": "Indicates whether the category is staged for a future campaign.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "description": "Contains information about linked products, including the link type and product type of each item.", + "fields": [ { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "name": "link_type", + "description": "One of related, associated, upsell, or crosssell.", "args": [], "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CategoryInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "The timestamp indicating when the category was updated.", + "name": "linked_product_sku", + "description": "The SKU of the linked product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "url_key", - "description": "The URL key assigned to the category.", + "name": "linked_product_type", + "description": "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).", "args": [], "type": { "kind": "SCALAR", @@ -15566,20 +14941,20 @@ "deprecationReason": null }, { - "name": "url_path", - "description": "The URL path assigned to the category.", + "name": "position", + "description": "The position within the list of product links.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "url_suffix", - "description": "The part of the category URL that is appended after the url key", + "name": "sku", + "description": "The identifier of the linked product.", "args": [], "type": { "kind": "SCALAR", @@ -15591,61 +14966,28 @@ } ], "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CategoryInterface", - "ofType": null - }, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ { - "kind": "INTERFACE", - "name": "RoutableInterface", + "kind": "OBJECT", + "name": "ProductLinks", "ofType": null } - ], - "enumValues": null, - "possibleTypes": null + ] }, { - "kind": "OBJECT", - "name": "CategoryResult", - "description": "Contains a collection of `CategoryTree` objects and pagination information.", + "kind": "INTERFACE", + "name": "PhysicalProductInterface", + "description": "Contains attributes specific to tangible products.", "fields": [ { - "name": "items", - "description": "A list of categories that match the filter criteria.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CategoryTree", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "An object that includes the `page_info` and `currentPage` values specified in the query.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The total number of categories that match the criteria.", + "name": "weight", + "description": "The weight of the item, in units defined by the store.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, "isDeprecated": false, @@ -15655,12 +14997,38 @@ "inputFields": null, "interfaces": [], "enumValues": null, - "possibleTypes": null + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SimpleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GroupedProduct", + "ofType": null + } + ] }, { "kind": "OBJECT", - "name": "CustomizableDateOption", - "description": "Contains information about a date picker that is defined as part of a customizable option.", + "name": "CustomizableAreaOption", + "description": "Contains information about a text area that is defined as part of a customizable option.", "fields": [ { "name": "option_id", @@ -15740,11 +15108,11 @@ }, { "name": "value", - "description": "An object that defines a date field in a customizable option.", + "description": "An object that defines a text area.", "args": [], "type": { "kind": "OBJECT", - "name": "CustomizableDateValue", + "name": "CustomizableAreaValue", "ofType": null }, "isDeprecated": false, @@ -15764,9 +15132,21 @@ }, { "kind": "OBJECT", - "name": "CustomizableDateValue", - "description": "Defines the price and sku of a product whose page contains a customized date picker.", + "name": "CustomizableAreaValue", + "description": "Defines the price and sku of a product whose page contains a customized text area.", "fields": [ + { + "name": "max_characters", + "description": "The maximum number of characters that can be entered for this customizable option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "price", "description": "The price assigned to this option.", @@ -15803,21 +15183,9 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "type", - "description": "DATE, DATE_TIME or TIME", - "args": [], - "type": { - "kind": "ENUM", - "name": "CustomizableDateTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "uid", - "description": "The unique ID for a `CustomizableDateValue` object.", + "description": "The unique ID for a `CustomizableAreaValue` object.", "args": [], "type": { "kind": "NON_NULL", @@ -15839,48 +15207,56 @@ }, { "kind": "OBJECT", - "name": "CustomizableDropDownOption", - "description": "Contains information about a drop down menu that is defined as part of a customizable option.", + "name": "CategoryTree", + "description": "Contains the hierarchy of categories.", "fields": [ { - "name": "option_id", - "description": "Option ID.", + "name": "automatic_sorting", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" + "isDeprecated": false, + "deprecationReason": null }, { - "name": "required", - "description": "Indicates whether the option is required.", + "name": "available_sort_by", + "description": null, "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the option is displayed.", + "name": "breadcrumbs", + "description": "An array of breadcrumb items.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Breadcrumb", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.", "args": [], "type": { "kind": "SCALAR", @@ -15891,93 +15267,72 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "An array that defines the set of options for a drop down menu.", + "name": "children", + "description": "A tree of child categories.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "CustomizableDropDownValue", + "name": "CategoryTree", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableDropDownValue", - "description": "Defines the price and sku of a product whose page contains a customized drop down menu.", - "fields": [ + }, { - "name": "option_type_id", - "description": "The ID assigned to the value.", + "name": "children_count", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price", - "description": "The price assigned to this option.", - "args": [], + "name": "cms_block", + "description": "Contains a category CMS block.", + "args": [], "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "OBJECT", + "name": "CmsBlock", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", + "name": "created_at", + "description": "The timestamp indicating when the category was created.", "args": [], "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "custom_layout_update_file", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", + "name": "default_sort_by", + "description": "The attribute to use for sorting.", "args": [], "type": { "kind": "SCALAR", @@ -15988,20 +15343,20 @@ "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the option is displayed.", + "name": "description", + "description": "An optional description of the category.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "display_mode", + "description": null, "args": [], "type": { "kind": "SCALAR", @@ -16012,35 +15367,20 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableDropDownValue` object.", + "name": "filter_price_range", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableMultipleOption", - "description": "Contains information about a multiselect that is defined as part of a customizable option.", - "fields": [ + }, { - "name": "option_id", - "description": "Option ID.", + "name": "id", + "description": "An ID that uniquely identifies the category.", "args": [], "type": { "kind": "SCALAR", @@ -16048,23 +15388,23 @@ "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `uid` instead" + "deprecationReason": "Use `uid` instead." }, { - "name": "required", - "description": "Indicates whether the option is required.", + "name": "image", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the option is displayed.", + "name": "include_in_menu", + "description": null, "args": [], "type": { "kind": "SCALAR", @@ -16075,105 +15415,92 @@ "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "is_anchor", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", + "name": "landing_page", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "value", - "description": "An array that defines the set of options for a multiselect.", + "name": "level", + "description": "The depth of the category within the tree.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomizableMultipleValue", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ + }, { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableMultipleValue", - "description": "Defines the price and sku of a product whose page contains a customized multiselect.", - "fields": [ + "name": "meta_description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "option_type_id", - "description": "The ID assigned to the value.", + "name": "meta_keywords", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price", - "description": "The price assigned to this option.", + "name": "meta_title", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", + "name": "name", + "description": "The display name of the category.", "args": [], "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", + "name": "path", + "description": "The full category path.", "args": [], "type": { "kind": "SCALAR", @@ -16184,8 +15511,20 @@ "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the option is displayed.", + "name": "path_in_store", + "description": "The category path within the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The position of the category relative to other categories at the same level in tree.", "args": [], "type": { "kind": "SCALAR", @@ -16196,8 +15535,79 @@ "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "product_count", + "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "The list of products assigned to the category.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "sort", + "description": "The attributes to sort on, and whether to return the results in ascending or descending order.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ProductAttributeSortInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CategoryProducts", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", "args": [], "type": { "kind": "SCALAR", @@ -16207,9 +15617,37 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "staged", + "description": "Indicates whether the category is staged for a future campaign.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "uid", - "description": "The unique ID for a `CustomizableMultipleValue` object.", + "description": "The unique ID for a `CategoryInterface` object.", "args": [], "type": { "kind": "NON_NULL", @@ -16222,6 +15660,116 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "updated_at", + "description": "The timestamp indicating when the category was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "url_key", + "description": "The URL key assigned to the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_path", + "description": "The URL path assigned to the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_suffix", + "description": "The part of the category URL that is appended after the url key", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CategoryResult", + "description": "Contains a collection of `CategoryTree` objects and pagination information.", + "fields": [ + { + "name": "items", + "description": "A list of categories that match the filter criteria.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryTree", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "An object that includes the `page_info` and `currentPage` values specified in the query.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The total number of categories that match the criteria.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -16231,8 +15779,8 @@ }, { "kind": "OBJECT", - "name": "CustomizableFieldOption", - "description": "Contains information about a text field that is defined as part of a customizable option.", + "name": "CustomizableDateOption", + "description": "Contains information about a date picker that is defined as part of a customizable option.", "fields": [ { "name": "option_id", @@ -16312,11 +15860,11 @@ }, { "name": "value", - "description": "An object that defines a text field.", + "description": "An object that defines a date field in a customizable option.", "args": [], "type": { "kind": "OBJECT", - "name": "CustomizableFieldValue", + "name": "CustomizableDateValue", "ofType": null }, "isDeprecated": false, @@ -16336,24 +15884,12 @@ }, { "kind": "OBJECT", - "name": "CustomizableFieldValue", - "description": "Defines the price and sku of a product whose page contains a customized text field.", + "name": "CustomizableDateValue", + "description": "Defines the price and sku of a product whose page contains a customized date picker.", "fields": [ - { - "name": "max_characters", - "description": "The maximum number of characters that can be entered for this customizable option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "price", - "description": "The price of the custom value.", + "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", @@ -16387,9 +15923,21 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "type", + "description": "DATE, DATE_TIME or TIME", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomizableDateTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "uid", - "description": "The unique ID for a `CustomizableFieldValue` object.", + "description": "The unique ID for a `CustomizableDateValue` object.", "args": [], "type": { "kind": "NON_NULL", @@ -16411,8 +15959,8 @@ }, { "kind": "OBJECT", - "name": "CustomizableFileOption", - "description": "Contains information about a file picker that is defined as part of a customizable option.", + "name": "CustomizableDropDownOption", + "description": "Contains information about a drop down menu that is defined as part of a customizable option.", "fields": [ { "name": "option_id", @@ -16426,18 +15974,6 @@ "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, - { - "name": "product_sku", - "description": "The Stock Keeping Unit of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "required", "description": "Indicates whether the option is required.", @@ -16492,12 +16028,16 @@ }, { "name": "value", - "description": "An object that defines a file value.", + "description": "An array that defines the set of options for a drop down menu.", "args": [], "type": { - "kind": "OBJECT", - "name": "CustomizableFileValue", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomizableDropDownValue", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null @@ -16516,72 +16056,72 @@ }, { "kind": "OBJECT", - "name": "CustomizableFileValue", - "description": "Defines the price and sku of a product whose page contains a customized file picker.", + "name": "CustomizableDropDownValue", + "description": "Defines the price and sku of a product whose page contains a customized drop down menu.", "fields": [ { - "name": "file_extension", - "description": "The file extension to accept.", + "name": "option_type_id", + "description": "The ID assigned to the value.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "image_size_x", - "description": "The maximum width of an image.", + "name": "price", + "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "image_size_y", - "description": "The maximum height of an image.", + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "ENUM", + "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price", - "description": "The price assigned to this option.", + "name": "sku", + "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", + "name": "sort_order", + "description": "The order in which the option is displayed.", "args": [], "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", @@ -16593,7 +16133,7 @@ }, { "name": "uid", - "description": "The unique ID for a `CustomizableFileValue` object.", + "description": "The unique ID for a `CustomizableDropDownValue` object.", "args": [], "type": { "kind": "NON_NULL", @@ -16614,13 +16154,25 @@ "possibleTypes": null }, { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "description": "Contains basic information about a product image or video.", + "kind": "OBJECT", + "name": "CustomizableMultipleOption", + "description": "Contains information about a multiselect that is defined as part of a customizable option.", "fields": [ { - "name": "disabled", - "description": "Indicates whether the image is hidden from view.", + "name": "option_id", + "description": "Option ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "required", + "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", @@ -16631,39 +16183,39 @@ "deprecationReason": null }, { - "name": "label", - "description": "The label of the product image or video.", + "name": "sort_order", + "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "position", - "description": "The media item's position after it has been sorted.", + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "types", - "description": "Array of image types. It can have the following values: image, small_image, thumbnail.", + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -16671,94 +16223,77 @@ "deprecationReason": null }, { - "name": "url", - "description": "The URL of the product image or video.", + "name": "value", + "description": "An array that defines the set of options for a multiselect.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomizableMultipleValue", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, + "interfaces": [ { - "kind": "OBJECT", - "name": "ProductVideo", + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", "ofType": null } - ] + ], + "enumValues": null, + "possibleTypes": null }, { "kind": "OBJECT", - "name": "ProductImage", - "description": "Contains product image information, including the image URL and label.", + "name": "CustomizableMultipleValue", + "description": "Defines the price and sku of a product whose page contains a customized multiselect.", "fields": [ { - "name": "disabled", - "description": "Indicates whether the image is hidden from view.", + "name": "option_type_id", + "description": "The ID assigned to the value.", "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "label", - "description": "The label of the product image or video.", + "name": "price", + "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "position", - "description": "The media item's position after it has been sorted.", + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "ENUM", + "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "types", - "description": "Array of image types. It can have the following values: image, small_image, thumbnail.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url", - "description": "The URL of the product image or video.", + "name": "sku", + "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", @@ -16767,116 +16302,57 @@ }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductVideo", - "description": "Contains information about a product video.", - "fields": [ - { - "name": "disabled", - "description": "Indicates whether the image is hidden from view.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null }, { - "name": "label", - "description": "The label of the product image or video.", + "name": "sort_order", + "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "position", - "description": "The media item's position after it has been sorted.", + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "types", - "description": "Array of image types. It can have the following values: image, small_image, thumbnail.", + "name": "uid", + "description": "The unique ID for a `CustomizableMultipleValue` object.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, - { - "name": "url", - "description": "The URL of the product image or video.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "video_content", - "description": "Contains a `ProductMediaGalleryEntriesVideoContent` object.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductMediaGalleryEntriesVideoContent", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null } ], "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } - ], + "interfaces": [], "enumValues": null, "possibleTypes": null }, { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "description": "Contains basic information about a customizable option. It can be implemented by several types of configurable options.", + "kind": "OBJECT", + "name": "CustomizableFieldOption", + "description": "Contains information about a text field that is defined as part of a customizable option.", "fields": [ { "name": "option_id", @@ -16890,6 +16366,18 @@ "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, + { + "name": "product_sku", + "description": "The Stock Keeping Unit of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "required", "description": "Indicates whether the option is required.", @@ -16941,176 +16429,75 @@ }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "CustomizableAreaOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableDateOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableDropDownOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableMultipleOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableFieldOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableFileOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableRadioOption", - "ofType": null }, { - "kind": "OBJECT", - "name": "CustomizableCheckboxOption", - "ofType": null - } - ] - }, - { - "kind": "INTERFACE", - "name": "CustomizableProductInterface", - "description": "Contains information about customizable product options.", - "fields": [ - { - "name": "options", - "description": "An array of options for a customizable product.", + "name": "value", + "description": "An object that defines a text field.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } + "kind": "OBJECT", + "name": "CustomizableFieldValue", + "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "VirtualProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "SimpleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "DownloadableProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleProduct", - "ofType": null - }, + "interfaces": [ { - "kind": "OBJECT", - "name": "GiftCardProduct", + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", "ofType": null } - ] + ], + "enumValues": null, + "possibleTypes": null }, { - "kind": "INTERFACE", - "name": "CategoryInterface", - "description": "Contains the full set of attributes that can be returned in a category search.", + "kind": "OBJECT", + "name": "CustomizableFieldValue", + "description": "Defines the price and sku of a product whose page contains a customized text field.", "fields": [ { - "name": "automatic_sorting", - "description": null, + "name": "max_characters", + "description": "The maximum number of characters that can be entered for this customizable option.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "available_sort_by", - "description": null, - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "breadcrumbs", - "description": "An array of breadcrumb items.", + "name": "price", + "description": "The price of the custom value.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Breadcrumb", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.", + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "ENUM", + "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "children_count", - "description": null, + "name": "sku", + "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", @@ -17121,32 +16508,47 @@ "deprecationReason": null }, { - "name": "cms_block", - "description": "Contains a category CMS block.", + "name": "uid", + "description": "The unique ID for a `CustomizableFieldValue` object.", "args": [], "type": { - "kind": "OBJECT", - "name": "CmsBlock", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableFileOption", + "description": "Contains information about a file picker that is defined as part of a customizable option.", + "fields": [ { - "name": "created_at", - "description": "The timestamp indicating when the category was created.", + "name": "option_id", + "description": "Option ID.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "deprecationReason": "Use `uid` instead" }, { - "name": "custom_layout_update_file", - "description": null, + "name": "product_sku", + "description": "The Stock Keeping Unit of the base product.", "args": [], "type": { "kind": "SCALAR", @@ -17157,32 +16559,32 @@ "deprecationReason": null }, { - "name": "default_sort_by", - "description": "The attribute to use for sorting.", + "name": "required", + "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "description", - "description": "An optional description of the category.", + "name": "sort_order", + "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "display_mode", - "description": null, + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", @@ -17193,32 +16595,53 @@ "deprecationReason": null }, { - "name": "filter_price_range", - "description": null, + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "An ID that uniquely identifies the category.", + "name": "value", + "description": "An object that defines a file value.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "CustomizableFileValue", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ { - "name": "image", - "description": null, + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableFileValue", + "description": "Defines the price and sku of a product whose page contains a customized file picker.", + "fields": [ + { + "name": "file_extension", + "description": "The file extension to accept.", "args": [], "type": { "kind": "SCALAR", @@ -17229,8 +16652,8 @@ "deprecationReason": null }, { - "name": "include_in_menu", - "description": null, + "name": "image_size_x", + "description": "The maximum width of an image.", "args": [], "type": { "kind": "SCALAR", @@ -17241,8 +16664,8 @@ "deprecationReason": null }, { - "name": "is_anchor", - "description": null, + "name": "image_size_y", + "description": "The maximum height of an image.", "args": [], "type": { "kind": "SCALAR", @@ -17253,32 +16676,32 @@ "deprecationReason": null }, { - "name": "landing_page", - "description": null, + "name": "price", + "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "level", - "description": "The depth of the category within the tree.", + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "ENUM", + "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "meta_description", - "description": null, + "name": "sku", + "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", @@ -17289,56 +16712,47 @@ "deprecationReason": null }, { - "name": "meta_keywords", - "description": null, + "name": "uid", + "description": "The unique ID for a `CustomizableFileValue` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_title", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The display name of the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "description": "Contains basic information about a product image or video.", + "fields": [ { - "name": "path", - "description": "The full category path.", + "name": "disabled", + "description": "Indicates whether the image is hidden from view.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "path_in_store", - "description": "The category path within the store.", + "name": "label", + "description": "The label of the product image or video.", "args": [], "type": { "kind": "SCALAR", @@ -17350,7 +16764,7 @@ }, { "name": "position", - "description": "The position of the category relative to other categories at the same level in tree.", + "description": "The media item's position after it has been sorted.", "args": [], "type": { "kind": "SCALAR", @@ -17361,107 +16775,54 @@ "deprecationReason": null }, { - "name": "product_count", - "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", + "name": "url", + "description": "The URL of the product image or video.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "products", - "description": "The list of products assigned to the category.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "sort", - "description": "The attributes to sort on, and whether to return the results in ascending or descending order.", - "type": { - "kind": "INPUT_OBJECT", - "name": "ProductAttributeSortInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CategoryProducts", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ { - "name": "staged", - "description": "Indicates whether the category is staged for a future campaign.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null }, { - "name": "uid", - "description": "The unique ID for a `CategoryInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, + "kind": "OBJECT", + "name": "ProductVideo", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "ProductImage", + "description": "Contains product image information, including the image URL and label.", + "fields": [ { - "name": "updated_at", - "description": "The timestamp indicating when the category was updated.", + "name": "disabled", + "description": "Indicates whether the image is hidden from view.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Boolean", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "url_key", - "description": "The URL key assigned to the category.", + "name": "label", + "description": "The label of the product image or video.", "args": [], "type": { "kind": "SCALAR", @@ -17472,20 +16833,20 @@ "deprecationReason": null }, { - "name": "url_path", - "description": "The URL path assigned to the category.", + "name": "position", + "description": "The media item's position after it has been sorted.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "url_suffix", - "description": "The part of the category URL that is appended after the url key", + "name": "url", + "description": "The URL of the product image or video.", "args": [], "type": { "kind": "SCALAR", @@ -17497,48 +16858,36 @@ } ], "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ + "interfaces": [ { - "kind": "OBJECT", - "name": "CategoryTree", + "kind": "INTERFACE", + "name": "MediaGalleryInterface", "ofType": null } - ] + ], + "enumValues": null, + "possibleTypes": null }, { "kind": "OBJECT", - "name": "Breadcrumb", - "description": "Contains details about an individual category that comprises a breadcrumb.", + "name": "ProductVideo", + "description": "Contains information about a product video.", "fields": [ { - "name": "category_id", - "description": "The ID of the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `category_uid` instead." - }, - { - "name": "category_level", - "description": "The category level.", + "name": "disabled", + "description": "Indicates whether the image is hidden from view.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "category_name", - "description": "The display name of the category.", + "name": "label", + "description": "The label of the product image or video.", "args": [], "type": { "kind": "SCALAR", @@ -17549,24 +16898,20 @@ "deprecationReason": null }, { - "name": "category_uid", - "description": "The unique ID for a `Breadcrumb` object.", + "name": "position", + "description": "The media item's position after it has been sorted.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "category_url_key", - "description": "The URL key of the category.", + "name": "url", + "description": "The URL of the product image or video.", "args": [], "type": { "kind": "SCALAR", @@ -17577,12 +16922,12 @@ "deprecationReason": null }, { - "name": "category_url_path", - "description": "The URL path of the category.", + "name": "video_content", + "description": "Contains a `ProductMediaGalleryEntriesVideoContent` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "ProductMediaGalleryEntriesVideoContent", "ofType": null }, "isDeprecated": false, @@ -17590,14 +16935,20 @@ } ], "inputFields": null, - "interfaces": [], + "interfaces": [ + { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } + ], "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "CustomizableRadioOption", - "description": "Contains information about a set of radio buttons that are defined as part of a customizable option.", + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "description": "Contains basic information about a customizable option. It can be implemented by several types of configurable options.", "fields": [ { "name": "option_id", @@ -17662,17 +17013,69 @@ }, "isDeprecated": false, "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CustomizableAreaOption", + "ofType": null }, { - "name": "value", - "description": "An array that defines a set of radio buttons.", + "kind": "OBJECT", + "name": "CustomizableDateOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableDropDownOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableMultipleOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableFieldOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableFileOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableRadioOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableCheckboxOption", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "CustomizableProductInterface", + "description": "Contains information about customizable product options.", + "fields": [ + { + "name": "options", + "description": "An array of options for a customizable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "CustomizableRadioValue", + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", "ofType": null } }, @@ -17681,60 +17084,93 @@ } ], "inputFields": null, - "interfaces": [ + "interfaces": [], + "enumValues": null, + "possibleTypes": [ { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", + "kind": "OBJECT", + "name": "VirtualProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SimpleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DownloadableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardProduct", "ofType": null } - ], - "enumValues": null, - "possibleTypes": null + ] }, { - "kind": "OBJECT", - "name": "CustomizableRadioValue", - "description": "Defines the price and sku of a product whose page contains a customized set of radio buttons.", + "kind": "INTERFACE", + "name": "CategoryInterface", + "description": "Contains the full set of attributes that can be returned in a category search.", "fields": [ { - "name": "option_type_id", - "description": "The ID assigned to the value.", + "name": "automatic_sorting", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price", - "description": "The price assigned to this option.", + "name": "available_sort_by", + "description": null, "args": [], "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", + "name": "breadcrumbs", + "description": "An array of breadcrumb items.", "args": [], "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Breadcrumb", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.", "args": [], "type": { "kind": "SCALAR", @@ -17745,95 +17181,80 @@ "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the radio button is displayed.", + "name": "children_count", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "cms_block", + "description": "Contains a category CMS block.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "CmsBlock", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableRadioValue` object.", + "name": "created_at", + "description": "The timestamp indicating when the category was created.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableCheckboxOption", - "description": "Contains information about a set of checkbox values that are defined as part of a customizable option.", - "fields": [ + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, { - "name": "option_id", - "description": "Option ID.", + "name": "custom_layout_update_file", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" + "isDeprecated": false, + "deprecationReason": null }, { - "name": "required", - "description": "Indicates whether the option is required.", + "name": "default_sort_by", + "description": "The attribute to use for sorting.", "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the option is displayed.", + "name": "description", + "description": "An optional description of the category.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "display_mode", + "description": null, "args": [], "type": { "kind": "SCALAR", @@ -17844,57 +17265,56 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", + "name": "filter_price_range", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "value", - "description": "An array that defines a set of checkbox values.", + "name": "id", + "description": "An ID that uniquely identifies the category.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomizableCheckboxValue", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "image", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ + }, { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableCheckboxValue", - "description": "Defines the price and sku of a product whose page contains a customized set of checkbox values.", - "fields": [ + "name": "include_in_menu", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "option_type_id", - "description": "The ID assigned to the value.", + "name": "is_anchor", + "description": null, "args": [], "type": { "kind": "SCALAR", @@ -17905,32 +17325,32 @@ "deprecationReason": null }, { - "name": "price", - "description": "The price assigned to this option.", + "name": "landing_page", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", + "name": "level", + "description": "The depth of the category within the tree.", "args": [], "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", + "name": "meta_description", + "description": null, "args": [], "type": { "kind": "SCALAR", @@ -17941,20 +17361,20 @@ "deprecationReason": null }, { - "name": "sort_order", - "description": "The order in which the checkbox value is displayed.", + "name": "meta_keywords", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name for this option.", + "name": "meta_title", + "description": null, "args": [], "type": { "kind": "SCALAR", @@ -17965,78 +17385,118 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CustomizableCheckboxValue` object.", + "name": "name", + "description": "The display name of the category.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "VirtualProduct", - "description": "Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory.", - "fields": [ + }, { - "name": "activity", - "description": null, + "name": "path", + "description": "The full category path.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", + "name": "path_in_store", + "description": "The category path within the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The position of the category relative to other categories at the same level in tree.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "name": "product_count", + "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "categories", - "description": "The categories assigned to a product.", + "name": "products", + "description": "The list of products assigned to the category.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "sort", + "description": "The attributes to sort on, and whether to return the results in ascending or descending order.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ProductAttributeSortInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CategoryProducts", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staged", + "description": "Indicates whether the category is staged for a future campaign.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", + "kind": "SCALAR", + "name": "Boolean", "ofType": null } }, @@ -18044,8 +17504,24 @@ "deprecationReason": null }, { - "name": "category_gear", - "description": null, + "name": "uid", + "description": "The unique ID for a `CategoryInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "The timestamp indicating when the category was updated.", "args": [], "type": { "kind": "SCALAR", @@ -18053,35 +17529,64 @@ "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "climate", - "description": null, + "name": "url_key", + "description": "The URL key assigned to the category.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "collar", - "description": null, + "name": "url_path", + "description": "The URL path assigned to the category.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "color", - "description": null, + "name": "url_suffix", + "description": "The part of the category URL that is appended after the url key", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CategoryTree", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "Breadcrumb", + "description": "Contains details about an individual category that comprises a breadcrumb.", + "fields": [ + { + "name": "category_id", + "description": "The ID of the category.", "args": [], "type": { "kind": "SCALAR", @@ -18089,42 +17594,42 @@ "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "Use `category_uid` instead." }, { - "name": "country_of_manufacture", - "description": "The product's country of origin.", + "name": "category_level", + "description": "The category level.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", + "name": "category_name", + "description": "The display name of the category.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "crosssell_products", - "description": "An array of cross-sell products.", + "name": "category_uid", + "description": "The unique ID for a `Breadcrumb` object.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, @@ -18132,55 +17637,43 @@ "deprecationReason": null }, { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", + "name": "category_url_key", + "description": "The URL key of the category.", "args": [], "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "eco_collection", - "description": null, + "name": "category_url_path", + "description": "The URL path of the category.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableRadioOption", + "description": "Contains information about a set of radio buttons that are defined as part of a customizable option.", + "fields": [ { - "name": "erin_recommends", - "description": null, + "name": "option_id", + "description": "Option ID.", "args": [], "type": { "kind": "SCALAR", @@ -18188,54 +17681,54 @@ "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "Use `uid` instead" }, { - "name": "features_bags", - "description": null, + "name": "required", + "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Boolean", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "format", - "description": null, + "name": "sort_order", + "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "gender", - "description": null, + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "gift_message_available", - "description": "Returns a value indicating gift message availability for the product.", + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Boolean", + "name": "ID", "ofType": null } }, @@ -18243,60 +17736,77 @@ "deprecationReason": null }, { - "name": "gift_wrapping_available", - "description": "Returns a value indicating gift wrapping availability for the product.", + "name": "value", + "description": "An array that defines a set of radio buttons.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Boolean", + "kind": "OBJECT", + "name": "CustomizableRadioValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [ { - "name": "gift_wrapping_price", - "description": "Returns value and currency indicating gift wrapping price for the product.", + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableRadioValue", + "description": "Defines the price and sku of a product whose page contains a customized set of radio buttons.", + "fields": [ + { + "name": "option_type_id", + "description": "The ID assigned to the value.", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The ID number assigned to the product.", + "name": "price", + "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "image", - "description": "The relative path to the main image on the product page.", + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { - "kind": "OBJECT", - "name": "ProductImage", + "kind": "ENUM", + "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", + "name": "sku", + "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", @@ -18307,100 +17817,95 @@ "deprecationReason": null }, { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", + "name": "sort_order", + "description": "The order in which the radio button is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "material", - "description": null, + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "max_sale_qty", - "description": "Maximum Qty Allowed in Shopping Cart", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, "isDeprecated": false, "deprecationReason": null }, { - "name": "media_gallery", - "description": "An array of media gallery objects.", + "name": "uid", + "description": "The unique ID for a `CustomizableRadioValue` object.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableCheckboxOption", + "description": "Contains information about a set of checkbox values that are defined as part of a customizable option.", + "fields": [ { - "name": "media_gallery_entries", - "description": "An array of MediaGalleryEntry objects.", + "name": "option_id", + "description": "Option ID.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "MediaGalleryEntry", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `media_gallery` instead." + "deprecationReason": "Use `uid` instead" }, { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "name": "required", + "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", + "name": "sort_order", + "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", @@ -18411,96 +17916,117 @@ "deprecationReason": null }, { - "name": "min_sale_qty", - "description": "Minimum Qty Allowed in Shopping Cart", + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "An array that defines a set of checkbox values.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomizableCheckboxValue", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [ { - "name": "new", - "description": null, + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableCheckboxValue", + "description": "Defines the price and sku of a product whose page contains a customized set of checkbox values.", + "fields": [ + { + "name": "option_type_id", + "description": "The ID assigned to the value.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "new_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "name": "price", + "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "new_to_date", - "description": "The end date for new product listings.", + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "ENUM", + "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "only_x_left_in_stock", - "description": "Product stock only x left count", + "name": "sku", + "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "options", - "description": "An array of options for a customizable product.", + "name": "sort_order", + "description": "The order in which the checkbox value is displayed.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", + "name": "title", + "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", @@ -18511,83 +18037,78 @@ "deprecationReason": null }, { - "name": "pattern", - "description": null, + "name": "uid", + "description": "The unique ID for a `CustomizableCheckboxValue` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VirtualProduct", + "description": "Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory.", + "fields": [ { - "name": "performance_fabric", + "name": "activity", "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "price", - "description": "Indicates the price of an item.", + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", "args": [], "type": { - "kind": "OBJECT", - "name": "ProductPrices", + "kind": "SCALAR", + "name": "Int", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `price_range` for product price information." - }, - { - "name": "price_range", - "description": "The range of prices for the product", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PriceRange", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "price_tiers", - "description": "An array of `TierPrice` objects.", + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TierPrice", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "product_links", - "description": "An array of `ProductLinks` objects.", + "name": "categories", + "description": "The categories assigned to a product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", - "name": "ProductLinksInterface", + "name": "CategoryInterface", "ofType": null } }, @@ -18595,99 +18116,87 @@ "deprecationReason": null }, { - "name": "purpose", + "name": "category_gear", "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "quantity", - "description": "Amount of available stock", + "name": "climate", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "rating_summary", - "description": "The average of all the ratings given to the product.", + "name": "collar", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "name": "color", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "related_products", - "description": "An array of related products.", + "name": "country_of_manufacture", + "description": "The product's country of origin.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "name": "created_at", + "description": "Timestamp indicating when the product was created.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "review_count", - "description": "The total count of all the reviews given to the product.", + "name": "crosssell_products", + "description": "An array of cross-sell products.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Int", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null } }, @@ -18695,57 +18204,31 @@ "deprecationReason": null }, { - "name": "reviews", - "description": "The list of products reviews.", + "name": "custom_attributesV2", + "description": "Product custom attributes.", "args": [ { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", + "name": "filters", + "description": "", "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", "ofType": null }, - "defaultValue": "1" + "defaultValue": null } ], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviews", - "ofType": null - } + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", "args": [], "type": { "kind": "OBJECT", @@ -18756,7 +18239,7 @@ "deprecationReason": null }, { - "name": "size", + "name": "eco_collection", "description": null, "args": [], "type": { @@ -18768,19 +18251,19 @@ "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "name": "erin_recommends", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "sleeve", + "name": "features_bags", "description": null, "args": [], "type": { @@ -18792,56 +18275,48 @@ "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", + "name": "format", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "special_price", - "description": "The discounted price of the product.", + "name": "gender", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "special_to_date", - "description": "The end date for a product with a special price.", + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "staged", - "description": "Indicates whether the product is staged for a future campaign.", + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", "args": [], "type": { "kind": "NON_NULL", @@ -18856,188 +18331,172 @@ "deprecationReason": null }, { - "name": "stock_status", - "description": "Stock status of the product", + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", "args": [], "type": { - "kind": "ENUM", - "name": "ProductStockStatus", + "kind": "OBJECT", + "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "strap_bags", - "description": null, + "name": "id", + "description": "The ID number assigned to the product.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "Use the `uid` field instead." }, { - "name": "style_bags", - "description": null, + "name": "image", + "description": "The relative path to the main image on the product page.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "ProductImage", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "style_bottom", - "description": null, + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "style_general", - "description": null, + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "swatch_image", - "description": "The file name of a swatch image.", + "name": "material", + "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", + "name": "max_sale_qty", + "description": "Maximum Qty Allowed in Shopping Cart", "args": [], "type": { - "kind": "OBJECT", - "name": "ProductImage", + "kind": "SCALAR", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "name": "media_gallery", + "description": "An array of media gallery objects.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "tier_prices", - "description": "An array of ProductTierPrices objects.", + "name": "media_gallery_entries", + "description": "An array of MediaGalleryEntry objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "ProductTierPrices", + "name": "MediaGalleryEntry", "ofType": null } }, "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." + "deprecationReason": "Use `media_gallery` instead." }, { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", "args": [], "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "type_id", - "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `__typename` instead." - }, - { - "name": "uid", - "description": "The unique ID for a `ProductInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, "isDeprecated": false, "deprecationReason": null }, { - "name": "updated_at", - "description": "Timestamp indicating when the product was updated.", + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "upsell_products", - "description": "An array of up-sell products.", + "name": "min_sale_qty", + "description": "Minimum Qty Allowed in Shopping Cart", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "url_key", - "description": "The part of the URL that identifies the product", + "name": "name", + "description": "The product name. Customers use this name to identify the product.", "args": [], "type": { "kind": "SCALAR", @@ -19048,36 +18507,32 @@ "deprecationReason": null }, { - "name": "url_path", + "name": "new", "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use product's `canonical_url` or url rewrites instead" + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "url_rewrites", - "description": "URL rewrites list", - "args": [], + "name": "new_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "UrlRewrite", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "url_suffix", - "description": "The part of the product URL that is appended after the url key", + "name": "new_to_date", + "description": "The end date for new product listings.", "args": [], "type": { "kind": "SCALAR", @@ -19088,50 +18543,47 @@ "deprecationReason": null }, { - "name": "websites", - "description": "An array of websites in which the product is available.", + "name": "only_x_left_in_stock", + "description": "Product stock only x left count", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "An array of options for a customizable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Website", + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", "ofType": null } }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "INTERFACE", - "name": "CustomizableProductInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SimpleProduct", - "description": "Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities.", - "fields": [ - { - "name": "activity", + "name": "pattern", "description": null, "args": [], "type": { @@ -19143,8 +18595,8 @@ "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", + "name": "performance_fabric", + "description": null, "args": [], "type": { "kind": "SCALAR", @@ -19152,30 +18604,62 @@ "ofType": null }, "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "name": "price", + "description": "Indicates the price of an item.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "ProductPrices", "ofType": null }, + "isDeprecated": true, + "deprecationReason": "Use `price_range` for product price information." + }, + { + "name": "price_range", + "description": "The range of prices for the product", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRange", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "categories", - "description": "The categories assigned to a product.", + "name": "price_tiers", + "description": "An array of `TierPrice` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TierPrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_links", + "description": "An array of `ProductLinks` objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", - "name": "CategoryInterface", + "name": "ProductLinksInterface", "ofType": null } }, @@ -19183,87 +18667,99 @@ "deprecationReason": null }, { - "name": "category_gear", + "name": "purpose", "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "climate", - "description": null, + "name": "quantity", + "description": "Amount of available stock", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "collar", - "description": null, + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "color", - "description": null, + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "country_of_manufacture", - "description": "The product's country of origin.", + "name": "related_products", + "description": "An array of related products.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "crosssell_products", - "description": "An array of cross-sell products.", + "name": "review_count", + "description": "The total count of all the reviews given to the product.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "SCALAR", + "name": "Int", "ofType": null } }, @@ -19271,42 +18767,60 @@ "deprecationReason": null }, { - "name": "custom_attributesV2", - "description": "Product custom attributes.", + "name": "reviews", + "description": "The list of products reviews.", "args": [ { - "name": "filters", - "description": "", + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "defaultValue": null + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" } ], "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", + "name": "rules", + "description": "Provides applied catalog rules in the current active cart", "args": [], "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CatalogRule", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "eco_collection", + "name": "sale", "description": null, "args": [], "type": { @@ -19318,7 +18832,19 @@ "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "erin_recommends", + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "size", "description": null, "args": [], "type": { @@ -19330,32 +18856,44 @@ "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "features_bags", - "description": null, + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "format", + "name": "sleeve", "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "gender", - "description": null, + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", @@ -19363,27 +18901,35 @@ "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "gift_message_available", - "description": "Returns a value indicating gift message availability for the product.", + "name": "special_price", + "description": "The discounted price of the product.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "gift_wrapping_available", - "description": "Returns a value indicating gift wrapping availability for the product.", + "name": "special_to_date", + "description": "The end date for a product with a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staged", + "description": "Indicates whether the product is staged for a future campaign.", "args": [], "type": { "kind": "NON_NULL", @@ -19398,67 +18944,55 @@ "deprecationReason": null }, { - "name": "gift_wrapping_price", - "description": "Returns value and currency indicating gift wrapping price for the product.", + "name": "stock_status", + "description": "Stock status of the product", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", + "kind": "ENUM", + "name": "ProductStockStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The ID number assigned to the product.", + "name": "strap_bags", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." - }, - { - "name": "image", - "description": "The relative path to the main image on the product page.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", + "name": "style_bags", + "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", + "name": "style_bottom", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "material", + "name": "style_general", "description": null, "args": [], "type": { @@ -19470,100 +19004,128 @@ "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "max_sale_qty", - "description": "Maximum Qty Allowed in Shopping Cart", + "name": "swatch_image", + "description": "The file name of a swatch image.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "media_gallery", - "description": "An array of media gallery objects.", + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "media_gallery_entries", - "description": "An array of MediaGalleryEntry objects.", + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "tier_prices", + "description": "An array of ProductTierPrices objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "MediaGalleryEntry", + "name": "ProductTierPrices", "ofType": null } }, "isDeprecated": true, - "deprecationReason": "Use `media_gallery` instead." + "deprecationReason": "Use `price_tiers` for product tier price information." }, { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", + "name": "type_id", + "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, + "isDeprecated": true, + "deprecationReason": "Use `__typename` instead." + }, + { + "name": "uid", + "description": "The unique ID for a `ProductInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "name": "updated_at", + "description": "Timestamp indicating when the product was updated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "min_sale_qty", - "description": "Minimum Qty Allowed in Shopping Cart", + "name": "upsell_products", + "description": "An array of up-sell products.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", + "name": "url_key", + "description": "The part of the URL that identifies the product", "args": [], "type": { "kind": "SCALAR", @@ -19574,32 +19136,36 @@ "deprecationReason": null }, { - "name": "new", + "name": "url_path", "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "Use product's `canonical_url` or url rewrites instead" }, { - "name": "new_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "name": "url_rewrites", + "description": "URL rewrites list", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRewrite", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "new_to_date", - "description": "The end date for new product listings.", + "name": "url_suffix", + "description": "The part of the product URL that is appended after the url key", "args": [], "type": { "kind": "SCALAR", @@ -19610,47 +19176,50 @@ "deprecationReason": null }, { - "name": "only_x_left_in_stock", - "description": "Product stock only x left count", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "An array of options for a customizable product.", + "name": "websites", + "description": "An array of websites in which the product is available.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", + "kind": "OBJECT", + "name": "Website", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null }, { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null }, { - "name": "pattern", + "kind": "INTERFACE", + "name": "CustomizableProductInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SimpleProduct", + "description": "Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities.", + "fields": [ + { + "name": "activity", "description": null, "args": [], "type": { @@ -19662,8 +19231,8 @@ "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "performance_fabric", - "description": null, + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", "args": [], "type": { "kind": "SCALAR", @@ -19671,62 +19240,30 @@ "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "price", - "description": "Indicates the price of an item.", + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", "args": [], "type": { - "kind": "OBJECT", - "name": "ProductPrices", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `price_range` for product price information." - }, - { - "name": "price_range", - "description": "The range of prices for the product", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PriceRange", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_tiers", - "description": "An array of `TierPrice` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TierPrice", - "ofType": null - } - }, "isDeprecated": false, "deprecationReason": null }, { - "name": "product_links", - "description": "An array of `ProductLinks` objects.", + "name": "categories", + "description": "The categories assigned to a product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", - "name": "ProductLinksInterface", + "name": "CategoryInterface", "ofType": null } }, @@ -19734,99 +19271,87 @@ "deprecationReason": null }, { - "name": "purpose", + "name": "category_gear", "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "quantity", - "description": "Amount of available stock", + "name": "climate", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "rating_summary", - "description": "The average of all the ratings given to the product.", + "name": "collar", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "name": "color", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "related_products", - "description": "An array of related products.", + "name": "country_of_manufacture", + "description": "The product's country of origin.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "name": "created_at", + "description": "Timestamp indicating when the product was created.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "review_count", - "description": "The total count of all the reviews given to the product.", + "name": "crosssell_products", + "description": "An array of cross-sell products.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Int", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null } }, @@ -19834,57 +19359,31 @@ "deprecationReason": null }, { - "name": "reviews", - "description": "The list of products reviews.", + "name": "custom_attributesV2", + "description": "Product custom attributes.", "args": [ { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", + "name": "filters", + "description": "", "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", "ofType": null }, - "defaultValue": "1" + "defaultValue": null } ], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviews", - "ofType": null - } + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", "args": [], "type": { "kind": "OBJECT", @@ -19895,7 +19394,7 @@ "deprecationReason": null }, { - "name": "size", + "name": "eco_collection", "description": null, "args": [], "type": { @@ -19907,19 +19406,19 @@ "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "name": "erin_recommends", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "sleeve", + "name": "features_bags", "description": null, "args": [], "type": { @@ -19931,56 +19430,48 @@ "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", + "name": "format", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "special_price", - "description": "The discounted price of the product.", + "name": "gender", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "special_to_date", - "description": "The end date for a product with a special price.", + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "staged", - "description": "Indicates whether the product is staged for a future campaign.", + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", "args": [], "type": { "kind": "NON_NULL", @@ -19995,188 +19486,208 @@ "deprecationReason": null }, { - "name": "stock_status", - "description": "Stock status of the product", + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", "args": [], "type": { - "kind": "ENUM", - "name": "ProductStockStatus", + "kind": "OBJECT", + "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "strap_bags", - "description": null, + "name": "id", + "description": "The ID number assigned to the product.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "deprecationReason": "Use the `uid` field instead." }, { - "name": "style_bags", - "description": null, + "name": "image", + "description": "The relative path to the main image on the product page.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "ProductImage", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "style_bottom", - "description": null, + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "style_general", - "description": null, + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "swatch_image", - "description": "The file name of a swatch image.", + "name": "material", + "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", + "name": "max_sale_qty", + "description": "Maximum Qty Allowed in Shopping Cart", "args": [], "type": { - "kind": "OBJECT", - "name": "ProductImage", + "kind": "SCALAR", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "name": "media_gallery", + "description": "An array of media gallery objects.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "tier_prices", - "description": "An array of ProductTierPrices objects.", + "name": "media_gallery_entries", + "description": "An array of MediaGalleryEntry objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "ProductTierPrices", + "name": "MediaGalleryEntry", "ofType": null } }, "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." + "deprecationReason": "Use `media_gallery` instead." }, { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", "args": [], "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "type_id", - "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `__typename` instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `ProductInterface` object.", + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "updated_at", - "description": "Timestamp indicating when the product was updated.", + "name": "min_sale_qty", + "description": "Minimum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The product name. Customers use this name to identify the product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "upsell_products", - "description": "An array of up-sell products.", + "name": "new_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "url_key", - "description": "The part of the URL that identifies the product", + "name": "new_to_date", + "description": "The end date for new product listings.", "args": [], "type": { "kind": "SCALAR", @@ -20187,27 +19698,27 @@ "deprecationReason": null }, { - "name": "url_path", - "description": null, + "name": "only_x_left_in_stock", + "description": "Product stock only x left count", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use product's `canonical_url` or url rewrites instead" + "isDeprecated": false, + "deprecationReason": null }, { - "name": "url_rewrites", - "description": "URL rewrites list", + "name": "options", + "description": "An array of options for a customizable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "UrlRewrite", + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", "ofType": null } }, @@ -20215,8 +19726,8 @@ "deprecationReason": null }, { - "name": "url_suffix", - "description": "The part of the product URL that is appended after the url key", + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", "args": [], "type": { "kind": "SCALAR", @@ -20227,86 +19738,51 @@ "deprecationReason": null }, { - "name": "websites", - "description": "An array of websites in which the product is available.", + "name": "pattern", + "description": null, "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Website", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", + "name": "performance_fabric", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "PhysicalProductInterface", - "ofType": null + "name": "price", + "description": "Indicates the price of an item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductPrices", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_range` for product price information." }, { - "kind": "INTERFACE", - "name": "CustomizableProductInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Products", - "description": "Contains the results of a `products` query.", - "fields": [ - { - "name": "aggregations", - "description": "A bucket that contains the attribute code and label for each filterable option.", - "args": [ - { - "name": "filter", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AggregationsFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], + "name": "price_range", + "description": "The range of prices for the product", + "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", - "name": "Aggregation", + "name": "PriceRange", "ofType": null } }, @@ -20314,31 +19790,31 @@ "deprecationReason": null }, { - "name": "filters", - "description": "Layered navigation filters array.", + "name": "price_tiers", + "description": "An array of `TierPrice` objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "LayerFilter", + "name": "TierPrice", "ofType": null } }, - "isDeprecated": true, - "deprecationReason": "Use `aggregations` instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "items", - "description": "An array of products that match the specified search criteria.", + "name": "product_links", + "description": "An array of `ProductLinks` objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", - "name": "ProductInterface", + "name": "ProductLinksInterface", "ofType": null } }, @@ -20346,39 +19822,39 @@ "deprecationReason": null }, { - "name": "page_info", - "description": "An object that includes the page_info and currentPage values specified in the query.", + "name": "purpose", + "description": null, "args": [], "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "sort_fields", - "description": "An object that includes the default sort field and all available sort fields.", + "name": "quantity", + "description": "Amount of available stock", "args": [], "type": { - "kind": "OBJECT", - "name": "SortFields", + "kind": "SCALAR", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "suggestions", - "description": "An array of search suggestions for case when search query have no results.", + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "SearchSuggestion", + "kind": "SCALAR", + "name": "Float", "ofType": null } }, @@ -20386,73 +19862,24 @@ "deprecationReason": null }, { - "name": "total_count", - "description": "The number of products that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AggregationsFilterInput", - "description": "An input object that specifies the filters used in product aggregations.", - "fields": null, - "inputFields": [ - { - "name": "category", - "description": "Filter category aggregations in layered navigation.", - "type": { - "kind": "INPUT_OBJECT", - "name": "AggregationsCategoryFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AggregationsCategoryFilterInput", - "description": "Filter category aggregations in layered navigation.", - "fields": null, - "inputFields": [ - { - "name": "includeDirectChildrenOnly", - "description": "Indicates whether to include only direct subcategories or all children categories at all levels.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CategoryProducts", - "description": "Contains details about the products assigned to a category.", - "fields": [ + }, { - "name": "items", - "description": "An array of products that are assigned to the category.", + "name": "related_products", + "description": "An array of related products.", "args": [], "type": { "kind": "LIST", @@ -20467,428 +19894,631 @@ "deprecationReason": null }, { - "name": "page_info", - "description": "Pagination metadata.", + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", "args": [], "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "total_count", - "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", + "name": "review_count", + "description": "The total count of all the reviews given to the product.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ProductAttributeFilterInput", - "description": "Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", - "fields": null, - "inputFields": [ + }, { - "name": "activity", - "description": "Attribute label: Activity", + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "category_gear", - "description": "Attribute label: Category Gear", + "name": "rules", + "description": "Provides applied catalog rules in the current active cart", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CatalogRule", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "category_id", - "description": "Deprecated: use `category_uid` to filter product by category ID.", + "name": "sale", + "description": null, + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "category_uid", - "description": "Filter product by the unique ID for a `CategoryInterface` object.", + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "OBJECT", + "name": "ComplexTextValue", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "category_url_path", - "description": "Filter product by category URL path.", + "name": "size", + "description": null, + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "climate", - "description": "Attribute label: Climate", + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "collar", - "description": "Attribute label: Collar", + "name": "sleeve", + "description": null, + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "color", - "description": "Attribute label: Color", + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "OBJECT", + "name": "ProductImage", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "description", - "description": "Attribute label: Description", + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "eco_collection", - "description": "Attribute label: Eco Collection", + "name": "special_price", + "description": "The discounted price of the product.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "SCALAR", + "name": "Float", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "erin_recommends", - "description": "Attribute label: Erin Recommends", + "name": "special_to_date", + "description": "The end date for a product with a special price.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "features_bags", - "description": "Attribute label: Features", + "name": "staged", + "description": "Indicates whether the product is staged for a future campaign.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "format", - "description": "Attribute label: Format", + "name": "stock_status", + "description": "Stock status of the product", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "ProductStockStatus", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "gender", - "description": "Attribute label: Gender", + "name": "strap_bags", + "description": null, + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "material", - "description": "Attribute label: Material", + "name": "style_bags", + "description": null, + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "name", - "description": "Attribute label: Product Name", + "name": "style_bottom", + "description": null, + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "new", - "description": "Attribute label: New", + "name": "style_general", + "description": null, + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "pattern", - "description": "Attribute label: Pattern", + "name": "swatch_image", + "description": "The file name of a swatch image.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "performance_fabric", - "description": "Attribute label: Performance Fabric", + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "OBJECT", + "name": "ProductImage", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "price", - "description": "Attribute label: Price", + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterRangeTypeInput", + "kind": "SCALAR", + "name": "Float", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." }, { - "name": "purpose", - "description": "Attribute label: Purpose", + "name": "tier_prices", + "description": "An array of ProductTierPrices objects.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductTierPrices", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." }, { - "name": "sale", - "description": "Attribute label: Sale", + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "short_description", - "description": "Attribute label: Short Description", + "name": "type_id", + "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `__typename` instead." }, { - "name": "size", - "description": "Attribute label: Size", + "name": "uid", + "description": "The unique ID for a `ProductInterface` object.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "sku", - "description": "Attribute label: SKU", + "name": "updated_at", + "description": "Timestamp indicating when the product was updated.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "sleeve", - "description": "Attribute label: Sleeve", + "name": "upsell_products", + "description": "An array of up-sell products.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "strap_bags", - "description": "Attribute label: Strap/Handle", + "name": "url_key", + "description": "The part of the URL that identifies the product", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "style_bags", - "description": "Attribute label: Style Bags", + "name": "url_path", + "description": null, + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use product's `canonical_url` or url rewrites instead" }, { - "name": "style_bottom", - "description": "Attribute label: Style Bottom", + "name": "url_rewrites", + "description": "URL rewrites list", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRewrite", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "style_general", - "description": "Attribute label: Style General", + "name": "url_suffix", + "description": "The part of the product URL that is appended after the url key", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "url_key", - "description": "The part of the URL that identifies the product", + "name": "websites", + "description": "An array of websites in which the product is available.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Website", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "weight", + "description": "The weight of the item, in units defined by the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "PhysicalProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "CustomizableProductInterface", + "ofType": null } ], - "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "INPUT_OBJECT", - "name": "CategoryFilterInput", - "description": "Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", - "fields": null, - "inputFields": [ + "kind": "OBJECT", + "name": "Products", + "description": "Contains the results of a `products` query.", + "fields": [ { - "name": "category_uid", - "description": "Filter by the unique category ID for a `CategoryInterface` object.", + "name": "aggregations", + "description": "A bucket that contains the attribute code and label for each filterable option.", + "args": [ + { + "name": "filter", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AggregationsFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Aggregation", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "ids", - "description": "Deprecated: use 'category_uid' to filter uniquely identifiers of categories.", + "name": "filters", + "description": "Layered navigation filters array.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LayerFilter", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `aggregations` instead." }, { - "name": "name", - "description": "Filter by the display name of the category.", + "name": "items", + "description": "An array of products that match the specified search criteria.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "parent_category_uid", - "description": "Filter by the unique parent category ID for a `CategoryInterface` object.", + "name": "page_info", + "description": "An object that includes the page_info and currentPage values specified in the query.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "OBJECT", + "name": "SearchResultPageInfo", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "parent_id", - "description": "Filter by the unique parent category ID for a `CategoryInterface` object.", + "name": "sort_fields", + "description": "An object that includes the default sort field and all available sort fields.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "kind": "OBJECT", + "name": "SortFields", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "url_key", - "description": "Filter by the part of the URL that identifies the category.", + "name": "suggestions", + "description": "An array of search suggestions for case when search query have no results.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchSuggestion", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "url_path", - "description": "Filter by the URL path for the category.", + "name": "total_count", + "description": "The number of products that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AggregationsFilterInput", + "description": "An input object that specifies the filters used in product aggregations.", + "fields": null, + "inputFields": [ + { + "name": "category", + "description": "Filter category aggregations in layered navigation.", "type": { "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", + "name": "AggregationsCategoryFilterInput", "ofType": null }, "defaultValue": null @@ -20900,246 +20530,720 @@ }, { "kind": "INPUT_OBJECT", - "name": "ProductFilterInput", - "description": "ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", + "name": "AggregationsCategoryFilterInput", + "description": "Filter category aggregations in layered navigation.", "fields": null, "inputFields": [ { - "name": "category_id", - "description": "The category ID the product belongs to.", + "name": "includeDirectChildrenOnly", + "description": "Indicates whether to include only direct subcategories or all children categories at all levels.", "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CategoryProducts", + "description": "Contains details about the products assigned to a category.", + "fields": [ + { + "name": "items", + "description": "An array of products that are assigned to the category.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null }, { - "name": "country_of_manufacture", - "description": "The product's country of origin.", + "name": "page_info", + "description": "Pagination metadata.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "OBJECT", + "name": "SearchResultPageInfo", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "created_at", - "description": "The timestamp indicating when the product was created.", + "name": "total_count", + "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "defaultValue": null - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductAttributeFilterInput", + "description": "Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", + "fields": null, + "inputFields": [ { - "name": "custom_layout", - "description": "The name of a custom layout.", + "name": "activity", + "description": "Attribute label: Activity", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "custom_layout_update", - "description": "XML code that is applied as a layout update to the product page.", + "name": "category_gear", + "description": "Attribute label: Category Gear", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", + "name": "category_id", + "description": "Deprecated: use `category_uid` to filter product by category ID.", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "gift_message_available", - "description": "Indicates whether a gift message is available.", + "name": "category_uid", + "description": "Filter product by the unique ID for a `CategoryInterface` object.", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "has_options", - "description": "Indicates whether additional attributes have been created for the product.", + "name": "category_url_path", + "description": "Filter product by category URL path.", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "image", - "description": "The relative path to the main image on the product page.", + "name": "climate", + "description": "Attribute label: Climate", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "image_label", - "description": "The label assigned to a product image.", + "name": "collar", + "description": "Attribute label: Collar", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", + "name": "color", + "description": "Attribute label: Color", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", + "name": "description", + "description": "Attribute label: Description", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterMatchTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "max_price", - "description": "The numeric maximal price of the product. Do not include the currency code.", + "name": "eco_collection", + "description": "Attribute label: Eco Collection", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "name": "erin_recommends", + "description": "Attribute label: Erin Recommends", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", + "name": "features_bags", + "description": "Attribute label: Features", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "name": "format", + "description": "Attribute label: Format", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "min_price", - "description": "The numeric minimal price of the product. Do not include the currency code.", + "name": "gender", + "description": "Attribute label: Gender", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", + "name": "material", + "description": "Attribute label: Material", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "news_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "name": "name", + "description": "Attribute label: Product Name", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterMatchTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "news_to_date", - "description": "The end date for new product listings.", + "name": "new", + "description": "Attribute label: New", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", + "name": "pattern", + "description": "Attribute label: Pattern", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "or", - "description": "The keyword required to perform a logical OR comparison.", + "name": "performance_fabric", + "description": "Attribute label: Performance Fabric", "type": { "kind": "INPUT_OBJECT", - "name": "ProductFilterInput", + "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "price", - "description": "The price of an item.", + "description": "Attribute label: Price", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterRangeTypeInput", "ofType": null }, "defaultValue": null }, { - "name": "required_options", - "description": "Indicates whether the product has required options.", + "name": "purpose", + "description": "Attribute label: Purpose", "type": { "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sale", + "description": "Attribute label: Sale", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "short_description", + "description": "Attribute label: Short Description", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterMatchTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "size", + "description": "Attribute label: Size", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sku", + "description": "Attribute label: SKU", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sleeve", + "description": "Attribute label: Sleeve", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "strap_bags", + "description": "Attribute label: Strap/Handle", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "style_bags", + "description": "Attribute label: Style Bags", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "style_bottom", + "description": "Attribute label: Style Bottom", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "style_general", + "description": "Attribute label: Style General", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url_key", + "description": "The part of the URL that identifies the product", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CategoryFilterInput", + "description": "Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", + "fields": null, + "inputFields": [ + { + "name": "category_uid", + "description": "Filter by the unique category ID for a `CategoryInterface` object.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ids", + "description": "Deprecated: use 'category_uid' to filter uniquely identifiers of categories.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "Filter by the display name of the category.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterMatchTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "parent_category_uid", + "description": "Filter by the unique parent category ID for a `CategoryInterface` object.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "parent_id", + "description": "Filter by the unique parent category ID for a `CategoryInterface` object.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url_key", + "description": "Filter by the part of the URL that identifies the category.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url_path", + "description": "Filter by the URL path for the category.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductFilterInput", + "description": "ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", + "fields": null, + "inputFields": [ + { + "name": "category_id", + "description": "The category ID the product belongs to.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "created_at", + "description": "The timestamp indicating when the product was created.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "custom_layout", + "description": "The name of a custom layout.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "custom_layout_update", + "description": "XML code that is applied as a layout update to the product page.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gift_message_available", + "description": "Indicates whether a gift message is available.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "has_options", + "description": "Indicates whether additional attributes have been created for the product.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "image", + "description": "The relative path to the main image on the product page.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "image_label", + "description": "The label assigned to a product image.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "max_price", + "description": "The numeric maximal price of the product. Do not include the currency code.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "min_price", + "description": "The numeric minimal price of the product. Do not include the currency code.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The product name. Customers use this name to identify the product.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "news_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "news_to_date", + "description": "The end date for new product listings.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "or", + "description": "The keyword required to perform a logical OR comparison.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ProductFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "price", + "description": "The price of an item.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "required_options", + "description": "Indicates whether the product has required options.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", "ofType": null }, "defaultValue": null @@ -23104,622 +23208,575 @@ "possibleTypes": null }, { - "kind": "ENUM", - "name": "ProductStockStatus", - "description": "This enumeration states whether a product stock status is in stock or out of stock", + "kind": "INPUT_OBJECT", + "name": "CreateGuestCartInput", + "description": "", "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ + "inputFields": [ { - "name": "IN_STOCK", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, + "name": "cart_uid", + "description": "Optional client-generated ID", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "createEmptyCartInput", + "description": "Assigns a specific `cart_id` to the empty cart.", + "fields": null, + "inputFields": [ { - "name": "OUT_OF_STOCK", - "description": "", - "isDeprecated": false, - "deprecationReason": null + "name": "cart_id", + "description": "The ID to assign to the cart.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null } ], + "interfaces": null, + "enumValues": null, "possibleTypes": null }, { - "kind": "INTERFACE", - "name": "CartItemInterface", - "description": "An interface for products in a cart.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "AddSimpleProductsToCartInput", + "description": "Defines the simple and group products to add to the cart.", + "fields": null, + "inputFields": [ { - "name": "discount", - "description": "Contains discount for quote line item.", - "args": [], + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Discount", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "errors", - "description": "An array of errors encountered while loading the cart item", - "args": [], + "name": "cart_items", + "description": "An array of simple and group items to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SimpleProductCartItemInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SimpleProductCartItemInput", + "description": "Defines a single product to add to the cart.", + "fields": null, + "inputFields": [ + { + "name": "customizable_options", + "description": "An array that defines customizable options for the product.", "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "CartItemError", + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "id", - "description": null, - "args": [], + "name": "data", + "description": "An object containing the `sku`, `quantity`, and other relevant information about the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "CartItemInput", "ofType": null } }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddVirtualProductsToCartInput", + "description": "Defines the virtual products to add to the cart.", + "fields": null, + "inputFields": [ { - "name": "is_available", - "description": "True if requested quantity is less than available stock, false otherwise.", - "args": [], + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Boolean", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "max_qty", - "description": "Line item max qty in quote template", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "min_qty", - "description": "Line item min qty in quote template", - "args": [], + "name": "cart_items", + "description": "An array of virtual products to add.", "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "VirtualProductCartItemInput", + "ofType": null + } + } }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "VirtualProductCartItemInput", + "description": "Defines a single product to add to the cart.", + "fields": null, + "inputFields": [ { - "name": "not_available_message", - "description": "Message to display when the product is not available with this selected option.", - "args": [], + "name": "customizable_options", + "description": "An array that defines customizable options for the product.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "note_from_buyer", - "description": "The buyer's quote line item note.", - "args": [], + "name": "data", + "description": "An object containing the `sku`, `quantity`, and other relevant information about the product.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "ItemNote", + "kind": "INPUT_OBJECT", + "name": "CartItemInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "description": "Defines an item to be added to the cart.", + "fields": null, + "inputFields": [ { - "name": "note_from_seller", - "description": "The seller's quote line item note.", - "args": [], + "name": "entered_options", + "description": "An array of entered options for the base product, such as personalization text.", "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "ItemNote", + "kind": "INPUT_OBJECT", + "name": "EnteredOptionInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", - "args": [], + "name": "parent_sku", + "description": "For a child product, the SKU of its parent product.", "type": { - "kind": "OBJECT", - "name": "CartItemPrices", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "product", - "description": "Details about an item in the cart.", - "args": [], + "name": "quantity", + "description": "The amount or number of an item to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "SCALAR", + "name": "Float", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "quantity", - "description": "The quantity of this item in the cart.", - "args": [], + "name": "selected_options", + "description": "The selected options for the base product, such as color or size, using the unique ID for an object such as `CustomizableRadioOption`, `CustomizableDropDownOption`, or `ConfigurableProductOptionsValues`.", "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", - "name": "Float", + "name": "ID", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", - "args": [], + "name": "sku", + "description": "The SKU of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null } ], - "inputFields": null, - "interfaces": [], + "interfaces": null, "enumValues": null, - "possibleTypes": [ + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SortQuoteItemsEnum", + "description": "Specifies the field to use for sorting quote items", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ { - "kind": "OBJECT", - "name": "SimpleCartItem", - "ofType": null + "name": "ITEM_ID", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "OBJECT", - "name": "VirtualCartItem", - "ofType": null + "name": "CREATED_AT", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "OBJECT", - "name": "ConfigurableCartItem", - "ofType": null + "name": "UPDATED_AT", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "OBJECT", - "name": "DownloadableCartItem", - "ofType": null + "name": "PRODUCT_ID", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "OBJECT", - "name": "BundleCartItem", - "ofType": null + "name": "SKU", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "OBJECT", - "name": "GiftCardCartItem", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "EntityUrl", - "description": "Contains the `uid`, `relative_url`, and `type` attributes.", - "fields": [ + "name": "NAME", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "canonical_url", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `relative_url` instead." + "name": "DESCRIPTION", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "name": "entity_uid", - "description": "The unique ID for a `ProductInterface`, `CategoryInterface`, `CmsPage`, or similar object associated with the specified URL. This could be a product, category, or CMS page UID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, + "name": "WEIGHT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `entity_uid` instead." + "name": "QTY", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "name": "redirectCode", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, + "name": "PRICE", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "BASE_PRICE", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, + "name": "CUSTOM_PRICE", + "description": "", "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "description": "This enumeration defines the entity type.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ + }, { - "name": "CMS_PAGE", + "name": "DISCOUNT_PERCENT", "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "PRODUCT", + "name": "DISCOUNT_AMOUNT", "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "CATEGORY", + "name": "BASE_DISCOUNT_AMOUNT", "description": "", "isDeprecated": false, "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UrlRewrite", - "description": "Contains URL rewrite details.", - "fields": [ + }, { - "name": "parameters", - "description": "An array of request parameters.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "HttpQueryParameter", - "ofType": null - } - }, + "name": "TAX_PERCENT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "url", - "description": "The request URL.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "TAX_AMOUNT", + "description": "", "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "HttpQueryParameter", - "description": "Contains target path parameters.", - "fields": [ + }, { - "name": "name", - "description": "A parameter name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "BASE_TAX_AMOUNT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "value", - "description": "A parameter value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "ROW_TOTAL", + "description": "", "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RoutableUrl", - "description": "Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity.", - "fields": [ + }, { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, + "name": "BASE_ROW_TOTAL", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "ROW_TOTAL_WITH_DISCOUNT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, + "name": "ROW_WEIGHT", + "description": "", "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "description": "Routable entities serve as the model for a rendered page.", - "fields": [ + }, { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, + "name": "PRODUCT_TYPE", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "BASE_TAX_BEFORE_DISCOUNT", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, + "name": "TAX_BEFORE_DISCOUNT", + "description": "", "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "CmsPage", - "ofType": null }, { - "kind": "OBJECT", - "name": "CategoryTree", - "ofType": null + "name": "ORIGINAL_CUSTOM_PRICE", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "OBJECT", - "name": "VirtualProduct", - "ofType": null + "name": "PRICE_INC_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "OBJECT", - "name": "SimpleProduct", - "ofType": null + "name": "BASE_PRICE_INC_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "OBJECT", - "name": "RoutableUrl", - "ofType": null + "name": "ROW_TOTAL_INC_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "OBJECT", - "name": "ConfigurableProduct", - "ofType": null + "name": "BASE_ROW_TOTAL_INC_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "OBJECT", - "name": "DownloadableProduct", - "ofType": null + "name": "DISCOUNT_TAX_COMPENSATION_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "OBJECT", - "name": "BundleProduct", - "ofType": null + "name": "BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null }, { - "kind": "OBJECT", - "name": "GiftCardProduct", - "ofType": null + "name": "FREE_SHIPPING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "QuoteItemsSortInput", + "description": "Specifies the field to use for sorting quote items", + "fields": null, + "inputFields": [ + { + "name": "field", + "description": "Specifies the quote items field to sort by", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortQuoteItemsEnum", + "ofType": null + } + }, + "defaultValue": null }, { - "kind": "OBJECT", - "name": "GroupedProduct", - "ofType": null + "name": "order", + "description": "Specifies the order of quote items' sorting", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + } + }, + "defaultValue": null } - ] + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null }, { "kind": "INPUT_OBJECT", - "name": "CreateGuestCartInput", - "description": "", + "name": "CustomizableOptionInput", + "description": "Defines a customizable option.", "fields": null, "inputFields": [ { - "name": "cart_uid", - "description": "Optional client-generated ID", + "name": "id", + "description": "The customizable option ID of the product.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null + }, + { + "name": "value_string", + "description": "The string value of the option.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null } ], "interfaces": null, @@ -23728,17 +23785,35 @@ }, { "kind": "INPUT_OBJECT", - "name": "createEmptyCartInput", - "description": "Assigns a specific `cart_id` to the empty cart.", + "name": "ApplyCouponToCartInput", + "description": "Specifies the coupon code to apply to the cart.", "fields": null, "inputFields": [ { "name": "cart_id", - "description": "The ID to assign to the cart.", + "description": "The unique ID of a `Cart` object.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "coupon_code", + "description": "A valid coupon code.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "defaultValue": null } @@ -23749,8 +23824,8 @@ }, { "kind": "INPUT_OBJECT", - "name": "AddSimpleProductsToCartInput", - "description": "Defines the simple and group products to add to the cart.", + "name": "UpdateCartItemsInput", + "description": "Modifies the specified items in the cart.", "fields": null, "inputFields": [ { @@ -23769,7 +23844,7 @@ }, { "name": "cart_items", - "description": "An array of simple and group items to add.", + "description": "An array of items to be updated.", "type": { "kind": "NON_NULL", "name": null, @@ -23778,7 +23853,7 @@ "name": null, "ofType": { "kind": "INPUT_OBJECT", - "name": "SimpleProductCartItemInput", + "name": "CartItemUpdateInput", "ofType": null } } @@ -23792,10 +23867,30 @@ }, { "kind": "INPUT_OBJECT", - "name": "SimpleProductCartItemInput", - "description": "Defines a single product to add to the cart.", + "name": "CartItemUpdateInput", + "description": "A single item to be updated.", "fields": null, "inputFields": [ + { + "name": "cart_item_id", + "description": "Deprecated. Use `cart_item_uid` instead.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cart_item_uid", + "description": "The unique ID for a `CartItemInterface` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, { "name": "customizable_options", "description": "An array that defines customizable options for the product.", @@ -23811,16 +23906,32 @@ "defaultValue": null }, { - "name": "data", - "description": "An object containing the `sku`, `quantity`, and other relevant information about the product.", + "name": "gift_message", + "description": "Gift message details for the cart item", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "GiftMessageInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gift_wrapping_id", + "description": "The unique ID for a `GiftWrapping` object to be used for the cart item.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The new quantity of the item.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "defaultValue": null } @@ -23831,8 +23942,8 @@ }, { "kind": "INPUT_OBJECT", - "name": "AddVirtualProductsToCartInput", - "description": "Defines the virtual products to add to the cart.", + "name": "RemoveItemFromCartInput", + "description": "Specifies which items to remove from the cart.", "fields": null, "inputFields": [ { @@ -23850,20 +23961,22 @@ "defaultValue": null }, { - "name": "cart_items", - "description": "An array of virtual products to add.", + "name": "cart_item_id", + "description": "Deprecated. Use `cart_item_uid` instead.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "VirtualProductCartItemInput", - "ofType": null - } - } + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cart_item_uid", + "description": "Required field. The unique ID for a `CartItemInterface` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null }, "defaultValue": null } @@ -23874,34 +23987,38 @@ }, { "kind": "INPUT_OBJECT", - "name": "VirtualProductCartItemInput", - "description": "Defines a single product to add to the cart.", + "name": "SetShippingAddressesOnCartInput", + "description": "Specifies an array of addresses to use for shipping.", "fields": null, "inputFields": [ { - "name": "customizable_options", - "description": "An array that defines customizable options for the product.", + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", + "kind": "SCALAR", + "name": "String", "ofType": null } }, "defaultValue": null }, { - "name": "data", - "description": "An object containing the `sku`, `quantity`, and other relevant information about the product.", + "name": "shipping_addresses", + "description": "An array of shipping addresses.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ShippingAddressInput", + "ofType": null + } } }, "defaultValue": null @@ -23913,65 +24030,78 @@ }, { "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "description": "Defines an item to be added to the cart.", + "name": "ShippingAddressInput", + "description": "Defines a single shipping address.", "fields": null, "inputFields": [ { - "name": "entered_options", - "description": "An array of entered options for the base product, such as personalization text.", + "name": "address", + "description": "Defines a shipping address.", "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "EnteredOptionInput", - "ofType": null - } + "kind": "INPUT_OBJECT", + "name": "CartAddressInput", + "ofType": null }, "defaultValue": null }, { - "name": "parent_sku", - "description": "For a child product, the SKU of its parent product.", + "name": "customer_address_id", + "description": "An ID from the customer's address book that uniquely identifies the address to be used for shipping.", "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "defaultValue": null }, { - "name": "quantity", - "description": "The amount or number of an item to add.", + "name": "customer_notes", + "description": "Text provided by the shopper.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "defaultValue": null }, { - "name": "selected_options", - "description": "The selected options for the base product, such as color or size, using the unique ID for an object such as `CustomizableRadioOption`, `CustomizableDropDownOption`, or `ConfigurableProductOptionsValues`.", + "name": "pickup_location_code", + "description": "The code of Pickup Location which will be used for In-Store Pickup.", "type": { - "kind": "LIST", + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SetBillingAddressOnCartInput", + "description": "Sets the billing address.", + "fields": null, + "inputFields": [ + { + "name": "billing_address", + "description": "The billing address.", + "type": { + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "INPUT_OBJECT", + "name": "BillingAddressInput", "ofType": null } }, "defaultValue": null }, { - "name": "sku", - "description": "The SKU of the product.", + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", "type": { "kind": "NON_NULL", "name": null, @@ -23989,245 +24119,48 @@ "possibleTypes": null }, { - "kind": "ENUM", - "name": "SortQuoteItemsEnum", - "description": "Specifies the field to use for sorting quote items", + "kind": "INPUT_OBJECT", + "name": "BillingAddressInput", + "description": "Defines the billing address.", "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ + "inputFields": [ { - "name": "ITEM_ID", - "description": "", - "isDeprecated": false, - "deprecationReason": null + "name": "address", + "description": "Defines a billing address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CartAddressInput", + "ofType": null + }, + "defaultValue": null }, { - "name": "CREATED_AT", - "description": "", - "isDeprecated": false, - "deprecationReason": null + "name": "customer_address_id", + "description": "An ID from the customer's address book that uniquely identifies the address to be used for billing.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null }, { - "name": "UPDATED_AT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "PRODUCT_ID", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "SKU", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "NAME", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "DESCRIPTION", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "WEIGHT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "QTY", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "PRICE", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "BASE_PRICE", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "CUSTOM_PRICE", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "DISCOUNT_PERCENT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "DISCOUNT_AMOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "BASE_DISCOUNT_AMOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "TAX_PERCENT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "TAX_AMOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "BASE_TAX_AMOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ROW_TOTAL", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "BASE_ROW_TOTAL", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ROW_TOTAL_WITH_DISCOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ROW_WEIGHT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "PRODUCT_TYPE", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "BASE_TAX_BEFORE_DISCOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "TAX_BEFORE_DISCOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ORIGINAL_CUSTOM_PRICE", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "PRICE_INC_TAX", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "BASE_PRICE_INC_TAX", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ROW_TOTAL_INC_TAX", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "BASE_ROW_TOTAL_INC_TAX", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "DISCOUNT_TAX_COMPENSATION_AMOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "FREE_SHIPPING", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "QuoteItemsSortInput", - "description": "Specifies the field to use for sorting quote items", - "fields": null, - "inputFields": [ - { - "name": "field", - "description": "Specifies the quote items field to sort by", + "name": "same_as_shipping", + "description": "Indicates whether to set the billing address to be the same as the existing shipping address on the cart.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "SortQuoteItemsEnum", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "defaultValue": null }, { - "name": "order", - "description": "Specifies the order of quote items' sorting", + "name": "use_for_shipping", + "description": "Indicates whether to set the shipping address to be the same as this billing address.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "defaultValue": null } @@ -24238,33 +24171,37 @@ }, { "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", - "description": "Defines a customizable option.", + "name": "CartAddressInput", + "description": "Defines the billing or shipping address to be applied to the cart.", "fields": null, "inputFields": [ { - "name": "id", - "description": "The customizable option ID of the product.", + "name": "city", + "description": "The city specified for the billing or shipping address.", "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "defaultValue": null }, { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", + "name": "company", + "description": "The company specified for the billing or shipping address.", "type": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null }, "defaultValue": null }, { - "name": "value_string", - "description": "The string value of the option.", + "name": "country_code", + "description": "The country code and label for the billing or shipping address.", "type": { "kind": "NON_NULL", "name": null, @@ -24275,60 +24212,34 @@ } }, "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ApplyCouponToCartInput", - "description": "Specifies the coupon code to apply to the cart.", - "fields": null, - "inputFields": [ + }, { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", + "name": "custom_attributes", + "description": "The custom attribute values of the billing or shipping address.", "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "INPUT_OBJECT", + "name": "AttributeValueInput", "ofType": null } }, "defaultValue": null }, { - "name": "coupon_code", - "description": "A valid coupon code.", + "name": "fax", + "description": "The customer's fax number.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "UpdateCartItemsInput", - "description": "Modifies the specified items in the cart.", - "fields": null, - "inputFields": [ + }, { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", + "name": "firstname", + "description": "The first name of the customer or guest.", "type": { "kind": "NON_NULL", "name": null, @@ -24341,139 +24252,123 @@ "defaultValue": null }, { - "name": "cart_items", - "description": "An array of items to be updated.", + "name": "lastname", + "description": "The last name of the customer or guest.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemUpdateInput", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null } }, "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CartItemUpdateInput", - "description": "A single item to be updated.", - "fields": null, - "inputFields": [ + }, { - "name": "cart_item_id", - "description": "Deprecated. Use `cart_item_uid` instead.", + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "defaultValue": null }, { - "name": "cart_item_uid", - "description": "The unique ID for a `CartItemInterface` object.", + "name": "postcode", + "description": "The ZIP or postal code of the billing or shipping address.", "type": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null }, "defaultValue": null }, { - "name": "customizable_options", - "description": "An array that defines customizable options for the product.", + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "defaultValue": null }, { - "name": "gift_message", - "description": "Gift message details for the cart item", + "name": "region", + "description": "A string that defines the state or province of the billing or shipping address.", "type": { - "kind": "INPUT_OBJECT", - "name": "GiftMessageInput", + "kind": "SCALAR", + "name": "String", "ofType": null }, "defaultValue": null }, { - "name": "gift_wrapping_id", - "description": "The unique ID for a `GiftWrapping` object to be used for the cart item.", + "name": "region_id", + "description": "An integer that defines the state or province of the billing or shipping address.", "type": { "kind": "SCALAR", - "name": "ID", + "name": "Int", "ofType": null }, "defaultValue": null }, { - "name": "quantity", - "description": "The new quantity of the item.", + "name": "save_in_address_book", + "description": "Determines whether to save the address in the customer's address book. The default value is true.", "type": { "kind": "SCALAR", - "name": "Float", + "name": "Boolean", "ofType": null }, "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RemoveItemFromCartInput", - "description": "Specifies which items to remove from the cart.", - "fields": null, - "inputFields": [ + }, { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", + "name": "street", + "description": "An array containing the street for the billing or shipping address.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } } }, "defaultValue": null }, { - "name": "cart_item_id", - "description": "Deprecated. Use `cart_item_uid` instead.", + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "defaultValue": null }, { - "name": "cart_item_uid", - "description": "Required field. The unique ID for a `CartItemInterface` object.", + "name": "telephone", + "description": "The telephone number for the billing or shipping address.", "type": { "kind": "SCALAR", - "name": "ID", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "vat_id", + "description": "The VAT company number for billing or shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", "ofType": null }, "defaultValue": null @@ -24485,8 +24380,8 @@ }, { "kind": "INPUT_OBJECT", - "name": "SetShippingAddressesOnCartInput", - "description": "Specifies an array of addresses to use for shipping.", + "name": "SetShippingMethodsOnCartInput", + "description": "Applies one or shipping methods to the cart.", "fields": null, "inputFields": [ { @@ -24504,8 +24399,8 @@ "defaultValue": null }, { - "name": "shipping_addresses", - "description": "An array of shipping addresses.", + "name": "shipping_methods", + "description": "An array of shipping methods.", "type": { "kind": "NON_NULL", "name": null, @@ -24514,7 +24409,7 @@ "name": null, "ofType": { "kind": "INPUT_OBJECT", - "name": "ShippingAddressInput", + "name": "ShippingMethodInput", "ofType": null } } @@ -24528,57 +24423,35 @@ }, { "kind": "INPUT_OBJECT", - "name": "ShippingAddressInput", - "description": "Defines a single shipping address.", + "name": "ShippingMethodInput", + "description": "Defines the shipping carrier and method.", "fields": null, "inputFields": [ { - "name": "address", - "description": "Defines a shipping address.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CartAddressInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "customer_address_id", - "description": "An ID from the customer's address book that uniquely identifies the address to be used for shipping.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "customer_address_uid", - "description": "The unique ID from the customer's address book that uniquely identifies the address to be used for shipping.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "customer_notes", - "description": "Text provided by the shopper.", + "name": "carrier_code", + "description": "A string that identifies a commercial carrier or an offline delivery method.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "defaultValue": null }, { - "name": "pickup_location_code", - "description": "The code of Pickup Location which will be used for In-Store Pickup.", + "name": "method_code", + "description": "A string that indicates which service a commercial carrier will use to ship items. For offline delivery methods, this value is similar to the label displayed on the checkout page.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "defaultValue": null } @@ -24589,414 +24462,19 @@ }, { "kind": "INPUT_OBJECT", - "name": "SetBillingAddressOnCartInput", - "description": "Sets the billing address.", + "name": "SetPaymentMethodAndPlaceOrderInput", + "description": "Applies a payment method to the quote.", "fields": null, "inputFields": [ { - "name": "billing_address", - "description": "The billing address.", + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "BillingAddressInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "BillingAddressInput", - "description": "Defines the billing address.", - "fields": null, - "inputFields": [ - { - "name": "address", - "description": "Defines a billing address.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CartAddressInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "customer_address_id", - "description": "An ID from the customer's address book that uniquely identifies the address to be used for billing.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "customer_address_uid", - "description": "The unique ID from the customer's address book that uniquely identifies the address to be used for billing.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "same_as_shipping", - "description": "Indicates whether to set the billing address to be the same as the existing shipping address on the cart.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "use_for_shipping", - "description": "Indicates whether to set the shipping address to be the same as this billing address.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CartAddressInput", - "description": "Defines the billing or shipping address to be applied to the cart.", - "fields": null, - "inputFields": [ - { - "name": "city", - "description": "The city specified for the billing or shipping address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "company", - "description": "The company specified for the billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "country_code", - "description": "The country code and label for the billing or shipping address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "custom_attributes", - "description": "The custom attribute values of the billing or shipping address.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "AttributeValueInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "fax", - "description": "The customer's fax number.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "firstname", - "description": "The first name of the customer or guest.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "lastname", - "description": "The last name of the customer or guest.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "middlename", - "description": "The middle name of the person associated with the billing/shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "postcode", - "description": "The ZIP or postal code of the billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "prefix", - "description": "An honorific, such as Dr., Mr., or Mrs.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "region", - "description": "A string that defines the state or province of the billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "region_id", - "description": "An integer that defines the state or province of the billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "save_in_address_book", - "description": "Determines whether to save the address in the customer's address book. The default value is true.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "street", - "description": "An array containing the street for the billing or shipping address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "suffix", - "description": "A value such as Sr., Jr., or III.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "telephone", - "description": "The telephone number for the billing or shipping address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "vat_id", - "description": "The VAT company number for billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SetShippingMethodsOnCartInput", - "description": "Applies one or shipping methods to the cart.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "shipping_methods", - "description": "An array of shipping methods.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "ShippingMethodInput", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ShippingMethodInput", - "description": "Defines the shipping carrier and method.", - "fields": null, - "inputFields": [ - { - "name": "carrier_code", - "description": "A string that identifies a commercial carrier or an offline delivery method.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "method_code", - "description": "A string that indicates which service a commercial carrier will use to ship items. For offline delivery methods, this value is similar to the label displayed on the checkout page.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SetPaymentMethodAndPlaceOrderInput", - "description": "Applies a payment method to the quote.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "SCALAR", + "name": "String", "ofType": null } }, @@ -25245,16 +24723,6 @@ }, "defaultValue": null }, - { - "name": "payment_services_paypal_fastlane", - "description": "Required input for fastlane", - "type": { - "kind": "INPUT_OBJECT", - "name": "FastlaneMethodInput", - "ofType": null - }, - "defaultValue": null - }, { "name": "payment_services_paypal_google_pay", "description": "Required input for Google Pay button", @@ -25744,12 +25212,16 @@ "description": "An array of place order errors.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "PlaceOrderError", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PlaceOrderError", + "ofType": null + } } }, "isDeprecated": false, @@ -25828,47 +25300,6 @@ "enumValues": null, "possibleTypes": null }, - { - "kind": "ENUM", - "name": "PlaceOrderErrorCodes", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "CART_NOT_FOUND", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "CART_NOT_ACTIVE", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "GUEST_EMAIL_MISSING", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "UNABLE_TO_PLACE_ORDER", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "UNDEFINED", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, { "kind": "OBJECT", "name": "Cart", @@ -26170,7 +25601,7 @@ "name": null, "ofType": { "kind": "OBJECT", - "name": "CartRuleStorefront", + "name": "CartRule", "ofType": null } }, @@ -26359,18 +25790,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "customer_address_uid", - "description": "The unique ID from the customer's address book that uniquely identifies the address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "fax", "description": "The customer's fax number.", @@ -26408,8 +25827,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `customer_address_uid` instead." + "isDeprecated": false, + "deprecationReason": null }, { "name": "lastname", @@ -26521,14 +25940,14 @@ }, { "name": "uid", - "description": "The unique id of the customer cart address.", + "description": "The unique id of the customer address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, @@ -26681,18 +26100,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "customer_address_uid", - "description": "The unique ID from the customer's address book that uniquely identifies the address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "customer_notes", "description": "Text provided by the shopper.", @@ -26742,8 +26149,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `customer_address_uid` instead." + "isDeprecated": false, + "deprecationReason": null }, { "name": "items_weight", @@ -26907,14 +26314,14 @@ }, { "name": "uid", - "description": "The unique id of the customer cart address.", + "description": "The unique id of the customer address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, @@ -27014,18 +26421,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "customer_address_uid", - "description": "The unique ID from the customer's address book that uniquely identifies the address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "customer_notes", "description": null, @@ -27075,8 +26470,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `customer_address_uid` instead." + "isDeprecated": false, + "deprecationReason": null }, { "name": "lastname", @@ -27188,14 +26583,14 @@ }, { "name": "uid", - "description": "The unique id of the customer cart address.", + "description": "The unique id of the customer address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, @@ -29458,6 +28853,47 @@ ], "possibleTypes": null }, + { + "kind": "ENUM", + "name": "PlaceOrderErrorCodes", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CART_NOT_FOUND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CART_NOT_ACTIVE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GUEST_EMAIL_MISSING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNABLE_TO_PLACE_ORDER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "ENUM", "name": "ProductImageThumbnail", @@ -29740,6 +29176,35 @@ ], "possibleTypes": null }, + { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "description": "This enumeration defines the entity type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CMS_PAGE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATEGORY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "ConfirmEmailInput", @@ -30883,11 +30348,11 @@ }, { "name": "group", - "description": "Customer group assigned to the customer", + "description": "Name of the customer group assigned to the customer", "args": [], "type": { "kind": "OBJECT", - "name": "CustomerGroupStorefront", + "name": "CustomerGroup", "ofType": null }, "isDeprecated": false, @@ -30907,19 +30372,15 @@ }, { "name": "id", - "description": "The unique ID assigned to the customer.", + "description": "The ID assigned to the customer.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "`id` is not needed as part of `Customer`, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side." }, { "name": "is_subscribed", @@ -31375,7 +30836,7 @@ "name": null, "ofType": { "kind": "OBJECT", - "name": "CustomerSegmentStorefront", + "name": "CustomerSegment", "ofType": null } }, @@ -31804,8 +31265,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." + "isDeprecated": false, + "deprecationReason": null }, { "name": "lastname", @@ -31919,18 +31380,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "uid", - "description": "The unique ID for a `CustomerAddress` object.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "vat_id", "description": "The customer's Value-added tax (VAT) number (for corporate customers).", @@ -33902,21 +33351,17 @@ }, { "kind": "OBJECT", - "name": "CustomerGroupStorefront", + "name": "CustomerGroup", "description": "Data of customer group.", "fields": [ { - "name": "uid", - "description": "The unique ID for a `CustomerGroup` object.", + "name": "name", + "description": "The name of customer group.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null @@ -38605,6 +38050,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "rules", + "description": "Provides applied catalog rules in the current active cart", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CatalogRule", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "sale", "description": null, @@ -41960,13 +41421,13 @@ }, { "kind": "INPUT_OBJECT", - "name": "ApplyStoreCreditToCartInput", - "description": "Defines the input required to run the `applyStoreCreditToCart` mutation.", + "name": "AddBundleProductsToCartInput", + "description": "Defines the bundle products to add to the cart.", "fields": null, "inputFields": [ { "name": "cart_id", - "description": "The unique ID that identifies the customer's cart.", + "description": "The ID of the cart.", "type": { "kind": "NON_NULL", "name": null, @@ -41977,6 +41438,24 @@ } }, "defaultValue": null + }, + { + "name": "cart_items", + "description": "An array of bundle products to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "BundleProductCartItemInput", + "ofType": null + } + } + }, + "defaultValue": null } ], "interfaces": null, @@ -41984,51 +41463,113 @@ "possibleTypes": null }, { - "kind": "OBJECT", - "name": "ApplyStoreCreditToCartOutput", - "description": "Defines the possible output for the `applyStoreCreditToCart` mutation.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "BundleProductCartItemInput", + "description": "Defines a single bundle product.", + "fields": null, + "inputFields": [ { - "name": "cart", - "description": "The contents of the specified shopping cart.", - "args": [], + "name": "bundle_options", + "description": "A mandatory array of options for the bundle product, including each chosen option and specified quantity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Cart", + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "BundleOptionInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "customizable_options", + "description": "The ID and value of the option.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null + }, + { + "name": "data", + "description": "The quantity and SKU of the bundle product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "ofType": null + } + }, + "defaultValue": null } ], - "inputFields": null, - "interfaces": [], + "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", - "name": "RemoveStoreCreditFromCartInput", - "description": "Defines the input required to run the `removeStoreCreditFromCart` mutation.", + "name": "BundleOptionInput", + "description": "Defines the input for a bundle option.", "fields": null, "inputFields": [ { - "name": "cart_id", - "description": "The unique ID that identifies the customer's cart.", + "name": "id", + "description": "The ID of the option.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null } }, "defaultValue": null + }, + { + "name": "quantity", + "description": "The number of the selected item to add to the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "An array with the chosen value of the option.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null } ], "interfaces": null, @@ -42037,12 +41578,12 @@ }, { "kind": "OBJECT", - "name": "RemoveStoreCreditFromCartOutput", - "description": "Defines the possible output for the `removeStoreCreditFromCart` mutation.", + "name": "AddBundleProductsToCartOutput", + "description": "Contains details about the cart after adding bundle products.", "fields": [ { "name": "cart", - "description": "The contents of the specified shopping cart.", + "description": "The cart after adding products.", "args": [], "type": { "kind": "NON_NULL", @@ -42064,134 +41605,95 @@ }, { "kind": "OBJECT", - "name": "AppliedStoreCredit", - "description": "Contains the applied and current balances.", + "name": "BundleCartItem", + "description": "An implementation for bundle product cart items.", "fields": [ { - "name": "applied_balance", - "description": "The applied store credit balance to the current cart.", + "name": "available_gift_wrapping", + "description": "The list of available gift wrapping options for the cart item.", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + } + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "current_balance", - "description": "The current balance remaining on store credit.", + "name": "bundle_options", + "description": "An array containing the bundle options the shopper selected.", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedBundleOption", + "ofType": null + } + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "enabled", - "description": "Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned.", + "name": "customizable_options", + "description": "An array containing the customizable options the shopper selected.", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerStoreCredit", - "description": "Contains store credit information with balance and history.", - "fields": [ - { - "name": "balance_history", - "description": "Contains the customer's store credit balance history. If the history or store credit feature is disabled, then a null value will be returned.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. This value is optional. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", "ofType": null - }, - "defaultValue": "1" + } } - ], - "type": { - "kind": "OBJECT", - "name": "CustomerStoreCreditHistory", - "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "current_balance", - "description": "The current balance of store credit.", + "name": "discount", + "description": "Contains discount for quote line item.", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "enabled", - "description": "Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerStoreCreditHistory", - "description": "Lists changes to the amount of store credit available to the customer.", - "fields": [ - { - "name": "items", - "description": "An array containing information about changes to the store credit available to the customer.", + "name": "errors", + "description": "An array of errors encountered while loading the cart item", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "CustomerStoreCreditHistoryItem", + "name": "CartItemError", "ofType": null } }, @@ -42199,79 +41701,88 @@ "deprecationReason": null }, { - "name": "page_info", - "description": "Metadata for pagination rendering.", + "name": "gift_message", + "description": "The entered gift message for the cart item", "args": [], "type": { "kind": "OBJECT", - "name": "SearchResultPageInfo", + "name": "GiftMessage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "total_count", - "description": "The number of items returned.", + "name": "gift_wrapping", + "description": "The selected gift wrapping for the cart item.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "GiftWrapping", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerStoreCreditHistoryItem", - "description": "Contains store credit history information.", - "fields": [ + }, { - "name": "action", - "description": "The action that was made on the store credit.", + "name": "id", + "description": null, "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "is_available", + "description": "True if requested quantity is less than available stock, false otherwise.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "actual_balance", - "description": "The store credit available to the customer as a result of this action. ", + "name": "max_qty", + "description": "Line item max qty in quote template", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "balance_change", - "description": "The amount added to or subtracted from the store credit as a result of this action.", + "name": "min_qty", + "description": "Line item min qty in quote template", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "date_time_changed", - "description": "The date and time when the store credit change was made.", + "name": "not_available_message", + "description": "Message to display when the product is not available with this selected option.", "args": [], "type": { "kind": "SCALAR", @@ -42280,28 +41791,17 @@ }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "OrderTotal", - "description": "Contains details about the sales total amounts used to calculate the final price.", - "fields": [ + }, { - "name": "base_grand_total", - "description": "The final base grand total amount in the base currency.", + "name": "note_from_buyer", + "description": "The buyer's quote line item note.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "Money", + "name": "ItemNote", "ofType": null } }, @@ -42309,15 +41809,15 @@ "deprecationReason": null }, { - "name": "discounts", - "description": "The applied discounts to the order.", + "name": "note_from_seller", + "description": "The seller's quote line item note.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "Discount", + "name": "ItemNote", "ofType": null } }, @@ -42325,27 +41825,27 @@ "deprecationReason": null }, { - "name": "gift_options", - "description": null, + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", "args": [], "type": { "kind": "OBJECT", - "name": "GiftOptionsPrices", + "name": "CartItemPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "grand_total", - "description": "The final total amount, including shipping, discounts, and taxes.", + "name": "product", + "description": "Details about an item in the cart.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null } }, @@ -42353,15 +41853,15 @@ "deprecationReason": null }, { - "name": "grand_total_excl_tax", - "description": "The grand total of the order, excluding taxes.", + "name": "quantity", + "description": "The quantity of this item in the cart.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "Float", "ofType": null } }, @@ -42369,59 +41869,64 @@ "deprecationReason": null }, { - "name": "shipping_handling", - "description": "Details about the shipping and handling costs for the order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ShippingHandling", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "subtotal", - "description": "The subtotal of the order, excluding shipping, discounts, and taxes.", + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, - "isDeprecated": true, - "deprecationReason": "Use subtotal_excl_tax field instead" - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ { - "name": "subtotal_excl_tax", - "description": "The subtotal of the order, excluding taxes.", + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SelectedBundleOption", + "description": "Contains details about a selected bundle option.", + "fields": [ + { + "name": "id", + "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "Int", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" }, { - "name": "subtotal_incl_tax", - "description": "The subtotal of the order, including taxes.", + "name": "label", + "description": "The display name of the selected bundle product option.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "String", "ofType": null } }, @@ -42429,15 +41934,15 @@ "deprecationReason": null }, { - "name": "taxes", - "description": "The order tax details.", + "name": "type", + "description": "The type of selected bundle product option.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "TaxItem", + "kind": "SCALAR", + "name": "String", "ofType": null } }, @@ -42445,39 +41950,15 @@ "deprecationReason": null }, { - "name": "total_giftcard", - "description": "The gift card balance applied to the order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_reward_points", - "description": "The total reward points applied to the order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_shipping", - "description": "The shipping amount for the order.", + "name": "uid", + "description": "The unique ID for a `SelectedBundleOption` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, @@ -42485,28 +41966,20 @@ "deprecationReason": null }, { - "name": "total_store_credit", - "description": "The total store credit applied to the order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_tax", - "description": "The amount of tax applied to the order.", + "name": "values", + "description": "An array of selected bundle option values.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedBundleOptionValue", + "ofType": null + } } }, "isDeprecated": false, @@ -42520,19 +41993,19 @@ }, { "kind": "OBJECT", - "name": "OrderAddress", - "description": "Contains detailed information about an order's billing and shipping addresses.", + "name": "SelectedBundleOptionValue", + "description": "Contains details about a value for a selected bundle option.", "fields": [ { - "name": "city", - "description": "The city or town.", + "name": "id", + "description": "Use `uid` instead", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null } }, @@ -42540,90 +42013,79 @@ "deprecationReason": null }, { - "name": "company", - "description": "The customer's company.", + "name": "label", + "description": "The display name of the value for the selected bundle product option.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "country_code", - "description": "The customer's country.", + "name": "original_price", + "description": "The original price of the value for the selected bundle product option.", "args": [], "type": { - "kind": "ENUM", - "name": "CountryCodeEnum", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "custom_attributesV2", - "description": "Custom attributes assigned to the customer address.", - "args": [ - { - "name": "attributeCodes", - "description": "", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - } - ], + "name": "price", + "description": "The price of the value for the selected bundle product option.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "AttributeValueInterface", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use priceV2 instead." }, { - "name": "fax", - "description": "The fax number.", + "name": "priceV2", + "description": "The price of the value for the selected bundle product option.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "firstname", - "description": "The first name of the person associated with the shipping/billing address.", + "name": "quantity", + "description": "The quantity of the value for the selected bundle product option.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null } }, @@ -42631,116 +42093,150 @@ "deprecationReason": null }, { - "name": "lastname", - "description": "The family name of the person associated with the shipping/billing address.", + "name": "uid", + "description": "The unique ID for a `SelectedBundleOptionValue` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceDetails", + "description": "Can be used to retrieve the main price details in case of bundle product", + "fields": [ { - "name": "middlename", - "description": "The middle name of the person associated with the shipping/billing address.", + "name": "discount_percentage", + "description": "The percentage of discount applied to the main product price", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "postcode", - "description": "The customer's ZIP or postal code.", + "name": "main_final_price", + "description": "The final price after applying the discount to the main product", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "prefix", - "description": "An honorific, such as Dr., Mr., or Mrs.", + "name": "main_price", + "description": "The regular price of the main product", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleItem", + "description": "Defines an individual item within a bundle product.", + "fields": [ { - "name": "region", - "description": "The state or province name.", + "name": "option_id", + "description": "An ID assigned to each type of item in a bundle product.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "options", + "description": "An array of additional options for this bundle item.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BundleItemOption", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null }, { - "name": "region_id", - "description": "The unique ID for a `Region` object of a pre-defined region.", + "name": "position", + "description": "A number indicating the sequence order of this item compared to the other bundle items.", "args": [], "type": { "kind": "SCALAR", - "name": "ID", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "street", - "description": "An array of strings that define the street number and name.", + "name": "price_range", + "description": "The range of prices for the product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "OBJECT", + "name": "PriceRange", + "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "suffix", - "description": "A value such as Sr., Jr., or III.", + "name": "required", + "description": "Indicates whether the item must be included in the bundle.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "telephone", - "description": "The telephone number.", + "name": "sku", + "description": "The SKU of the bundle product.", "args": [], "type": { "kind": "SCALAR", @@ -42751,8 +42247,8 @@ "deprecationReason": null }, { - "name": "vat_id", - "description": "The customer's Value-added tax (VAT) number (for corporate customers).", + "name": "title", + "description": "The display name of the item.", "args": [], "type": { "kind": "SCALAR", @@ -42761,151 +42257,27 @@ }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddDownloadableProductsToCartInput", - "description": "", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The ID of the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cart_items", - "description": "An array of downloadable products to add.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "DownloadableProductCartItemInput", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "DownloadableProductCartItemInput", - "description": "Defines a single downloadable product.", - "fields": null, - "inputFields": [ - { - "name": "customizable_options", - "description": "The ID and value of the option.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", - "ofType": null - } - }, - "defaultValue": null }, { - "name": "data", - "description": "The quantity and SKU of the downloadable product.", + "name": "type", + "description": "The input type that the customer uses to select the item. Examples include radio button and checkbox.", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "downloadable_product_links", - "description": "An array of objects containing the link_id of the downloadable product link.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "DownloadableProductLinksInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "DownloadableProductLinksInput", - "description": "Contains the link ID for the downloadable product.", - "fields": null, - "inputFields": [ - { - "name": "link_id", - "description": "The unique ID of the downloadable product link.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddDownloadableProductsToCartOutput", - "description": "Contains details about the cart after adding downloadable products.", - "fields": [ - { - "name": "cart", - "description": "The cart after adding products.", + "name": "uid", + "description": "The unique ID for a `BundleItem` object.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } + "kind": "SCALAR", + "name": "ID", + "ofType": null }, "isDeprecated": false, "deprecationReason": null @@ -42918,136 +42290,48 @@ }, { "kind": "OBJECT", - "name": "DownloadableCartItem", - "description": "An implementation for downloadable product cart items.", + "name": "BundleItemOption", + "description": "Defines the characteristics that comprise a specific bundle item and its options.", "fields": [ { - "name": "customizable_options", - "description": "An array containing the customizable options the shopper selected.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discount", - "description": "Contains discount for quote line item.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "errors", - "description": "An array of errors encountered while loading the cart item", + "name": "can_change_quantity", + "description": "Indicates whether the customer can change the number of items for this option.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartItemError", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "is_available", - "description": "True if requested quantity is less than available stock, false otherwise.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "links", - "description": "An array containing information about the links for the downloadable product added to the cart.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductLinks", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "max_qty", - "description": "Line item max qty in quote template", + "description": "The ID assigned to the bundled item option.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" }, { - "name": "min_qty", - "description": "Line item min qty in quote template", + "name": "is_default", + "description": "Indicates whether this option is the default option.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "not_available_message", - "description": "Message to display when the product is not available with this selected option.", + "name": "label", + "description": "The text that identifies the bundled item option.", "args": [], "type": { "kind": "SCALAR", @@ -43058,44 +42342,36 @@ "deprecationReason": null }, { - "name": "note_from_buyer", - "description": "The buyer's quote line item note.", + "name": "position", + "description": "When a bundle item contains multiple options, the relative position of this option compared to the other options.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "note_from_seller", - "description": "The seller's quote line item note.", + "name": "price", + "description": "The price of the selected option.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", + "name": "price_type", + "description": "One of FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { - "kind": "OBJECT", - "name": "CartItemPrices", + "kind": "ENUM", + "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, @@ -43103,55 +42379,43 @@ }, { "name": "product", - "description": "Details about an item in the cart.", + "description": "Contains details about this product option.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "quantity", - "description": "The quantity of this item in the cart.", + "name": "qty", + "description": "Indicates the quantity of this specific bundle item.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `quantity` instead." }, { - "name": "samples", - "description": "An array containing information about samples of the selected downloadable product.", + "name": "quantity", + "description": "The quantity of this specific bundle item.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductSamples", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", + "description": "The unique ID for a `BundleItemOption` object.", "args": [], "type": { "kind": "NON_NULL", @@ -43167,20 +42431,14 @@ } ], "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CartItemInterface", - "ofType": null - } - ], + "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "DownloadableProduct", - "description": "Defines a product that the shopper downloads.", + "name": "BundleProduct", + "description": "Defines basic features of a bundle product and contains multiple BundleItems.", "fields": [ { "name": "activity", @@ -43358,33 +42616,37 @@ "deprecationReason": null }, { - "name": "downloadable_product_links", - "description": "An array containing information about the links for this downloadable product.", + "name": "dynamic_price", + "description": "Indicates whether the bundle product has a dynamic price.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductLinks", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "downloadable_product_samples", - "description": "An array containing information about samples of this downloadable product.", + "name": "dynamic_sku", + "description": "Indicates whether the bundle product has a dynamic SKU.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductSamples", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dynamic_weight", + "description": "Indicates whether the bundle product has a dynamically calculated weight.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "isDeprecated": false, "deprecationReason": null @@ -43530,36 +42792,28 @@ "deprecationReason": null }, { - "name": "links_purchased_separately", - "description": "A value of 1 indicates that each link in the array must be purchased separately.", + "name": "items", + "description": "An array containing information about individual bundle items.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BundleItem", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "links_title", - "description": "The heading above the list of downloadable products.", + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", "args": [], "type": { "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", + "name": "Int", "ofType": null }, "isDeprecated": true, @@ -43793,6 +43047,18 @@ "isDeprecated": true, "deprecationReason": "Use `price_range` for product price information." }, + { + "name": "price_details", + "description": "The price details of the main product", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceDetails", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "price_range", "description": "The range of prices for the product", @@ -43825,6 +43091,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "price_view", + "description": "One of PRICE_RANGE or AS_LOW_AS.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceViewEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "product_links", "description": "An array of `ProductLinks` objects.", @@ -43978,6 +43256,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "rules", + "description": "Provides applied catalog rules in the current active cart", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CatalogRule", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "sale", "description": null, @@ -43990,6 +43284,18 @@ "isDeprecated": true, "deprecationReason": "Use the `custom_attributes` field instead." }, + { + "name": "ship_bundle_items", + "description": "Indicates whether to ship bundle items together or individually.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ShipBundleItemsEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", @@ -44349,6 +43655,18 @@ }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "weight", + "description": "The weight of the item, in units defined by the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -44363,6 +43681,11 @@ "name": "RoutableInterface", "ofType": null }, + { + "kind": "INTERFACE", + "name": "PhysicalProductInterface", + "ofType": null + }, { "kind": "INTERFACE", "name": "CustomizableProductInterface", @@ -44374,272 +43697,65 @@ }, { "kind": "ENUM", - "name": "DownloadableFileTypeEnum", - "description": "", + "name": "PriceViewEnum", + "description": "Defines whether a bundle product's price is displayed as the lowest possible value or as a range.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { - "name": "FILE", - "description": "", - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - }, - { - "name": "URL", + "name": "PRICE_RANGE", "description": "", - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableProductLinks", - "description": "Defines characteristics of a downloadable product.", - "fields": [ - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "This information should not be exposed on frontend." - }, - { - "name": "is_shareable", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "This information should not be exposed on frontend." - }, - { - "name": "link_type", - "description": null, - "args": [], - "type": { - "kind": "ENUM", - "name": "DownloadableFileTypeEnum", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - }, - { - "name": "number_of_downloads", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "This information should not be exposed on frontend." - }, - { - "name": "price", - "description": "The price of the downloadable product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sample_file", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - }, - { - "name": "sample_type", - "description": null, - "args": [], - "type": { - "kind": "ENUM", - "name": "DownloadableFileTypeEnum", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - }, - { - "name": "sample_url", - "description": "The full URL to the downloadable sample.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "A number indicating the sort order.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name of the link.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `DownloadableProductLinks` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, + "name": "AS_LOW_AS", + "description": "", "isDeprecated": false, "deprecationReason": null } ], - "inputFields": null, - "interfaces": [], - "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "DownloadableProductSamples", - "description": "Defines characteristics of a downloadable product.", - "fields": [ - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "This information should not be exposed on frontend." - }, - { - "name": "sample_file", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - }, - { - "name": "sample_type", - "description": null, - "args": [], - "type": { - "kind": "ENUM", - "name": "DownloadableFileTypeEnum", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - }, - { - "name": "sample_url", - "description": "The full URL to the downloadable sample.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, + "kind": "ENUM", + "name": "ShipBundleItemsEnum", + "description": "Defines whether bundle items must be shipped together.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ { - "name": "sort_order", - "description": "A number indicating the sort order.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, + "name": "TOGETHER", + "description": "", "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name of the sample.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, + "name": "SEPARATELY", + "description": "", "isDeprecated": false, "deprecationReason": null } ], - "inputFields": null, - "interfaces": [], - "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "DownloadableOrderItem", - "description": "Defines downloadable product options for `OrderItemInterface`.", + "name": "BundleOrderItem", + "description": "Defines bundle product options for `OrderItemInterface`.", "fields": [ { - "name": "discounts", - "description": "The final discount information for the product.", + "name": "bundle_options", + "description": "A list of bundle options that are assigned to the bundle product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "Discount", + "name": "ItemSelectedBundleOption", "ofType": null } }, @@ -44647,15 +43763,15 @@ "deprecationReason": null }, { - "name": "downloadable_links", - "description": "A list of downloadable links that are ordered from the downloadable product.", + "name": "discounts", + "description": "The final discount information for the product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "DownloadableItemsLinks", + "name": "Discount", "ofType": null } }, @@ -44730,6 +43846,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "parent_sku", + "description": "The SKU of parent product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "prices", "description": "Contains details about the price of the item, including taxes and discounts.", @@ -44948,19 +44076,19 @@ }, { "kind": "OBJECT", - "name": "DownloadableInvoiceItem", - "description": "Defines downloadable product options for `InvoiceItemInterface`.", + "name": "BundleInvoiceItem", + "description": "Defines bundle product options for `InvoiceItemInterface`.", "fields": [ { - "name": "discounts", - "description": "Information about the final discount amount for the base product, including discounts on options.", + "name": "bundle_options", + "description": "A list of bundle options that are assigned to an invoiced bundle product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "Discount", + "name": "ItemSelectedBundleOption", "ofType": null } }, @@ -44968,15 +44096,15 @@ "deprecationReason": null }, { - "name": "downloadable_links", - "description": "A list of downloadable links that are invoiced from the downloadable product.", + "name": "discounts", + "description": "Information about the final discount amount for the base product, including discounts on options.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "DownloadableItemsLinks", + "name": "Discount", "ofType": null } }, @@ -45081,35 +44209,19 @@ }, { "kind": "OBJECT", - "name": "DownloadableCreditMemoItem", - "description": "Defines downloadable product options for `CreditMemoItemInterface`.", + "name": "BundleShipmentItem", + "description": "Defines bundle product options for `ShipmentItemInterface`.", "fields": [ { - "name": "discounts", - "description": "Details about the final discount amount for the base product, including discounts on options.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "downloadable_links", - "description": "A list of downloadable links that are refunded from the downloadable product.", + "name": "bundle_options", + "description": "A list of bundle options that are assigned to a shipped product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "DownloadableItemsLinks", + "name": "ItemSelectedBundleOption", "ofType": null } }, @@ -45118,7 +44230,7 @@ }, { "name": "id", - "description": "The unique ID for a `CreditMemoItemInterface` object.", + "description": "The unique ID for a `ShipmentItemInterface` object.", "args": [], "type": { "kind": "NON_NULL", @@ -45134,7 +44246,7 @@ }, { "name": "order_item", - "description": "The order item the credit memo is applied to.", + "description": "The order item associated with the shipment item.", "args": [], "type": { "kind": "INTERFACE", @@ -45158,7 +44270,7 @@ }, { "name": "product_sale_price", - "description": "The sale price for the base product, including selected options.", + "description": "The sale price for the base product.", "args": [], "type": { "kind": "NON_NULL", @@ -45189,13 +44301,17 @@ "deprecationReason": null }, { - "name": "quantity_refunded", - "description": "The number of refunded items.", + "name": "quantity_shipped", + "description": "The number of shipped items.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null @@ -45205,7 +44321,7 @@ "interfaces": [ { "kind": "INTERFACE", - "name": "CreditMemoItemInterface", + "name": "ShipmentItemInterface", "ofType": null } ], @@ -45214,36 +44330,44 @@ }, { "kind": "OBJECT", - "name": "DownloadableItemsLinks", - "description": "Defines characteristics of the links for downloadable product.", + "name": "BundleCreditMemoItem", + "description": "Defines bundle product options for `CreditMemoItemInterface`.", "fields": [ { - "name": "sort_order", - "description": "A number indicating the sort order.", + "name": "bundle_options", + "description": "A list of bundle options that are assigned to a bundle product that is part of a credit memo.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemSelectedBundleOption", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name of the link.", + "name": "discounts", + "description": "Details about the final discount amount for the base product, including discounts on options.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `DownloadableItemsLinks` object.", + "name": "id", + "description": "The unique ID for a `CreditMemoItemInterface` object.", "args": [], "type": { "kind": "NON_NULL", @@ -45256,28 +44380,41 @@ }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableWishlistItem", - "description": "A downloadable product wish list item.", - "fields": [ + }, { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", + "name": "order_item", + "description": "The order item the credit memo is applied to.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product, including selected options.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "Money", "ofType": null } }, @@ -45285,40 +44422,53 @@ "deprecationReason": null }, { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", + "name": "product_sku", + "description": "The SKU of the base product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "description", - "description": "The description of the item.", + "name": "quantity_refunded", + "description": "The number of refunded items.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CreditMemoItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ItemSelectedBundleOption", + "description": "A list of options of the selected bundle product.", + "fields": [ { "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", + "description": "The unique ID for a `ItemSelectedBundleOption` object.", "args": [], "type": { "kind": "NON_NULL", @@ -45329,19 +44479,19 @@ "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." }, { - "name": "links_v2", - "description": "An array containing information about the selected links.", + "name": "label", + "description": "The label of the option.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductLinks", + "kind": "SCALAR", + "name": "String", "ofType": null } }, @@ -45349,27 +44499,15 @@ "deprecationReason": null }, { - "name": "product", - "description": "Product details of the wish list item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this wish list item.", + "name": "uid", + "description": "The unique ID for a `ItemSelectedBundleOption` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Float", + "name": "ID", "ofType": null } }, @@ -45377,15 +44515,15 @@ "deprecationReason": null }, { - "name": "samples", - "description": "An array containing information about the selected samples.", + "name": "values", + "description": "A list of products that represent the values of the parent option.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "DownloadableProductSamples", + "name": "ItemSelectedBundleOptionValue", "ofType": null } }, @@ -45394,31 +44532,41 @@ } ], "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null - } - ], + "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "Company", - "description": "Contains the output schema for a company.", + "name": "ItemSelectedBundleOptionValue", + "description": "A list of values for the selected bundle product.", "fields": [ { - "name": "acl_resources", - "description": "The list of all resources defined within the company.", + "name": "id", + "description": "The unique ID for a `ItemSelectedBundleOptionValue` object.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "price", + "description": "The price of the child bundle product.", + "args": [], + "type": { + "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", - "name": "CompanyAclResource", + "name": "Money", "ofType": null } }, @@ -45426,27 +44574,31 @@ "deprecationReason": null }, { - "name": "company_admin", - "description": "An object containing information about the company administrator.", + "name": "product_name", + "description": "The name of the child bundle product.", "args": [], "type": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "credit", - "description": "Company credit balances and limits.", + "name": "product_sku", + "description": "The SKU of the child bundle product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "CompanyCredit", + "kind": "SCALAR", + "name": "String", "ofType": null } }, @@ -45454,46 +44606,15 @@ "deprecationReason": null }, { - "name": "credit_history", - "description": "Details about the history of company credit operations.", - "args": [ - { - "name": "filter", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "CompanyCreditHistoryFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pageSize", - "description": "", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], + "name": "quantity", + "description": "The number of this bundle product that were ordered.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "CompanyCreditHistory", + "kind": "SCALAR", + "name": "Float", "ofType": null } }, @@ -45501,27 +44622,42 @@ "deprecationReason": null }, { - "name": "email", - "description": "The email address of the company contact.", + "name": "uid", + "description": "The unique ID for a `ItemSelectedBundleOptionValue` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleWishlistItem", + "description": "Defines bundle product options for `WishlistItemInterface`.", + "fields": [ { - "name": "id", - "description": "The unique ID of a `Company` object.", + "name": "added_at", + "description": "The date and time the item was added to the wish list.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, @@ -45529,32 +44665,44 @@ "deprecationReason": null }, { - "name": "legal_address", - "description": "The address where the company is registered to conduct business.", + "name": "bundle_options", + "description": "An array containing information about the selected bundle items.", "args": [], "type": { - "kind": "OBJECT", - "name": "CompanyLegalAddress", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedBundleOption", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "legal_name", - "description": "The full legal name of the company.", + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "name", - "description": "The name of the company.", + "name": "description", + "description": "The description of the item.", "args": [], "type": { "kind": "SCALAR", @@ -45565,15 +44713,15 @@ "deprecationReason": null }, { - "name": "payment_methods", - "description": "The list of payment methods available to a company.", + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -45581,197 +44729,208 @@ "deprecationReason": null }, { - "name": "reseller_id", - "description": "The resale number that is assigned to the company for tax reporting purposes.", + "name": "product", + "description": "Product details of the wish list item.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "role", - "description": "A company role filtered by the unique ID of a `CompanyRole` object.", - "args": [ - { - "name": "id", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], + "name": "quantity", + "description": "The quantity of this wish list item.", + "args": [], "type": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [ { - "name": "roles", - "description": "An object that contains a list of company roles.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ApplyStoreCreditToCartInput", + "description": "Defines the input required to run the `applyStoreCreditToCart` mutation.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID that identifies the customer's cart.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "CompanyRoles", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sales_representative", - "description": "An object containing information about the company sales representative.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CompanySalesRepresentative", - "ofType": null + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ApplyStoreCreditToCartOutput", + "description": "Defines the possible output for the `applyStoreCreditToCart` mutation.", + "fields": [ + { + "name": "cart", + "description": "The contents of the specified shopping cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RemoveStoreCreditFromCartInput", + "description": "Defines the input required to run the `removeStoreCreditFromCart` mutation.", + "fields": null, + "inputFields": [ { - "name": "structure", - "description": "The company structure of teams and customers in depth-first order.", - "args": [ - { - "name": "rootId", - "description": "The ID of the node in the company structure that serves as the root for the query.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "depth", - "description": "The maximum depth that can be reached when listing structure nodes.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "10" + "name": "cart_id", + "description": "The unique ID that identifies the customer's cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null } - ], + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RemoveStoreCreditFromCartOutput", + "description": "Defines the possible output for the `removeStoreCreditFromCart` mutation.", + "fields": [ + { + "name": "cart", + "description": "The contents of the specified shopping cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppliedStoreCredit", + "description": "Contains the applied and current balances.", + "fields": [ + { + "name": "applied_balance", + "description": "The applied store credit balance to the current cart.", + "args": [], "type": { "kind": "OBJECT", - "name": "CompanyStructure", + "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "team", - "description": "The company team data filtered by the unique ID for a `CompanyTeam` object.", - "args": [ - { - "name": "id", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], + "name": "current_balance", + "description": "The current balance remaining on store credit.", + "args": [], "type": { "kind": "OBJECT", - "name": "CompanyTeam", + "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "user", - "description": "A company user filtered by the unique ID of a `Customer` object.", - "args": [ - { - "name": "id", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], + "name": "enabled", + "description": "Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned.", + "args": [], "type": { - "kind": "OBJECT", - "name": "Customer", + "kind": "SCALAR", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerStoreCredit", + "description": "Contains store credit information with balance and history.", + "fields": [ { - "name": "users", - "description": "An object that contains a list of company users based on activity status.", + "name": "balance_history", + "description": "Contains the customer's store credit balance history. If the history or store credit feature is disabled, then a null value will be returned.", "args": [ - { - "name": "filter", - "description": "The type of company users to return.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CompanyUsersFilterInput", - "ofType": null - }, - "defaultValue": null - }, { "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", + "description": "The maximum number of results to return at once. The default is 20.", "type": { "kind": "SCALAR", "name": "Int", @@ -45781,7 +44940,7 @@ }, { "name": "currentPage", - "description": "The page of results to return. The default value is 1.", + "description": "The page of results to return. This value is optional. The default is 1.", "type": { "kind": "SCALAR", "name": "Int", @@ -45792,19 +44951,31 @@ ], "type": { "kind": "OBJECT", - "name": "CompanyUsers", + "name": "CustomerStoreCreditHistory", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "vat_tax_id", - "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", + "name": "current_balance", + "description": "The current balance of store credit.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "enabled", + "description": "Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Boolean", "ofType": null }, "isDeprecated": false, @@ -45818,36 +44989,63 @@ }, { "kind": "OBJECT", - "name": "CompanyLegalAddress", - "description": "Contains details about the address where the company is registered to conduct business.", + "name": "CustomerStoreCreditHistory", + "description": "Lists changes to the amount of store credit available to the customer.", "fields": [ { - "name": "city", - "description": "The city where the company is registered to conduct business.", + "name": "items", + "description": "An array containing information about changes to the store credit available to the customer.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerStoreCreditHistoryItem", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "country_code", - "description": "The country code of the company's legal address.", + "name": "page_info", + "description": "Metadata for pagination rendering.", "args": [], "type": { - "kind": "ENUM", - "name": "CountryCodeEnum", + "kind": "OBJECT", + "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "postcode", - "description": "The company's postal code.", + "name": "total_count", + "description": "The number of items returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerStoreCreditHistoryItem", + "description": "Contains store credit history information.", + "fields": [ + { + "name": "action", + "description": "The action that was made on the store credit.", "args": [], "type": { "kind": "SCALAR", @@ -45858,36 +45056,32 @@ "deprecationReason": null }, { - "name": "region", - "description": "An object containing region data for the company.", + "name": "actual_balance", + "description": "The store credit available to the customer as a result of this action. ", "args": [], "type": { "kind": "OBJECT", - "name": "CustomerAddressRegion", + "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "street", - "description": "An array of strings that define the company's street address.", + "name": "balance_change", + "description": "The amount added to or subtracted from the store credit as a result of this action.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "OBJECT", + "name": "Money", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "telephone", - "description": "The company's phone number.", + "name": "date_time_changed", + "description": "The date and time when the store credit change was made.", "args": [], "type": { "kind": "SCALAR", @@ -45905,55 +45099,63 @@ }, { "kind": "OBJECT", - "name": "CompanyAdmin", - "description": "Contains details about the company administrator.", + "name": "OrderTotal", + "description": "Contains details about the sales total amounts used to calculate the final price.", "fields": [ { - "name": "email", - "description": "The email address of the company administrator.", + "name": "base_grand_total", + "description": "The final base grand total amount in the base currency.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "firstname", - "description": "The company administrator's first name.", + "name": "discounts", + "description": "The applied discounts to the order.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "gender", - "description": "The company administrator's gender (Male - 1, Female - 2, Not Specified - 3).", + "name": "gift_options", + "description": null, "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "GiftOptionsPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The unique ID for a `CompanyAdmin` object.", + "name": "grand_total", + "description": "The final total amount, including shipping, discounts, and taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "OBJECT", + "name": "Money", "ofType": null } }, @@ -45961,129 +45163,143 @@ "deprecationReason": null }, { - "name": "job_title", - "description": "The job title of the company administrator.", + "name": "shipping_handling", + "description": "Details about the shipping and handling costs for the order.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "ShippingHandling", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "lastname", - "description": "The company administrator's last name.", + "name": "subtotal", + "description": "The subtotal of the order, excluding shipping, discounts, and taxes.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use subtotal_excl_tax field instead" + }, + { + "name": "subtotal_excl_tax", + "description": "The subtotal of the order, excluding taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanySalesRepresentative", - "description": "Contains details about a company sales representative.", - "fields": [ + }, { - "name": "email", - "description": "The email address of the company sales representative.", + "name": "subtotal_incl_tax", + "description": "The subtotal of the order, including taxes.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "firstname", - "description": "The company sales representative's first name.", + "name": "taxes", + "description": "The order tax details.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_giftcard", + "description": "The gift card balance applied to the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "lastname", - "description": "The company sales representative's last name.", + "name": "total_reward_points", + "description": "The total reward points applied to the order.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyUsers", - "description": "Contains details about company users.", - "fields": [ + }, { - "name": "items", - "description": "An array of `CompanyUser` objects that match the specified filter criteria.", + "name": "total_shipping", + "description": "The shipping amount for the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - } + "kind": "OBJECT", + "name": "Money", + "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "page_info", - "description": "Pagination metadata.", + "name": "total_store_credit", + "description": "The total store credit applied to the order.", "args": [], "type": { "kind": "OBJECT", - "name": "SearchResultPageInfo", + "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "total_count", - "description": "The number of objects returned.", + "name": "total_tax", + "description": "The amount of tax applied to the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "Money", "ofType": null } }, @@ -46098,78 +45314,126 @@ }, { "kind": "OBJECT", - "name": "CompanyRoles", - "description": "Contains an array of roles.", + "name": "OrderAddress", + "description": "Contains detailed information about an order's billing and shipping addresses.", "fields": [ { - "name": "items", - "description": "A list of company roles that match the specified filter criteria.", + "name": "city", + "description": "The city or town.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "page_info", - "description": "Pagination metadata.", + "name": "company", + "description": "The customer's company.", "args": [], "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "total_count", - "description": "The total number of objects matching the specified filter.", + "name": "country_code", + "description": "The customer's country.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", + "kind": "ENUM", + "name": "CountryCodeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributesV2", + "description": "Custom attributes assigned to the customer address.", + "args": [ + { + "name": "attributeCodes", + "description": "", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fax", + "description": "The fax number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": "The first name of the person associated with the shipping/billing address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyRole", - "description": "Contails details about a single role.", - "fields": [ + }, { - "name": "id", - "description": "The unique ID for a `CompanyRole` object.", + "name": "lastname", + "description": "The family name of the person associated with the shipping/billing address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, @@ -46177,8 +45441,8 @@ "deprecationReason": null }, { - "name": "name", - "description": "The name assigned to the role.", + "name": "middlename", + "description": "The middle name of the person associated with the shipping/billing address.", "args": [], "type": { "kind": "SCALAR", @@ -46189,91 +45453,100 @@ "deprecationReason": null }, { - "name": "permissions", - "description": "A list of permission resources defined for a role.", + "name": "postcode", + "description": "The customer's ZIP or postal code.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyAclResource", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "users_count", - "description": "The total number of users assigned the specified role.", + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyAclResource", - "description": "Contains details about the access control list settings of a resource.", - "fields": [ + }, { - "name": "children", - "description": "An array of sub-resources.", + "name": "region", + "description": "The state or province name.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyAclResource", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The unique ID for a `CompanyAclResource` object.", + "name": "region_id", + "description": "The unique ID for a `Region` object of a pre-defined region.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "An array of strings that define the street number and name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sort_order", - "description": "The sort order of an ACL resource.", + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "text", - "description": "The label assigned to the ACL resource.", + "name": "telephone", + "description": "The telephone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vat_id", + "description": "The customer's Value-added tax (VAT) number (for corporate customers).", "args": [], "type": { "kind": "SCALAR", @@ -46290,149 +45563,141 @@ "possibleTypes": null }, { - "kind": "OBJECT", - "name": "IsCompanyRoleNameAvailableOutput", - "description": "Contains the response of a role name validation query.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "AddDownloadableProductsToCartInput", + "description": "", + "fields": null, + "inputFields": [ { - "name": "is_role_name_available", - "description": "Indicates whether the specified company role name is available.", - "args": [], + "name": "cart_id", + "description": "The ID of the cart.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Boolean", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "IsCompanyUserEmailAvailableOutput", - "description": "Contains the response of a company user email validation query.", - "fields": [ + "defaultValue": null + }, { - "name": "is_email_available", - "description": "Indicates whether the specified email address can be used to create a company user.", - "args": [], + "name": "cart_items", + "description": "An array of downloadable products to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DownloadableProductCartItemInput", + "ofType": null + } } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null } ], - "inputFields": null, - "interfaces": [], + "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "IsCompanyAdminEmailAvailableOutput", - "description": "Contains the response of a company admin email validation query.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "DownloadableProductCartItemInput", + "description": "Defines a single downloadable product.", + "fields": null, + "inputFields": [ { - "name": "is_email_available", - "description": "Indicates whether the specified email address can be used to create a company administrator.", - "args": [], + "name": "customizable_options", + "description": "The ID and value of the option.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "data", + "description": "The quantity and SKU of the downloadable product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Boolean", + "kind": "INPUT_OBJECT", + "name": "CartItemInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null + }, + { + "name": "downloadable_product_links", + "description": "An array of objects containing the link_id of the downloadable product link.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DownloadableProductLinksInput", + "ofType": null + } + }, + "defaultValue": null } ], - "inputFields": null, - "interfaces": [], + "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "IsCompanyEmailAvailableOutput", - "description": "Contains the response of a company email validation query.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "DownloadableProductLinksInput", + "description": "Contains the link ID for the downloadable product.", + "fields": null, + "inputFields": [ { - "name": "is_email_available", - "description": "Indicates whether the specified email address can be used to create a company.", - "args": [], + "name": "link_id", + "description": "The unique ID of the downloadable product link.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Boolean", + "name": "Int", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null } ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "UNION", - "name": "CompanyStructureEntity", - "description": "", - "fields": null, - "inputFields": null, "interfaces": null, "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "CompanyTeam", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - } - ] + "possibleTypes": null }, { "kind": "OBJECT", - "name": "CompanyStructure", - "description": "Contains an array of the individual nodes that comprise the company structure.", + "name": "AddDownloadableProductsToCartOutput", + "description": "Contains details about the cart after adding downloadable products.", "fields": [ { - "name": "items", - "description": "An array of elements in a company structure.", + "name": "cart", + "description": "The cart after adding products.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", - "name": "CompanyStructureItem", + "name": "Cart", "ofType": null } }, @@ -46447,471 +45712,247 @@ }, { "kind": "OBJECT", - "name": "CompanyTeam", - "description": "Describes a company team.", + "name": "DownloadableCartItem", + "description": "An implementation for downloadable product cart items.", "fields": [ { - "name": "description", - "description": "An optional description of the team.", + "name": "customizable_options", + "description": "An array containing the customizable options the shopper selected.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The unique ID for a `CompanyTeam` object.", + "name": "discount", + "description": "Contains discount for quote line item.", "args": [], "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "name", - "description": "The display name of the team.", + "name": "errors", + "description": "An array of errors encountered while loading the cart item", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartItemError", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "structure_id", - "description": "ID of the company structure", + "name": "id", + "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyUsersFilterInput", - "description": "Defines the filter for returning a list of company users.", - "fields": null, - "inputFields": [ - { - "name": "status", - "description": "The activity status to filter on.", - "type": { - "kind": "ENUM", - "name": "CompanyUserStatusEnum", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CompanyUserStatusEnum", - "description": "Defines the list of company user status values.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "ACTIVE", - "description": "Only active users.", - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." }, { - "name": "INACTIVE", - "description": "Only inactive users.", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateCompanyTeamOutput", - "description": "Contains the response to the request to create a company team.", - "fields": [ - { - "name": "team", - "description": "The new company team instance.", + "name": "is_available", + "description": "True if requested quantity is less than available stock, false otherwise.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "CompanyTeam", + "kind": "SCALAR", + "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyTeamOutput", - "description": "Contains the response to the request to update a company team.", - "fields": [ + }, { - "name": "team", - "description": "The updated company team instance.", + "name": "links", + "description": "An array containing information about the links for the downloadable product added to the cart.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "CompanyTeam", + "name": "DownloadableProductLinks", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeleteCompanyTeamOutput", - "description": "Contains the status of the request to delete a company team.", - "fields": [ + }, { - "name": "success", - "description": "Indicates whether the delete operation succeeded.", + "name": "max_qty", + "description": "Line item max qty in quote template", "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyTeamCreateInput", - "description": "Defines the input schema for creating a company team.", - "fields": null, - "inputFields": [ - { - "name": "description", - "description": "An optional description of the team.", "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, - "defaultValue": null - }, - { - "name": "name", - "description": "The display name of the team.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "target_id", - "description": "The ID of a node within a company's structure. This ID will be the parent of the created team.", + "name": "min_qty", + "description": "Line item min qty in quote template", + "args": [], "type": { "kind": "SCALAR", - "name": "ID", + "name": "Float", "ofType": null }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyTeamUpdateInput", - "description": "Defines the input schema for updating a company team.", - "fields": null, - "inputFields": [ + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "description", - "description": "An optional description of the team.", + "name": "not_available_message", + "description": "Message to display when the product is not available with this selected option.", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "id", - "description": "The unique ID of the `CompanyTeam` object to update.", + "name": "note_from_buyer", + "description": "The buyer's quote line item note.", + "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "OBJECT", + "name": "ItemNote", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "name", - "description": "The display name of the team.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyStructureOutput", - "description": "Contains the response to the request to update the company structure.", - "fields": [ - { - "name": "company", - "description": "The updated company instance.", + "name": "note_from_seller", + "description": "The seller's quote line item note.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "Company", + "name": "ItemNote", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyStructureUpdateInput", - "description": "Defines the input schema for updating the company structure.", - "fields": null, - "inputFields": [ - { - "name": "parent_tree_id", - "description": "The ID of a company that will be the new parent.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null }, { - "name": "tree_id", - "description": "The ID of the company team that is being moved to another parent.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateCompanyOutput", - "description": "Contains the response to the request to create a company.", - "fields": [ - { - "name": "company", - "description": "The new company instance.", + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Company", - "ofType": null - } + "kind": "OBJECT", + "name": "CartItemPrices", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyOutput", - "description": "Contains the response to the request to update the company.", - "fields": [ + }, { - "name": "company", - "description": "The updated company instance.", + "name": "product", + "description": "Details about an item in the cart.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Company", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateCompanyUserOutput", - "description": "Contains the response to the request to create a company user.", - "fields": [ + }, { - "name": "user", - "description": "The new company user instance.", + "name": "quantity", + "description": "The quantity of this item in the cart.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Customer", + "kind": "SCALAR", + "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyUserOutput", - "description": "Contains the response to the request to update the company user.", - "fields": [ + }, { - "name": "user", - "description": "The updated company user instance.", + "name": "samples", + "description": "An array containing information about samples of the selected downloadable product.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "Customer", + "name": "DownloadableProductSamples", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeleteCompanyUserOutput", - "description": "Contains the response to the request to delete the company user.", - "fields": [ + }, { - "name": "success", - "description": "Indicates whether the company user has been deactivated successfully.", + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Boolean", + "name": "ID", "ofType": null } }, @@ -46920,999 +45961,827 @@ } ], "inputFields": null, - "interfaces": [], + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "CreateCompanyRoleOutput", - "description": "Contains the response to the request to create a company role.", + "name": "DownloadableProduct", + "description": "Defines a product that the shopper downloads.", "fields": [ { - "name": "role", - "description": "The new company role instance.", + "name": "activity", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyRoleOutput", - "description": "Contains the response to the request to update the company role.", - "fields": [ + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, { - "name": "role", - "description": "The updated company role instance.", + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeleteCompanyRoleOutput", - "description": "Contains the response to the request to delete the company role.", - "fields": [ + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, { - "name": "success", - "description": "SIndicates whether the company role has been deleted successfully.", + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyCreateInput", - "description": "Defines the input schema for creating a new company.", - "fields": null, - "inputFields": [ + }, { - "name": "company_admin", - "description": "Defines the company administrator.", + "name": "categories", + "description": "The categories assigned to a product.", + "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyAdminInput", + "kind": "INTERFACE", + "name": "CategoryInterface", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "company_email", - "description": "The email address of the company contact.", + "name": "category_gear", + "description": null, + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "company_name", - "description": "The name of the company to create.", + "name": "climate", + "description": null, + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "legal_address", - "description": "Defines legal address data of the company.", + "name": "collar", + "description": null, + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyLegalAddressCreateInput", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "legal_name", - "description": "The full legal name of the company.", + "name": "color", + "description": null, + "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "reseller_id", - "description": "The resale number that is assigned to the company for tax reporting purposes.", + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "vat_tax_id", - "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", + "name": "created_at", + "description": "Timestamp indicating when the product was created.", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyAdminInput", - "description": "Defines the input schema for creating a company administrator.", - "fields": null, - "inputFields": [ + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, { - "name": "custom_attributes", - "description": "The company administrator's custom attributes.", + "name": "crosssell_products", + "description": "An array of cross-sell products.", + "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "AttributeValueInput", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "email", - "description": "The email address of the company administrator.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "name": "custom_attributesV2", + "description": "Product custom attributes.", + "args": [ + { + "name": "filters", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + }, + "defaultValue": null } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "firstname", - "description": "The company administrator's first name.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "gender", - "description": "The company administrator's gender (Male - 1, Female - 2, Not Specified - 3).", + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "args": [], "type": { - "kind": "SCALAR", - "name": "Int", + "kind": "OBJECT", + "name": "ComplexTextValue", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "job_title", - "description": "The job title of the company administrator.", + "name": "downloadable_product_links", + "description": "An array containing information about the links for this downloadable product.", + "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductLinks", + "ofType": null + } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "lastname", - "description": "The company administrator's last name.", + "name": "downloadable_product_samples", + "description": "An array containing information about samples of this downloadable product.", + "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "DownloadableProductSamples", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "telephone", - "description": "The phone number of the company administrator.", + "name": "eco_collection", + "description": null, + "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyLegalAddressCreateInput", - "description": "Defines the input schema for defining a company's legal address.", - "fields": null, - "inputFields": [ + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, { - "name": "city", - "description": "The city where the company is registered to conduct business.", + "name": "erin_recommends", + "description": null, + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "country_id", - "description": "The company's country ID. Use the `countries` query to get this value.", + "name": "features_bags", + "description": null, + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CountryCodeEnum", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "postcode", - "description": "The postal code of the company.", + "name": "format", + "description": null, + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "region", - "description": "An object containing the region name and/or region ID where the company is registered to conduct business.", + "name": "gender", + "description": null, + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressRegionInput", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "street", - "description": "An array of strings that define the street address where the company is registered to conduct business.", + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "telephone", - "description": "The primary phone number of the company.", + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "Boolean", "ofType": null } }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyUpdateInput", - "description": "Defines the input schema for updating a company.", - "fields": null, - "inputFields": [ + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "company_email", - "description": "The email address of the company contact.", + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", + "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "Money", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "company_name", - "description": "The name of the company to update.", + "name": "id", + "description": "The ID number assigned to the product.", + "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `uid` field instead." }, { - "name": "legal_address", - "description": "The legal address data of the company.", + "name": "image", + "description": "The relative path to the main image on the product page.", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "CompanyLegalAddressUpdateInput", + "kind": "OBJECT", + "name": "ProductImage", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "legal_name", - "description": "The full legal name of the company.", + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "reseller_id", - "description": "The resale number that is assigned to the company for tax reporting purposes.", + "name": "links_purchased_separately", + "description": "A value of 1 indicates that each link in the array must be purchased separately.", + "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "vat_tax_id", - "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyLegalAddressUpdateInput", - "description": "Defines the input schema for updating a company's legal address.", - "fields": null, - "inputFields": [ - { - "name": "city", - "description": "The city where the company is registered to conduct business.", + "name": "links_title", + "description": "The heading above the list of downloadable products.", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "country_id", - "description": "The unique ID for a `Country` object.", + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", + "args": [], "type": { - "kind": "ENUM", - "name": "CountryCodeEnum", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "postcode", - "description": "The postal code of the company.", + "name": "material", + "description": null, + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "region", - "description": "An object containing the region name and/or region ID where the company is registered to conduct business.", + "name": "max_sale_qty", + "description": "Maximum Qty Allowed in Shopping Cart", + "args": [], "type": { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressRegionInput", + "kind": "SCALAR", + "name": "Float", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "street", - "description": "An array of strings that define the street address where the company is registered to conduct business.", + "name": "media_gallery", + "description": "An array of media gallery objects.", + "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "INTERFACE", + "name": "MediaGalleryInterface", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "telephone", - "description": "The primary phone number of the company.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyUserCreateInput", - "description": "Defines the input schema for creating a company user.", - "fields": null, - "inputFields": [ - { - "name": "email", - "description": "The company user's email address", + "name": "media_gallery_entries", + "description": "An array of MediaGalleryEntry objects.", + "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "MediaGalleryEntry", "ofType": null } }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `media_gallery` instead." }, { - "name": "firstname", - "description": "The company user's first name.", + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "job_title", - "description": "The company user's job title or function.", + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "lastname", - "description": "The company user's last name.", + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "role_id", - "description": "The unique ID for a `CompanyRole` object.", + "name": "min_sale_qty", + "description": "Minimum Qty Allowed in Shopping Cart", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "status", - "description": "Indicates whether the company user is ACTIVE or INACTIVE.", + "name": "name", + "description": "The product name. Customers use this name to identify the product.", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CompanyUserStatusEnum", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "target_id", - "description": "The ID of a node within a company's structure. This ID will be the parent of the created company user.", + "name": "new", + "description": null, + "args": [], "type": { "kind": "SCALAR", - "name": "ID", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "telephone", - "description": "The company user's phone number.", + "name": "new_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyUserUpdateInput", - "description": "Defines the input schema for updating a company user.", - "fields": null, - "inputFields": [ + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "email", - "description": "The company user's email address.", + "name": "new_to_date", + "description": "The end date for new product listings.", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "firstname", - "description": "The company user's first name.", + "name": "only_x_left_in_stock", + "description": "Product stock only x left count", + "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "id", - "description": "The unique ID of a `Customer` object.", + "name": "options", + "description": "An array of options for a customizable product.", + "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "job_title", - "description": "The company user's job title or function.", + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "lastname", - "description": "The company user's last name.", + "name": "pattern", + "description": null, + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "role_id", - "description": "The unique ID for a `CompanyRole` object.", + "name": "performance_fabric", + "description": null, + "args": [], "type": { "kind": "SCALAR", - "name": "ID", + "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "status", - "description": "Indicates whether the company user is ACTIVE or INACTIVE.", + "name": "price", + "description": "Indicates the price of an item.", + "args": [], "type": { - "kind": "ENUM", - "name": "CompanyUserStatusEnum", + "kind": "OBJECT", + "name": "ProductPrices", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use `price_range` for product price information." }, { - "name": "telephone", - "description": "The company user's phone number.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyRoleCreateInput", - "description": "Defines the input schema for creating a company role.", - "fields": null, - "inputFields": [ - { - "name": "name", - "description": "The name of the role to create.", + "name": "price_range", + "description": "The range of prices for the product", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "PriceRange", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "permissions", - "description": "A list of resources the role can access.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyRoleUpdateInput", - "description": "Defines the input schema for updating a company role.", - "fields": null, - "inputFields": [ - { - "name": "id", - "description": "The unique ID for a `CompanyRole` object.", + "name": "price_tiers", + "description": "An array of `TierPrice` objects.", + "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "OBJECT", + "name": "TierPrice", "ofType": null } }, - "defaultValue": null - }, - { - "name": "name", - "description": "The name of the role to update.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "permissions", - "description": "A list of resources the role can access.", + "name": "product_links", + "description": "An array of `ProductLinks` objects.", + "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "INTERFACE", + "name": "ProductLinksInterface", "ofType": null } }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "UserCompaniesInput", - "description": "Defines the input for returning matching companies the customer is assigned to.", - "fields": null, - "inputFields": [ + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "currentPage", - "description": "Specifies which page of results to return. The default value is 1.", + "name": "purpose", + "description": null, + "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "pageSize", - "description": "Specifies the maximum number of results to return at once. This attribute is optional.", + "name": "quantity", + "description": "Amount of available stock", + "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "sort", - "description": "Defines the sorting of the results.", + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompaniesSortInput", + "kind": "SCALAR", + "name": "Float", "ofType": null } }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UserCompaniesOutput", - "description": "An object that contains a list of companies customer is assigned to.", - "fields": [ + "isDeprecated": false, + "deprecationReason": null + }, { - "name": "items", - "description": "An array of companies customer is assigned to.", + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyBasicInfo", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "page_info", - "description": "Provides navigation for the query response.", + "name": "related_products", + "description": "An array of related products.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompaniesSortInput", - "description": "Specifies which field to sort on, and whether to return the results in ascending or descending order.", - "fields": null, - "inputFields": [ + }, { - "name": "field", - "description": "The field for sorting the results.", + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "ENUM", - "name": "CompaniesSortFieldEnum", + "kind": "SCALAR", + "name": "Int", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "order", - "description": "Indicates whether to return results in ascending or descending order.", + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "ENUM", - "name": "SortEnum", + "kind": "OBJECT", + "name": "ProductReviews", "ofType": null } }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CompaniesSortFieldEnum", - "description": "The fields available for sorting the customer companies.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "NAME", - "description": "The name of the company.", "isDeprecated": false, "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyBasicInfo", - "description": "The minimal required information to identify and display the company.", - "fields": [ + }, { - "name": "id", - "description": "The unique ID of a `Company` object.", + "name": "rules", + "description": "Provides applied catalog rules in the current active cart", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "OBJECT", + "name": "CatalogRule", "ofType": null } }, @@ -47920,203 +46789,123 @@ "deprecationReason": null }, { - "name": "legal_name", - "description": "The full legal name of the company.", + "name": "sale", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "name", - "description": "The name of the company.", + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyInvitationInput", - "description": "Defines the input schema for accepting the company invitation.", - "fields": null, - "inputFields": [ - { - "name": "code", - "description": "The invitation code.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null }, { - "name": "role_id", - "description": "The company role id.", + "name": "size", + "description": null, + "args": [], "type": { "kind": "SCALAR", - "name": "ID", + "name": "Int", "ofType": null }, - "defaultValue": null - }, - { - "name": "user", - "description": "Company user attributes in the invitation.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyInvitationUserInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyInvitationUserInput", - "description": "Company user attributes in the invitation.", - "fields": null, - "inputFields": [ - { - "name": "company_id", - "description": "The company unique identifier.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "customer_id", - "description": "The customer unique identifier.", + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "job_title", - "description": "The job title of a company user.", + "name": "sleeve", + "description": null, + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "status", - "description": "Indicates whether the company user is ACTIVE or INACTIVE.", + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", + "args": [], "type": { - "kind": "ENUM", - "name": "CompanyUserStatusEnum", + "kind": "OBJECT", + "name": "ProductImage", "ofType": null }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null }, { - "name": "telephone", - "description": "The phone number of the company user.", + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", + "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyInvitationOutput", - "description": "The result of accepting the company invitation.", - "fields": [ + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, { - "name": "success", - "description": "Indicates whether the customer was added to the company successfully.", + "name": "special_price", + "description": "The discounted price of the product.", "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyStructureItem", - "description": "Defines an individual node in the company structure.", - "fields": [ + }, { - "name": "entity", - "description": "A union of `CompanyTeam` and `Customer` objects.", + "name": "special_to_date", + "description": "The end date for a product with a special price.", "args": [], "type": { - "kind": "UNION", - "name": "CompanyStructureEntity", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The unique ID for a `CompanyStructureItem` object.", + "name": "staged", + "description": "Indicates whether the product is staged for a future campaign.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "Boolean", "ofType": null } }, @@ -48124,381 +46913,151 @@ "deprecationReason": null }, { - "name": "parent_id", - "description": "The ID of the parent item in the company hierarchy.", + "name": "stock_status", + "description": "Stock status of the product", "args": [], "type": { - "kind": "SCALAR", - "name": "ID", + "kind": "ENUM", + "name": "ProductStockStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerSegmentStorefront", - "description": "Customer segment details", - "fields": [ - { - "name": "uid", - "description": "The unique ID for a `CustomerSegment` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddBundleProductsToCartInput", - "description": "Defines the bundle products to add to the cart.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The ID of the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cart_items", - "description": "An array of bundle products to add.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "BundleProductCartItemInput", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "BundleProductCartItemInput", - "description": "Defines a single bundle product.", - "fields": null, - "inputFields": [ - { - "name": "bundle_options", - "description": "A mandatory array of options for the bundle product, including each chosen option and specified quantity.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "BundleOptionInput", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "customizable_options", - "description": "The ID and value of the option.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", - "ofType": null - } - }, - "defaultValue": null }, { - "name": "data", - "description": "The quantity and SKU of the bundle product.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "BundleOptionInput", - "description": "Defines the input for a bundle option.", - "fields": null, - "inputFields": [ - { - "name": "id", - "description": "The ID of the option.", + "name": "strap_bags", + "description": null, + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "quantity", - "description": "The number of the selected item to add to the cart.", + "name": "style_bags", + "description": null, + "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "defaultValue": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "value", - "description": "An array with the chosen value of the option.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddBundleProductsToCartOutput", - "description": "Contains details about the cart after adding bundle products.", - "fields": [ - { - "name": "cart", - "description": "The cart after adding products.", + "name": "style_bottom", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleCartItem", - "description": "An implementation for bundle product cart items.", - "fields": [ + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, { - "name": "available_gift_wrapping", - "description": "The list of available gift wrapping options for the cart item.", + "name": "style_general", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - } - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." }, { - "name": "bundle_options", - "description": "An array containing the bundle options the shopper selected.", + "name": "swatch_image", + "description": "The file name of a swatch image.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedBundleOption", - "ofType": null - } - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "customizable_options", - "description": "An array containing the customizable options the shopper selected.", + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "discount", - "description": "Contains discount for quote line item.", + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." }, { - "name": "errors", - "description": "An array of errors encountered while loading the cart item", + "name": "tier_prices", + "description": "An array of ProductTierPrices objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "CartItemError", + "name": "ProductTierPrices", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." }, { - "name": "gift_message", - "description": "The entered gift message for the cart item", + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", "args": [], "type": { - "kind": "OBJECT", - "name": "GiftMessage", + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "gift_wrapping", - "description": "The selected gift wrapping for the cart item.", + "name": "type_id", + "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", "args": [], "type": { - "kind": "OBJECT", - "name": "GiftWrapping", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, "isDeprecated": true, - "deprecationReason": "Use `uid` instead." + "deprecationReason": "Use `__typename` instead." }, { - "name": "is_available", - "description": "True if requested quantity is less than available stock, false otherwise.", + "name": "uid", + "description": "The unique ID for a `ProductInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Boolean", + "name": "ID", "ofType": null } }, @@ -48506,51 +47065,27 @@ "deprecationReason": null }, { - "name": "max_qty", - "description": "Line item max qty in quote template", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "min_qty", - "description": "Line item min qty in quote template", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "not_available_message", - "description": "Message to display when the product is not available with this selected option.", + "name": "updated_at", + "description": "Timestamp indicating when the product was updated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." }, { - "name": "note_from_buyer", - "description": "The buyer's quote line item note.", + "name": "upsell_products", + "description": "An array of up-sell products.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "ItemNote", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null } }, @@ -48558,43 +47093,39 @@ "deprecationReason": null }, { - "name": "note_from_seller", - "description": "The seller's quote line item note.", + "name": "url_key", + "description": "The part of the URL that identifies the product", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", + "name": "url_path", + "description": null, "args": [], "type": { - "kind": "OBJECT", - "name": "CartItemPrices", + "kind": "SCALAR", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use product's `canonical_url` or url rewrites instead" }, { - "name": "product", - "description": "Details about an item in the cart.", + "name": "url_rewrites", + "description": "URL rewrites list", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "OBJECT", + "name": "UrlRewrite", "ofType": null } }, @@ -48602,248 +47133,206 @@ "deprecationReason": null }, { - "name": "quantity", - "description": "The quantity of this item in the cart.", + "name": "url_suffix", + "description": "The part of the product URL that is appended after the url key", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", + "name": "websites", + "description": "An array of websites in which the product is available.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "OBJECT", + "name": "Website", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", - "name": "CartItemInterface", + "name": "ProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "CustomizableProductInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, + { + "kind": "ENUM", + "name": "DownloadableFileTypeEnum", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FILE", + "description": "", + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "URL", + "description": "", + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + } + ], + "possibleTypes": null + }, { "kind": "OBJECT", - "name": "SelectedBundleOption", - "description": "Contains details about a selected bundle option.", + "name": "DownloadableProductLinks", + "description": "Defines characteristics of a downloadable product.", "fields": [ { "name": "id", "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": true, - "deprecationReason": "Use `uid` instead" + "deprecationReason": "This information should not be exposed on frontend." }, { - "name": "label", - "description": "The display name of the selected bundle product option.", + "name": "is_shareable", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "This information should not be exposed on frontend." }, { - "name": "type", - "description": "The type of selected bundle product option.", + "name": "link_type", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "ENUM", + "name": "DownloadableFileTypeEnum", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" }, { - "name": "uid", - "description": "The unique ID for a `SelectedBundleOption` object", + "name": "number_of_downloads", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "This information should not be exposed on frontend." }, { - "name": "values", - "description": "An array of selected bundle option values.", + "name": "price", + "description": "The price of the downloadable product.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedBundleOptionValue", - "ofType": null - } - } + "kind": "SCALAR", + "name": "Float", + "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SelectedBundleOptionValue", - "description": "Contains details about a value for a selected bundle option.", - "fields": [ + }, { - "name": "id", - "description": "Use `uid` instead", + "name": "sample_file", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" }, { - "name": "label", - "description": "The display name of the value for the selected bundle product option.", + "name": "sample_type", + "description": null, "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "ENUM", + "name": "DownloadableFileTypeEnum", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" }, { - "name": "original_price", - "description": "The original price of the value for the selected bundle product option.", + "name": "sample_url", + "description": "The full URL to the downloadable sample.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price", - "description": "The price of the value for the selected bundle product option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use priceV2 instead." - }, - { - "name": "priceV2", - "description": "The price of the value for the selected bundle product option.", + "name": "sort_order", + "description": "A number indicating the sort order.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "quantity", - "description": "The quantity of the value for the selected bundle product option.", + "name": "title", + "description": "The display name of the link.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", - "description": "The unique ID for a `SelectedBundleOptionValue` object", + "description": "The unique ID for a `DownloadableProductLinks` object.", "args": [], "type": { "kind": "NON_NULL", @@ -48865,40 +47354,76 @@ }, { "kind": "OBJECT", - "name": "PriceDetails", - "description": "Can be used to retrieve the main price details in case of bundle product", + "name": "DownloadableProductSamples", + "description": "Defines characteristics of a downloadable product.", "fields": [ { - "name": "discount_percentage", - "description": "The percentage of discount applied to the main product price", + "name": "id", + "description": null, "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This information should not be exposed on frontend." + }, + { + "name": "sample_file", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "sample_type", + "description": null, + "args": [], + "type": { + "kind": "ENUM", + "name": "DownloadableFileTypeEnum", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "sample_url", + "description": "The full URL to the downloadable sample.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "main_final_price", - "description": "The final price after applying the discount to the main product", + "name": "sort_order", + "description": "A number indicating the sort order.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "main_price", - "description": "The regular price of the main product", + "name": "title", + "description": "The display name of the sample.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, @@ -48912,31 +47437,35 @@ }, { "kind": "OBJECT", - "name": "BundleItem", - "description": "Defines an individual item within a bundle product.", + "name": "DownloadableOrderItem", + "description": "Defines downloadable product options for `OrderItemInterface`.", "fields": [ { - "name": "option_id", - "description": "An ID assigned to each type of item in a bundle product.", + "name": "discounts", + "description": "The final discount information for the product.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" + "isDeprecated": false, + "deprecationReason": null }, { - "name": "options", - "description": "An array of additional options for this bundle item.", + "name": "downloadable_links", + "description": "A list of downloadable links that are ordered from the downloadable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "BundleItemOption", + "name": "DownloadableItemsLinks", "ofType": null } }, @@ -48944,27 +47473,27 @@ "deprecationReason": null }, { - "name": "position", - "description": "A number indicating the sequence order of this item compared to the other bundle items.", + "name": "eligible_for_return", + "description": "Indicates whether the order item is eligible to be in a return request.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price_range", - "description": "The range of prices for the product", + "name": "entered_options", + "description": "The entered option for the base product, such as a logo or image.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "PriceRange", + "name": "OrderItemOption", "ofType": null } }, @@ -48972,115 +47501,116 @@ "deprecationReason": null }, { - "name": "required", - "description": "Indicates whether the item must be included in the bundle.", + "name": "gift_message", + "description": "The selected gift message for the order item", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", + "kind": "OBJECT", + "name": "GiftMessage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sku", - "description": "The SKU of the bundle product.", + "name": "gift_wrapping", + "description": "The selected gift wrapping for the order item.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "GiftWrapping", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "title", - "description": "The display name of the item.", + "name": "id", + "description": "The unique ID for an `OrderItemInterface` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "type", - "description": "The input type that the customer uses to select the item. Examples include radio button and checkbox.", + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "OrderItemPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `BundleItem` object.", + "name": "product", + "description": "The ProductInterface object, which contains details about the base product", "args": [], "type": { - "kind": "SCALAR", - "name": "ID", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleItemOption", - "description": "Defines the characteristics that comprise a specific bundle item and its options.", - "fields": [ + }, { - "name": "can_change_quantity", - "description": "Indicates whether the customer can change the number of items for this option.", + "name": "product_name", + "description": "The name of the base product.", "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The ID assigned to the bundled item option.", + "name": "product_sale_price", + "description": "The sale price of the base product, including selected options.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" + "isDeprecated": false, + "deprecationReason": null }, { - "name": "is_default", - "description": "Indicates whether this option is the default option.", + "name": "product_sku", + "description": "The SKU of the base product.", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "label", - "description": "The text that identifies the bundled item option.", + "name": "product_type", + "description": "The type of product, such as simple, configurable, etc.", "args": [], "type": { "kind": "SCALAR", @@ -49091,20 +47621,20 @@ "deprecationReason": null }, { - "name": "position", - "description": "When a bundle item contains multiple options, the relative position of this option compared to the other options.", + "name": "product_url_key", + "description": "URL key of the base product.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price", - "description": "The price of the selected option.", + "name": "quantity_canceled", + "description": "The number of canceled items.", "args": [], "type": { "kind": "SCALAR", @@ -49115,44 +47645,44 @@ "deprecationReason": null }, { - "name": "price_type", - "description": "One of FIXED, PERCENT, or DYNAMIC.", + "name": "quantity_invoiced", + "description": "The number of invoiced items.", "args": [], "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", + "kind": "SCALAR", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "product", - "description": "Contains details about this product option.", + "name": "quantity_ordered", + "description": "The number of units ordered for this item.", "args": [], "type": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "SCALAR", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "qty", - "description": "Indicates the quantity of this specific bundle item.", + "name": "quantity_refunded", + "description": "The number of refunded items.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use `quantity` instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "quantity", - "description": "The quantity of this specific bundle item.", + "name": "quantity_return_requested", + "description": "The requested return quantity of the item.", "args": [], "type": { "kind": "SCALAR", @@ -49163,78 +47693,39 @@ "deprecationReason": null }, { - "name": "uid", - "description": "The unique ID for a `BundleItemOption` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleProduct", - "description": "Defines basic features of a bundle product and contains multiple BundleItems.", - "fields": [ - { - "name": "activity", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", + "name": "quantity_returned", + "description": "The number of returned items.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "name": "quantity_shipped", + "description": "The number of shipped items.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "categories", - "description": "The categories assigned to a product.", + "name": "selected_options", + "description": "The selected options for the base product, such as color or size.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", + "kind": "OBJECT", + "name": "OrderItemOption", "ofType": null } }, @@ -49242,87 +47733,60 @@ "deprecationReason": null }, { - "name": "category_gear", - "description": null, + "name": "status", + "description": "The status of the order item.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ { - "name": "climate", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "collar", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "color", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableInvoiceItem", + "description": "Defines downloadable product options for `InvoiceItemInterface`.", + "fields": [ { - "name": "country_of_manufacture", - "description": "The product's country of origin.", + "name": "discounts", + "description": "Information about the final discount amount for the base product, including discounts on options.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "crosssell_products", - "description": "An array of cross-sell products.", + "name": "downloadable_links", + "description": "A list of downloadable links that are invoiced from the downloadable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "OBJECT", + "name": "DownloadableItemsLinks", "ofType": null } }, @@ -49330,146 +47794,132 @@ "deprecationReason": null }, { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], + "name": "id", + "description": "The unique ID for an `InvoiceItemInterface` object.", + "args": [], "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", + "name": "order_item", + "description": "Details about an individual order item.", "args": [], "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", + "kind": "INTERFACE", + "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "dynamic_price", - "description": "Indicates whether the bundle product has a dynamic price.", + "name": "product_name", + "description": "The name of the base product.", "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "dynamic_sku", - "description": "Indicates whether the bundle product has a dynamic SKU.", + "name": "product_sale_price", + "description": "The sale price for the base product including selected options.", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "dynamic_weight", - "description": "Indicates whether the bundle product has a dynamically calculated weight.", + "name": "product_sku", + "description": "The SKU of the base product.", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, + "name": "quantity_invoiced", + "description": "The number of invoiced items.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Float", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "kind": "INTERFACE", + "name": "InvoiceItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableCreditMemoItem", + "description": "Defines downloadable product options for `CreditMemoItemInterface`.", + "fields": [ { - "name": "gender", - "description": null, + "name": "discounts", + "description": "Details about the final discount amount for the base product, including discounts on options.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "gift_message_available", - "description": "Returns a value indicating gift message availability for the product.", + "name": "downloadable_links", + "description": "A list of downloadable links that are refunded from the downloadable product.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Boolean", + "kind": "OBJECT", + "name": "DownloadableItemsLinks", "ofType": null } }, @@ -49477,15 +47927,15 @@ "deprecationReason": null }, { - "name": "gift_wrapping_available", - "description": "Returns a value indicating gift wrapping availability for the product.", + "name": "id", + "description": "The unique ID for a `CreditMemoItemInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Boolean", + "name": "ID", "ofType": null } }, @@ -49493,63 +47943,55 @@ "deprecationReason": null }, { - "name": "gift_wrapping_price", - "description": "Returns value and currency indicating gift wrapping price for the product.", + "name": "order_item", + "description": "The order item the credit memo is applied to.", "args": [], "type": { - "kind": "OBJECT", - "name": "Money", + "kind": "INTERFACE", + "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The ID number assigned to the product.", + "name": "product_name", + "description": "The name of the base product.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." - }, - { - "name": "image", - "description": "The relative path to the main image on the product page.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", + "name": "product_sale_price", + "description": "The sale price for the base product, including selected options.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "items", - "description": "An array containing information about individual bundle items.", + "name": "product_sku", + "description": "The SKU of the base product.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "BundleItem", + "kind": "SCALAR", + "name": "String", "ofType": null } }, @@ -49557,88 +47999,124 @@ "deprecationReason": null }, { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", + "name": "quantity_refunded", + "description": "The number of refunded items.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "Float", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ { - "name": "material", - "description": null, + "kind": "INTERFACE", + "name": "CreditMemoItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableItemsLinks", + "description": "Defines characteristics of the links for downloadable product.", + "fields": [ + { + "name": "sort_order", + "description": "A number indicating the sort order.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "max_sale_qty", - "description": "Maximum Qty Allowed in Shopping Cart", + "name": "title", + "description": "The display name of the link.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "media_gallery", - "description": "An array of media gallery objects.", + "name": "uid", + "description": "The unique ID for a `DownloadableItemsLinks` object.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableWishlistItem", + "description": "A downloadable product wish list item.", + "fields": [ { - "name": "media_gallery_entries", - "description": "An array of MediaGalleryEntry objects.", + "name": "added_at", + "description": "The date and time the item was added to the wish list.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "MediaGalleryEntry", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "isDeprecated": true, - "deprecationReason": "Use `media_gallery` instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", + "name": "description", + "description": "The description of the item.", "args": [], "type": { "kind": "SCALAR", @@ -49649,99 +48127,136 @@ "deprecationReason": null }, { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "min_sale_qty", - "description": "Minimum Qty Allowed in Shopping Cart", + "name": "links_v2", + "description": "An array containing information about the selected links.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductLinks", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", + "name": "product", + "description": "Product details of the wish list item.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "INTERFACE", + "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "new", - "description": null, + "name": "quantity", + "description": "The quantity of this wish list item.", "args": [], "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "new_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "name": "samples", + "description": "An array containing information about the selected samples.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductSamples", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [ { - "name": "new_to_date", - "description": "The end date for new product listings.", + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Company", + "description": "Contains the output schema for a company.", + "fields": [ + { + "name": "acl_resources", + "description": "The list of all resources defined within the company.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyAclResource", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "only_x_left_in_stock", - "description": "Product stock only x left count", + "name": "company_admin", + "description": "An object containing information about the company administrator.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "OBJECT", + "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "options", - "description": "An array of options for a customizable product.", + "name": "credit", + "description": "Company credit balances and limits.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", + "kind": "OBJECT", + "name": "CompanyCredit", "ofType": null } }, @@ -49749,75 +48264,74 @@ "deprecationReason": null }, { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "args": [], + "name": "credit_history", + "description": "Details about the history of company credit operations.", + "args": [ + { + "name": "filter", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompanyCreditHistoryFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyCreditHistory", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "pattern", - "description": null, + "name": "email", + "description": "The email address of the company contact.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "price", - "description": "Indicates the price of an item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductPrices", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_range` for product price information." - }, - { - "name": "price_details", - "description": "The price details of the main product", - "args": [], - "type": { - "kind": "OBJECT", - "name": "PriceDetails", - "ofType": null - }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price_range", - "description": "The range of prices for the product", + "name": "id", + "description": "The unique ID of a `Company` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "PriceRange", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, @@ -49825,43 +48339,51 @@ "deprecationReason": null }, { - "name": "price_tiers", - "description": "An array of `TierPrice` objects.", + "name": "legal_address", + "description": "The address where the company is registered to conduct business.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TierPrice", - "ofType": null - } + "kind": "OBJECT", + "name": "CompanyLegalAddress", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "price_view", - "description": "One of PRICE_RANGE or AS_LOW_AS.", + "name": "legal_name", + "description": "The full legal name of the company.", "args": [], "type": { - "kind": "ENUM", - "name": "PriceViewEnum", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "product_links", - "description": "An array of `ProductLinks` objects.", + "name": "name", + "description": "The name of the company.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_methods", + "description": "The list of payment methods available to a company.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "ProductLinksInterface", + "kind": "SCALAR", + "name": "String", "ofType": null } }, @@ -49869,39 +48391,75 @@ "deprecationReason": null }, { - "name": "purpose", - "description": null, + "name": "reseller_id", + "description": "The resale number that is assigned to the company for tax reporting purposes.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "quantity", - "description": "Amount of available stock", - "args": [], + "name": "role", + "description": "A company role filtered by the unique ID of a `CompanyRole` object.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "OBJECT", + "name": "CompanyRole", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "rating_summary", - "description": "The average of all the ratings given to the product.", - "args": [], + "name": "roles", + "description": "An object that contains a list of company roles.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Float", + "kind": "OBJECT", + "name": "CompanyRoles", "ofType": null } }, @@ -49909,72 +48467,121 @@ "deprecationReason": null }, { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "name": "sales_representative", + "description": "An object containing information about the company sales representative.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } + "kind": "OBJECT", + "name": "CompanySalesRepresentative", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "related_products", - "description": "An array of related products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null + "name": "structure", + "description": "The company structure of teams and customers in depth-first order.", + "args": [ + { + "name": "rootId", + "description": "The ID of the node in the company structure that serves as the root for the query.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "depth", + "description": "The maximum depth that can be reached when listing structure nodes.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "10" } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyStructure", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], + "name": "team", + "description": "The company team data filtered by the unique ID for a `CompanyTeam` object.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "CompanyTeam", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "review_count", - "description": "The total count of all the reviews given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null + "name": "user", + "description": "A company user filtered by the unique ID of a `Customer` object.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null } + ], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "reviews", - "description": "The list of products reviews.", + "name": "users", + "description": "An object that contains a list of company users based on activity status.", "args": [ + { + "name": "filter", + "description": "The type of company users to return.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompanyUsersFilterInput", + "ofType": null + }, + "defaultValue": null + }, { "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", + "description": "The maximum number of results to return at once. The default value is 20.", "type": { "kind": "SCALAR", "name": "Int", @@ -49984,7 +48591,7 @@ }, { "name": "currentPage", - "description": "The page of results to return. The default is 1.", + "description": "The page of results to return. The default value is 1.", "type": { "kind": "SCALAR", "name": "Int", @@ -49994,147 +48601,169 @@ } ], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviews", - "ofType": null - } + "kind": "OBJECT", + "name": "CompanyUsers", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sale", - "description": null, + "name": "vat_tax_id", + "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLegalAddress", + "description": "Contains details about the address where the company is registered to conduct business.", + "fields": [ { - "name": "ship_bundle_items", - "description": "Indicates whether to ship bundle items together or individually.", + "name": "city", + "description": "The city where the company is registered to conduct business.", "args": [], "type": { - "kind": "ENUM", - "name": "ShipBundleItemsEnum", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", + "name": "country_code", + "description": "The country code of the company's legal address.", "args": [], "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", + "kind": "ENUM", + "name": "CountryCodeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "size", - "description": null, + "name": "postcode", + "description": "The company's postal code.", "args": [], "type": { "kind": "SCALAR", - "name": "Int", + "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "name": "region", + "description": "An object containing region data for the company.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "CustomerAddressRegion", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "sleeve", - "description": null, + "name": "street", + "description": "An array of strings that define the company's street address.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", + "name": "telephone", + "description": "The company's phone number.", "args": [], "type": { - "kind": "OBJECT", - "name": "ProductImage", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyAdmin", + "description": "Contains details about the company administrator.", + "fields": [ { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", + "name": "email", + "description": "The email address of the company administrator.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "special_price", - "description": "The discounted price of the product.", + "name": "firstname", + "description": "The company administrator's first name.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "special_to_date", - "description": "The end date for a product with a special price.", + "name": "gender", + "description": "The company administrator's gender (Male - 1, Female - 2, Not Specified - 3).", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "staged", - "description": "Indicates whether the product is staged for a future campaign.", + "name": "id", + "description": "The unique ID for a `CompanyAdmin` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Boolean", + "name": "ID", "ofType": null } }, @@ -50142,144 +48771,208 @@ "deprecationReason": null }, { - "name": "stock_status", - "description": "Stock status of the product", + "name": "job_title", + "description": "The job title of the company administrator.", "args": [], "type": { - "kind": "ENUM", - "name": "ProductStockStatus", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "strap_bags", - "description": null, + "name": "lastname", + "description": "The company administrator's last name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanySalesRepresentative", + "description": "Contains details about a company sales representative.", + "fields": [ { - "name": "style_bags", - "description": null, + "name": "email", + "description": "The email address of the company sales representative.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "style_bottom", - "description": null, + "name": "firstname", + "description": "The company sales representative's first name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "style_general", - "description": null, + "name": "lastname", + "description": "The company sales representative's last name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyUsers", + "description": "Contains details about company users.", + "fields": [ { - "name": "swatch_image", - "description": "The file name of a swatch image.", + "name": "items", + "description": "An array of `CompanyUser` objects that match the specified filter criteria.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", + "name": "page_info", + "description": "Pagination metadata.", "args": [], "type": { "kind": "OBJECT", - "name": "ProductImage", + "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "name": "total_count", + "description": "The number of objects returned.", "args": [], "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyRoles", + "description": "Contains an array of roles.", + "fields": [ { - "name": "tier_prices", - "description": "An array of ProductTierPrices objects.", + "name": "items", + "description": "A list of company roles that match the specified filter criteria.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "ProductTierPrices", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyRole", + "ofType": null + } } }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "name": "page_info", + "description": "Pagination metadata.", "args": [], "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", + "kind": "OBJECT", + "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "type_id", - "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", + "name": "total_count", + "description": "The total number of objects matching the specified filter.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } }, - "isDeprecated": true, - "deprecationReason": "Use `__typename` instead." - }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyRole", + "description": "Contails details about a single role.", + "fields": [ { - "name": "uid", - "description": "The unique ID for a `ProductInterface` object.", + "name": "id", + "description": "The unique ID for a `CompanyRole` object.", "args": [], "type": { "kind": "NON_NULL", @@ -50294,27 +48987,27 @@ "deprecationReason": null }, { - "name": "updated_at", - "description": "Timestamp indicating when the product was updated.", + "name": "name", + "description": "The name assigned to the role.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "upsell_products", - "description": "An array of up-sell products.", + "name": "permissions", + "description": "A list of permission resources defined for a role.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "OBJECT", + "name": "CompanyAclResource", "ofType": null } }, @@ -50322,39 +49015,38 @@ "deprecationReason": null }, { - "name": "url_key", - "description": "The part of the URL that identifies the product", + "name": "users_count", + "description": "The total number of users assigned the specified role.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, - { - "name": "url_path", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use product's `canonical_url` or url rewrites instead" - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyAclResource", + "description": "Contains details about the access control list settings of a resource.", + "fields": [ { - "name": "url_rewrites", - "description": "URL rewrites list", + "name": "children", + "description": "An array of sub-resources.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "UrlRewrite", + "name": "CompanyAclResource", "ofType": null } }, @@ -50362,40 +49054,40 @@ "deprecationReason": null }, { - "name": "url_suffix", - "description": "The part of the product URL that is appended after the url key", + "name": "id", + "description": "The unique ID for a `CompanyAclResource` object.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "websites", - "description": "An array of websites in which the product is available.", + "name": "sort_order", + "description": "The sort order of an ACL resource.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Website", - "ofType": null - } + "kind": "SCALAR", + "name": "Int", + "ofType": null }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." + "isDeprecated": false, + "deprecationReason": null }, { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", + "name": "text", + "description": "The label assigned to the ACL resource.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, @@ -50403,136 +49095,193 @@ } ], "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "PhysicalProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "CustomizableProductInterface", - "ofType": null - } - ], + "interfaces": [], "enumValues": null, "possibleTypes": null }, { - "kind": "ENUM", - "name": "PriceViewEnum", - "description": "Defines whether a bundle product's price is displayed as the lowest possible value or as a range.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "PRICE_RANGE", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, + "kind": "OBJECT", + "name": "IsCompanyRoleNameAvailableOutput", + "description": "Contains the response of a role name validation query.", + "fields": [ { - "name": "AS_LOW_AS", - "description": "", + "name": "is_role_name_available", + "description": "Indicates whether the specified company role name is available.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null } ], + "inputFields": null, + "interfaces": [], + "enumValues": null, "possibleTypes": null }, { - "kind": "ENUM", - "name": "ShipBundleItemsEnum", - "description": "Defines whether bundle items must be shipped together.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ + "kind": "OBJECT", + "name": "IsCompanyUserEmailAvailableOutput", + "description": "Contains the response of a company user email validation query.", + "fields": [ { - "name": "TOGETHER", - "description": "", + "name": "is_email_available", + "description": "Indicates whether the specified email address can be used to create a company user.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "IsCompanyAdminEmailAvailableOutput", + "description": "Contains the response of a company admin email validation query.", + "fields": [ { - "name": "SEPARATELY", - "description": "", + "name": "is_email_available", + "description": "Indicates whether the specified email address can be used to create a company administrator.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null } ], + "inputFields": null, + "interfaces": [], + "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "BundleOrderItem", - "description": "Defines bundle product options for `OrderItemInterface`.", + "name": "IsCompanyEmailAvailableOutput", + "description": "Contains the response of a company email validation query.", "fields": [ { - "name": "bundle_options", - "description": "A list of bundle options that are assigned to the bundle product.", + "name": "is_email_available", + "description": "Indicates whether the specified email address can be used to create a company.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "ItemSelectedBundleOption", + "kind": "SCALAR", + "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "CompanyStructureEntity", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CompanyTeam", + "ofType": null }, { - "name": "discounts", - "description": "The final discount information for the product.", + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CompanyStructure", + "description": "Contains an array of the individual nodes that comprise the company structure.", + "fields": [ + { + "name": "items", + "description": "An array of elements in a company structure.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", - "name": "Discount", + "name": "CompanyStructureItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyTeam", + "description": "Describes a company team.", + "fields": [ { - "name": "eligible_for_return", - "description": "Indicates whether the order item is eligible to be in a return request.", + "name": "description", + "description": "An optional description of the team.", "args": [], "type": { "kind": "SCALAR", - "name": "Boolean", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "entered_options", - "description": "The entered option for the base product, such as a logo or image.", + "name": "id", + "description": "The unique ID for a `CompanyTeam` object.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "OrderItemOption", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, @@ -50540,32 +49289,20 @@ "deprecationReason": null }, { - "name": "gift_message", - "description": "The selected gift message for the order item", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftMessage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_wrapping", - "description": "The selected gift wrapping for the order item.", + "name": "name", + "description": "The display name of the team.", "args": [], "type": { - "kind": "OBJECT", - "name": "GiftWrapping", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "id", - "description": "The unique ID for an `OrderItemInterface` object.", + "name": "structure_id", + "description": "ID of the company structure", "args": [], "type": { "kind": "NON_NULL", @@ -50578,75 +49315,787 @@ }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyUsersFilterInput", + "description": "Defines the filter for returning a list of company users.", + "fields": null, + "inputFields": [ { - "name": "parent_sku", - "description": "The SKU of parent product.", - "args": [], + "name": "status", + "description": "The activity status to filter on.", "type": { - "kind": "SCALAR", - "name": "String", + "kind": "ENUM", + "name": "CompanyUserStatusEnum", "ofType": null }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompanyUserStatusEnum", + "description": "Defines the list of company user status values.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACTIVE", + "description": "Only active users.", "isDeprecated": false, "deprecationReason": null }, { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", + "name": "INACTIVE", + "description": "Only inactive users.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateCompanyTeamOutput", + "description": "Contains the response to the request to create a company team.", + "fields": [ + { + "name": "team", + "description": "The new company team instance.", "args": [], "type": { - "kind": "OBJECT", - "name": "OrderItemPrices", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyTeam", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCompanyTeamOutput", + "description": "Contains the response to the request to update a company team.", + "fields": [ + { + "name": "team", + "description": "The updated company team instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyTeam", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeleteCompanyTeamOutput", + "description": "Contains the status of the request to delete a company team.", + "fields": [ + { + "name": "success", + "description": "Indicates whether the delete operation succeeded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyTeamCreateInput", + "description": "Defines the input schema for creating a company team.", + "fields": null, + "inputFields": [ + { + "name": "description", + "description": "An optional description of the team.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The display name of the team.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "target_id", + "description": "The ID of a node within a company's structure. This ID will be the parent of the created team.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyTeamUpdateInput", + "description": "Defines the input schema for updating a company team.", + "fields": null, + "inputFields": [ + { + "name": "description", + "description": "An optional description of the team.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "id", + "description": "The unique ID of the `CompanyTeam` object to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The display name of the team.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCompanyStructureOutput", + "description": "Contains the response to the request to update the company structure.", + "fields": [ + { + "name": "company", + "description": "The updated company instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyStructureUpdateInput", + "description": "Defines the input schema for updating the company structure.", + "fields": null, + "inputFields": [ + { + "name": "parent_tree_id", + "description": "The ID of a company that will be the new parent.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "tree_id", + "description": "The ID of the company team that is being moved to another parent.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateCompanyOutput", + "description": "Contains the response to the request to create a company.", + "fields": [ + { + "name": "company", + "description": "The new company instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCompanyOutput", + "description": "Contains the response to the request to update the company.", + "fields": [ + { + "name": "company", + "description": "The updated company instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateCompanyUserOutput", + "description": "Contains the response to the request to create a company user.", + "fields": [ + { + "name": "user", + "description": "The new company user instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCompanyUserOutput", + "description": "Contains the response to the request to update the company user.", + "fields": [ + { + "name": "user", + "description": "The updated company user instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeleteCompanyUserOutput", + "description": "Contains the response to the request to delete the company user.", + "fields": [ + { + "name": "success", + "description": "Indicates whether the company user has been deactivated successfully.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateCompanyRoleOutput", + "description": "Contains the response to the request to create a company role.", + "fields": [ + { + "name": "role", + "description": "The new company role instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyRole", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCompanyRoleOutput", + "description": "Contains the response to the request to update the company role.", + "fields": [ + { + "name": "role", + "description": "The updated company role instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyRole", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeleteCompanyRoleOutput", + "description": "Contains the response to the request to delete the company role.", + "fields": [ + { + "name": "success", + "description": "SIndicates whether the company role has been deleted successfully.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyCreateInput", + "description": "Defines the input schema for creating a new company.", + "fields": null, + "inputFields": [ + { + "name": "company_admin", + "description": "Defines the company administrator.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyAdminInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "company_email", + "description": "The email address of the company contact.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "company_name", + "description": "The name of the company to create.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "legal_address", + "description": "Defines legal address data of the company.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyLegalAddressCreateInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "legal_name", + "description": "The full legal name of the company.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reseller_id", + "description": "The resale number that is assigned to the company for tax reporting purposes.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "vat_tax_id", + "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyAdminInput", + "description": "Defines the input schema for creating a company administrator.", + "fields": null, + "inputFields": [ + { + "name": "custom_attributes", + "description": "The company administrator's custom attributes.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeValueInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The email address of the company administrator.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "firstname", + "description": "The company administrator's first name.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "gender", + "description": "The company administrator's gender (Male - 1, Female - 2, Not Specified - 3).", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "job_title", + "description": "The job title of the company administrator.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "The company administrator's last name.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "telephone", + "description": "The phone number of the company administrator.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyLegalAddressCreateInput", + "description": "Defines the input schema for defining a company's legal address.", + "fields": null, + "inputFields": [ + { + "name": "city", + "description": "The city where the company is registered to conduct business.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "country_id", + "description": "The company's country ID. Use the `countries` query to get this value.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCodeEnum", + "ofType": null + } + }, + "defaultValue": null }, { - "name": "product", - "description": "The ProductInterface object, which contains details about the base product", - "args": [], + "name": "postcode", + "description": "The postal code of the company.", "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "product_name", - "description": "The name of the base product.", - "args": [], + "name": "region", + "description": "An object containing the region name and/or region ID where the company is registered to conduct business.", "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressRegionInput", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "product_sale_price", - "description": "The sale price of the base product, including selected options.", - "args": [], + "name": "street", + "description": "An array of strings that define the street address where the company is registered to conduct business.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], + "name": "telephone", + "description": "The primary phone number of the company.", "type": { "kind": "NON_NULL", "name": null, @@ -50656,198 +50105,224 @@ "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyUpdateInput", + "description": "Defines the input schema for updating a company.", + "fields": null, + "inputFields": [ { - "name": "product_type", - "description": "The type of product, such as simple, configurable, etc.", - "args": [], + "name": "company_email", + "description": "The email address of the company contact.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "product_url_key", - "description": "URL key of the base product.", - "args": [], + "name": "company_name", + "description": "The name of the company to update.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "quantity_canceled", - "description": "The number of canceled items.", - "args": [], + "name": "legal_address", + "description": "The legal address data of the company.", "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "INPUT_OBJECT", + "name": "CompanyLegalAddressUpdateInput", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "quantity_invoiced", - "description": "The number of invoiced items.", - "args": [], + "name": "legal_name", + "description": "The full legal name of the company.", "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "quantity_ordered", - "description": "The number of units ordered for this item.", - "args": [], + "name": "reseller_id", + "description": "The resale number that is assigned to the company for tax reporting purposes.", "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "quantity_refunded", - "description": "The number of refunded items.", - "args": [], + "name": "vat_tax_id", + "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyLegalAddressUpdateInput", + "description": "Defines the input schema for updating a company's legal address.", + "fields": null, + "inputFields": [ { - "name": "quantity_return_requested", - "description": "The requested return quantity of the item.", - "args": [], + "name": "city", + "description": "The city where the company is registered to conduct business.", "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "quantity_returned", - "description": "The number of returned items.", - "args": [], + "name": "country_id", + "description": "The unique ID for a `Country` object.", "type": { - "kind": "SCALAR", - "name": "Float", + "kind": "ENUM", + "name": "CountryCodeEnum", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "quantity_shipped", - "description": "The number of shipped items.", - "args": [], + "name": "postcode", + "description": "The postal code of the company.", "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "selected_options", - "description": "The selected options for the base product, such as color or size.", - "args": [], + "name": "region", + "description": "An object containing the region name and/or region ID where the company is registered to conduct business.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressRegionInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "street", + "description": "An array of strings that define the street address where the company is registered to conduct business.", "type": { "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "OrderItemOption", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "status", - "description": "The status of the order item.", - "args": [], + "name": "telephone", + "description": "The primary phone number of the company.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null + "defaultValue": null } ], + "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "BundleInvoiceItem", - "description": "Defines bundle product options for `InvoiceItemInterface`.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "CompanyUserCreateInput", + "description": "Defines the input schema for creating a company user.", + "fields": null, + "inputFields": [ { - "name": "bundle_options", - "description": "A list of bundle options that are assigned to an invoiced bundle product.", - "args": [], + "name": "email", + "description": "The company user's email address", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "ItemSelectedBundleOption", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "discounts", - "description": "Information about the final discount amount for the base product, including discounts on options.", - "args": [], + "name": "firstname", + "description": "The company user's first name.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Discount", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "id", - "description": "The unique ID for an `InvoiceItemInterface` object.", - "args": [], + "name": "job_title", + "description": "The company user's job title or function.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "The company user's last name.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "role_id", + "description": "The unique ID for a `CompanyRole` object.", "type": { "kind": "NON_NULL", "name": null, @@ -50857,114 +50332,198 @@ "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "order_item", - "description": "Details about an individual order item.", - "args": [], + "name": "status", + "description": "Indicates whether the company user is ACTIVE or INACTIVE.", "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CompanyUserStatusEnum", + "ofType": null + } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "product_name", - "description": "The name of the base product.", - "args": [], + "name": "target_id", + "description": "The ID of a node within a company's structure. This ID will be the parent of the created company user.", "type": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "product_sale_price", - "description": "The sale price for the base product including selected options.", - "args": [], + "name": "telephone", + "description": "The company user's phone number.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyUserUpdateInput", + "description": "Defines the input schema for updating a company user.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "The company user's email address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null }, { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], + "name": "firstname", + "description": "The company user's first name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "id", + "description": "The unique ID of a `Customer` object.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "quantity_invoiced", - "description": "The number of invoiced items.", - "args": [], + "name": "job_title", + "description": "The company user's job title or function.", "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ + "defaultValue": null + }, { - "kind": "INTERFACE", - "name": "InvoiceItemInterface", - "ofType": null + "name": "lastname", + "description": "The company user's last name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "role_id", + "description": "The unique ID for a `CompanyRole` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "status", + "description": "Indicates whether the company user is ACTIVE or INACTIVE.", + "type": { + "kind": "ENUM", + "name": "CompanyUserStatusEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "telephone", + "description": "The company user's phone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null } ], + "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "BundleShipmentItem", - "description": "Defines bundle product options for `ShipmentItemInterface`.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "CompanyRoleCreateInput", + "description": "Defines the input schema for creating a company role.", + "fields": null, + "inputFields": [ { - "name": "bundle_options", - "description": "A list of bundle options that are assigned to a shipped product.", - "args": [], + "name": "name", + "description": "The name of the role to create.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "ItemSelectedBundleOption", + "kind": "SCALAR", + "name": "String", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, + { + "name": "permissions", + "description": "A list of resources the role can access.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyRoleUpdateInput", + "description": "Defines the input schema for updating a company role.", + "fields": null, + "inputFields": [ { "name": "id", - "description": "The unique ID for a `ShipmentItemInterface` object.", - "args": [], + "description": "The unique ID for a `CompanyRole` object.", "type": { "kind": "NON_NULL", "name": null, @@ -50974,75 +50533,117 @@ "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null + }, + { + "name": "name", + "description": "The name of the role to update.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null }, { - "name": "order_item", - "description": "The order item associated with the shipment item.", - "args": [], + "name": "permissions", + "description": "A list of resources the role can access.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UserCompaniesInput", + "description": "Defines the input for returning matching companies the customer is assigned to.", + "fields": null, + "inputFields": [ + { + "name": "currentPage", + "description": "Specifies which page of results to return. The default value is 1.", "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", + "kind": "SCALAR", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "product_name", - "description": "The name of the base product.", - "args": [], + "name": "pageSize", + "description": "Specifies the maximum number of results to return at once. This attribute is optional.", "type": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "product_sale_price", - "description": "The sale price for the base product.", - "args": [], + "name": "sort", + "description": "Defines the sorting of the results.", "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", + "kind": "INPUT_OBJECT", + "name": "CompaniesSortInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UserCompaniesOutput", + "description": "An object that contains a list of companies customer is assigned to.", + "fields": [ { - "name": "product_sku", - "description": "The SKU of the base product.", + "name": "items", + "description": "An array of companies customer is assigned to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyBasicInfo", + "ofType": null + } } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "quantity_shipped", - "description": "The number of shipped items.", + "name": "page_info", + "description": "Provides navigation for the query response.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "Float", + "kind": "OBJECT", + "name": "SearchResultPageInfo", "ofType": null } }, @@ -51051,56 +50652,74 @@ } ], "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ShipmentItemInterface", - "ofType": null - } - ], + "interfaces": [], "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "BundleCreditMemoItem", - "description": "Defines bundle product options for `CreditMemoItemInterface`.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "CompaniesSortInput", + "description": "Specifies which field to sort on, and whether to return the results in ascending or descending order.", + "fields": null, + "inputFields": [ { - "name": "bundle_options", - "description": "A list of bundle options that are assigned to a bundle product that is part of a credit memo.", - "args": [], + "name": "field", + "description": "The field for sorting the results.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "ItemSelectedBundleOption", + "kind": "ENUM", + "name": "CompaniesSortFieldEnum", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "discounts", - "description": "Details about the final discount amount for the base product, including discounts on options.", - "args": [], + "name": "order", + "description": "Indicates whether to return results in ascending or descending order.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Discount", + "kind": "ENUM", + "name": "SortEnum", "ofType": null } }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompaniesSortFieldEnum", + "description": "The fields available for sorting the customer companies.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NAME", + "description": "The name of the company.", "isDeprecated": false, "deprecationReason": null - }, + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyBasicInfo", + "description": "The minimal required information to identify and display the company.", + "fields": [ { "name": "id", - "description": "The unique ID for a `CreditMemoItemInterface` object.", + "description": "The unique ID of a `Company` object.", "args": [], "type": { "kind": "NON_NULL", @@ -51115,20 +50734,8 @@ "deprecationReason": null }, { - "name": "order_item", - "description": "The order item the credit memo is applied to.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", + "name": "legal_name", + "description": "The full legal name of the company.", "args": [], "type": { "kind": "SCALAR", @@ -51139,44 +50746,12 @@ "deprecationReason": null }, { - "name": "product_sale_price", - "description": "The sale price for the base product, including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_refunded", - "description": "The number of refunded items.", + "name": "name", + "description": "The name of the company.", "args": [], "type": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null }, "isDeprecated": false, @@ -51184,41 +50759,19 @@ } ], "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CreditMemoItemInterface", - "ofType": null - } - ], + "interfaces": [], "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "ItemSelectedBundleOption", - "description": "A list of options of the selected bundle product.", - "fields": [ - { - "name": "id", - "description": "The unique ID for a `ItemSelectedBundleOption` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, + "kind": "INPUT_OBJECT", + "name": "CompanyInvitationInput", + "description": "Defines the input schema for accepting the company invitation.", + "fields": null, + "inputFields": [ { - "name": "label", - "description": "The label of the option.", - "args": [], + "name": "code", + "description": "The invitation code.", "type": { "kind": "NON_NULL", "name": null, @@ -51228,56 +50781,46 @@ "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "uid", - "description": "The unique ID for a `ItemSelectedBundleOption` object.", - "args": [], + "name": "role_id", + "description": "The company role id.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "ID", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "values", - "description": "A list of products that represent the values of the parent option.", - "args": [], + "name": "user", + "description": "Company user attributes in the invitation.", "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "ItemSelectedBundleOptionValue", + "kind": "INPUT_OBJECT", + "name": "CompanyInvitationUserInput", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null } ], - "inputFields": null, - "interfaces": [], + "interfaces": null, "enumValues": null, "possibleTypes": null }, { - "kind": "OBJECT", - "name": "ItemSelectedBundleOptionValue", - "description": "A list of values for the selected bundle product.", - "fields": [ + "kind": "INPUT_OBJECT", + "name": "CompanyInvitationUserInput", + "description": "Company user attributes in the invitation.", + "fields": null, + "inputFields": [ { - "name": "id", - "description": "The unique ID for a `ItemSelectedBundleOptionValue` object.", - "args": [], + "name": "company_id", + "description": "The company unique identifier.", "type": { "kind": "NON_NULL", "name": null, @@ -51287,85 +50830,70 @@ "ofType": null } }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." + "defaultValue": null }, { - "name": "price", - "description": "The price of the child bundle product.", - "args": [], + "name": "customer_id", + "description": "The customer unique identifier.", "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Money", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "product_name", - "description": "The name of the child bundle product.", - "args": [], + "name": "job_title", + "description": "The job title of a company user.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "product_sku", - "description": "The SKU of the child bundle product.", - "args": [], + "name": "status", + "description": "Indicates whether the company user is ACTIVE or INACTIVE.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "ENUM", + "name": "CompanyUserStatusEnum", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "defaultValue": null }, { - "name": "quantity", - "description": "The number of this bundle product that were ordered.", - "args": [], + "name": "telephone", + "description": "The phone number of the company user.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, - "isDeprecated": false, - "deprecationReason": null - }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyInvitationOutput", + "description": "The result of accepting the company invitation.", + "fields": [ { - "name": "uid", - "description": "The unique ID for a `ItemSelectedBundleOptionValue` object.", + "name": "success", + "description": "Indicates whether the customer was added to the company successfully.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "isDeprecated": false, "deprecationReason": null @@ -51378,83 +50906,70 @@ }, { "kind": "OBJECT", - "name": "BundleWishlistItem", - "description": "Defines bundle product options for `WishlistItemInterface`.", + "name": "CompanyStructureItem", + "description": "Defines an individual node in the company structure.", "fields": [ { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "bundle_options", - "description": "An array containing information about the selected bundle items.", + "name": "entity", + "description": "A union of `CompanyTeam` and `Customer` objects.", "args": [], "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedBundleOption", - "ofType": null - } + "kind": "UNION", + "name": "CompanyStructureEntity", + "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", + "name": "id", + "description": "The unique ID for a `CompanyStructureItem` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } + "kind": "SCALAR", + "name": "ID", + "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "description", - "description": "The description of the item.", + "name": "parent_id", + "description": "The ID of the parent item in the company hierarchy.", "args": [], "type": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null - }, + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerSegment", + "description": "Customer segment.", + "fields": [ { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", + "name": "apply_to", + "description": "Customer segment is applicable to visitor, registered customer or both.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "SCALAR", - "name": "ID", + "kind": "ENUM", + "name": "CustomerSegmentApplyTo", "ofType": null } }, @@ -51462,27 +50977,27 @@ "deprecationReason": null }, { - "name": "product", - "description": "Product details of the wish list item.", + "name": "description", + "description": "Customer segment description.", "args": [], "type": { - "kind": "INTERFACE", - "name": "ProductInterface", + "kind": "SCALAR", + "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "quantity", - "description": "The quantity of this wish list item.", + "name": "name", + "description": "Customer segment name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Float", + "name": "String", "ofType": null } }, @@ -51491,14 +51006,37 @@ } ], "inputFields": null, - "interfaces": [ + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerSegmentApplyTo", + "description": "Customer segment is applicable to visitor, registered customers or both.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null + "name": "BOTH", + "description": "Customer segment is applicable to visitor and registered customers.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REGISTERED", + "description": "Customer segment is applicable to registered customers.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VISITOR", + "description": "Customer segment is applicable to visitors/guests.", + "isDeprecated": false, + "deprecationReason": null } ], - "enumValues": null, "possibleTypes": null }, { @@ -53375,12 +52913,12 @@ }, { "kind": "OBJECT", - "name": "DownloadableOrderItem", + "name": "BundleOrderItem", "ofType": null }, { "kind": "OBJECT", - "name": "BundleOrderItem", + "name": "DownloadableOrderItem", "ofType": null }, { @@ -53725,12 +53263,12 @@ }, { "kind": "OBJECT", - "name": "DownloadableWishlistItem", + "name": "BundleWishlistItem", "ofType": null }, { "kind": "OBJECT", - "name": "BundleWishlistItem", + "name": "DownloadableWishlistItem", "ofType": null }, { @@ -54011,12 +53549,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "REQUIRED_PARAMETER_MISSING", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, { "name": "NOT_SALABLE", "description": "", @@ -55272,6 +54804,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "rules", + "description": "Provides applied catalog rules in the current active cart", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CatalogRule", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "sale", "description": null, @@ -56852,266 +56400,20 @@ "description": "The name of the person receiving the gift card.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sender_email", - "description": "The email address of the sender.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sender_name", - "description": "The name of the sender.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CartItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftCardWishlistItem", - "description": "A single gift card added to a wish list.", - "fields": [ - { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "The description of the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_card_options", - "description": "Details about a gift card.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftCardOptions", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Product details of the wish list item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftCardOptions", - "description": "Contains details about the sender, recipient, and amount of a gift card.", - "fields": [ - { - "name": "amount", - "description": "The amount and currency of the gift card.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_giftcard_amount", - "description": "The custom amount and currency of the gift card.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "message", - "description": "A message to the recipient.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "recipient_email", - "description": "The email address of the person receiving the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "recipient_name", - "description": "The name of the person receiving the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sender_email", - "description": "The email address of the person sending the gift card.", + "description": "The email address of the sender.", "args": [], "type": { "kind": "SCALAR", @@ -57123,37 +56425,63 @@ }, { "name": "sender_name", - "description": "The name of the person sending the gift card.", + "description": "The name of the sender.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, - "interfaces": [], + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "GiftCartAttributeValue", - "description": "Gift card custom attribute value containing array data.", + "name": "GiftCardWishlistItem", + "description": "A single gift card added to a wish list.", "fields": [ { - "name": "code", - "description": "The attribute code.", + "name": "added_at", + "description": "The date and time the item was added to the wish list.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, @@ -57161,8 +56489,8 @@ "deprecationReason": null }, { - "name": "options", - "description": "Array of gift card attribute option values.", + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", "args": [], "type": { "kind": "NON_NULL", @@ -57171,27 +56499,194 @@ "kind": "LIST", "name": null, "ofType": { - "kind": "SCALAR", - "name": "String", + "kind": "OBJECT", + "name": "SelectedCustomizableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_card_options", + "description": "Details about a gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftCardOptions", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Product details of the wish list item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", - "name": "AttributeValueInterface", + "name": "WishlistItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "GiftCardOptions", + "description": "Contains details about the sender, recipient, and amount of a gift card.", + "fields": [ + { + "name": "amount", + "description": "The amount and currency of the gift card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_giftcard_amount", + "description": "The custom amount and currency of the gift card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A message to the recipient.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recipient_email", + "description": "The email address of the person receiving the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recipient_name", + "description": "The name of the person receiving the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sender_email", + "description": "The email address of the person sending the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sender_name", + "description": "The name of the person sending the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "GiftRegistrySearchResult", @@ -57830,16 +57325,6 @@ "ofType": null }, "defaultValue": null - }, - { - "name": "customer_address_uid", - "description": "The unique ID assigned to this customer address.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null } ], "interfaces": null, @@ -60740,6 +60225,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "rules", + "description": "Provides applied catalog rules in the current active cart", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CatalogRule", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "sale", "description": null, @@ -63195,12 +62696,12 @@ "possibleTypes": [ { "kind": "OBJECT", - "name": "DownloadableInvoiceItem", + "name": "BundleInvoiceItem", "ofType": null }, { "kind": "OBJECT", - "name": "BundleInvoiceItem", + "name": "DownloadableInvoiceItem", "ofType": null }, { @@ -64244,12 +63745,12 @@ "possibleTypes": [ { "kind": "OBJECT", - "name": "DownloadableCreditMemoItem", + "name": "BundleCreditMemoItem", "ofType": null }, { "kind": "OBJECT", - "name": "BundleCreditMemoItem", + "name": "DownloadableCreditMemoItem", "ofType": null }, { @@ -64667,69 +64168,6 @@ "name": "OrderInformationInput", "description": "Input to retrieve an order based on details.", "fields": null, - "inputFields": [ - { - "name": "email", - "description": "Order billing address email.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "lastname", - "description": "Order billing address lastname.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "number", - "description": "Order number.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "postcode", - "description": "Order billing address postcode", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "GuestOrderInformationInput", - "description": "Input to retrieve an order based on details.", - "fields": null, "inputFields": [ { "name": "email", @@ -67058,31 +66496,35 @@ }, { "kind": "OBJECT", - "name": "AddProductsToNewCartOutput", - "description": "Contains details about the cart after adding products to it.", + "name": "DynamicBlock", + "description": "Contains a single dynamic block.", "fields": [ { - "name": "cart", - "description": "The cart after products have been added.", + "name": "content", + "description": "The renderable HTML code of the dynamic block.", "args": [], "type": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null }, { - "name": "user_errors", - "description": "Contains errors encountered while adding an item to the cart.", + "name": "uid", + "description": "The unique ID of a `DynamicBlock` object.", "args": [], "type": { - "kind": "LIST", + "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "CartUserInputError", + "kind": "SCALAR", + "name": "ID", "ofType": null } }, @@ -67097,31 +66539,51 @@ }, { "kind": "OBJECT", - "name": "SetCartAsInactiveOutput", - "description": "Sets the cart as inactive", + "name": "DynamicBlocks", + "description": "Contains an array of dynamic blocks.", "fields": [ { - "name": "error", - "description": "The error message returned after failing to set the cart as inactive", + "name": "items", + "description": "An array containing individual dynamic blocks.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DynamicBlock", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Metadata for pagination rendering.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { - "name": "success", - "description": "Indicates whether the cart was set as inactive", + "name": "total_count", + "description": "The number of returned dynamic blocks.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "Boolean", + "name": "Int", "ofType": null } }, @@ -67134,6 +66596,129 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "DynamicBlocksFilterInput", + "description": "Defines the dynamic block filter. The filter can identify the block type, location and IDs to return.", + "fields": null, + "inputFields": [ + { + "name": "dynamic_block_uids", + "description": "An array of dynamic block UIDs to filter on.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "locations", + "description": "An array indicating the locations the dynamic block can be placed.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DynamicBlockLocationEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "type", + "description": "A value indicating the type of dynamic block to filter on.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DynamicBlockTypeEnum", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DynamicBlockTypeEnum", + "description": "Indicates the selected Dynamic Blocks Rotator inline widget.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SPECIFIED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CART_PRICE_RULE_RELATED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_PRICE_RULE_RELATED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DynamicBlockLocationEnum", + "description": "Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CONTENT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HEADER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FOOTER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LEFT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RIGHT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "OBJECT", "name": "GetPaymentSDKOutput", @@ -67453,45 +67038,6 @@ "enumValues": null, "possibleTypes": null }, - { - "kind": "INPUT_OBJECT", - "name": "CompleteOrderInput", - "description": "Update the quote and complete the order", - "fields": null, - "inputFields": [ - { - "name": "cartId", - "description": "The customer cart ID", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "id", - "description": "PayPal order ID", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, { "kind": "INPUT_OBJECT", "name": "SyncPaymentOrderInput", @@ -67634,12 +67180,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "START_OF_CHECKOUT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, { "name": "ADMIN", "description": "", @@ -67666,18 +67206,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "fastlane", - "description": "Fastlane payment method configuration", - "args": [], - "type": { - "kind": "OBJECT", - "name": "FastlaneConfig", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "google_pay", "description": "GooglePay payment method configuration", @@ -67830,11 +67358,6 @@ "kind": "OBJECT", "name": "GooglePayConfig", "ofType": null - }, - { - "kind": "OBJECT", - "name": "FastlaneConfig", - "ofType": null } ] }, @@ -68130,18 +67653,6 @@ "name": "SmartButtonsConfig", "description": "", "fields": [ - { - "name": "app_switch_when_available", - "description": "Indicated whether to use App Switch on enabled mobile devices", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "button_styles", "description": "The styles for the PayPal Smart Button configuration", @@ -68397,138 +67908,21 @@ }, { "kind": "OBJECT", - "name": "GooglePayConfig", - "description": "", - "fields": [ - { - "name": "button_styles", - "description": "The styles for the GooglePay Button configuration", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GooglePayButtonStyles", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "code", - "description": "The payment method code as defined in the payment gateway", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_visible", - "description": "Indicates whether the payment method is displayed", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "payment_intent", - "description": "Defines the payment intent (Authorize or Capture", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "payment_source", - "description": "The payment source for the payment method", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sdk_params", - "description": "The PayPal parameters required to load the JS SDK", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SDKParams", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The relative order the payment method is displayed on the checkout page", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "three_ds_mode", - "description": "3DS mode", - "args": [], - "type": { - "kind": "ENUM", - "name": "ThreeDSMode", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The name displayed for the payment method", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "PaymentConfigItem", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "FastlaneConfig", + "name": "GooglePayConfig", "description": "", "fields": [ + { + "name": "button_styles", + "description": "The styles for the GooglePay Button configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GooglePayButtonStyles", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "code", "description": "The payment method code as defined in the payment gateway", @@ -69151,37 +68545,6 @@ "enumValues": null, "possibleTypes": null }, - { - "kind": "INPUT_OBJECT", - "name": "FastlaneMethodInput", - "description": "Fastlane Payment inputs", - "fields": null, - "inputFields": [ - { - "name": "payment_source", - "description": "The payment source for the payment method", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "paypal_fastlane_token", - "description": "The single use token from Fastlane", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, { "kind": "INPUT_OBJECT", "name": "CreateVaultCardSetupTokenInput", @@ -76608,244 +75971,19 @@ }, { "kind": "OBJECT", - "name": "DynamicBlock", - "description": "Contains a single dynamic block.", - "fields": [ - { - "name": "content", - "description": "The renderable HTML code of the dynamic block.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID of a `DynamicBlock` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DynamicBlocks", - "description": "Contains an array of dynamic blocks.", - "fields": [ - { - "name": "items", - "description": "An array containing individual dynamic blocks.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DynamicBlock", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Metadata for pagination rendering.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The number of returned dynamic blocks.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "DynamicBlocksFilterInput", - "description": "Defines the dynamic block filter. The filter can identify the block type, location and IDs to return.", - "fields": null, - "inputFields": [ - { - "name": "dynamic_block_uids", - "description": "An array of dynamic block UIDs to filter on.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "locations", - "description": "An array indicating the locations the dynamic block can be placed.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "DynamicBlockLocationEnum", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "type", - "description": "A value indicating the type of dynamic block to filter on.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "DynamicBlockTypeEnum", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "DynamicBlockTypeEnum", - "description": "Indicates the selected Dynamic Blocks Rotator inline widget.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "SPECIFIED", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "CART_PRICE_RULE_RELATED", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "CATALOG_PRICE_RULE_RELATED", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "DynamicBlockLocationEnum", - "description": "Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "CONTENT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "HEADER", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "FOOTER", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "LEFT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "RIGHT", - "description": "", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CartRuleStorefront", + "name": "CartRule", "description": "", "fields": [ { - "name": "uid", - "description": "The unique ID for a `CartRule` object.", + "name": "name", + "description": "Name of the cart price rule", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "String", "ofType": null } }, @@ -77192,45 +76330,177 @@ "possibleTypes": null }, { - "kind": "INPUT_OBJECT", - "name": "ExchangeExternalCustomerTokenInput", - "description": "Contains details about external customer.", - "fields": null, - "inputFields": [ + "kind": "OBJECT", + "name": "EntityUrl", + "description": "Contains the `uid`, `relative_url`, and `type` attributes.", + "fields": [ { - "name": "customer", - "description": "An input object that defines the customer characteristics to update.", + "name": "canonical_url", + "description": null, + "args": [], "type": { - "kind": "NON_NULL", + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `relative_url` instead." + }, + { + "name": "entity_uid", + "description": "The unique ID for a `ProductInterface`, `CategoryInterface`, `CmsPage`, or similar object associated with the specified URL. This could be a product, category, or CMS page UID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `entity_uid` instead." + }, + { + "name": "redirectCode", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRewrite", + "description": "Contains URL rewrite details.", + "fields": [ + { + "name": "parameters", + "description": "An array of request parameters.", + "args": [], + "type": { + "kind": "LIST", "name": null, "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomerCreateInput", + "kind": "OBJECT", + "name": "HttpQueryParameter", "ofType": null } }, - "defaultValue": null + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The request URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], - "interfaces": null, + "inputFields": null, + "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", - "name": "ExchangeExternalCustomerTokenOutput", - "description": "Contains customer token for external customer.", + "name": "HttpQueryParameter", + "description": "Contains target path parameters.", "fields": [ { - "name": "customer", - "description": "Return detailed information about a customer account.", + "name": "name", + "description": "A parameter name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "A parameter value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RoutableUrl", + "description": "Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity.", + "fields": [ + { + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Customer", + "kind": "SCALAR", + "name": "Int", "ofType": null } }, @@ -77238,26 +76508,142 @@ "deprecationReason": null }, { - "name": "token", - "description": "The customer authorization token.", + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "description": "Routable entities serve as the model for a rendered page.", + "fields": [ + { + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, - "possibleTypes": null + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CmsPage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CategoryTree", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VirtualProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SimpleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DownloadableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GroupedProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "RoutableUrl", + "ofType": null + } + ] }, { "kind": "INTERFACE", @@ -78144,18 +77530,6 @@ "name": "__Schema", "description": "A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.", "fields": [ - { - "name": "description", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "types", "description": "A list of all types supported by this server.", @@ -78303,13 +77677,9 @@ "name": "includeDeprecated", "description": null, "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "defaultValue": "false" } @@ -78378,13 +77748,9 @@ "name": "includeDeprecated", "description": null, "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "defaultValue": "false" } @@ -78413,13 +77779,9 @@ "name": "includeDeprecated", "description": null, "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "defaultValue": "false" } @@ -78451,18 +77813,6 @@ }, "isDeprecated": false, "deprecationReason": null - }, - { - "name": "isOneOf", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null } ], "inputFields": null, @@ -78570,13 +77920,9 @@ "name": "includeDeprecated", "description": null, "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } + "kind": "SCALAR", + "name": "Boolean", + "ofType": null }, "defaultValue": "false" } @@ -78889,22 +78235,7 @@ { "name": "args", "description": null, - "args": [ - { - "name": "includeDeprecated", - "description": null, - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "defaultValue": "false" - } - ], + "args": [], "type": { "kind": "NON_NULL", "name": null, @@ -79129,14 +78460,6 @@ "defaultValue": "\"No longer supported\"" } ] - }, - { - "name": "oneOf", - "description": "Indicates that an Input Object is a OneOf Input Object (and thus requires exactly one of its fields be provided).", - "locations": [ - "INPUT_OBJECT" - ], - "args": [] } ] } diff --git a/src/data/navigation/header.js b/src/data/navigation/header.js index 85281e473..e30f4c3f8 100644 --- a/src/data/navigation/header.js +++ b/src/data/navigation/header.js @@ -36,8 +36,8 @@ module.exports = [ path: "/reference/graphql/saas" }, { - title: "2.4.9-beta-1 Reference", - path: "/reference/graphql/2.4.9-beta-1", + title: "2.4.9 Reference", + path: "/reference/graphql/2.4.9", }, { title: "2.4.8 Reference", diff --git a/src/data/navigation/sections/graphql.js b/src/data/navigation/sections/graphql.js index 0420c4378..433dbd4f2 100644 --- a/src/data/navigation/sections/graphql.js +++ b/src/data/navigation/sections/graphql.js @@ -1601,8 +1601,8 @@ module.exports = [ EventTarget: "_top" }, { - title: "2.4.9-beta-1", - path: "https://developer.adobe.com/commerce/webapi/reference/graphql/2.4.9-beta-1/", + title: "2.4.9", + path: "https://developer.adobe.com/commerce/webapi/reference/graphql/2.4.9/", EventTarget: "_top" }, { diff --git a/src/openapi/admin-schema-2.4.9-beta-1.yaml b/src/openapi/admin-schema-2.4.9-beta-1.yaml deleted file mode 100644 index 31d73755e..000000000 --- a/src/openapi/admin-schema-2.4.9-beta-1.yaml +++ /dev/null @@ -1,37205 +0,0 @@ ---- -securityDefinitions: - api_key: - type: apiKey - name: api_key - in: header -swagger: '2.0' -info: - version: 2.4.9-beta-1 - title: Commerce Admin REST endpoints - All inclusive - description: - "$ref": "../_includes/redocly-intro.md" -host: example.com -basePath: "/rest/default" -schemes: -- http -tags: -- name: addresses/{addressId} -- name: adminuisdk/appmanagement/validate -- name: adminuisdk/massaction/{request_id} -- name: adminuisdk/orderviewbutton/{request_id} -- name: adobe_io_events/check_configuration -- name: adobestock/asset/{id} -- name: adobestock/asset/list -- name: adobestock/asset/search -- name: adobestock/search -- name: analytics/link -- name: applepay/auth -- name: attributeMetadata/customer -- name: attributeMetadata/customer/attribute/{attributeCode} -- name: attributeMetadata/customer/custom -- name: attributeMetadata/customer/form/{formCode} -- name: attributeMetadata/customerAddress -- name: attributeMetadata/customerAddress/attribute/{attributeCode} -- name: attributeMetadata/customerAddress/custom -- name: attributeMetadata/customerAddress/form/{formCode} -- name: braintree/mine/payment/vault -- name: bulk -- name: bulk/{bulkUuid}/detailed-status -- name: bulk/{bulkUuid}/operation-status/{status} -- name: bulk/{bulkUuid}/status -- name: bundle-products/{productSku}/children -- name: bundle-products/{sku}/links/{id} -- name: bundle-products/{sku}/links/{optionId} -- name: bundle-products/{sku}/options/{optionId} -- name: bundle-products/{sku}/options/{optionId}/children/{childSku} -- name: bundle-products/{sku}/options/all -- name: bundle-products/options/{optionId} -- name: bundle-products/options/add -- name: bundle-products/options/types -- name: carts/ -- name: carts/{cartId} -- name: carts/{cartId}/billing-address -- name: carts/{cartId}/coupons -- name: carts/{cartId}/coupons/{couponCode} -- name: carts/{cartId}/coupons/deleteByCodes -- name: carts/{cartId}/estimate-shipping-methods -- name: carts/{cartId}/estimate-shipping-methods-by-address-id -- name: carts/{cartId}/gift-message -- name: carts/{cartId}/gift-message/{itemId} -- name: carts/{cartId}/giftCards -- name: carts/{cartId}/giftCards/{giftCardCode} -- name: carts/{cartId}/items -- name: carts/{cartId}/items/{itemId} -- name: carts/{cartId}/order -- name: carts/{cartId}/payment-methods -- name: carts/{cartId}/selected-payment-method -- name: carts/{cartId}/shipping-information -- name: carts/{cartId}/shipping-methods -- name: carts/{cartId}/totals -- name: carts/{cartId}/totals-information -- name: carts/{quoteId}/giftCards -- name: carts/{quoteId}/items -- name: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} -- name: carts/guest-carts/{cartId}/giftCards -- name: carts/guest-carts/{cartId}/giftCards/{giftCardCode} -- name: carts/licence -- name: carts/licence/list -- name: carts/mine -- name: carts/mine/balance/apply -- name: carts/mine/billing-address -- name: carts/mine/checkGiftCard/{giftCardCode} -- name: carts/mine/collect-totals -- name: carts/mine/coupons -- name: carts/mine/coupons/{couponCode} -- name: carts/mine/coupons/deleteByCodes -- name: carts/mine/estimate-shipping-methods -- name: carts/mine/estimate-shipping-methods-by-address-id -- name: carts/mine/gift-message -- name: carts/mine/gift-message/{itemId} -- name: carts/mine/giftCards -- name: carts/mine/giftCards/{giftCardCode} -- name: carts/mine/items -- name: carts/mine/items/{itemId} -- name: carts/mine/order -- name: carts/mine/payment-information -- name: carts/mine/payment-methods -- name: carts/mine/payment-order -- name: carts/mine/payment-order/{id} -- name: carts/mine/po-payment-information -- name: carts/mine/selected-payment-method -- name: carts/mine/set-payment-information -- name: carts/mine/shipping-information -- name: carts/mine/shipping-methods -- name: carts/mine/totals -- name: carts/mine/totals-information -- name: carts/search -- name: categories -- name: categories/{categoryId} -- name: categories/{categoryId}/move -- name: categories/{categoryId}/products -- name: categories/{categoryId}/products/{sku} -- name: categories/{id} -- name: categories/attributes -- name: categories/attributes/{attributeCode} -- name: categories/attributes/{attributeCode}/options -- name: categories/list -- name: cmsBlock -- name: cmsBlock/{blockId} -- name: cmsBlock/{id} -- name: cmsBlock/search -- name: cmsPage -- name: cmsPage/{id} -- name: cmsPage/{pageId} -- name: cmsPage/search -- name: company/ -- name: company/{companyId} -- name: company/{parentId}/relations -- name: company/{parentId}/relations/{companyId} -- name: company/assignRoles -- name: company/relations -- name: company/role/ -- name: company/role/{id} -- name: company/role/{roleId} -- name: company/role/{roleId}/users -- name: companyCredits/ -- name: companyCredits/{creditId} -- name: companyCredits/{creditId}/decreaseBalance -- name: companyCredits/{creditId}/increaseBalance -- name: companyCredits/{id} -- name: companyCredits/company/{companyId} -- name: companyCredits/history -- name: companyCredits/history/{historyId} -- name: configurable-products/{sku}/child -- name: configurable-products/{sku}/children -- name: configurable-products/{sku}/children/{childSku} -- name: configurable-products/{sku}/options -- name: configurable-products/{sku}/options/{id} -- name: configurable-products/{sku}/options/all -- name: configurable-products/variation -- name: coupons -- name: coupons/{couponId} -- name: coupons/deleteByCodes -- name: coupons/deleteByIds -- name: coupons/generate -- name: coupons/search -- name: creditmemo -- name: creditmemo/{id} -- name: creditmemo/{id}/comments -- name: creditmemo/{id}/emails -- name: creditmemo/refund -- name: creditmemos -- name: customerGroups -- name: customerGroups/{id} -- name: customerGroups/{id}/permissions -- name: customerGroups/default -- name: customerGroups/default/{id} -- name: customerGroups/default/{storeId} -- name: customerGroups/search -- name: customers -- name: customers/{customerId} -- name: customers/{customerId}/billingAddress -- name: customers/{customerId}/carts -- name: customers/{customerId}/companies -- name: customers/{customerId}/companies/{companyId} -- name: customers/{customerId}/confirm -- name: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} -- name: customers/{customerId}/permissions/readonly -- name: customers/{customerId}/shippingAddress -- name: customers/{customerId}/token -- name: customers/{email}/activate -- name: customers/activate -- name: customers/addresses/{addressId} -- name: customers/companies -- name: customers/confirm -- name: customers/isEmailAvailable -- name: customers/me -- name: customers/me/activate -- name: customers/me/billingAddress -- name: customers/me/password -- name: customers/me/shippingAddress -- name: customers/password -- name: customers/resetPassword -- name: customers/search -- name: customers/validate -- name: directory/countries -- name: directory/countries/{countryId} -- name: directory/currency -- name: eav/attribute-sets -- name: eav/attribute-sets/{attributeSetId} -- name: eav/attribute-sets/list -- name: eventing/eventProvider -- name: eventing/eventProvider/{providerId} -- name: eventing/eventSubscribe -- name: eventing/eventSubscribe/{name} -- name: eventing/eventUnsubscribe/{name} -- name: eventing/getEventProviders -- name: eventing/getEventSubscriptions -- name: eventing/updateConfiguration -- name: gift-wrappings -- name: gift-wrappings/{id} -- name: gift-wrappings/{wrappingId} -- name: giftregistry/mine/estimate-shipping-methods -- name: guest-carts -- name: guest-carts/{cartId} -- name: guest-carts/{cartId}/billing-address -- name: guest-carts/{cartId}/collect-totals -- name: guest-carts/{cartId}/coupons -- name: guest-carts/{cartId}/coupons/{couponCode} -- name: guest-carts/{cartId}/estimate-shipping-methods -- name: guest-carts/{cartId}/gift-message -- name: guest-carts/{cartId}/gift-message/{itemId} -- name: guest-carts/{cartId}/items -- name: guest-carts/{cartId}/items/{itemId} -- name: guest-carts/{cartId}/order -- name: guest-carts/{cartId}/payment-information -- name: guest-carts/{cartId}/payment-methods -- name: guest-carts/{cartId}/payment-order -- name: guest-carts/{cartId}/payment-order/{id} -- name: guest-carts/{cartId}/selected-payment-method -- name: guest-carts/{cartId}/set-payment-information -- name: guest-carts/{cartId}/shipping-information -- name: guest-carts/{cartId}/shipping-methods -- name: guest-carts/{cartId}/totals -- name: guest-carts/{cartId}/totals-information -- name: guest-giftregistry/{cartId}/estimate-shipping-methods -- name: hierarchy/{id} -- name: hierarchy/move/{id} -- name: import/csv -- name: import/json -- name: integration/admin/token -- name: integration/customer/revoke-customer-token -- name: integration/customer/token -- name: inventory/are-product-salable-for-requested-qty/ -- name: inventory/are-products-salable -- name: inventory/bulk-partial-source-transfer -- name: inventory/bulk-product-source-assign -- name: inventory/bulk-product-source-transfer -- name: inventory/bulk-product-source-unassign -- name: inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode} -- name: inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode} -- name: inventory/get-distance -- name: inventory/get-distance-provider-code -- name: inventory/get-latlng-from-address -- name: inventory/get-latslngs-from-address -- name: inventory/get-product-salable-quantity/{sku}/{stockId} -- name: inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId} -- name: inventory/in-store-pickup/pickup-locations/ -- name: inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty} -- name: inventory/is-product-salable/{sku}/{stockId} -- name: inventory/low-quantity-notification -- name: inventory/low-quantity-notification/{sourceCode}/{sku} -- name: inventory/low-quantity-notifications-delete -- name: inventory/source-items -- name: inventory/source-items-delete -- name: inventory/source-selection-algorithm-list -- name: inventory/source-selection-algorithm-result -- name: inventory/sources -- name: inventory/sources/{sourceCode} -- name: inventory/stock-resolver/{type}/{code} -- name: inventory/stock-source-links -- name: inventory/stock-source-links-delete -- name: inventory/stocks -- name: inventory/stocks/{stockId} -- name: invoice/{invoiceId}/refund -- name: invoices -- name: invoices/ -- name: invoices/{id} -- name: invoices/{id}/capture -- name: invoices/{id}/comments -- name: invoices/{id}/emails -- name: invoices/{id}/void -- name: invoices/comments -- name: modules -- name: negotiable-cart-item-note -- name: negotiable-cart-item-note/{noteId} -- name: negotiable-cart-item-note/search -- name: negotiable-carts/{cartId}/billing-address -- name: negotiable-carts/{cartId}/coupons -- name: negotiable-carts/{cartId}/coupons/{couponCode} -- name: negotiable-carts/{cartId}/estimate-shipping-methods -- name: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id -- name: negotiable-carts/{cartId}/giftCards -- name: negotiable-carts/{cartId}/giftCards/{giftCardCode} -- name: negotiable-carts/{cartId}/payment-information -- name: negotiable-carts/{cartId}/po-payment-information -- name: negotiable-carts/{cartId}/set-payment-information -- name: negotiable-carts/{cartId}/shipping-information -- name: negotiable-carts/{cartId}/totals -- name: negotiableQuote/{negotiableQuoteId}/duplicate -- name: negotiableQuote/{quoteId} -- name: negotiableQuote/{quoteId}/comments -- name: negotiableQuote/{quoteId}/shippingMethod -- name: negotiableQuote/attachmentContent -- name: negotiableQuote/decline -- name: negotiableQuote/draft -- name: negotiableQuote/pricesUpdated -- name: negotiableQuote/request -- name: negotiableQuote/submitToCustomer -- name: negotiableQuoteTemplate -- name: negotiableQuoteTemplate/{templateId} -- name: negotiableQuoteTemplate/accept -- name: negotiableQuoteTemplate/cancel -- name: negotiableQuoteTemplate/cancel/me -- name: negotiableQuoteTemplate/decline -- name: negotiableQuoteTemplate/draft -- name: negotiableQuoteTemplate/generateQuote -- name: negotiableQuoteTemplate/me -- name: negotiableQuoteTemplate/me/{templateId} -- name: negotiableQuoteTemplate/open -- name: negotiableQuoteTemplate/open/me -- name: negotiableQuoteTemplate/referenceDocumentLink -- name: negotiableQuoteTemplate/referenceDocumentLink/{linkId} -- name: negotiableQuoteTemplate/request -- name: negotiableQuoteTemplate/request/me -- name: negotiableQuoteTemplate/submitToCustomer -- name: negotiableQuoteTemplate/submitToSeller -- name: order/{orderId}/invoice -- name: order/{orderId}/refund -- name: order/{orderId}/ship -- name: order/notify-orders-are-ready-for-pickup -- name: orders -- name: orders/{id} -- name: orders/{id}/cancel -- name: orders/{id}/comments -- name: orders/{id}/emails -- name: orders/{id}/hold -- name: orders/{id}/statuses -- name: orders/{id}/unhold -- name: orders/{parent_id} -- name: orders/create -- name: orders/items -- name: orders/items/{id} -- name: payment-order/completeOrder -- name: payments-config/{location} -- name: payments-config/apple-pay/{location} -- name: payments-config/google-pay/{location} -- name: payments-config/hosted-fields/{location} -- name: payments-config/smart-buttons/{location} -- name: payments-sdk/{location} -- name: payments-sdk/{location}/{methodCode} -- name: paypal/lineItems -- name: paypal/oneClick -- name: paypal/validatePhoneNumber -- name: products -- name: products-render-info -- name: products/{productSku}/stockItems/{itemId} -- name: products/{sku} -- name: products/{sku}/downloadable-links -- name: products/{sku}/downloadable-links/{id} -- name: products/{sku}/downloadable-links/samples -- name: products/{sku}/downloadable-links/samples/{id} -- name: products/{sku}/group-prices/{customerGroupId}/tiers -- name: products/{sku}/group-prices/{customerGroupId}/tiers/{qty} -- name: products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price} -- name: products/{sku}/links -- name: products/{sku}/links/{type} -- name: products/{sku}/links/{type}/{linkedProductSku} -- name: products/{sku}/media -- name: products/{sku}/media/{entryId} -- name: products/{sku}/options -- name: products/{sku}/options/{optionId} -- name: products/{sku}/websites -- name: products/{sku}/websites/{websiteId} -- name: products/attribute-sets -- name: products/attribute-sets/{attributeSetId} -- name: products/attribute-sets/{attributeSetId}/attributes -- name: products/attribute-sets/{attributeSetId}/attributes/{attributeCode} -- name: products/attribute-sets/{attributeSetId}/groups -- name: products/attribute-sets/attributes -- name: products/attribute-sets/groups -- name: products/attribute-sets/groups/{groupId} -- name: products/attribute-sets/groups/list -- name: products/attribute-sets/sets/list -- name: products/attributes -- name: products/attributes/{attributeCode} -- name: products/attributes/{attributeCode}/is-filterable -- name: products/attributes/{attributeCode}/is-filterable/{isFilterable} -- name: products/attributes/{attributeCode}/options -- name: products/attributes/{attributeCode}/options/{optionId} -- name: products/attributes/types -- name: products/base-prices -- name: products/base-prices-information -- name: products/cost -- name: products/cost-delete -- name: products/cost-information -- name: products/downloadable-links/{id} -- name: products/downloadable-links/samples/{id} -- name: products/links/{type}/attributes -- name: products/links/types -- name: products/media/types/{attributeSetName} -- name: products/options -- name: products/options/{optionId} -- name: products/options/types -- name: products/special-price -- name: products/special-price-delete -- name: products/special-price-information -- name: products/tier-prices -- name: products/tier-prices-delete -- name: products/tier-prices-information -- name: products/types -- name: purchase-order-carts/{cartId}/billing-address -- name: purchase-order-carts/{cartId}/estimate-shipping-methods -- name: purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id -- name: purchase-order-carts/{cartId}/giftCards -- name: purchase-order-carts/{cartId}/giftCards/{giftCardCode} -- name: purchase-order-carts/{cartId}/payment-information -- name: purchase-order-carts/{cartId}/set-payment-information -- name: purchase-order-carts/{cartId}/totals -- name: requisition_lists -- name: returns -- name: returns/{id} -- name: returns/{id}/comments -- name: returns/{id}/labels -- name: returns/{id}/tracking-numbers -- name: returns/{id}/tracking-numbers/{trackId} -- name: returnsAttributeMetadata -- name: returnsAttributeMetadata/{attributeCode} -- name: returnsAttributeMetadata/custom -- name: returnsAttributeMetadata/form/{formCode} -- name: reward/mine/use-reward -- name: salesRules -- name: salesRules/{ruleId} -- name: salesRules/search -- name: search -- name: sharedCatalog -- name: sharedCatalog/ -- name: sharedCatalog/{id} -- name: sharedCatalog/{id}/assignCategories -- name: sharedCatalog/{id}/assignProducts -- name: sharedCatalog/{id}/categories -- name: sharedCatalog/{id}/products -- name: sharedCatalog/{id}/unassignCategories -- name: sharedCatalog/{id}/unassignProducts -- name: sharedCatalog/{sharedCatalogId} -- name: sharedCatalog/{sharedCatalogId}/assignCompanies -- name: sharedCatalog/{sharedCatalogId}/assignTierPrices -- name: sharedCatalog/{sharedCatalogId}/companies -- name: sharedCatalog/{sharedCatalogId}/resetTierPrices -- name: sharedCatalog/{sharedCatalogId}/unassignCompanies -- name: shipment/ -- name: shipment/{id} -- name: shipment/{id}/comments -- name: shipment/{id}/emails -- name: shipment/{id}/label -- name: shipment/track -- name: shipment/track/{id} -- name: shipments -- name: stockItems/{productSku} -- name: stockItems/lowStock/ -- name: stockStatuses/{productSku} -- name: store/storeConfigs -- name: store/storeGroups -- name: store/storeViews -- name: store/websites -- name: taxClasses -- name: taxClasses/{classId} -- name: taxClasses/{taxClassId} -- name: taxClasses/search -- name: taxRates -- name: taxRates/{rateId} -- name: taxRates/search -- name: taxRules -- name: taxRules/{ruleId} -- name: taxRules/search -- name: team/ -- name: team/{companyId} -- name: team/{teamId} -- name: tfa/default-provider-code/{userId} -- name: tfa/forced-providers -- name: tfa/installed-providers -- name: tfa/provider/authy/activate -- name: tfa/provider/authy/authenticate -- name: tfa/provider/authy/authenticate-onetouch -- name: tfa/provider/authy/configure -- name: tfa/provider/authy/send-token/{via} -- name: tfa/provider/duo_security/activate -- name: tfa/provider/duo_security/authenticate -- name: tfa/provider/duo_security/configure -- name: tfa/provider/google/activate -- name: tfa/provider/google/authenticate -- name: tfa/provider/google/configure -- name: tfa/provider/u2fkey/activate -- name: tfa/provider/u2fkey/authentication-challenge -- name: tfa/provider/u2fkey/configure -- name: tfa/provider/u2fkey/verify -- name: tfa/providers-to-activate/{userId} -- name: tfa/tfat-providers-to-activate -- name: tfa/tfat-user-providers -- name: tfa/user-providers/{userId} -- name: transactions -- name: transactions/{id} -- name: webhooks/list -- name: webhooks/subscribe -- name: webhooks/unsubscribe -paths: - "/V1/addresses/{addressId}": - delete: - tags: - - addresses/{addressId} - description: Delete customer address by ID. - operationId: DeleteV1AddressesAddressId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: addressId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: addresses/{addressId} - "/V1/adminuisdk/appmanagement/validate": - post: - tags: - - adminuisdk/appmanagement/validate - description: Validate App Management User token - operationId: PostV1AdminuisdkAppmanagementValidate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1AdminuisdkAppmanagementValidateBody - in: body - schema: - required: - - orgId - properties: - orgId: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/commerce-backend-uix-data-app-management-validation-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: adminuisdk/appmanagement/validate - "/V1/adminuisdk/massaction/{request_id}": - get: - tags: - - adminuisdk/massaction/{request_id} - description: Load mass actions failed request by request id - operationId: GetV1AdminuisdkMassactionRequest_id - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: requestId - in: query - type: string - required: true - - name: request_id - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/commerce-backend-uix-data-mass-action-failed-request-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: adminuisdk/massaction/{request_id} - "/V1/adminuisdk/orderviewbutton/{request_id}": - get: - tags: - - adminuisdk/orderviewbutton/{request_id} - description: Load order view button failed request by request id - operationId: GetV1AdminuisdkOrderviewbuttonRequest_id - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: requestId - in: query - type: string - required: true - - name: request_id - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/commerce-backend-uix-data-order-view-button-failed-request-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: adminuisdk/orderviewbutton/{request_id} - "/V1/adobe_io_events/check_configuration": - get: - tags: - - adobe_io_events/check_configuration - description: Checks configuration and returns success/failure results for each - component - operationId: GetV1Adobe_io_eventsCheck_configuration - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/adobe-io-events-client-configuration-check-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: adobe_io_events/check_configuration - "/V1/adobestock/asset/list": - get: - tags: - - adobestock/asset/list - description: Search for images based on search criteria - operationId: GetV1AdobestockAssetList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[requestName] - in: query - type: string - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/framework-search-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: adobestock/asset/list - "/V1/adobestock/asset/search": - get: - tags: - - adobestock/asset/search - description: Get a list of assets - operationId: GetV1AdobestockAssetSearch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/adobe-stock-asset-api-data-asset-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: adobestock/asset/search - "/V1/adobestock/asset/{id}": - delete: - tags: - - adobestock/asset/{id} - description: Delete asset - operationId: DeleteV1AdobestockAssetId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: adobestock/asset/{id} - get: - tags: - - adobestock/asset/{id} - description: Get asset by id - operationId: GetV1AdobestockAssetId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/adobe-stock-asset-api-data-asset-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: adobestock/asset/{id} - "/V1/adobestock/search": - get: - tags: - - adobestock/search - description: Search for images based on search criteria - operationId: GetV1AdobestockSearch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[requestName] - in: query - type: string - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/framework-search-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: adobestock/search - "/V1/analytics/link": - get: - tags: - - analytics/link - description: Retrieve link - operationId: GetV1AnalyticsLink - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/analytics-data-link-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: analytics/link - "/V1/applepay/auth": - get: - tags: - - applepay/auth - description: Returns details required to be able to submit a payment with Apple - Pay - operationId: GetV1ApplepayAuth - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/pay-pal-braintree-data-auth-data-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: applepay/auth - "/V1/attributeMetadata/customer": - get: - tags: - - attributeMetadata/customer - description: Get all attribute metadata. - operationId: GetV1AttributeMetadataCustomer - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: attributeMetadata/customer - "/V1/attributeMetadata/customer/attribute/{attributeCode}": - get: - tags: - - attributeMetadata/customer/attribute/{attributeCode} - description: Retrieve attribute metadata. - operationId: GetV1AttributeMetadataCustomerAttributeAttributeCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: attributeMetadata/customer/attribute/{attributeCode} - "/V1/attributeMetadata/customer/custom": - get: - tags: - - attributeMetadata/customer/custom - description: Get custom attributes metadata for the given data interface. - operationId: GetV1AttributeMetadataCustomerCustom - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: dataInterfaceName - in: query - type: string - required: false - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: attributeMetadata/customer/custom - "/V1/attributeMetadata/customer/form/{formCode}": - get: - tags: - - attributeMetadata/customer/form/{formCode} - description: Retrieve all attributes filtered by form code - operationId: GetV1AttributeMetadataCustomerFormFormCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: formCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: attributeMetadata/customer/form/{formCode} - "/V1/attributeMetadata/customerAddress": - get: - tags: - - attributeMetadata/customerAddress - description: Get all attribute metadata. - operationId: GetV1AttributeMetadataCustomerAddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: attributeMetadata/customerAddress - "/V1/attributeMetadata/customerAddress/attribute/{attributeCode}": - get: - tags: - - attributeMetadata/customerAddress/attribute/{attributeCode} - description: Retrieve attribute metadata. - operationId: GetV1AttributeMetadataCustomerAddressAttributeAttributeCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: attributeMetadata/customerAddress/attribute/{attributeCode} - "/V1/attributeMetadata/customerAddress/custom": - get: - tags: - - attributeMetadata/customerAddress/custom - description: Get custom attributes metadata for the given data interface. - operationId: GetV1AttributeMetadataCustomerAddressCustom - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: dataInterfaceName - in: query - type: string - required: false - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: attributeMetadata/customerAddress/custom - "/V1/attributeMetadata/customerAddress/form/{formCode}": - get: - tags: - - attributeMetadata/customerAddress/form/{formCode} - description: Retrieve all attributes filtered by form code - operationId: GetV1AttributeMetadataCustomerAddressFormFormCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: formCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: attributeMetadata/customerAddress/form/{formCode} - "/V1/braintree/mine/payment/vault": - post: - tags: - - braintree/mine/payment/vault - description: Vault a Payment nonce for a customer. Billing address is optional - but advised for Card vaulting. - operationId: PostV1BraintreeMinePaymentVault - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1BraintreeMinePaymentVaultBody - in: body - schema: - required: - - payment - properties: - payment: - "$ref": "#/definitions/pay-pal-braintree-data-payment-interface" - billingAddress: - "$ref": "#/definitions/customer-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: braintree/mine/payment/vault - "/V1/bulk": - get: - tags: - - bulk - description: Lists the bulk operation items that match specified search criteria. - operationId: GetV1Bulk - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/asynchronous-operations-data-operation-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: bulk - "/V1/bulk/{bulkUuid}/detailed-status": - get: - tags: - - bulk/{bulkUuid}/detailed-status - description: Get Bulk summary data with list of operations items full data. - operationId: GetV1BulkBulkUuidDetailedstatus - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: bulkUuid - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/asynchronous-operations-data-detailed-bulk-operations-status-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: bulk/{bulkUuid}/detailed-status - "/V1/bulk/{bulkUuid}/operation-status/{status}": - get: - tags: - - bulk/{bulkUuid}/operation-status/{status} - description: Get operations count by bulk uuid and status. - operationId: GetV1BulkBulkUuidOperationstatusStatus - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: bulkUuid - in: path - type: string - required: true - - name: status - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: integer - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: bulk/{bulkUuid}/operation-status/{status} - "/V1/bulk/{bulkUuid}/status": - get: - tags: - - bulk/{bulkUuid}/status - description: Get Bulk summary data with list of operations items short data. - operationId: GetV1BulkBulkUuidStatus - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: bulkUuid - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/asynchronous-operations-data-bulk-operations-status-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: bulk/{bulkUuid}/status - "/V1/bundle-products/options/add": - post: - tags: - - bundle-products/options/add - description: Add new option for bundle product - operationId: PostV1BundleproductsOptionsAdd - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1BundleproductsOptionsAddBody - in: body - schema: - required: - - option - properties: - option: - "$ref": "#/definitions/bundle-data-option-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: bundle-products/options/add - "/V1/bundle-products/options/types": - get: - tags: - - bundle-products/options/types - description: Get all types for options for bundle products - operationId: GetV1BundleproductsOptionsTypes - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/bundle-data-option-type-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: bundle-products/options/types - "/V1/bundle-products/options/{optionId}": - put: - tags: - - bundle-products/options/{optionId} - description: Add new option for bundle product - operationId: PutV1BundleproductsOptionsOptionId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: optionId - in: path - type: string - required: true - - name: PutV1BundleproductsOptionsOptionIdBody - in: body - schema: - required: - - option - properties: - option: - "$ref": "#/definitions/bundle-data-option-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: bundle-products/options/{optionId} - "/V1/bundle-products/{productSku}/children": - get: - tags: - - bundle-products/{productSku}/children - description: Get all children for Bundle product - operationId: GetV1BundleproductsProductSkuChildren - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: productSku - in: path - type: string - required: true - - name: optionId - in: query - type: integer - required: false - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/bundle-data-link-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: bundle-products/{productSku}/children - "/V1/bundle-products/{sku}/links/{id}": - put: - tags: - - bundle-products/{sku}/links/{id} - description: '' - operationId: PutV1BundleproductsSkuLinksId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: id - in: path - type: string - required: true - - name: PutV1BundleproductsSkuLinksIdBody - in: body - schema: - required: - - linkedProduct - properties: - linkedProduct: - "$ref": "#/definitions/bundle-data-link-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: bundle-products/{sku}/links/{id} - "/V1/bundle-products/{sku}/links/{optionId}": - post: - tags: - - bundle-products/{sku}/links/{optionId} - description: Add child product to specified Bundle option by product sku - operationId: PostV1BundleproductsSkuLinksOptionId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: optionId - in: path - type: integer - required: true - - name: PostV1BundleproductsSkuLinksOptionIdBody - in: body - schema: - required: - - linkedProduct - properties: - linkedProduct: - "$ref": "#/definitions/bundle-data-link-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: bundle-products/{sku}/links/{optionId} - "/V1/bundle-products/{sku}/options/all": - get: - tags: - - bundle-products/{sku}/options/all - description: Get all options for bundle product - operationId: GetV1BundleproductsSkuOptionsAll - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/bundle-data-option-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: bundle-products/{sku}/options/all - "/V1/bundle-products/{sku}/options/{optionId}": - get: - tags: - - bundle-products/{sku}/options/{optionId} - description: Get option for bundle product - operationId: GetV1BundleproductsSkuOptionsOptionId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: optionId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/bundle-data-option-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: bundle-products/{sku}/options/{optionId} - delete: - tags: - - bundle-products/{sku}/options/{optionId} - description: Remove bundle option - operationId: DeleteV1BundleproductsSkuOptionsOptionId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: optionId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: bundle-products/{sku}/options/{optionId} - "/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}": - delete: - tags: - - bundle-products/{sku}/options/{optionId}/children/{childSku} - description: Remove product from Bundle product option - operationId: DeleteV1BundleproductsSkuOptionsOptionIdChildrenChildSku - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: optionId - in: path - type: integer - required: true - - name: childSku - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: bundle-products/{sku}/options/{optionId}/children/{childSku} - "/V1/carts/": - post: - tags: - - carts/ - description: Creates an empty cart and quote for a guest. - operationId: PostV1Carts - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Cart ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/ - "/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}": - get: - tags: - - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} - description: Check gift card balance if added to the cart. - operationId: GetV1CartsGuestcartsCartIdCheckGiftCardGiftCardCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: giftCardCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: number - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} - "/V1/carts/guest-carts/{cartId}/giftCards": - post: - tags: - - carts/guest-carts/{cartId}/giftCards - description: Add gift card to the cart. - operationId: PostV1CartsGuestcartsCartIdGiftCards - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1CartsGuestcartsCartIdGiftCardsBody - in: body - schema: - required: - - giftCardAccountData - properties: - giftCardAccountData: - "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/guest-carts/{cartId}/giftCards - "/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}": - delete: - tags: - - carts/guest-carts/{cartId}/giftCards/{giftCardCode} - description: Remove GiftCard Account entity. - operationId: DeleteV1CartsGuestcartsCartIdGiftCardsGiftCardCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: giftCardCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/guest-carts/{cartId}/giftCards/{giftCardCode} - "/V1/carts/licence": - get: - tags: - - carts/licence - description: Lists active checkout agreements. - operationId: GetV1CartsLicence - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/checkout-agreements-data-agreement-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/licence - "/V1/carts/licence/list": - get: - tags: - - carts/licence/list - description: List of checkout agreements. - operationId: GetV1CartsLicenceList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/checkout-agreements-data-agreement-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/licence/list - "/V1/carts/mine": - put: - tags: - - carts/mine - description: Save quote - operationId: PutV1CartsMine - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CartsMineBody - in: body - schema: - required: - - quote - properties: - quote: - "$ref": "#/definitions/quote-data-cart-interface" - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine - post: - tags: - - carts/mine - description: Creates an empty cart and quote for a specified customer if customer - does not have a cart yet. - operationId: PostV1CartsMine - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: integer - description: new cart ID if customer did not have a cart or ID of the - existing cart otherwise. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine - get: - tags: - - carts/mine - description: Returns information for the cart for a specified customer. - operationId: GetV1CartsMine - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine - "/V1/carts/mine/balance/apply": - post: - tags: - - carts/mine/balance/apply - description: Apply store credit - operationId: PostV1CartsMineBalanceApply - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/balance/apply - "/V1/carts/mine/billing-address": - get: - tags: - - carts/mine/billing-address - description: Returns the billing address for a specified quote. - operationId: GetV1CartsMineBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-address-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/billing-address - post: - tags: - - carts/mine/billing-address - description: Assigns a specified billing address to a specified cart. - operationId: PostV1CartsMineBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMineBillingaddressBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - useForShipping: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Address ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/billing-address - "/V1/carts/mine/checkGiftCard/{giftCardCode}": - get: - tags: - - carts/mine/checkGiftCard/{giftCardCode} - description: Check gift card balance if applied to given cart. - operationId: GetV1CartsMineCheckGiftCardGiftCardCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: giftCardCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: number - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/checkGiftCard/{giftCardCode} - "/V1/carts/mine/collect-totals": - put: - tags: - - carts/mine/collect-totals - description: Set shipping/billing methods and additional data for cart and collect - totals. - operationId: PutV1CartsMineCollecttotals - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CartsMineCollecttotalsBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - shippingCarrierCode: - type: string - description: The carrier code. - shippingMethodCode: - type: string - description: The shipping method code. - additionalData: - "$ref": "#/definitions/quote-data-totals-additional-data-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/collect-totals - "/V1/carts/mine/coupons": - get: - tags: - - carts/mine/coupons - description: Returns information for a coupon in a specified cart. - operationId: GetV1CartsMineCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: string - description: The coupon code data. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/coupons - delete: - tags: - - carts/mine/coupons - description: Deletes a coupon from a specified cart. - operationId: DeleteV1CartsMineCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/coupons - "/V1/carts/mine/coupons/{couponCode}": - put: - tags: - - carts/mine/coupons/{couponCode} - description: Adds a coupon by code to a specified cart. - operationId: PutV1CartsMineCouponsCouponCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: couponCode - in: path - type: string - required: true - description: The coupon code data. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/coupons/{couponCode} - "/V1/carts/mine/estimate-shipping-methods": - post: - tags: - - carts/mine/estimate-shipping-methods - description: Estimate shipping by address and return list of available shipping - methods - operationId: PostV1CartsMineEstimateshippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMineEstimateshippingmethodsBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/estimate-shipping-methods - "/V1/carts/mine/estimate-shipping-methods-by-address-id": - post: - tags: - - carts/mine/estimate-shipping-methods-by-address-id - description: Estimate shipping - operationId: PostV1CartsMineEstimateshippingmethodsbyaddressid - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMineEstimateshippingmethodsbyaddressidBody - in: body - schema: - required: - - addressId - properties: - addressId: - type: integer - description: The estimate address id - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/estimate-shipping-methods-by-address-id - "/V1/carts/mine/gift-message": - get: - tags: - - carts/mine/gift-message - description: Return the gift message for a specified order. - operationId: GetV1CartsMineGiftmessage - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-message-data-message-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/gift-message - post: - tags: - - carts/mine/gift-message - description: Set the gift message for an entire order. - operationId: PostV1CartsMineGiftmessage - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMineGiftmessageBody - in: body - schema: - required: - - giftMessage - properties: - giftMessage: - "$ref": "#/definitions/gift-message-data-message-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/gift-message - "/V1/carts/mine/gift-message/{itemId}": - get: - tags: - - carts/mine/gift-message/{itemId} - description: Return the gift message for a specified item in a specified shopping - cart. - operationId: GetV1CartsMineGiftmessageItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: itemId - in: path - type: integer - required: true - description: The item ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-message-data-message-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/gift-message/{itemId} - post: - tags: - - carts/mine/gift-message/{itemId} - description: Set the gift message for a specified item in a specified shopping - cart. - operationId: PostV1CartsMineGiftmessageItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: itemId - in: path - type: integer - required: true - description: The item ID. - - name: PostV1CartsMineGiftmessageItemIdBody - in: body - schema: - required: - - giftMessage - properties: - giftMessage: - "$ref": "#/definitions/gift-message-data-message-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/gift-message/{itemId} - "/V1/carts/mine/giftCards": - post: - tags: - - carts/mine/giftCards - description: Add gift card to the cart. - operationId: PostV1CartsMineGiftCards - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMineGiftCardsBody - in: body - schema: - required: - - giftCardAccountData - properties: - giftCardAccountData: - "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/giftCards - "/V1/carts/mine/giftCards/{giftCardCode}": - delete: - tags: - - carts/mine/giftCards/{giftCardCode} - description: Remove GiftCard Account entity - operationId: DeleteV1CartsMineGiftCardsGiftCardCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: giftCardCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/giftCards/{giftCardCode} - "/V1/carts/mine/items": - get: - tags: - - carts/mine/items - description: Lists items that are assigned to a specified cart. - operationId: GetV1CartsMineItems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - description: Array of items. - items: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/items - post: - tags: - - carts/mine/items - description: Add/update the specified cart item. - operationId: PostV1CartsMineItems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMineItemsBody - in: body - schema: - required: - - cartItem - properties: - cartItem: - "$ref": "#/definitions/quote-data-cart-item-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/items - "/V1/carts/mine/items/{itemId}": - put: - tags: - - carts/mine/items/{itemId} - description: Add/update the specified cart item. - operationId: PutV1CartsMineItemsItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: itemId - in: path - type: string - required: true - - name: PutV1CartsMineItemsItemIdBody - in: body - schema: - required: - - cartItem - properties: - cartItem: - "$ref": "#/definitions/quote-data-cart-item-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/items/{itemId} - delete: - tags: - - carts/mine/items/{itemId} - description: Removes the specified item from the specified cart. - operationId: DeleteV1CartsMineItemsItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: itemId - in: path - type: integer - required: true - description: The item ID of the item to be removed. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/items/{itemId} - "/V1/carts/mine/order": - put: - tags: - - carts/mine/order - description: Places an order for a specified cart. - operationId: PutV1CartsMineOrder - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CartsMineOrderBody - in: body - schema: - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/order - "/V1/carts/mine/payment-information": - post: - tags: - - carts/mine/payment-information - description: Set payment information and place order for a specified cart. - operationId: PostV1CartsMinePaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMinePaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/payment-information - get: - tags: - - carts/mine/payment-information - description: Get payment information - operationId: GetV1CartsMinePaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/payment-information - "/V1/carts/mine/payment-methods": - get: - tags: - - carts/mine/payment-methods - description: Lists available payment methods for a specified shopping cart. - This call returns an array of objects, but detailed information about each - object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#PaymentMethodManagementInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1CartsMinePaymentmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - description: Array of payment methods. - items: - "$ref": "#/definitions/quote-data-payment-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/payment-methods - "/V1/carts/mine/payment-order": - post: - tags: - - carts/mine/payment-order - description: Create a payment order for logged in customer - operationId: PostV1CartsMinePaymentorder - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMinePaymentorderBody - in: body - schema: - required: - - methodCode - - paymentSource - - location - properties: - methodCode: - type: string - paymentSource: - type: string - location: - type: string - vaultIntent: - type: boolean - threeDSMode: - type: string - description: "| null $threeDSMode" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/payment-order - "/V1/carts/mine/payment-order/{id}": - get: - tags: - - carts/mine/payment-order/{id} - description: Get payment order for logged in customer - operationId: GetV1CartsMinePaymentorderId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/payment-order/{id} - post: - tags: - - carts/mine/payment-order/{id} - description: Sync payment order for logged in customer - operationId: PostV1CartsMinePaymentorderId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/payment-order/{id} - "/V1/carts/mine/po-payment-information": - post: - tags: - - carts/mine/po-payment-information - description: Set payment information and place purchase order for a specified - cart. - operationId: PostV1CartsMinePopaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMinePopaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Purchase Order ID. - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/po-payment-information - "/V1/carts/mine/selected-payment-method": - get: - tags: - - carts/mine/selected-payment-method - description: Returns the payment method for a specified shopping cart. - operationId: GetV1CartsMineSelectedpaymentmethod - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-payment-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/selected-payment-method - put: - tags: - - carts/mine/selected-payment-method - description: Adds a specified payment method to a specified shopping cart. - operationId: PutV1CartsMineSelectedpaymentmethod - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CartsMineSelectedpaymentmethodBody - in: body - schema: - required: - - method - properties: - method: - "$ref": "#/definitions/quote-data-payment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - description: redirect url or error message. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/selected-payment-method - "/V1/carts/mine/set-payment-information": - post: - tags: - - carts/mine/set-payment-information - description: Set payment information for a specified cart. - operationId: PostV1CartsMineSetpaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMineSetpaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/set-payment-information - "/V1/carts/mine/shipping-information": - post: - tags: - - carts/mine/shipping-information - description: '' - operationId: PostV1CartsMineShippinginformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMineShippinginformationBody - in: body - schema: - required: - - addressInformation - properties: - addressInformation: - "$ref": "#/definitions/checkout-data-shipping-information-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/shipping-information - "/V1/carts/mine/shipping-methods": - get: - tags: - - carts/mine/shipping-methods - description: Lists applicable shipping methods for a specified quote. - operationId: GetV1CartsMineShippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/shipping-methods - "/V1/carts/mine/totals": - get: - tags: - - carts/mine/totals - description: Returns quote totals data for a specified cart. - operationId: GetV1CartsMineTotals - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/totals - "/V1/carts/mine/totals-information": - post: - tags: - - carts/mine/totals-information - description: Calculate quote totals based on address and shipping method. - operationId: PostV1CartsMineTotalsinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMineTotalsinformationBody - in: body - schema: - required: - - addressInformation - properties: - addressInformation: - "$ref": "#/definitions/checkout-data-totals-information-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/totals-information - "/V1/carts/search": - get: - tags: - - carts/search - description: Enables administrative users to list carts that match specified - search criteria. This call returns an array of objects, but detailed information - about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CartRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1CartsSearch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/search - "/V1/carts/{cartId}": - get: - tags: - - carts/{cartId} - description: Enables an administrative user to return information for a specified - cart. - operationId: GetV1CartsCartId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId} - put: - tags: - - carts/{cartId} - description: Assigns a specified customer to a specified shopping cart. - operationId: PutV1CartsCartId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - - name: PutV1CartsCartIdBody - in: body - schema: - required: - - customerId - - storeId - properties: - customerId: - type: integer - description: The customer ID. - storeId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId} - "/V1/carts/{cartId}/billing-address": - get: - tags: - - carts/{cartId}/billing-address - description: Returns the billing address for a specified quote. - operationId: GetV1CartsCartIdBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-address-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/billing-address - post: - tags: - - carts/{cartId}/billing-address - description: Assigns a specified billing address to a specified cart. - operationId: PostV1CartsCartIdBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - - name: PostV1CartsCartIdBillingaddressBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - useForShipping: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Address ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/billing-address - "/V1/carts/{cartId}/coupons": - get: - tags: - - carts/{cartId}/coupons - description: Returns information for a coupon in a specified cart. - operationId: GetV1CartsCartIdCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: string - description: The coupon code data. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/coupons - delete: - tags: - - carts/{cartId}/coupons - description: Deletes a coupon from a specified cart. - operationId: DeleteV1CartsCartIdCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/coupons - "/V1/carts/{cartId}/coupons/{couponCode}": - put: - tags: - - carts/{cartId}/coupons/{couponCode} - description: Adds a coupon by code to a specified cart. - operationId: PutV1CartsCartIdCouponsCouponCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - - name: couponCode - in: path - type: string - required: true - description: The coupon code data. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/coupons/{couponCode} - "/V1/carts/{cartId}/estimate-shipping-methods": - post: - tags: - - carts/{cartId}/estimate-shipping-methods - description: Estimate shipping by address and return list of available shipping - methods - operationId: PostV1CartsCartIdEstimateshippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1CartsCartIdEstimateshippingmethodsBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/estimate-shipping-methods - "/V1/carts/{cartId}/estimate-shipping-methods-by-address-id": - post: - tags: - - carts/{cartId}/estimate-shipping-methods-by-address-id - description: Estimate shipping - operationId: PostV1CartsCartIdEstimateshippingmethodsbyaddressid - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The shopping cart ID. - - name: PostV1CartsCartIdEstimateshippingmethodsbyaddressidBody - in: body - schema: - required: - - addressId - properties: - addressId: - type: integer - description: The estimate address id - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/estimate-shipping-methods-by-address-id - "/V1/carts/{cartId}/gift-message": - get: - tags: - - carts/{cartId}/gift-message - description: Return the gift message for a specified order. - operationId: GetV1CartsCartIdGiftmessage - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The shopping cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-message-data-message-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/gift-message - post: - tags: - - carts/{cartId}/gift-message - description: Set the gift message for an entire order. - operationId: PostV1CartsCartIdGiftmessage - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - - name: PostV1CartsCartIdGiftmessageBody - in: body - schema: - required: - - giftMessage - properties: - giftMessage: - "$ref": "#/definitions/gift-message-data-message-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/gift-message - "/V1/carts/{cartId}/gift-message/{itemId}": - get: - tags: - - carts/{cartId}/gift-message/{itemId} - description: Return the gift message for a specified item in a specified shopping - cart. - operationId: GetV1CartsCartIdGiftmessageItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The shopping cart ID. - - name: itemId - in: path - type: integer - required: true - description: The item ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-message-data-message-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/gift-message/{itemId} - post: - tags: - - carts/{cartId}/gift-message/{itemId} - description: Set the gift message for a specified item in a specified shopping - cart. - operationId: PostV1CartsCartIdGiftmessageItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - - name: itemId - in: path - type: integer - required: true - description: The item ID. - - name: PostV1CartsCartIdGiftmessageItemIdBody - in: body - schema: - required: - - giftMessage - properties: - giftMessage: - "$ref": "#/definitions/gift-message-data-message-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/gift-message/{itemId} - "/V1/carts/{cartId}/giftCards": - put: - tags: - - carts/{cartId}/giftCards - description: Add gift card to the cart. - operationId: PutV1CartsCartIdGiftCards - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PutV1CartsCartIdGiftCardsBody - in: body - schema: - required: - - giftCardAccountData - properties: - giftCardAccountData: - "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/giftCards - "/V1/carts/{cartId}/giftCards/{giftCardCode}": - delete: - tags: - - carts/{cartId}/giftCards/{giftCardCode} - description: Remove GiftCard Account entity - operationId: DeleteV1CartsCartIdGiftCardsGiftCardCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: giftCardCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/giftCards/{giftCardCode} - "/V1/carts/{cartId}/items": - get: - tags: - - carts/{cartId}/items - description: Lists items that are assigned to a specified cart. - operationId: GetV1CartsCartIdItems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: array - description: Array of items. - items: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/items - "/V1/carts/{cartId}/items/{itemId}": - put: - tags: - - carts/{cartId}/items/{itemId} - description: Add/update the specified cart item. - operationId: PutV1CartsCartIdItemsItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: itemId - in: path - type: string - required: true - - name: PutV1CartsCartIdItemsItemIdBody - in: body - schema: - required: - - cartItem - properties: - cartItem: - "$ref": "#/definitions/quote-data-cart-item-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/items/{itemId} - delete: - tags: - - carts/{cartId}/items/{itemId} - description: Removes the specified item from the specified cart. - operationId: DeleteV1CartsCartIdItemsItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - - name: itemId - in: path - type: integer - required: true - description: The item ID of the item to be removed. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/items/{itemId} - "/V1/carts/{cartId}/order": - put: - tags: - - carts/{cartId}/order - description: Places an order for a specified cart. - operationId: PutV1CartsCartIdOrder - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - - name: PutV1CartsCartIdOrderBody - in: body - schema: - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/order - "/V1/carts/{cartId}/payment-methods": - get: - tags: - - carts/{cartId}/payment-methods - description: Lists available payment methods for a specified shopping cart. - This call returns an array of objects, but detailed information about each - object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#PaymentMethodManagementInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1CartsCartIdPaymentmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: array - description: Array of payment methods. - items: - "$ref": "#/definitions/quote-data-payment-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/payment-methods - "/V1/carts/{cartId}/selected-payment-method": - get: - tags: - - carts/{cartId}/selected-payment-method - description: Returns the payment method for a specified shopping cart. - operationId: GetV1CartsCartIdSelectedpaymentmethod - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-payment-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/selected-payment-method - put: - tags: - - carts/{cartId}/selected-payment-method - description: Adds a specified payment method to a specified shopping cart. - operationId: PutV1CartsCartIdSelectedpaymentmethod - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - - name: PutV1CartsCartIdSelectedpaymentmethodBody - in: body - schema: - required: - - method - properties: - method: - "$ref": "#/definitions/quote-data-payment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - description: redirect url or error message. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/selected-payment-method - "/V1/carts/{cartId}/shipping-information": - post: - tags: - - carts/{cartId}/shipping-information - description: '' - operationId: PostV1CartsCartIdShippinginformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1CartsCartIdShippinginformationBody - in: body - schema: - required: - - addressInformation - properties: - addressInformation: - "$ref": "#/definitions/checkout-data-shipping-information-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/shipping-information - "/V1/carts/{cartId}/shipping-methods": - get: - tags: - - carts/{cartId}/shipping-methods - description: Lists applicable shipping methods for a specified quote. - operationId: GetV1CartsCartIdShippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The shopping cart ID. - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/shipping-methods - "/V1/carts/{cartId}/totals": - get: - tags: - - carts/{cartId}/totals - description: Returns quote totals data for a specified cart. - operationId: GetV1CartsCartIdTotals - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/totals - "/V1/carts/{cartId}/totals-information": - post: - tags: - - carts/{cartId}/totals-information - description: Calculate quote totals based on address and shipping method. - operationId: PostV1CartsCartIdTotalsinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1CartsCartIdTotalsinformationBody - in: body - schema: - required: - - addressInformation - properties: - addressInformation: - "$ref": "#/definitions/checkout-data-totals-information-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/totals-information - "/V1/carts/{quoteId}/giftCards": - get: - tags: - - carts/{quoteId}/giftCards - description: Return GiftCard Account cards. - operationId: GetV1CartsQuoteIdGiftCards - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: quoteId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{quoteId}/giftCards - "/V1/carts/{quoteId}/items": - post: - tags: - - carts/{quoteId}/items - description: Add/update the specified cart item. - operationId: PostV1CartsQuoteIdItems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: quoteId - in: path - type: string - required: true - - name: PostV1CartsQuoteIdItemsBody - in: body - schema: - required: - - cartItem - properties: - cartItem: - "$ref": "#/definitions/quote-data-cart-item-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{quoteId}/items - "/V1/categories": - post: - tags: - - categories - description: Create category service - operationId: PostV1Categories - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CategoriesBody - in: body - schema: - required: - - category - properties: - category: - "$ref": "#/definitions/catalog-data-category-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-category-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: categories - get: - tags: - - categories - description: Retrieve list of categories - operationId: GetV1Categories - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: rootCategoryId - in: query - type: integer - required: false - - name: depth - in: query - type: integer - required: false - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-category-tree-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: categories - "/V1/categories/attributes": - get: - tags: - - categories/attributes - description: Retrieve all attributes for entity type - operationId: GetV1CategoriesAttributes - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-category-attribute-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: categories/attributes - "/V1/categories/attributes/{attributeCode}": - get: - tags: - - categories/attributes/{attributeCode} - description: Retrieve specific attribute - operationId: GetV1CategoriesAttributesAttributeCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-category-attribute-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: categories/attributes/{attributeCode} - "/V1/categories/attributes/{attributeCode}/options": - get: - tags: - - categories/attributes/{attributeCode}/options - description: Retrieve list of attribute options - operationId: GetV1CategoriesAttributesAttributeCodeOptions - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/eav-data-attribute-option-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: categories/attributes/{attributeCode}/options - "/V1/categories/list": - get: - tags: - - categories/list - description: Get category list - operationId: GetV1CategoriesList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-category-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: categories/list - "/V1/categories/{categoryId}": - delete: - tags: - - categories/{categoryId} - description: Delete category by identifier - operationId: DeleteV1CategoriesCategoryId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: categoryId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: Will returned True if deleted - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: categories/{categoryId} - get: - tags: - - categories/{categoryId} - description: Get info about category by category id - operationId: GetV1CategoriesCategoryId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: categoryId - in: path - type: integer - required: true - - name: storeId - in: query - type: integer - required: false - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-category-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: categories/{categoryId} - "/V1/categories/{categoryId}/move": - put: - tags: - - categories/{categoryId}/move - description: Move category - operationId: PutV1CategoriesCategoryIdMove - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: categoryId - in: path - type: integer - required: true - - name: PutV1CategoriesCategoryIdMoveBody - in: body - schema: - required: - - parentId - properties: - parentId: - type: integer - afterId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: categories/{categoryId}/move - "/V1/categories/{categoryId}/products": - get: - tags: - - categories/{categoryId}/products - description: Get products assigned to category - operationId: GetV1CategoriesCategoryIdProducts - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: categoryId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-category-product-link-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: categories/{categoryId}/products - post: - tags: - - categories/{categoryId}/products - description: Assign a product to the required category - operationId: PostV1CategoriesCategoryIdProducts - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: categoryId - in: path - type: string - required: true - - name: PostV1CategoriesCategoryIdProductsBody - in: body - schema: - required: - - productLink - properties: - productLink: - "$ref": "#/definitions/catalog-data-category-product-link-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: will returned True if assigned - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: categories/{categoryId}/products - put: - tags: - - categories/{categoryId}/products - description: Assign a product to the required category - operationId: PutV1CategoriesCategoryIdProducts - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: categoryId - in: path - type: string - required: true - - name: PutV1CategoriesCategoryIdProductsBody - in: body - schema: - required: - - productLink - properties: - productLink: - "$ref": "#/definitions/catalog-data-category-product-link-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: will returned True if assigned - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: categories/{categoryId}/products - "/V1/categories/{categoryId}/products/{sku}": - delete: - tags: - - categories/{categoryId}/products/{sku} - description: Remove the product assignment from the category by category id - and sku - operationId: DeleteV1CategoriesCategoryIdProductsSku - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: categoryId - in: path - type: integer - required: true - - name: sku - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: will returned True if products successfully deleted - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: categories/{categoryId}/products/{sku} - "/V1/categories/{id}": - put: - tags: - - categories/{id} - description: Create category service - operationId: PutV1CategoriesId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - - name: PutV1CategoriesIdBody - in: body - schema: - required: - - category - properties: - category: - "$ref": "#/definitions/catalog-data-category-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-category-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: categories/{id} - "/V1/cmsBlock": - post: - tags: - - cmsBlock - description: Save block. - operationId: PostV1CmsBlock - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CmsBlockBody - in: body - schema: - required: - - block - properties: - block: - "$ref": "#/definitions/cms-data-block-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/cms-data-block-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: cmsBlock - "/V1/cmsBlock/search": - get: - tags: - - cmsBlock/search - description: Retrieve blocks matching the specified criteria. - operationId: GetV1CmsBlockSearch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/cms-data-block-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: cmsBlock/search - "/V1/cmsBlock/{blockId}": - get: - tags: - - cmsBlock/{blockId} - description: Retrieve block. - operationId: GetV1CmsBlockBlockId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: blockId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/cms-data-block-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: cmsBlock/{blockId} - delete: - tags: - - cmsBlock/{blockId} - description: Delete block by ID. - operationId: DeleteV1CmsBlockBlockId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: blockId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: cmsBlock/{blockId} - "/V1/cmsBlock/{id}": - put: - tags: - - cmsBlock/{id} - description: Save block. - operationId: PutV1CmsBlockId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - - name: PutV1CmsBlockIdBody - in: body - schema: - required: - - block - properties: - block: - "$ref": "#/definitions/cms-data-block-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/cms-data-block-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: cmsBlock/{id} - "/V1/cmsPage": - post: - tags: - - cmsPage - description: Save page. - operationId: PostV1CmsPage - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CmsPageBody - in: body - schema: - required: - - page - properties: - page: - "$ref": "#/definitions/cms-data-page-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/cms-data-page-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: cmsPage - "/V1/cmsPage/search": - get: - tags: - - cmsPage/search - description: Retrieve pages matching the specified criteria. - operationId: GetV1CmsPageSearch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/cms-data-page-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: cmsPage/search - "/V1/cmsPage/{id}": - put: - tags: - - cmsPage/{id} - description: Save page. - operationId: PutV1CmsPageId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - - name: PutV1CmsPageIdBody - in: body - schema: - required: - - page - properties: - page: - "$ref": "#/definitions/cms-data-page-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/cms-data-page-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: cmsPage/{id} - "/V1/cmsPage/{pageId}": - get: - tags: - - cmsPage/{pageId} - description: Retrieve page. - operationId: GetV1CmsPagePageId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: pageId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/cms-data-page-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: cmsPage/{pageId} - delete: - tags: - - cmsPage/{pageId} - description: Delete page by ID. - operationId: DeleteV1CmsPagePageId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: pageId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: cmsPage/{pageId} - "/V1/company/": - get: - tags: - - company/ - description: Returns the list of companies. The list is an array of objects, - and detailed information about item attributes might not be included. - operationId: GetV1Company - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-data-company-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/ - post: - tags: - - company/ - description: Create or update a company account. - operationId: PostV1Company - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CompanyBody - in: body - schema: - required: - - company - properties: - company: - "$ref": "#/definitions/company-data-company-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-data-company-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/ - "/V1/company/assignRoles": - put: - tags: - - company/assignRoles - description: Change a role for a company user. - operationId: PutV1CompanyAssignRoles - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CompanyAssignRolesBody - in: body - schema: - required: - - userId - - roles - properties: - userId: - type: integer - roles: - type: array - items: - "$ref": "#/definitions/company-data-role-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/assignRoles - "/V1/company/relations": - get: - tags: - - company/relations - description: Get existing company relation(s) - operationId: GetV1CompanyRelations - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-relation-data-relation-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/relations - "/V1/company/role/": - get: - tags: - - company/role/ - description: Returns the list of roles and permissions for a specified company. - operationId: GetV1CompanyRole - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-data-role-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/role/ - post: - tags: - - company/role/ - description: Create or update a role for a selected company. - operationId: PostV1CompanyRole - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CompanyRoleBody - in: body - schema: - required: - - role - properties: - role: - "$ref": "#/definitions/company-data-role-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-data-role-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/role/ - "/V1/company/role/{id}": - put: - tags: - - company/role/{id} - description: Create or update a role for a selected company. - operationId: PutV1CompanyRoleId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - - name: PutV1CompanyRoleIdBody - in: body - schema: - required: - - role - properties: - role: - "$ref": "#/definitions/company-data-role-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-data-role-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/role/{id} - "/V1/company/role/{roleId}": - get: - tags: - - company/role/{roleId} - description: Returns the list of permissions for a specified role. - operationId: GetV1CompanyRoleRoleId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: roleId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-data-role-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/role/{roleId} - delete: - tags: - - company/role/{roleId} - description: Delete a role. - operationId: DeleteV1CompanyRoleRoleId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: roleId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/role/{roleId} - "/V1/company/role/{roleId}/users": - get: - tags: - - company/role/{roleId}/users - description: View the list of company users assigned to a specified role. - operationId: GetV1CompanyRoleRoleIdUsers - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: roleId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/customer-data-customer-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/role/{roleId}/users - "/V1/company/{companyId}": - get: - tags: - - company/{companyId} - description: Returns company details. - operationId: GetV1CompanyCompanyId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: companyId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-data-company-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/{companyId} - delete: - tags: - - company/{companyId} - description: Delete a company. Customers belonging to a company are not deleted - with this request. - operationId: DeleteV1CompanyCompanyId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: companyId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/{companyId} - put: - tags: - - company/{companyId} - description: Create or update a company account. - operationId: PutV1CompanyCompanyId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: companyId - in: path - type: string - required: true - - name: PutV1CompanyCompanyIdBody - in: body - schema: - required: - - company - properties: - company: - "$ref": "#/definitions/company-data-company-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-data-company-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/{companyId} - "/V1/company/{parentId}/relations": - post: - tags: - - company/{parentId}/relations - description: Create relation(s) between companies. - operationId: PostV1CompanyParentIdRelations - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: parentId - in: path - type: integer - required: true - - name: PostV1CompanyParentIdRelationsBody - in: body - schema: - required: - - relations - properties: - relations: - type: array - items: - "$ref": "#/definitions/company-relation-data-relation-interface" - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/{parentId}/relations - "/V1/company/{parentId}/relations/{companyId}": - delete: - tags: - - company/{parentId}/relations/{companyId} - description: Delete relation of the company to the parent by respective ids. - operationId: DeleteV1CompanyParentIdRelationsCompanyId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: parentId - in: path - type: integer - required: true - - name: companyId - in: path - type: integer - required: true - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: company/{parentId}/relations/{companyId} - "/V1/companyCredits/": - get: - tags: - - companyCredits/ - description: Returns the list of credits for specified companies. - operationId: GetV1CompanyCredits - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-credit-data-credit-limit-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: companyCredits/ - "/V1/companyCredits/company/{companyId}": - get: - tags: - - companyCredits/company/{companyId} - description: Returns data on the credit limit for a specified company. - operationId: GetV1CompanyCreditsCompanyCompanyId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: companyId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-credit-data-credit-limit-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: companyCredits/company/{companyId} - "/V1/companyCredits/history": - get: - tags: - - companyCredits/history - description: Returns the credit history for one or more companies. - operationId: GetV1CompanyCreditsHistory - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-credit-data-history-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: companyCredits/history - "/V1/companyCredits/history/{historyId}": - put: - tags: - - companyCredits/history/{historyId} - description: Update the PO Number and/or comment for a Reimburse transaction. - operationId: PutV1CompanyCreditsHistoryHistoryId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: historyId - in: path - type: integer - required: true - - name: PutV1CompanyCreditsHistoryHistoryIdBody - in: body - schema: - properties: - purchaseOrder: - type: string - description: "[optional]" - comment: - type: string - description: "[optional]" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: companyCredits/history/{historyId} - "/V1/companyCredits/{creditId}": - get: - tags: - - companyCredits/{creditId} - description: Returns data on the credit limit for a specified credit limit ID. - operationId: GetV1CompanyCreditsCreditId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: creditId - in: path - type: integer - required: true - - name: reload - in: query - type: boolean - description: "[optional]" - required: false - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-credit-data-credit-limit-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: companyCredits/{creditId} - "/V1/companyCredits/{creditId}/decreaseBalance": - post: - tags: - - companyCredits/{creditId}/decreaseBalance - description: Decreases the company credit with an Update, Reimburse, or Purchase - transaction. This transaction increases company's outstanding balance and - decreases company's available credit. - operationId: PostV1CompanyCreditsCreditIdDecreaseBalance - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: creditId - in: path - type: integer - required: true - - name: PostV1CompanyCreditsCreditIdDecreaseBalanceBody - in: body - schema: - required: - - value - - currency - - operationType - properties: - value: - type: number - currency: - type: string - operationType: - type: integer - comment: - type: string - description: "[optional]" - options: - "$ref": "#/definitions/company-credit-data-credit-balance-options-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: companyCredits/{creditId}/decreaseBalance - "/V1/companyCredits/{creditId}/increaseBalance": - post: - tags: - - companyCredits/{creditId}/increaseBalance - description: Increases the company credit with an Allocate, Update, Refund, - Revert, or Reimburse transaction. This transaction decreases company's outstanding - balance and increases company's available credit. - operationId: PostV1CompanyCreditsCreditIdIncreaseBalance - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: creditId - in: path - type: integer - required: true - - name: PostV1CompanyCreditsCreditIdIncreaseBalanceBody - in: body - schema: - required: - - value - - currency - - operationType - properties: - value: - type: number - currency: - type: string - operationType: - type: integer - comment: - type: string - description: "[optional]" - options: - "$ref": "#/definitions/company-credit-data-credit-balance-options-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: companyCredits/{creditId}/increaseBalance - "/V1/companyCredits/{id}": - put: - tags: - - companyCredits/{id} - description: 'Update the following company credit attributes: credit currency, - credit limit and setting to exceed credit.' - operationId: PutV1CompanyCreditsId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - - name: PutV1CompanyCreditsIdBody - in: body - schema: - required: - - creditLimit - properties: - creditLimit: - "$ref": "#/definitions/company-credit-data-credit-limit-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-credit-data-credit-limit-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: companyCredits/{id} - "/V1/configurable-products/variation": - put: - tags: - - configurable-products/variation - description: Generate variation based on same product - operationId: PutV1ConfigurableproductsVariation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1ConfigurableproductsVariationBody - in: body - schema: - required: - - product - - options - properties: - product: - "$ref": "#/definitions/catalog-data-product-interface" - options: - type: array - items: - "$ref": "#/definitions/configurable-product-data-option-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-product-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: configurable-products/variation - "/V1/configurable-products/{sku}/child": - post: - tags: - - configurable-products/{sku}/child - description: '' - operationId: PostV1ConfigurableproductsSkuChild - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: PostV1ConfigurableproductsSkuChildBody - in: body - schema: - required: - - childSku - properties: - childSku: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: configurable-products/{sku}/child - "/V1/configurable-products/{sku}/children": - get: - tags: - - configurable-products/{sku}/children - description: Get all children for Configurable product - operationId: GetV1ConfigurableproductsSkuChildren - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-product-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: configurable-products/{sku}/children - "/V1/configurable-products/{sku}/children/{childSku}": - delete: - tags: - - configurable-products/{sku}/children/{childSku} - description: Remove configurable product option - operationId: DeleteV1ConfigurableproductsSkuChildrenChildSku - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: childSku - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: configurable-products/{sku}/children/{childSku} - "/V1/configurable-products/{sku}/options": - post: - tags: - - configurable-products/{sku}/options - description: Save option - operationId: PostV1ConfigurableproductsSkuOptions - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: PostV1ConfigurableproductsSkuOptionsBody - in: body - schema: - required: - - option - properties: - option: - "$ref": "#/definitions/configurable-product-data-option-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: configurable-products/{sku}/options - "/V1/configurable-products/{sku}/options/all": - get: - tags: - - configurable-products/{sku}/options/all - description: Get all options for configurable product - operationId: GetV1ConfigurableproductsSkuOptionsAll - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/configurable-product-data-option-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: configurable-products/{sku}/options/all - "/V1/configurable-products/{sku}/options/{id}": - get: - tags: - - configurable-products/{sku}/options/{id} - description: Get option for configurable product - operationId: GetV1ConfigurableproductsSkuOptionsId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/configurable-product-data-option-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: configurable-products/{sku}/options/{id} - put: - tags: - - configurable-products/{sku}/options/{id} - description: Save option - operationId: PutV1ConfigurableproductsSkuOptionsId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: id - in: path - type: string - required: true - - name: PutV1ConfigurableproductsSkuOptionsIdBody - in: body - schema: - required: - - option - properties: - option: - "$ref": "#/definitions/configurable-product-data-option-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: configurable-products/{sku}/options/{id} - delete: - tags: - - configurable-products/{sku}/options/{id} - description: Remove option from configurable product - operationId: DeleteV1ConfigurableproductsSkuOptionsId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: configurable-products/{sku}/options/{id} - "/V1/coupons": - post: - tags: - - coupons - description: Save a coupon. - operationId: PostV1Coupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CouponsBody - in: body - schema: - required: - - coupon - properties: - coupon: - "$ref": "#/definitions/sales-rule-data-coupon-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-rule-data-coupon-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: coupons - "/V1/coupons/deleteByCodes": - post: - tags: - - coupons/deleteByCodes - description: Delete coupon by coupon codes. - operationId: PostV1CouponsDeleteByCodes - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CouponsDeleteByCodesBody - in: body - schema: - required: - - codes - properties: - codes: - type: array - items: - type: string - ignoreInvalidCoupons: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-rule-data-coupon-mass-delete-result-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: coupons/deleteByCodes - "/V1/coupons/deleteByIds": - post: - tags: - - coupons/deleteByIds - description: Delete coupon by coupon ids. - operationId: PostV1CouponsDeleteByIds - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CouponsDeleteByIdsBody - in: body - schema: - required: - - ids - properties: - ids: - type: array - items: - type: integer - ignoreInvalidCoupons: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-rule-data-coupon-mass-delete-result-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: coupons/deleteByIds - "/V1/coupons/generate": - post: - tags: - - coupons/generate - description: Generate coupon for a rule - operationId: PostV1CouponsGenerate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CouponsGenerateBody - in: body - schema: - required: - - couponSpec - properties: - couponSpec: - "$ref": "#/definitions/sales-rule-data-coupon-generation-spec-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - type: string - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: coupons/generate - "/V1/coupons/search": - get: - tags: - - coupons/search - description: Retrieve a coupon using the specified search criteria. This call - returns an array of objects, but detailed information about each object’s - attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CouponRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1CouponsSearch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-rule-data-coupon-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: coupons/search - "/V1/coupons/{couponId}": - get: - tags: - - coupons/{couponId} - description: Get coupon by coupon id. - operationId: GetV1CouponsCouponId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: couponId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-rule-data-coupon-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: coupons/{couponId} - put: - tags: - - coupons/{couponId} - description: Save a coupon. - operationId: PutV1CouponsCouponId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: couponId - in: path - type: string - required: true - - name: PutV1CouponsCouponIdBody - in: body - schema: - required: - - coupon - properties: - coupon: - "$ref": "#/definitions/sales-rule-data-coupon-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-rule-data-coupon-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: coupons/{couponId} - delete: - tags: - - coupons/{couponId} - description: Delete coupon by coupon id. - operationId: DeleteV1CouponsCouponId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: couponId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: coupons/{couponId} - "/V1/creditmemo": - post: - tags: - - creditmemo - description: Performs persist operations for a specified credit memo. - operationId: PostV1Creditmemo - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CreditmemoBody - in: body - schema: - required: - - entity - properties: - entity: - "$ref": "#/definitions/sales-data-creditmemo-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-creditmemo-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: creditmemo - "/V1/creditmemo/refund": - post: - tags: - - creditmemo/refund - description: Prepare creditmemo to refund and save it. - operationId: PostV1CreditmemoRefund - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CreditmemoRefundBody - in: body - schema: - required: - - creditmemo - properties: - creditmemo: - "$ref": "#/definitions/sales-data-creditmemo-interface" - offlineRequested: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-creditmemo-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: creditmemo/refund - "/V1/creditmemo/{id}": - put: - tags: - - creditmemo/{id} - description: Cancels a specified credit memo. - operationId: PutV1CreditmemoId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The credit memo ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: creditmemo/{id} - get: - tags: - - creditmemo/{id} - description: Loads a specified credit memo. - operationId: GetV1CreditmemoId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The credit memo ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-creditmemo-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: creditmemo/{id} - "/V1/creditmemo/{id}/comments": - get: - tags: - - creditmemo/{id}/comments - description: Lists comments for a specified credit memo. - operationId: GetV1CreditmemoIdComments - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The credit memo ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-creditmemo-comment-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: creditmemo/{id}/comments - post: - tags: - - creditmemo/{id}/comments - description: Performs persist operations for a specified entity. - operationId: PostV1CreditmemoIdComments - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - - name: PostV1CreditmemoIdCommentsBody - in: body - schema: - required: - - entity - properties: - entity: - "$ref": "#/definitions/sales-data-creditmemo-comment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-creditmemo-comment-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: creditmemo/{id}/comments - "/V1/creditmemo/{id}/emails": - post: - tags: - - creditmemo/{id}/emails - description: Emails a user a specified credit memo. - operationId: PostV1CreditmemoIdEmails - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The credit memo ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: creditmemo/{id}/emails - "/V1/creditmemos": - get: - tags: - - creditmemos - description: Lists credit memos that match specified search criteria. This call - returns an array of objects, but detailed information about each object’s - attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CreditmemoRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1Creditmemos - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-creditmemo-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: creditmemos - "/V1/customerGroups": - post: - tags: - - customerGroups - description: Save customer group. - operationId: PostV1CustomerGroups - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CustomerGroupsBody - in: body - schema: - required: - - group - properties: - group: - "$ref": "#/definitions/customer-data-group-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-group-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customerGroups - "/V1/customerGroups/default": - get: - tags: - - customerGroups/default - description: Get default customer group. - operationId: GetV1CustomerGroupsDefault - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: storeId - in: query - type: integer - required: false - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-group-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customerGroups/default - "/V1/customerGroups/default/{id}": - put: - tags: - - customerGroups/default/{id} - description: Set system default customer group. - operationId: PutV1CustomerGroupsDefaultId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customerGroups/default/{id} - "/V1/customerGroups/default/{storeId}": - get: - tags: - - customerGroups/default/{storeId} - description: Get default customer group. - operationId: GetV1CustomerGroupsDefaultStoreId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: storeId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-group-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customerGroups/default/{storeId} - "/V1/customerGroups/search": - get: - tags: - - customerGroups/search - description: Retrieve customer groups. The list of groups can be filtered to - exclude the NOT_LOGGED_IN group using the first parameter and/or it can be - filtered by tax class. This call returns an array of objects, but detailed - information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#GroupRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1CustomerGroupsSearch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-group-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customerGroups/search - "/V1/customerGroups/{id}": - get: - tags: - - customerGroups/{id} - description: Get customer group by group ID. - operationId: GetV1CustomerGroupsId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-group-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customerGroups/{id} - put: - tags: - - customerGroups/{id} - description: Save customer group. - operationId: PutV1CustomerGroupsId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - - name: PutV1CustomerGroupsIdBody - in: body - schema: - required: - - group - properties: - group: - "$ref": "#/definitions/customer-data-group-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-group-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customerGroups/{id} - delete: - tags: - - customerGroups/{id} - description: Delete customer group by ID. - operationId: DeleteV1CustomerGroupsId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customerGroups/{id} - "/V1/customerGroups/{id}/permissions": - get: - tags: - - customerGroups/{id}/permissions - description: Check if customer group can be deleted. - operationId: GetV1CustomerGroupsIdPermissions - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customerGroups/{id}/permissions - "/V1/customers": - post: - tags: - - customers - description: Create customer account. Perform necessary business operations - like sending email. - operationId: PostV1Customers - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CustomersBody - in: body - schema: - required: - - customer - properties: - customer: - "$ref": "#/definitions/customer-data-customer-interface" - password: - type: string - redirectUrl: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-customer-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers - "/V1/customers/activate": - post: - tags: - - customers/activate - description: Activate a customer account using a key that was sent in a confirmation - email. - operationId: PostV1CustomersActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CustomersActivateBody - in: body - schema: - required: - - email - - confirmationKey - properties: - email: - type: string - confirmationKey: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-customer-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/activate - "/V1/customers/addresses/{addressId}": - get: - tags: - - customers/addresses/{addressId} - description: Retrieve customer address. - operationId: GetV1CustomersAddressesAddressId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: addressId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-address-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/addresses/{addressId} - "/V1/customers/companies": - post: - tags: - - customers/companies - description: Save customer attributes for company. - operationId: PostV1CustomersCompanies - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CustomersCompaniesBody - in: body - schema: - required: - - companyAttributes - properties: - companyAttributes: - "$ref": "#/definitions/company-data-company-customer-interface" - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/companies - get: - tags: - - customers/companies - description: Returns the list of company customer attributes. - operationId: GetV1CustomersCompanies - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: criteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: criteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: criteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: criteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: criteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: criteria[pageSize] - in: query - type: integer - description: Page size. - - name: criteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-data-company-customer-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/companies - "/V1/customers/confirm": - post: - tags: - - customers/confirm - description: Resend confirmation email. - operationId: PostV1CustomersConfirm - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CustomersConfirmBody - in: body - schema: - required: - - email - - websiteId - properties: - email: - type: string - websiteId: - type: integer - redirectUrl: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/confirm - "/V1/customers/isEmailAvailable": - post: - tags: - - customers/isEmailAvailable - description: Check if given email is associated with a customer account in given - website. - operationId: PostV1CustomersIsEmailAvailable - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CustomersIsEmailAvailableBody - in: body - schema: - required: - - customerEmail - properties: - customerEmail: - type: string - websiteId: - type: integer - description: If not set, will use the current websiteId - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/isEmailAvailable - "/V1/customers/me": - put: - tags: - - customers/me - description: Create or update a customer. - operationId: PutV1CustomersMe - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CustomersMeBody - in: body - schema: - required: - - customer - properties: - customer: - "$ref": "#/definitions/customer-data-customer-interface" - passwordHash: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-customer-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/me - get: - tags: - - customers/me - description: Get customer by Customer ID. - operationId: GetV1CustomersMe - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-customer-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/me - "/V1/customers/me/activate": - put: - tags: - - customers/me/activate - description: Activate a customer account using a key that was sent in a confirmation - email. - operationId: PutV1CustomersMeActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CustomersMeActivateBody - in: body - schema: - required: - - confirmationKey - properties: - confirmationKey: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-customer-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/me/activate - "/V1/customers/me/billingAddress": - get: - tags: - - customers/me/billingAddress - description: Retrieve default billing address for the given customerId. - operationId: GetV1CustomersMeBillingAddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-address-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/me/billingAddress - "/V1/customers/me/password": - put: - tags: - - customers/me/password - description: Change customer password. - operationId: PutV1CustomersMePassword - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CustomersMePasswordBody - in: body - schema: - required: - - currentPassword - - newPassword - properties: - currentPassword: - type: string - newPassword: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/me/password - "/V1/customers/me/shippingAddress": - get: - tags: - - customers/me/shippingAddress - description: Retrieve default shipping address for the given customerId. - operationId: GetV1CustomersMeShippingAddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-address-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/me/shippingAddress - "/V1/customers/password": - put: - tags: - - customers/password - description: Send an email to the customer with a password reset link. - operationId: PutV1CustomersPassword - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CustomersPasswordBody - in: body - schema: - required: - - email - - template - properties: - email: - type: string - template: - type: string - websiteId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/password - "/V1/customers/resetPassword": - post: - tags: - - customers/resetPassword - description: Reset customer password. - operationId: PostV1CustomersResetPassword - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CustomersResetPasswordBody - in: body - schema: - required: - - email - - resetToken - - newPassword - properties: - email: - type: string - description: If empty value given then the customer will be matched - by the RP token. - resetToken: - type: string - newPassword: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/resetPassword - "/V1/customers/search": - get: - tags: - - customers/search - description: Retrieve customers which match a specified criteria. This call - returns an array of objects, but detailed information about each object’s - attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CustomerRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1CustomersSearch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-customer-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/search - "/V1/customers/validate": - put: - tags: - - customers/validate - description: Validate customer data. - operationId: PutV1CustomersValidate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CustomersValidateBody - in: body - schema: - required: - - customer - properties: - customer: - "$ref": "#/definitions/customer-data-customer-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-validation-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/validate - "/V1/customers/{customerId}": - get: - tags: - - customers/{customerId} - description: Get customer by Customer ID. - operationId: GetV1CustomersCustomerId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: customerId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-customer-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId} - put: - tags: - - customers/{customerId} - description: Create or update a customer. - operationId: PutV1CustomersCustomerId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: customerId - in: path - type: string - required: true - - name: PutV1CustomersCustomerIdBody - in: body - schema: - required: - - customer - properties: - customer: - "$ref": "#/definitions/customer-data-customer-interface" - passwordHash: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-customer-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId} - delete: - tags: - - customers/{customerId} - description: Delete customer by Customer ID. - operationId: DeleteV1CustomersCustomerId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: customerId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId} - "/V1/customers/{customerId}/billingAddress": - get: - tags: - - customers/{customerId}/billingAddress - description: Retrieve default billing address for the given customerId. - operationId: GetV1CustomersCustomerIdBillingAddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: customerId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-address-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId}/billingAddress - "/V1/customers/{customerId}/carts": - post: - tags: - - customers/{customerId}/carts - description: Creates an empty cart and quote for a specified customer if customer - does not have a cart yet. - operationId: PostV1CustomersCustomerIdCarts - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: customerId - in: path - type: integer - required: true - description: The customer ID. - responses: - '200': - description: 200 Success. - schema: - type: integer - description: new cart ID if customer did not have a cart or ID of the - existing cart otherwise. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId}/carts - "/V1/customers/{customerId}/companies": - get: - tags: - - customers/{customerId}/companies - description: Returns a list of companies the customer is assigned to - operationId: GetV1CustomersCustomerIdCompanies - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: customerId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/company-data-company-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId}/companies - "/V1/customers/{customerId}/companies/{companyId}": - put: - tags: - - customers/{customerId}/companies/{companyId} - description: Assigns customer as a company user. - operationId: PutV1CustomersCustomerIdCompaniesCompanyId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: companyId - in: path - type: integer - required: true - - name: customerId - in: path - type: integer - required: true - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId}/companies/{companyId} - delete: - tags: - - customers/{customerId}/companies/{companyId} - description: Unassigns customer from the company. - operationId: DeleteV1CustomersCustomerIdCompaniesCompanyId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: companyId - in: path - type: integer - required: true - - name: customerId - in: path - type: integer - required: true - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId}/companies/{companyId} - get: - tags: - - customers/{customerId}/companies/{companyId} - description: Returns customer attributes for company by ID. - operationId: GetV1CustomersCustomerIdCompaniesCompanyId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: customerId - in: path - type: integer - required: true - - name: companyId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-data-company-customer-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId}/companies/{companyId} - "/V1/customers/{customerId}/confirm": - get: - tags: - - customers/{customerId}/confirm - description: Gets the account confirmation status. - operationId: GetV1CustomersCustomerIdConfirm - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: customerId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: string - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId}/confirm - "/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}": - get: - tags: - - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} - description: Check if password reset token is valid. - operationId: GetV1CustomersCustomerIdPasswordResetLinkTokenResetPasswordLinkToken - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: customerId - in: path - type: integer - required: true - description: If null is given then a customer will be matched by the RP token. - - name: resetPasswordLinkToken - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: True if the token is valid - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} - "/V1/customers/{customerId}/permissions/readonly": - get: - tags: - - customers/{customerId}/permissions/readonly - description: Check if customer can be deleted. - operationId: GetV1CustomersCustomerIdPermissionsReadonly - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: customerId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId}/permissions/readonly - "/V1/customers/{customerId}/shippingAddress": - get: - tags: - - customers/{customerId}/shippingAddress - description: Retrieve default shipping address for the given customerId. - operationId: GetV1CustomersCustomerIdShippingAddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: customerId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-address-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId}/shippingAddress - "/V1/customers/{customerId}/token": - post: - tags: - - customers/{customerId}/token - description: Generate a customer token based on the provided customer ID. - operationId: PostV1CustomersCustomerIdToken - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: customerId - in: path - type: integer - required: true - description: The ID of the customer for whom the token is to be generated. - responses: - '200': - description: 200 Success. - schema: - type: string - description: The generated customer token. - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId}/token - "/V1/customers/{email}/activate": - put: - tags: - - customers/{email}/activate - description: Activate a customer account using a key that was sent in a confirmation - email. - operationId: PutV1CustomersEmailActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: email - in: path - type: string - required: true - - name: PutV1CustomersEmailActivateBody - in: body - schema: - required: - - confirmationKey - properties: - confirmationKey: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-customer-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{email}/activate - "/V1/directory/countries": - get: - tags: - - directory/countries - description: Get all countries and regions information for the store. - operationId: GetV1DirectoryCountries - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/directory-data-country-information-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: directory/countries - "/V1/directory/countries/{countryId}": - get: - tags: - - directory/countries/{countryId} - description: Get country and region information for the store. - operationId: GetV1DirectoryCountriesCountryId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: countryId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/directory-data-country-information-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: directory/countries/{countryId} - "/V1/directory/currency": - get: - tags: - - directory/currency - description: Get currency information for the store. - operationId: GetV1DirectoryCurrency - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/directory-data-currency-information-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: directory/currency - "/V1/eav/attribute-sets": - post: - tags: - - eav/attribute-sets - description: Create attribute set from data - operationId: PostV1EavAttributesets - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1EavAttributesetsBody - in: body - schema: - required: - - entityTypeCode - - attributeSet - - skeletonId - properties: - entityTypeCode: - type: string - attributeSet: - "$ref": "#/definitions/eav-data-attribute-set-interface" - skeletonId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/eav-data-attribute-set-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eav/attribute-sets - "/V1/eav/attribute-sets/list": - get: - tags: - - eav/attribute-sets/list - description: Retrieve list of Attribute Sets This call returns an array of objects, - but detailed information about each object’s attributes might not be included. - See https://developer.adobe.com/commerce/webapi/rest/attributes#AttributeSetRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1EavAttributesetsList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/eav-data-attribute-set-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eav/attribute-sets/list - "/V1/eav/attribute-sets/{attributeSetId}": - get: - tags: - - eav/attribute-sets/{attributeSetId} - description: Retrieve attribute set information based on given ID - operationId: GetV1EavAttributesetsAttributeSetId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeSetId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/eav-data-attribute-set-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eav/attribute-sets/{attributeSetId} - delete: - tags: - - eav/attribute-sets/{attributeSetId} - description: Remove attribute set by given ID - operationId: DeleteV1EavAttributesetsAttributeSetId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeSetId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eav/attribute-sets/{attributeSetId} - put: - tags: - - eav/attribute-sets/{attributeSetId} - description: Save attribute set data - operationId: PutV1EavAttributesetsAttributeSetId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeSetId - in: path - type: string - required: true - - name: PutV1EavAttributesetsAttributeSetIdBody - in: body - schema: - required: - - attributeSet - properties: - attributeSet: - "$ref": "#/definitions/eav-data-attribute-set-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/eav-data-attribute-set-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eav/attribute-sets/{attributeSetId} - "/V1/eventing/eventProvider": - get: - tags: - - eventing/eventProvider - description: Returns the list of event providers - operationId: GetV1EventingEventProvider - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eventing/eventProvider - post: - tags: - - eventing/eventProvider - description: Create or update the event provider - operationId: PostV1EventingEventProvider - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1EventingEventProviderBody - in: body - schema: - required: - - eventProvider - properties: - eventProvider: - "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eventing/eventProvider - put: - tags: - - eventing/eventProvider - description: Create or update the event provider - operationId: PutV1EventingEventProvider - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1EventingEventProviderBody - in: body - schema: - required: - - eventProvider - properties: - eventProvider: - "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eventing/eventProvider - "/V1/eventing/eventProvider/{providerId}": - get: - tags: - - eventing/eventProvider/{providerId} - description: Get a single event provider by provider ID - operationId: GetV1EventingEventProviderProviderId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: providerId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eventing/eventProvider/{providerId} - delete: - tags: - - eventing/eventProvider/{providerId} - description: Delete an event provider by provider ID - operationId: DeleteV1EventingEventProviderProviderId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: providerId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eventing/eventProvider/{providerId} - "/V1/eventing/eventSubscribe": - post: - tags: - - eventing/eventSubscribe - description: Subscribes to the event. - operationId: PostV1EventingEventSubscribe - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1EventingEventSubscribeBody - in: body - schema: - required: - - event - properties: - event: - "$ref": "#/definitions/adobe-commerce-events-client-data-event-data-interface" - force: - type: boolean - type: object - xml: - name: request - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eventing/eventSubscribe - "/V1/eventing/eventSubscribe/{name}": - put: - tags: - - eventing/eventSubscribe/{name} - description: Update the event subscription. - operationId: PutV1EventingEventSubscribeName - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: name - in: path - type: string - required: true - - name: PutV1EventingEventSubscribeNameBody - in: body - schema: - required: - - event - properties: - event: - "$ref": "#/definitions/adobe-commerce-events-client-data-event-data-interface" - type: object - xml: - name: request - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eventing/eventSubscribe/{name} - "/V1/eventing/eventUnsubscribe/{name}": - post: - tags: - - eventing/eventUnsubscribe/{name} - description: Unsubscribes from the event with the provided name. - operationId: PostV1EventingEventUnsubscribeName - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: name - in: path - type: string - required: true - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eventing/eventUnsubscribe/{name} - "/V1/eventing/getEventProviders": - get: - tags: - - eventing/getEventProviders - description: Returns the list of event providers - operationId: GetV1EventingGetEventProviders - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eventing/getEventProviders - "/V1/eventing/getEventSubscriptions": - get: - tags: - - eventing/getEventSubscriptions - description: Returns the list of all subscribed events - operationId: GetV1EventingGetEventSubscriptions - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/adobe-commerce-events-client-data-event-data-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eventing/getEventSubscriptions - "/V1/eventing/updateConfiguration": - put: - tags: - - eventing/updateConfiguration - description: Updates eventing configuration - operationId: PutV1EventingUpdateConfiguration - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1EventingUpdateConfigurationBody - in: body - schema: - required: - - config - properties: - config: - "$ref": "#/definitions/adobe-commerce-events-client-data-configuration-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: eventing/updateConfiguration - "/V1/gift-wrappings": - post: - tags: - - gift-wrappings - description: Create/Update new gift wrapping with data object values - operationId: PostV1Giftwrappings - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1GiftwrappingsBody - in: body - schema: - required: - - data - properties: - data: - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - storeId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: gift-wrappings - get: - tags: - - gift-wrappings - description: Return list of gift wrapping data objects based on search criteria - operationId: GetV1Giftwrappings - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-wrapping-data-wrapping-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: gift-wrappings - "/V1/gift-wrappings/{id}": - get: - tags: - - gift-wrappings/{id} - description: Return data object for specified wrapping ID and store. - operationId: GetV1GiftwrappingsId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - - name: storeId - in: query - type: integer - required: false - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: gift-wrappings/{id} - delete: - tags: - - gift-wrappings/{id} - description: Delete gift wrapping - operationId: DeleteV1GiftwrappingsId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: gift-wrappings/{id} - "/V1/gift-wrappings/{wrappingId}": - put: - tags: - - gift-wrappings/{wrappingId} - description: Create/Update new gift wrapping with data object values - operationId: PutV1GiftwrappingsWrappingId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: wrappingId - in: path - type: string - required: true - - name: PutV1GiftwrappingsWrappingIdBody - in: body - schema: - required: - - data - properties: - data: - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - storeId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: gift-wrappings/{wrappingId} - "/V1/giftregistry/mine/estimate-shipping-methods": - post: - tags: - - giftregistry/mine/estimate-shipping-methods - description: Estimate shipping - operationId: PostV1GiftregistryMineEstimateshippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1GiftregistryMineEstimateshippingmethodsBody - in: body - schema: - required: - - registryId - properties: - registryId: - type: integer - description: The estimate registry id - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: giftregistry/mine/estimate-shipping-methods - "/V1/guest-carts": - post: - tags: - - guest-carts - description: Enable an customer or guest user to create an empty cart and quote - for an anonymous customer. - operationId: PostV1Guestcarts - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: string - description: Cart ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts - "/V1/guest-carts/{cartId}": - get: - tags: - - guest-carts/{cartId} - description: Enable a guest user to return information for a specified cart. - operationId: GetV1GuestcartsCartId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId} - put: - tags: - - guest-carts/{cartId} - description: Assign a specified customer to a specified shopping cart. - operationId: PutV1GuestcartsCartId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PutV1GuestcartsCartIdBody - in: body - schema: - required: - - storeId - properties: - storeId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId} - "/V1/guest-carts/{cartId}/billing-address": - get: - tags: - - guest-carts/{cartId}/billing-address - description: Return the billing address for a specified quote. - operationId: GetV1GuestcartsCartIdBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-address-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/billing-address - post: - tags: - - guest-carts/{cartId}/billing-address - description: Assign a specified billing address to a specified cart. - operationId: PostV1GuestcartsCartIdBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PostV1GuestcartsCartIdBillingaddressBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - useForShipping: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Address ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/billing-address - "/V1/guest-carts/{cartId}/collect-totals": - put: - tags: - - guest-carts/{cartId}/collect-totals - description: Set shipping/billing methods and additional data for cart and collect - totals for guest. - operationId: PutV1GuestcartsCartIdCollecttotals - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PutV1GuestcartsCartIdCollecttotalsBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - shippingCarrierCode: - type: string - description: The carrier code. - shippingMethodCode: - type: string - description: The shipping method code. - additionalData: - "$ref": "#/definitions/quote-data-totals-additional-data-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/collect-totals - "/V1/guest-carts/{cartId}/coupons": - get: - tags: - - guest-carts/{cartId}/coupons - description: Return information for a coupon in a specified cart. - operationId: GetV1GuestcartsCartIdCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: string - description: The coupon code data. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/coupons - delete: - tags: - - guest-carts/{cartId}/coupons - description: Delete a coupon from a specified cart. - operationId: DeleteV1GuestcartsCartIdCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/coupons - "/V1/guest-carts/{cartId}/coupons/{couponCode}": - put: - tags: - - guest-carts/{cartId}/coupons/{couponCode} - description: Add a coupon by code to a specified cart. - operationId: PutV1GuestcartsCartIdCouponsCouponCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: couponCode - in: path - type: string - required: true - description: The coupon code data. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/coupons/{couponCode} - "/V1/guest-carts/{cartId}/estimate-shipping-methods": - post: - tags: - - guest-carts/{cartId}/estimate-shipping-methods - description: Estimate shipping by address and return list of available shipping - methods - operationId: PostV1GuestcartsCartIdEstimateshippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdEstimateshippingmethodsBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/estimate-shipping-methods - "/V1/guest-carts/{cartId}/gift-message": - get: - tags: - - guest-carts/{cartId}/gift-message - description: Return the gift message for a specified order. - operationId: GetV1GuestcartsCartIdGiftmessage - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The shopping cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-message-data-message-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/gift-message - post: - tags: - - guest-carts/{cartId}/gift-message - description: Set the gift message for an entire order. - operationId: PostV1GuestcartsCartIdGiftmessage - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PostV1GuestcartsCartIdGiftmessageBody - in: body - schema: - required: - - giftMessage - properties: - giftMessage: - "$ref": "#/definitions/gift-message-data-message-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/gift-message - "/V1/guest-carts/{cartId}/gift-message/{itemId}": - get: - tags: - - guest-carts/{cartId}/gift-message/{itemId} - description: Return the gift message for a specified item in a specified shopping - cart. - operationId: GetV1GuestcartsCartIdGiftmessageItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The shopping cart ID. - - name: itemId - in: path - type: integer - required: true - description: The item ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-message-data-message-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/gift-message/{itemId} - post: - tags: - - guest-carts/{cartId}/gift-message/{itemId} - description: Set the gift message for a specified item in a specified shopping - cart. - operationId: PostV1GuestcartsCartIdGiftmessageItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: itemId - in: path - type: integer - required: true - description: The item ID. - - name: PostV1GuestcartsCartIdGiftmessageItemIdBody - in: body - schema: - required: - - giftMessage - properties: - giftMessage: - "$ref": "#/definitions/gift-message-data-message-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/gift-message/{itemId} - "/V1/guest-carts/{cartId}/items": - get: - tags: - - guest-carts/{cartId}/items - description: List items that are assigned to a specified cart. - operationId: GetV1GuestcartsCartIdItems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: array - description: Array of items. - items: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/items - post: - tags: - - guest-carts/{cartId}/items - description: Add/update the specified cart item. - operationId: PostV1GuestcartsCartIdItems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdItemsBody - in: body - schema: - required: - - cartItem - properties: - cartItem: - "$ref": "#/definitions/quote-data-cart-item-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/items - "/V1/guest-carts/{cartId}/items/{itemId}": - put: - tags: - - guest-carts/{cartId}/items/{itemId} - description: Add/update the specified cart item. - operationId: PutV1GuestcartsCartIdItemsItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: itemId - in: path - type: string - required: true - - name: PutV1GuestcartsCartIdItemsItemIdBody - in: body - schema: - required: - - cartItem - properties: - cartItem: - "$ref": "#/definitions/quote-data-cart-item-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/items/{itemId} - delete: - tags: - - guest-carts/{cartId}/items/{itemId} - description: Remove the specified item from the specified cart. - operationId: DeleteV1GuestcartsCartIdItemsItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: itemId - in: path - type: integer - required: true - description: The item ID of the item to be removed. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/items/{itemId} - "/V1/guest-carts/{cartId}/order": - put: - tags: - - guest-carts/{cartId}/order - description: Place an order for a specified cart. - operationId: PutV1GuestcartsCartIdOrder - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PutV1GuestcartsCartIdOrderBody - in: body - schema: - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/order - "/V1/guest-carts/{cartId}/payment-information": - post: - tags: - - guest-carts/{cartId}/payment-information - description: Set payment information and place order for a specified cart. - operationId: PostV1GuestcartsCartIdPaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdPaymentinformationBody - in: body - schema: - required: - - email - - paymentMethod - properties: - email: - type: string - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-information - get: - tags: - - guest-carts/{cartId}/payment-information - description: Get payment information - operationId: GetV1GuestcartsCartIdPaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-information - "/V1/guest-carts/{cartId}/payment-methods": - get: - tags: - - guest-carts/{cartId}/payment-methods - description: List available payment methods for a specified shopping cart. This - call returns an array of objects, but detailed information about each object’s - attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#GuestPaymentMethodManagementInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1GuestcartsCartIdPaymentmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: array - description: Array of payment methods. - items: - "$ref": "#/definitions/quote-data-payment-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-methods - "/V1/guest-carts/{cartId}/payment-order": - post: - tags: - - guest-carts/{cartId}/payment-order - description: Create a payment order for guest customer - operationId: PostV1GuestcartsCartIdPaymentorder - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdPaymentorderBody - in: body - schema: - required: - - methodCode - - paymentSource - - location - properties: - methodCode: - type: string - paymentSource: - type: string - location: - type: string - vaultIntent: - type: boolean - threeDSMode: - type: string - description: "| null $threeDSMode" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-order - "/V1/guest-carts/{cartId}/payment-order/{id}": - get: - tags: - - guest-carts/{cartId}/payment-order/{id} - description: Get payment order for guest customer - operationId: GetV1GuestcartsCartIdPaymentorderId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: id - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-order/{id} - post: - tags: - - guest-carts/{cartId}/payment-order/{id} - description: Sync payment order for guest customer - operationId: PostV1GuestcartsCartIdPaymentorderId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: id - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-order/{id} - "/V1/guest-carts/{cartId}/selected-payment-method": - get: - tags: - - guest-carts/{cartId}/selected-payment-method - description: Return the payment method for a specified shopping cart. - operationId: GetV1GuestcartsCartIdSelectedpaymentmethod - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-payment-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/selected-payment-method - put: - tags: - - guest-carts/{cartId}/selected-payment-method - description: Add a specified payment method to a specified shopping cart. - operationId: PutV1GuestcartsCartIdSelectedpaymentmethod - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PutV1GuestcartsCartIdSelectedpaymentmethodBody - in: body - schema: - required: - - method - properties: - method: - "$ref": "#/definitions/quote-data-payment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Payment method ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/selected-payment-method - "/V1/guest-carts/{cartId}/set-payment-information": - post: - tags: - - guest-carts/{cartId}/set-payment-information - description: Set payment information for a specified cart. - operationId: PostV1GuestcartsCartIdSetpaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdSetpaymentinformationBody - in: body - schema: - required: - - email - - paymentMethod - properties: - email: - type: string - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/set-payment-information - "/V1/guest-carts/{cartId}/shipping-information": - post: - tags: - - guest-carts/{cartId}/shipping-information - description: '' - operationId: PostV1GuestcartsCartIdShippinginformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdShippinginformationBody - in: body - schema: - required: - - addressInformation - properties: - addressInformation: - "$ref": "#/definitions/checkout-data-shipping-information-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/shipping-information - "/V1/guest-carts/{cartId}/shipping-methods": - get: - tags: - - guest-carts/{cartId}/shipping-methods - description: List applicable shipping methods for a specified quote. - operationId: GetV1GuestcartsCartIdShippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The shopping cart ID. - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/shipping-methods - "/V1/guest-carts/{cartId}/totals": - get: - tags: - - guest-carts/{cartId}/totals - description: Return quote totals data for a specified cart. - operationId: GetV1GuestcartsCartIdTotals - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/totals - "/V1/guest-carts/{cartId}/totals-information": - post: - tags: - - guest-carts/{cartId}/totals-information - description: Calculate quote totals based on address and shipping method. - operationId: PostV1GuestcartsCartIdTotalsinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdTotalsinformationBody - in: body - schema: - required: - - addressInformation - properties: - addressInformation: - "$ref": "#/definitions/checkout-data-totals-information-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/totals-information - "/V1/guest-giftregistry/{cartId}/estimate-shipping-methods": - post: - tags: - - guest-giftregistry/{cartId}/estimate-shipping-methods - description: Estimate shipping - operationId: PostV1GuestgiftregistryCartIdEstimateshippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The shopping cart ID. - - name: PostV1GuestgiftregistryCartIdEstimateshippingmethodsBody - in: body - schema: - required: - - registryId - properties: - registryId: - type: integer - description: The estimate registry id - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-giftregistry/{cartId}/estimate-shipping-methods - "/V1/hierarchy/move/{id}": - put: - tags: - - hierarchy/move/{id} - description: Moves teams and users within the company structure. - operationId: PutV1HierarchyMoveId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - - name: PutV1HierarchyMoveIdBody - in: body - schema: - required: - - newParentId - properties: - newParentId: - type: integer - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: hierarchy/move/{id} - "/V1/hierarchy/{id}": - get: - tags: - - hierarchy/{id} - description: Returns the list of teams and company users in the company structure. - operationId: GetV1HierarchyId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/company-data-hierarchy-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: hierarchy/{id} - "/V1/import/csv": - post: - tags: - - import/csv - description: Start import operation - operationId: PostV1ImportCsv - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ImportCsvBody - in: body - schema: - required: - - source - properties: - source: - "$ref": "#/definitions/import-csv-api-data-localized-source-data-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - type: string - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: import/csv - "/V1/import/json": - post: - tags: - - import/json - description: Starts import operation. - operationId: PostV1ImportJson - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ImportJsonBody - in: body - schema: - required: - - source - properties: - source: - "$ref": "#/definitions/import-json-api-data-source-data-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - type: string - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: import/json - "/V1/integration/admin/token": - post: - tags: - - integration/admin/token - description: Create access token for admin given the admin credentials. - operationId: PostV1IntegrationAdminToken - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1IntegrationAdminTokenBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - description: Token created - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: integration/admin/token - "/V1/integration/customer/revoke-customer-token": - post: - tags: - - integration/customer/revoke-customer-token - description: Revoke token by customer id. - operationId: PostV1IntegrationCustomerRevokecustomertoken - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: integration/customer/revoke-customer-token - "/V1/integration/customer/token": - post: - tags: - - integration/customer/token - description: Create access token for admin given the customer credentials. - operationId: PostV1IntegrationCustomerToken - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1IntegrationCustomerTokenBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - description: Token created - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: integration/customer/token - "/V1/inventory/are-product-salable-for-requested-qty/": - get: - tags: - - inventory/are-product-salable-for-requested-qty/ - description: Get whether products are salable in requested Qty for given set - of SKUs in specified stock. - operationId: GetV1InventoryAreproductsalableforrequestedqty - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: skuRequests[0][sku] - in: query - type: string - description: Product sku. - - name: skuRequests[0][qty] - in: query - type: number - description: Product quantity. - - name: stockId - in: query - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/inventory-sales-api-data-is-product-salable-for-requested-qty-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/are-product-salable-for-requested-qty/ - "/V1/inventory/are-products-salable": - get: - tags: - - inventory/are-products-salable - description: Get products salable status for given SKUs and given Stock. - operationId: GetV1InventoryAreproductssalable - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: skus - in: query - type: array - items: - type: string - required: true - - name: stockId - in: query - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/inventory-sales-api-data-is-product-salable-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/are-products-salable - "/V1/inventory/bulk-partial-source-transfer": - post: - tags: - - inventory/bulk-partial-source-transfer - description: Run bulk partial inventory transfer for specified items. - operationId: PostV1InventoryBulkpartialsourcetransfer - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventoryBulkpartialsourcetransferBody - in: body - schema: - required: - - originSourceCode - - destinationSourceCode - - items - properties: - originSourceCode: - type: string - destinationSourceCode: - type: string - items: - type: array - items: - "$ref": "#/definitions/inventory-catalog-api-data-partial-inventory-transfer-item-interface" - type: object - xml: - name: request - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/bulk-partial-source-transfer - "/V1/inventory/bulk-product-source-assign": - post: - tags: - - inventory/bulk-product-source-assign - description: Run mass product to source assignment - operationId: PostV1InventoryBulkproductsourceassign - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventoryBulkproductsourceassignBody - in: body - schema: - required: - - skus - - sourceCodes - properties: - skus: - type: array - items: - type: string - sourceCodes: - type: array - items: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/bulk-product-source-assign - "/V1/inventory/bulk-product-source-transfer": - post: - tags: - - inventory/bulk-product-source-transfer - description: Run bulk inventory transfer - operationId: PostV1InventoryBulkproductsourcetransfer - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventoryBulkproductsourcetransferBody - in: body - schema: - required: - - skus - - originSource - - destinationSource - - unassignFromOrigin - properties: - skus: - type: array - items: - type: string - originSource: - type: string - destinationSource: - type: string - unassignFromOrigin: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/bulk-product-source-transfer - "/V1/inventory/bulk-product-source-unassign": - post: - tags: - - inventory/bulk-product-source-unassign - description: Run mass product to source un-assignment - operationId: PostV1InventoryBulkproductsourceunassign - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventoryBulkproductsourceunassignBody - in: body - schema: - required: - - skus - - sourceCodes - properties: - skus: - type: array - items: - type: string - sourceCodes: - type: array - items: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/bulk-product-source-unassign - "/V1/inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode}": - get: - tags: - - inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode} - description: Provides stock index export from inventory_stock_% table - operationId: GetV1InventoryDumpstockindexdataSalesChannelTypeSalesChannelCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: salesChannelType - in: path - type: string - required: true - - name: salesChannelCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/inventory-export-stock-api-data-product-stock-index-data-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode} - "/V1/inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode}": - get: - tags: - - inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode} - description: Export product stock data filtered by search criteria. - operationId: GetV1InventoryExportstocksalableqtySalesChannelTypeSalesChannelCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: salesChannelType - in: path - type: string - required: true - - name: salesChannelCode - in: path - type: string - required: true - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-export-stock-api-data-export-stock-salable-qty-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode} - "/V1/inventory/get-distance": - get: - tags: - - inventory/get-distance - description: Get distance between two points - operationId: GetV1InventoryGetdistance - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: source[lat] - in: query - type: number - description: Latitude - - name: source[lng] - in: query - type: number - description: Longitude - - name: destination[lat] - in: query - type: number - description: Latitude - - name: destination[lng] - in: query - type: number - description: Longitude - responses: - '200': - description: 200 Success. - schema: - type: number - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/get-distance - "/V1/inventory/get-distance-provider-code": - get: - tags: - - inventory/get-distance-provider-code - description: Get Default distance provider code - operationId: GetV1InventoryGetdistanceprovidercode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: string - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/get-distance-provider-code - "/V1/inventory/get-latlng-from-address": - get: - tags: - - inventory/get-latlng-from-address - description: Get latitude and longitude object from address - operationId: GetV1InventoryGetlatlngfromaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: address[country] - in: query - type: string - description: Shipping country - - name: address[postcode] - in: query - type: string - description: Shipping postcode - - name: address[street] - in: query - type: string - description: Shipping street address - - name: address[region] - in: query - type: string - description: Shipping region - - name: address[city] - in: query - type: string - description: Shipping city - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-distance-based-source-selection-api-data-lat-lng-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/get-latlng-from-address - "/V1/inventory/get-latslngs-from-address": - get: - tags: - - inventory/get-latslngs-from-address - description: Get all available latitude and longitude objects from address. - operationId: GetV1InventoryGetlatslngsfromaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: address[country] - in: query - type: string - description: Shipping country - - name: address[postcode] - in: query - type: string - description: Shipping postcode - - name: address[street] - in: query - type: string - description: Shipping street address - - name: address[region] - in: query - type: string - description: Shipping region - - name: address[city] - in: query - type: string - description: Shipping city - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/inventory-distance-based-source-selection-api-data-lat-lng-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/get-latslngs-from-address - "/V1/inventory/get-product-salable-quantity/{sku}/{stockId}": - get: - tags: - - inventory/get-product-salable-quantity/{sku}/{stockId} - description: Get Product Quantity for given SKU and Stock - operationId: GetV1InventoryGetproductsalablequantitySkuStockId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: stockId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: number - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/get-product-salable-quantity/{sku}/{stockId} - "/V1/inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId}": - get: - tags: - - inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId} - description: Get Sources assigned to Stock ordered by priority If Stock with - given id doesn't exist then return an empty array - operationId: GetV1InventoryGetsourcesassignedtostockorderedbypriorityStockId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: stockId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/inventory-api-data-source-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId} - "/V1/inventory/in-store-pickup/pickup-locations/": - get: - tags: - - inventory/in-store-pickup/pickup-locations/ - description: Get Pickup Locations according to the results of filtration by - Search Request. - operationId: GetV1InventoryInstorepickupPickuplocations - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchRequest[area][radius] - in: query - type: integer - description: Search radius in KM. - - name: searchRequest[area][searchTerm] - in: query - type: string - description: Search term string. - - name: searchRequest[filters][country][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][country][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][postcode][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][postcode][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][region][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][region][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][regionId][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][regionId][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][city][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][city][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][street][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][street][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][name][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][name][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][pickupLocationCode][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][pickupLocationCode][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[pageSize] - in: query - type: integer - description: Page size. - - name: searchRequest[currentPage] - in: query - type: integer - description: Current page. - - name: searchRequest[scopeType] - in: query - type: string - description: Sales Channel Type. - - name: searchRequest[scopeCode] - in: query - type: string - description: Sales Channel code. - - name: searchRequest[sort][0][field] - in: query - type: string - description: Sorting field. - - name: searchRequest[sort][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchRequest[extensionAttributes][productsInfo][0][sku] - in: query - type: string - description: Product SKU. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/in-store-pickup/pickup-locations/ - post: - tags: - - inventory/in-store-pickup/pickup-locations/ - description: Get Pickup Locations according to the results of filtration by - Search Request. - operationId: PostV1InventoryInstorepickupPickuplocations - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventoryInstorepickupPickuplocationsBody - in: body - schema: - required: - - searchRequest - properties: - searchRequest: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/in-store-pickup/pickup-locations/ - "/V1/inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty}": - get: - tags: - - inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty} - description: Get is product salable for given SKU in a given Stock for a certain - Qty - operationId: GetV1InventoryIsproductsalableforrequestedqtySkuStockIdRequestedQty - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: stockId - in: path - type: integer - required: true - - name: requestedQty - in: path - type: number - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-sales-api-data-product-salable-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty} - "/V1/inventory/is-product-salable/{sku}/{stockId}": - get: - tags: - - inventory/is-product-salable/{sku}/{stockId} - description: Get is product in salable for given SKU in a given Stock - operationId: GetV1InventoryIsproductsalableSkuStockId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: stockId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/is-product-salable/{sku}/{stockId} - "/V1/inventory/low-quantity-notification": - post: - tags: - - inventory/low-quantity-notification - description: Save an array of SourceItemConfigurationInterface objects passed - as parameter. - operationId: PostV1InventoryLowquantitynotification - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventoryLowquantitynotificationBody - in: body - schema: - required: - - sourceItemConfigurations - properties: - sourceItemConfigurations: - type: array - items: - "$ref": "#/definitions/inventory-low-quantity-notification-api-data-source-item-configuration-interface" - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/low-quantity-notification - "/V1/inventory/low-quantity-notification/{sourceCode}/{sku}": - get: - tags: - - inventory/low-quantity-notification/{sourceCode}/{sku} - description: Get the source item configuration - operationId: GetV1InventoryLowquantitynotificationSourceCodeSku - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sourceCode - in: path - type: string - required: true - - name: sku - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-low-quantity-notification-api-data-source-item-configuration-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/low-quantity-notification/{sourceCode}/{sku} - "/V1/inventory/low-quantity-notifications-delete": - post: - tags: - - inventory/low-quantity-notifications-delete - description: Delete multiple source items configuration for low quantity - operationId: PostV1InventoryLowquantitynotificationsdelete - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventoryLowquantitynotificationsdeleteBody - in: body - schema: - required: - - sourceItems - properties: - sourceItems: - type: array - items: - "$ref": "#/definitions/inventory-api-data-source-item-interface" - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/low-quantity-notifications-delete - "/V1/inventory/source-items": - get: - tags: - - inventory/source-items - description: Find SourceItems by SearchCriteria We need to have this method - for direct work with SourceItems because this object contains additional data - like as qty, status (for example can be searchable by additional field) - operationId: GetV1InventorySourceitems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-api-data-source-item-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/source-items - post: - tags: - - inventory/source-items - description: Save Multiple Source item data - operationId: PostV1InventorySourceitems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventorySourceitemsBody - in: body - schema: - required: - - sourceItems - properties: - sourceItems: - type: array - items: - "$ref": "#/definitions/inventory-api-data-source-item-interface" - type: object - xml: - name: request - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/source-items - "/V1/inventory/source-items-delete": - post: - tags: - - inventory/source-items-delete - description: Delete Multiple Source item data - operationId: PostV1InventorySourceitemsdelete - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventorySourceitemsdeleteBody - in: body - schema: - required: - - sourceItems - properties: - sourceItems: - type: array - items: - "$ref": "#/definitions/inventory-api-data-source-item-interface" - type: object - xml: - name: request - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/source-items-delete - "/V1/inventory/source-selection-algorithm-list": - get: - tags: - - inventory/source-selection-algorithm-list - description: Returns a list of registered Source Selection Algorithm (SSA) data - interfaces available in the system. - operationId: GetV1InventorySourceselectionalgorithmlist - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-algorithm-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/source-selection-algorithm-list - "/V1/inventory/source-selection-algorithm-result": - post: - tags: - - inventory/source-selection-algorithm-result - description: Executes the source selection service using the provided inventory - request and algorithm code. - operationId: PostV1InventorySourceselectionalgorithmresult - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventorySourceselectionalgorithmresultBody - in: body - schema: - required: - - inventoryRequest - - algorithmCode - properties: - inventoryRequest: - "$ref": "#/definitions/inventory-source-selection-api-data-inventory-request-interface" - algorithmCode: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/source-selection-algorithm-result - "/V1/inventory/sources": - get: - tags: - - inventory/sources - description: Find Sources by SearchCriteria SearchCriteria is not required because - load all stocks is useful case - operationId: GetV1InventorySources - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-api-data-source-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/sources - post: - tags: - - inventory/sources - description: Save Source data - operationId: PostV1InventorySources - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventorySourcesBody - in: body - schema: - required: - - source - properties: - source: - "$ref": "#/definitions/inventory-api-data-source-interface" - type: object - xml: - name: request - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/sources - "/V1/inventory/sources/{sourceCode}": - get: - tags: - - inventory/sources/{sourceCode} - description: Get Source data by given code. If you want to create plugin on - get method, also you need to create separate Plugin on getList method, because - entity loading way is different for these methods - operationId: GetV1InventorySourcesSourceCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sourceCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-api-data-source-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/sources/{sourceCode} - put: - tags: - - inventory/sources/{sourceCode} - description: Save Source data - operationId: PutV1InventorySourcesSourceCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sourceCode - in: path - type: string - required: true - - name: PutV1InventorySourcesSourceCodeBody - in: body - schema: - required: - - source - properties: - source: - "$ref": "#/definitions/inventory-api-data-source-interface" - type: object - xml: - name: request - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/sources/{sourceCode} - "/V1/inventory/stock-resolver/{type}/{code}": - get: - tags: - - inventory/stock-resolver/{type}/{code} - description: Resolve Stock by Sales Channel type and code - operationId: GetV1InventoryStockresolverTypeCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: type - in: path - type: string - required: true - - name: code - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-api-data-stock-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/stock-resolver/{type}/{code} - "/V1/inventory/stock-source-links": - get: - tags: - - inventory/stock-source-links - description: Find StockSourceLink list by given SearchCriteria - operationId: GetV1InventoryStocksourcelinks - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-api-data-stock-source-link-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/stock-source-links - post: - tags: - - inventory/stock-source-links - description: Save StockSourceLink list data - operationId: PostV1InventoryStocksourcelinks - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventoryStocksourcelinksBody - in: body - schema: - required: - - links - properties: - links: - type: array - items: - "$ref": "#/definitions/inventory-api-data-stock-source-link-interface" - type: object - xml: - name: request - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/stock-source-links - "/V1/inventory/stock-source-links-delete": - post: - tags: - - inventory/stock-source-links-delete - description: Remove StockSourceLink list list - operationId: PostV1InventoryStocksourcelinksdelete - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventoryStocksourcelinksdeleteBody - in: body - schema: - required: - - links - properties: - links: - type: array - items: - "$ref": "#/definitions/inventory-api-data-stock-source-link-interface" - type: object - xml: - name: request - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/stock-source-links-delete - "/V1/inventory/stocks": - get: - tags: - - inventory/stocks - description: Find Stocks by given SearchCriteria SearchCriteria is not required - because load all stocks is useful case - operationId: GetV1InventoryStocks - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-api-data-stock-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/stocks - post: - tags: - - inventory/stocks - description: Save Stock data - operationId: PostV1InventoryStocks - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventoryStocksBody - in: body - schema: - required: - - stock - properties: - stock: - "$ref": "#/definitions/inventory-api-data-stock-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/stocks - "/V1/inventory/stocks/{stockId}": - get: - tags: - - inventory/stocks/{stockId} - description: Get Stock data by given stockId. If you want to create plugin on - get method, also you need to create separate Plugin on getList method, because - entity loading way is different for these methods - operationId: GetV1InventoryStocksStockId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: stockId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-api-data-stock-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/stocks/{stockId} - delete: - tags: - - inventory/stocks/{stockId} - description: Delete the Stock data by stockId. If stock is not found do nothing - operationId: DeleteV1InventoryStocksStockId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: stockId - in: path - type: integer - required: true - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/stocks/{stockId} - put: - tags: - - inventory/stocks/{stockId} - description: Save Stock data - operationId: PutV1InventoryStocksStockId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: stockId - in: path - type: string - required: true - - name: PutV1InventoryStocksStockIdBody - in: body - schema: - required: - - stock - properties: - stock: - "$ref": "#/definitions/inventory-api-data-stock-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/stocks/{stockId} - "/V1/invoice/{invoiceId}/refund": - post: - tags: - - invoice/{invoiceId}/refund - description: Create refund for invoice - operationId: PostV1InvoiceInvoiceIdRefund - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: invoiceId - in: path - type: integer - required: true - - name: PostV1InvoiceInvoiceIdRefundBody - in: body - schema: - properties: - items: - type: array - items: - "$ref": "#/definitions/sales-data-creditmemo-item-creation-interface" - isOnline: - type: boolean - notify: - type: boolean - appendComment: - type: boolean - comment: - "$ref": "#/definitions/sales-data-creditmemo-comment-creation-interface" - arguments: - "$ref": "#/definitions/sales-data-creditmemo-creation-arguments-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: invoice/{invoiceId}/refund - "/V1/invoices": - get: - tags: - - invoices - description: Lists invoices that match specified search criteria. This call - returns an array of objects, but detailed information about each object’s - attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#InvoiceRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1Invoices - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-invoice-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: invoices - "/V1/invoices/": - post: - tags: - - invoices/ - description: Performs persist operations for a specified invoice. - operationId: PostV1Invoices - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InvoicesBody - in: body - schema: - required: - - entity - properties: - entity: - "$ref": "#/definitions/sales-data-invoice-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-invoice-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: invoices/ - "/V1/invoices/comments": - post: - tags: - - invoices/comments - description: Performs persist operations for a specified invoice comment. - operationId: PostV1InvoicesComments - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InvoicesCommentsBody - in: body - schema: - required: - - entity - properties: - entity: - "$ref": "#/definitions/sales-data-invoice-comment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-invoice-comment-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: invoices/comments - "/V1/invoices/{id}": - get: - tags: - - invoices/{id} - description: Loads a specified invoice. - operationId: GetV1InvoicesId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The invoice ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-invoice-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: invoices/{id} - "/V1/invoices/{id}/capture": - post: - tags: - - invoices/{id}/capture - description: Sets invoice capture. - operationId: PostV1InvoicesIdCapture - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: string - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: invoices/{id}/capture - "/V1/invoices/{id}/comments": - get: - tags: - - invoices/{id}/comments - description: Lists comments for a specified invoice. - operationId: GetV1InvoicesIdComments - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The invoice ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-invoice-comment-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: invoices/{id}/comments - "/V1/invoices/{id}/emails": - post: - tags: - - invoices/{id}/emails - description: Emails a user a specified invoice. - operationId: PostV1InvoicesIdEmails - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The invoice ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: invoices/{id}/emails - "/V1/invoices/{id}/void": - post: - tags: - - invoices/{id}/void - description: Voids a specified invoice. - operationId: PostV1InvoicesIdVoid - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The invoice ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: invoices/{id}/void - "/V1/modules": - get: - tags: - - modules - description: Returns an array of enabled modules - operationId: GetV1Modules - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - type: string - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: modules - "/V1/negotiable-cart-item-note": - post: - tags: - - negotiable-cart-item-note - description: Set the note for an item in negotiable quote. - operationId: PostV1Negotiablecartitemnote - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiablecartitemnoteBody - in: body - schema: - required: - - itemNote - properties: - itemNote: - "$ref": "#/definitions/negotiable-quote-data-item-note-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-cart-item-note - "/V1/negotiable-cart-item-note/search": - get: - tags: - - negotiable-cart-item-note/search - description: Get list of item notes - operationId: GetV1NegotiablecartitemnoteSearch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/negotiable-quote-data-item-note-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-cart-item-note/search - "/V1/negotiable-cart-item-note/{noteId}": - get: - tags: - - negotiable-cart-item-note/{noteId} - description: Get item note by ID - operationId: GetV1NegotiablecartitemnoteNoteId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: noteId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/negotiable-quote-data-item-note-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-cart-item-note/{noteId} - delete: - tags: - - negotiable-cart-item-note/{noteId} - description: Delete item note by ID. - operationId: DeleteV1NegotiablecartitemnoteNoteId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: noteId - in: path - type: integer - required: true - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-cart-item-note/{noteId} - "/V1/negotiable-carts/{cartId}/billing-address": - get: - tags: - - negotiable-carts/{cartId}/billing-address - description: Returns the billing address for a specified quote. - operationId: GetV1NegotiablecartsCartIdBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-address-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/billing-address - post: - tags: - - negotiable-carts/{cartId}/billing-address - description: Assigns a specified billing address to a specified cart. - operationId: PostV1NegotiablecartsCartIdBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - - name: PostV1NegotiablecartsCartIdBillingaddressBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - useForShipping: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Address ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/billing-address - "/V1/negotiable-carts/{cartId}/coupons": - delete: - tags: - - negotiable-carts/{cartId}/coupons - description: Deletes a coupon from a specified cart. - operationId: DeleteV1NegotiablecartsCartIdCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/coupons - "/V1/negotiable-carts/{cartId}/coupons/{couponCode}": - put: - tags: - - negotiable-carts/{cartId}/coupons/{couponCode} - description: Adds a coupon by code to a specified cart. - operationId: PutV1NegotiablecartsCartIdCouponsCouponCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - - name: couponCode - in: path - type: string - required: true - description: The coupon code data. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/coupons/{couponCode} - "/V1/negotiable-carts/{cartId}/estimate-shipping-methods": - post: - tags: - - negotiable-carts/{cartId}/estimate-shipping-methods - description: Estimate shipping by address and return list of available shipping - methods - operationId: PostV1NegotiablecartsCartIdEstimateshippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1NegotiablecartsCartIdEstimateshippingmethodsBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/estimate-shipping-methods - "/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id": - post: - tags: - - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id - description: Estimate shipping - operationId: PostV1NegotiablecartsCartIdEstimateshippingmethodsbyaddressid - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The shopping cart ID. - - name: PostV1NegotiablecartsCartIdEstimateshippingmethodsbyaddressidBody - in: body - schema: - required: - - addressId - properties: - addressId: - type: integer - description: The estimate address id - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id - "/V1/negotiable-carts/{cartId}/giftCards": - post: - tags: - - negotiable-carts/{cartId}/giftCards - description: '' - operationId: PostV1NegotiablecartsCartIdGiftCards - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1NegotiablecartsCartIdGiftCardsBody - in: body - schema: - required: - - giftCardAccountData - properties: - giftCardAccountData: - "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/giftCards - "/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}": - delete: - tags: - - negotiable-carts/{cartId}/giftCards/{giftCardCode} - description: Remove GiftCard Account entity - operationId: DeleteV1NegotiablecartsCartIdGiftCardsGiftCardCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: giftCardCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/giftCards/{giftCardCode} - "/V1/negotiable-carts/{cartId}/payment-information": - post: - tags: - - negotiable-carts/{cartId}/payment-information - description: Set payment information and place order for a specified cart. - operationId: PostV1NegotiablecartsCartIdPaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1NegotiablecartsCartIdPaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/payment-information - get: - tags: - - negotiable-carts/{cartId}/payment-information - description: Get payment information - operationId: GetV1NegotiablecartsCartIdPaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/payment-information - "/V1/negotiable-carts/{cartId}/po-payment-information": - post: - tags: - - negotiable-carts/{cartId}/po-payment-information - description: Set payment information and place purchase order for a specified - negotiable quote. - operationId: PostV1NegotiablecartsCartIdPopaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1NegotiablecartsCartIdPopaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Purchase Order ID. - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/po-payment-information - "/V1/negotiable-carts/{cartId}/set-payment-information": - post: - tags: - - negotiable-carts/{cartId}/set-payment-information - description: Set payment information for a specified cart. - operationId: PostV1NegotiablecartsCartIdSetpaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1NegotiablecartsCartIdSetpaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/set-payment-information - "/V1/negotiable-carts/{cartId}/shipping-information": - post: - tags: - - negotiable-carts/{cartId}/shipping-information - description: '' - operationId: PostV1NegotiablecartsCartIdShippinginformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1NegotiablecartsCartIdShippinginformationBody - in: body - schema: - required: - - addressInformation - properties: - addressInformation: - "$ref": "#/definitions/checkout-data-shipping-information-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/shipping-information - "/V1/negotiable-carts/{cartId}/totals": - get: - tags: - - negotiable-carts/{cartId}/totals - description: Returns quote totals data for a specified cart. - operationId: GetV1NegotiablecartsCartIdTotals - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/totals - "/V1/negotiableQuote/attachmentContent": - get: - tags: - - negotiableQuote/attachmentContent - description: Returns content for one or more files attached on the quote comment. - operationId: GetV1NegotiableQuoteAttachmentContent - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attachmentIds - in: query - type: array - items: - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuote/attachmentContent - "/V1/negotiableQuote/decline": - post: - tags: - - negotiableQuote/decline - description: Decline the B2B quote. All custom pricing will be removed from - this quote. The buyer will be able to place an order using their standard - catalog prices and discounts. - operationId: PostV1NegotiableQuoteDecline - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteDeclineBody - in: body - schema: - required: - - quoteId - - reason - properties: - quoteId: - type: integer - reason: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuote/decline - "/V1/negotiableQuote/draft": - post: - tags: - - negotiableQuote/draft - description: Create a new empty B2B quote with NegotiableQuoteInterface::STATUS_DRAFT_BY_ADMIN - status. - operationId: PostV1NegotiableQuoteDraft - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteDraftBody - in: body - schema: - required: - - customerId - properties: - customerId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Quote Id - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuote/draft - "/V1/negotiableQuote/pricesUpdated": - post: - tags: - - negotiableQuote/pricesUpdated - description: Refreshes item prices, taxes, discounts, cart rules in the negotiable - quote as per the latest changes in the catalog / shared catalog and in the - price rules. Depending on the negotiable quote state and totals, all or just - some of quote numbers will be recalculated. 'Update Prices' parameter forces - refresh on any quote that is not locked for admin user, including the quotes - with a negotiated price. The request can be applied to one or more quotes - at the same time. - operationId: PostV1NegotiableQuotePricesUpdated - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuotePricesUpdatedBody - in: body - schema: - required: - - quoteIds - properties: - quoteIds: - type: array - items: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuote/pricesUpdated - "/V1/negotiableQuote/request": - post: - tags: - - negotiableQuote/request - description: Create a B2B quote based on a regular Magento quote. If the B2B - quote requires a shipping address (for negotiation or tax calculations), add - it to the regular quote before you create a B2B quote. - operationId: PostV1NegotiableQuoteRequest - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteRequestBody - in: body - schema: - required: - - quoteId - - quoteName - properties: - quoteId: - type: integer - quoteName: - type: string - comment: - type: string - files: - type: array - items: - "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuote/request - "/V1/negotiableQuote/submitToCustomer": - post: - tags: - - negotiableQuote/submitToCustomer - description: Submit the B2B quote to the customer. The quote status for the - customer will be changed to 'Updated', and the customer can work with the - quote. - operationId: PostV1NegotiableQuoteSubmitToCustomer - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteSubmitToCustomerBody - in: body - schema: - required: - - quoteId - properties: - quoteId: - type: integer - comment: - type: string - files: - type: array - items: - "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuote/submitToCustomer - "/V1/negotiableQuote/{negotiableQuoteId}/duplicate": - post: - tags: - - negotiableQuote/{negotiableQuoteId}/duplicate - description: Duplicate Negotiable Quote based on the ID of existing negotiable - quote. Returns ID of a duplicated quote. - operationId: PostV1NegotiableQuoteNegotiableQuoteIdDuplicate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: negotiableQuoteId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: integer - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuote/{negotiableQuoteId}/duplicate - "/V1/negotiableQuote/{quoteId}": - put: - tags: - - negotiableQuote/{quoteId} - description: Save quote - operationId: PutV1NegotiableQuoteQuoteId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: quoteId - in: path - type: string - required: true - - name: PutV1NegotiableQuoteQuoteIdBody - in: body - schema: - required: - - quote - properties: - quote: - "$ref": "#/definitions/quote-data-cart-interface" - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuote/{quoteId} - "/V1/negotiableQuote/{quoteId}/comments": - get: - tags: - - negotiableQuote/{quoteId}/comments - description: Returns comments for a specified negotiable quote. - operationId: GetV1NegotiableQuoteQuoteIdComments - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: quoteId - in: path - type: integer - required: true - description: Negotiable Quote ID. - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of quote comments. - items: - "$ref": "#/definitions/negotiable-quote-data-comment-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuote/{quoteId}/comments - "/V1/negotiableQuote/{quoteId}/shippingMethod": - put: - tags: - - negotiableQuote/{quoteId}/shippingMethod - description: Updates the shipping method on a negotiable quote. - operationId: PutV1NegotiableQuoteQuoteIdShippingMethod - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: quoteId - in: path - type: integer - required: true - description: Negotiable Quote id - - name: PutV1NegotiableQuoteQuoteIdShippingMethodBody - in: body - schema: - required: - - shippingMethod - properties: - shippingMethod: - type: string - description: The shipping method code. - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuote/{quoteId}/shippingMethod - "/V1/negotiableQuoteTemplate": - get: - tags: - - negotiableQuoteTemplate - description: Get list of quote templates - operationId: GetV1NegotiableQuoteTemplate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/framework-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate - put: - tags: - - negotiableQuoteTemplate - description: Edit a quote template. - operationId: PutV1NegotiableQuoteTemplate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1NegotiableQuoteTemplateBody - in: body - schema: - required: - - template - properties: - template: - "$ref": "#/definitions/negotiable-quote-template-data-template-interface" - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate - "/V1/negotiableQuoteTemplate/accept": - post: - tags: - - negotiableQuoteTemplate/accept - description: Create quote template from quote - operationId: PostV1NegotiableQuoteTemplateAccept - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateAcceptBody - in: body - schema: - required: - - templateId - properties: - templateId: - type: integer - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/accept - "/V1/negotiableQuoteTemplate/cancel": - post: - tags: - - negotiableQuoteTemplate/cancel - description: Cancel a quote template. - operationId: PostV1NegotiableQuoteTemplateCancel - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateCancelBody - in: body - schema: - required: - - templateId - properties: - templateId: - type: integer - comment: - type: string - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/cancel - "/V1/negotiableQuoteTemplate/cancel/me": - post: - tags: - - negotiableQuoteTemplate/cancel/me - description: Cancel a quote template. - operationId: PostV1NegotiableQuoteTemplateCancelMe - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateCancelMeBody - in: body - schema: - required: - - templateId - properties: - templateId: - type: integer - comment: - type: string - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/cancel/me - "/V1/negotiableQuoteTemplate/decline": - post: - tags: - - negotiableQuoteTemplate/decline - description: Decline a quote template. - operationId: PostV1NegotiableQuoteTemplateDecline - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateDeclineBody - in: body - schema: - required: - - templateId - - reason - properties: - templateId: - type: integer - reason: - type: string - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/decline - "/V1/negotiableQuoteTemplate/draft": - post: - tags: - - negotiableQuoteTemplate/draft - description: Create a new empty B2B quote template with NegotiableQuoteInterface::STATUS_DRAFT_BY_ADMIN - status. - operationId: PostV1NegotiableQuoteTemplateDraft - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateDraftBody - in: body - schema: - required: - - customerId - properties: - customerId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/negotiable-quote-template-data-template-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/draft - "/V1/negotiableQuoteTemplate/generateQuote": - post: - tags: - - negotiableQuoteTemplate/generateQuote - description: Generate quote from template - operationId: PostV1NegotiableQuoteTemplateGenerateQuote - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateGenerateQuoteBody - in: body - schema: - required: - - templateId - properties: - templateId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/generateQuote - "/V1/negotiableQuoteTemplate/me": - put: - tags: - - negotiableQuoteTemplate/me - description: Edit a quote template. - operationId: PutV1NegotiableQuoteTemplateMe - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1NegotiableQuoteTemplateMeBody - in: body - schema: - required: - - template - properties: - template: - "$ref": "#/definitions/negotiable-quote-template-data-template-interface" - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/me - "/V1/negotiableQuoteTemplate/me/{templateId}": - delete: - tags: - - negotiableQuoteTemplate/me/{templateId} - description: Delete a quote template. - operationId: DeleteV1NegotiableQuoteTemplateMeTemplateId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: templateId - in: path - type: integer - required: true - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/me/{templateId} - "/V1/negotiableQuoteTemplate/open": - post: - tags: - - negotiableQuoteTemplate/open - description: Open template - operationId: PostV1NegotiableQuoteTemplateOpen - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateOpenBody - in: body - schema: - required: - - templateId - properties: - templateId: - type: integer - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/open - "/V1/negotiableQuoteTemplate/open/me": - post: - tags: - - negotiableQuoteTemplate/open/me - description: Open template - operationId: PostV1NegotiableQuoteTemplateOpenMe - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateOpenMeBody - in: body - schema: - required: - - templateId - properties: - templateId: - type: integer - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/open/me - "/V1/negotiableQuoteTemplate/referenceDocumentLink": - get: - tags: - - negotiableQuoteTemplate/referenceDocumentLink - description: Get list of reference document links - operationId: GetV1NegotiableQuoteTemplateReferenceDocumentLink - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/framework-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/referenceDocumentLink - put: - tags: - - negotiableQuoteTemplate/referenceDocumentLink - description: Save reference document link - operationId: PutV1NegotiableQuoteTemplateReferenceDocumentLink - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1NegotiableQuoteTemplateReferenceDocumentLinkBody - in: body - schema: - required: - - referenceDocumentLink - properties: - referenceDocumentLink: - "$ref": "#/definitions/negotiable-quote-template-data-reference-document-link-interface" - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/referenceDocumentLink - "/V1/negotiableQuoteTemplate/referenceDocumentLink/{linkId}": - get: - tags: - - negotiableQuoteTemplate/referenceDocumentLink/{linkId} - description: Get reference document link by id - operationId: GetV1NegotiableQuoteTemplateReferenceDocumentLinkLinkId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: linkId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/negotiable-quote-template-data-reference-document-link-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/referenceDocumentLink/{linkId} - delete: - tags: - - negotiableQuoteTemplate/referenceDocumentLink/{linkId} - description: Delete a quote template reference document link - operationId: DeleteV1NegotiableQuoteTemplateReferenceDocumentLinkLinkId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: linkId - in: path - type: integer - required: true - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/referenceDocumentLink/{linkId} - "/V1/negotiableQuoteTemplate/request": - post: - tags: - - negotiableQuoteTemplate/request - description: Create a template for a quote. - operationId: PostV1NegotiableQuoteTemplateRequest - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateRequestBody - in: body - schema: - required: - - quoteId - properties: - quoteId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/negotiable-quote-template-data-template-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/request - "/V1/negotiableQuoteTemplate/request/me": - post: - tags: - - negotiableQuoteTemplate/request/me - description: Create a template for a quote. - operationId: PostV1NegotiableQuoteTemplateRequestMe - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateRequestMeBody - in: body - schema: - required: - - quoteId - properties: - quoteId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/negotiable-quote-template-data-template-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/request/me - "/V1/negotiableQuoteTemplate/submitToCustomer": - post: - tags: - - negotiableQuoteTemplate/submitToCustomer - description: Seller send action - operationId: PostV1NegotiableQuoteTemplateSubmitToCustomer - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateSubmitToCustomerBody - in: body - schema: - required: - - templateId - properties: - templateId: - type: integer - commentText: - type: string - files: - type: array - items: - "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/submitToCustomer - "/V1/negotiableQuoteTemplate/submitToSeller": - post: - tags: - - negotiableQuoteTemplate/submitToSeller - description: Send template to seller - operationId: PostV1NegotiableQuoteTemplateSubmitToSeller - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateSubmitToSellerBody - in: body - schema: - required: - - templateId - properties: - templateId: - type: integer - commentText: - type: string - files: - type: array - items: - "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/submitToSeller - "/V1/negotiableQuoteTemplate/{templateId}": - get: - tags: - - negotiableQuoteTemplate/{templateId} - description: Return the negotiable quote template for a specified quote ID. - operationId: GetV1NegotiableQuoteTemplateTemplateId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: templateId - in: path - type: integer - required: true - description: template id - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/negotiable-quote-template-data-template-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/{templateId} - delete: - tags: - - negotiableQuoteTemplate/{templateId} - description: Delete a quote template. - operationId: DeleteV1NegotiableQuoteTemplateTemplateId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: templateId - in: path - type: integer - required: true - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/{templateId} - "/V1/order/notify-orders-are-ready-for-pickup": - post: - tags: - - order/notify-orders-are-ready-for-pickup - description: Notify customer that the orders is ready for pickup. - operationId: PostV1OrderNotifyordersarereadyforpickup - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1OrderNotifyordersarereadyforpickupBody - in: body - schema: - required: - - orderIds - properties: - orderIds: - type: array - items: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-in-store-pickup-sales-api-data-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: order/notify-orders-are-ready-for-pickup - "/V1/order/{orderId}/invoice": - post: - tags: - - order/{orderId}/invoice - description: '' - operationId: PostV1OrderOrderIdInvoice - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: orderId - in: path - type: integer - required: true - - name: PostV1OrderOrderIdInvoiceBody - in: body - schema: - properties: - capture: - type: boolean - items: - type: array - items: - "$ref": "#/definitions/sales-data-invoice-item-creation-interface" - notify: - type: boolean - appendComment: - type: boolean - comment: - "$ref": "#/definitions/sales-data-invoice-comment-creation-interface" - arguments: - "$ref": "#/definitions/sales-data-invoice-creation-arguments-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: order/{orderId}/invoice - "/V1/order/{orderId}/refund": - post: - tags: - - order/{orderId}/refund - description: Create offline refund for order - operationId: PostV1OrderOrderIdRefund - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: orderId - in: path - type: integer - required: true - - name: PostV1OrderOrderIdRefundBody - in: body - schema: - properties: - items: - type: array - items: - "$ref": "#/definitions/sales-data-creditmemo-item-creation-interface" - notify: - type: boolean - appendComment: - type: boolean - comment: - "$ref": "#/definitions/sales-data-creditmemo-comment-creation-interface" - arguments: - "$ref": "#/definitions/sales-data-creditmemo-creation-arguments-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: order/{orderId}/refund - "/V1/order/{orderId}/ship": - post: - tags: - - order/{orderId}/ship - description: Creates new Shipment for given Order. - operationId: PostV1OrderOrderIdShip - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: orderId - in: path - type: integer - required: true - - name: PostV1OrderOrderIdShipBody - in: body - schema: - properties: - items: - type: array - items: - "$ref": "#/definitions/sales-data-shipment-item-creation-interface" - notify: - type: boolean - appendComment: - type: boolean - comment: - "$ref": "#/definitions/sales-data-shipment-comment-creation-interface" - tracks: - type: array - items: - "$ref": "#/definitions/sales-data-shipment-track-creation-interface" - packages: - type: array - items: - "$ref": "#/definitions/sales-data-shipment-package-creation-interface" - arguments: - "$ref": "#/definitions/sales-data-shipment-creation-arguments-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Id of created Shipment. - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: order/{orderId}/ship - "/V1/orders": - get: - tags: - - orders - description: Lists orders that match specified search criteria. This call returns - an array of objects, but detailed information about each object’s attributes - might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#OrderRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1Orders - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-order-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: orders - post: - tags: - - orders - description: Performs persist operations for a specified order. - operationId: PostV1Orders - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1OrdersBody - in: body - schema: - required: - - entity - properties: - entity: - "$ref": "#/definitions/sales-data-order-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-order-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: orders - "/V1/orders/create": - put: - tags: - - orders/create - description: Performs persist operations for a specified order. - operationId: PutV1OrdersCreate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1OrdersCreateBody - in: body - schema: - required: - - entity - properties: - entity: - "$ref": "#/definitions/sales-data-order-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-order-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: orders/create - "/V1/orders/items": - get: - tags: - - orders/items - description: Lists order items that match specified search criteria. This call - returns an array of objects, but detailed information about each object’s - attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#OrderItemRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1OrdersItems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-order-item-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: orders/items - "/V1/orders/items/{id}": - get: - tags: - - orders/items/{id} - description: Loads a specified order item. - operationId: GetV1OrdersItemsId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The order item ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-order-item-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: orders/items/{id} - "/V1/orders/{id}": - get: - tags: - - orders/{id} - description: Loads a specified order. - operationId: GetV1OrdersId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The order ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-order-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: orders/{id} - "/V1/orders/{id}/cancel": - post: - tags: - - orders/{id}/cancel - description: Cancels a specified order. - operationId: PostV1OrdersIdCancel - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The order ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: orders/{id}/cancel - "/V1/orders/{id}/comments": - post: - tags: - - orders/{id}/comments - description: Adds a comment to a specified order. - operationId: PostV1OrdersIdComments - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The order ID. - - name: PostV1OrdersIdCommentsBody - in: body - schema: - required: - - statusHistory - properties: - statusHistory: - "$ref": "#/definitions/sales-data-order-status-history-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: orders/{id}/comments - get: - tags: - - orders/{id}/comments - description: Lists comments for a specified order. - operationId: GetV1OrdersIdComments - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The order ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-order-status-history-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: orders/{id}/comments - "/V1/orders/{id}/emails": - post: - tags: - - orders/{id}/emails - description: Emails a user a specified order. - operationId: PostV1OrdersIdEmails - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The order ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: orders/{id}/emails - "/V1/orders/{id}/hold": - post: - tags: - - orders/{id}/hold - description: Holds a specified order. - operationId: PostV1OrdersIdHold - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The order ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: orders/{id}/hold - "/V1/orders/{id}/statuses": - get: - tags: - - orders/{id}/statuses - description: Gets the status for a specified order. - operationId: GetV1OrdersIdStatuses - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The order ID. - responses: - '200': - description: 200 Success. - schema: - type: string - description: Order status. - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: orders/{id}/statuses - "/V1/orders/{id}/unhold": - post: - tags: - - orders/{id}/unhold - description: Releases a specified order from hold status. - operationId: PostV1OrdersIdUnhold - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The order ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: orders/{id}/unhold - "/V1/orders/{parent_id}": - put: - tags: - - orders/{parent_id} - description: Performs persist operations for a specified order address. - operationId: PutV1OrdersParent_id - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: parent_id - in: path - type: string - required: true - - name: PutV1OrdersParent_idBody - in: body - schema: - required: - - entity - properties: - entity: - "$ref": "#/definitions/sales-data-order-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-order-address-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: orders/{parent_id} - "/V1/payment-order/completeOrder": - post: - tags: - - payment-order/completeOrder - description: Rest API endpoint to place an order - operationId: PostV1PaymentorderCompleteOrder - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1PaymentorderCompleteOrderBody - in: body - schema: - required: - - orderId - properties: - orderId: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payment-order/completeOrder - "/V1/payments-config/apple-pay/{location}": - get: - tags: - - payments-config/apple-pay/{location} - description: Get Apple Pay Config. - operationId: GetV1PaymentsconfigApplepayLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/apple-pay/{location} - "/V1/payments-config/google-pay/{location}": - get: - tags: - - payments-config/google-pay/{location} - description: Get Google Pay Config. - operationId: GetV1PaymentsconfigGooglepayLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/google-pay/{location} - "/V1/payments-config/hosted-fields/{location}": - get: - tags: - - payments-config/hosted-fields/{location} - description: Get Hosted Fields Config. - operationId: GetV1PaymentsconfigHostedfieldsLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/hosted-fields/{location} - "/V1/payments-config/smart-buttons/{location}": - get: - tags: - - payments-config/smart-buttons/{location} - description: Get Smart Buttons Config. - operationId: GetV1PaymentsconfigSmartbuttonsLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/smart-buttons/{location} - "/V1/payments-config/{location}": - get: - tags: - - payments-config/{location} - description: Get Config. - operationId: GetV1PaymentsconfigLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-payment-config-response-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/{location} - "/V1/payments-sdk/{location}": - get: - tags: - - payments-sdk/{location} - description: Get payment sdk url by location - operationId: GetV1PaymentssdkLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-sdk/{location} - "/V1/payments-sdk/{location}/{methodCode}": - get: - tags: - - payments-sdk/{location}/{methodCode} - description: Get payment sdk url by location and methodCode - operationId: GetV1PaymentssdkLocationMethodCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - - name: methodCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-sdk/{location}/{methodCode} - "/V1/paypal/lineItems": - post: - tags: - - paypal/lineItems - description: Rest endpoint to calculate totals and line items - operationId: PostV1PaypalLineItems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1PaypalLineItemsBody - in: body - schema: - required: - - method - - cartId - properties: - method: - type: string - cartId: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: paypal/lineItems - "/V1/paypal/oneClick": - post: - tags: - - paypal/oneClick - description: Rest endpoint to add product to cart (mainly use for PayPal button - from PDP) - operationId: PostV1PaypalOneClick - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1PaypalOneClickBody - in: body - schema: - required: - - method - - productData - properties: - method: - type: string - productData: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: paypal/oneClick - "/V1/paypal/validatePhoneNumber": - post: - tags: - - paypal/validatePhoneNumber - description: Get & validate phone number and get shipping/billing email address - operationId: PostV1PaypalValidatePhoneNumber - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1PaypalValidatePhoneNumberBody - in: body - schema: - required: - - cartId - properties: - cartId: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: paypal/validatePhoneNumber - "/V1/products": - post: - tags: - - products - description: Create product - operationId: PostV1Products - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsBody - in: body - schema: - required: - - product - properties: - product: - "$ref": "#/definitions/catalog-data-product-interface" - saveOptions: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products - get: - tags: - - products - description: Get product list - operationId: GetV1Products - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products - "/V1/products-render-info": - get: - tags: - - products-render-info - description: Collect and retrieve the list of product render info. This info - contains raw prices and formatted prices, product name, stock status, store_id, - etc. - operationId: GetV1Productsrenderinfo - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - - name: storeId - in: query - type: integer - required: true - - name: currencyCode - in: query - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-render-search-results-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products-render-info - "/V1/products/attribute-sets": - post: - tags: - - products/attribute-sets - description: Create attribute set from data - operationId: PostV1ProductsAttributesets - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsAttributesetsBody - in: body - schema: - required: - - attributeSet - - skeletonId - properties: - attributeSet: - "$ref": "#/definitions/eav-data-attribute-set-interface" - skeletonId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/eav-data-attribute-set-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attribute-sets - "/V1/products/attribute-sets/attributes": - post: - tags: - - products/attribute-sets/attributes - description: Assign attribute to attribute set - operationId: PostV1ProductsAttributesetsAttributes - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsAttributesetsAttributesBody - in: body - schema: - required: - - attributeSetId - - attributeGroupId - - attributeCode - - sortOrder - properties: - attributeSetId: - type: integer - attributeGroupId: - type: integer - attributeCode: - type: string - sortOrder: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attribute-sets/attributes - "/V1/products/attribute-sets/groups": - post: - tags: - - products/attribute-sets/groups - description: Save attribute group - operationId: PostV1ProductsAttributesetsGroups - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsAttributesetsGroupsBody - in: body - schema: - required: - - group - properties: - group: - "$ref": "#/definitions/eav-data-attribute-group-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/eav-data-attribute-group-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attribute-sets/groups - "/V1/products/attribute-sets/groups/list": - get: - tags: - - products/attribute-sets/groups/list - description: Retrieve list of attribute groups - operationId: GetV1ProductsAttributesetsGroupsList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/eav-data-attribute-group-search-results-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attribute-sets/groups/list - "/V1/products/attribute-sets/groups/{groupId}": - delete: - tags: - - products/attribute-sets/groups/{groupId} - description: Remove attribute group by id - operationId: DeleteV1ProductsAttributesetsGroupsGroupId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: groupId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attribute-sets/groups/{groupId} - "/V1/products/attribute-sets/sets/list": - get: - tags: - - products/attribute-sets/sets/list - description: Retrieve list of Attribute Sets - operationId: GetV1ProductsAttributesetsSetsList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/eav-data-attribute-set-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attribute-sets/sets/list - "/V1/products/attribute-sets/{attributeSetId}": - get: - tags: - - products/attribute-sets/{attributeSetId} - description: Retrieve attribute set information based on given ID - operationId: GetV1ProductsAttributesetsAttributeSetId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeSetId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/eav-data-attribute-set-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attribute-sets/{attributeSetId} - delete: - tags: - - products/attribute-sets/{attributeSetId} - description: Remove attribute set by given ID - operationId: DeleteV1ProductsAttributesetsAttributeSetId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeSetId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attribute-sets/{attributeSetId} - put: - tags: - - products/attribute-sets/{attributeSetId} - description: Save attribute set data - operationId: PutV1ProductsAttributesetsAttributeSetId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeSetId - in: path - type: string - required: true - - name: PutV1ProductsAttributesetsAttributeSetIdBody - in: body - schema: - required: - - attributeSet - properties: - attributeSet: - "$ref": "#/definitions/eav-data-attribute-set-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/eav-data-attribute-set-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attribute-sets/{attributeSetId} - "/V1/products/attribute-sets/{attributeSetId}/attributes": - get: - tags: - - products/attribute-sets/{attributeSetId}/attributes - description: Retrieve related attributes based on given attribute set ID - operationId: GetV1ProductsAttributesetsAttributeSetIdAttributes - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeSetId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-product-attribute-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attribute-sets/{attributeSetId}/attributes - "/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}": - delete: - tags: - - products/attribute-sets/{attributeSetId}/attributes/{attributeCode} - description: Remove attribute from attribute set - operationId: DeleteV1ProductsAttributesetsAttributeSetIdAttributesAttributeCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeSetId - in: path - type: string - required: true - - name: attributeCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attribute-sets/{attributeSetId}/attributes/{attributeCode} - "/V1/products/attribute-sets/{attributeSetId}/groups": - put: - tags: - - products/attribute-sets/{attributeSetId}/groups - description: Save attribute group - operationId: PutV1ProductsAttributesetsAttributeSetIdGroups - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeSetId - in: path - type: string - required: true - - name: PutV1ProductsAttributesetsAttributeSetIdGroupsBody - in: body - schema: - required: - - group - properties: - group: - "$ref": "#/definitions/eav-data-attribute-group-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/eav-data-attribute-group-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attribute-sets/{attributeSetId}/groups - "/V1/products/attributes": - get: - tags: - - products/attributes - description: Retrieve all attributes for entity type - operationId: GetV1ProductsAttributes - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-attribute-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attributes - post: - tags: - - products/attributes - description: Save attribute data - operationId: PostV1ProductsAttributes - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsAttributesBody - in: body - schema: - required: - - attribute - properties: - attribute: - "$ref": "#/definitions/catalog-data-product-attribute-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-attribute-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attributes - "/V1/products/attributes/types": - get: - tags: - - products/attributes/types - description: Retrieve list of product attribute types - operationId: GetV1ProductsAttributesTypes - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-product-attribute-type-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attributes/types - "/V1/products/attributes/{attributeCode}": - get: - tags: - - products/attributes/{attributeCode} - description: Retrieve specific attribute - operationId: GetV1ProductsAttributesAttributeCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-attribute-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attributes/{attributeCode} - put: - tags: - - products/attributes/{attributeCode} - description: Save attribute data - operationId: PutV1ProductsAttributesAttributeCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeCode - in: path - type: string - required: true - - name: PutV1ProductsAttributesAttributeCodeBody - in: body - schema: - required: - - attribute - properties: - attribute: - "$ref": "#/definitions/catalog-data-product-attribute-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-attribute-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attributes/{attributeCode} - delete: - tags: - - products/attributes/{attributeCode} - description: Delete Attribute by id - operationId: DeleteV1ProductsAttributesAttributeCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attributes/{attributeCode} - "/V1/products/attributes/{attributeCode}/is-filterable": - get: - tags: - - products/attributes/{attributeCode}/is-filterable - description: Retrieve 'is_filterable' property for specific attribute as integer - operationId: GetV1ProductsAttributesAttributeCodeIsfilterable - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attributes/{attributeCode}/is-filterable - "/V1/products/attributes/{attributeCode}/is-filterable/{isFilterable}": - put: - tags: - - products/attributes/{attributeCode}/is-filterable/{isFilterable} - description: Set 'is_filterable' property for specific attribute as integer - operationId: PutV1ProductsAttributesAttributeCodeIsfilterableIsFilterable - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeCode - in: path - type: string - required: true - - name: isFilterable - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attributes/{attributeCode}/is-filterable/{isFilterable} - "/V1/products/attributes/{attributeCode}/options": - get: - tags: - - products/attributes/{attributeCode}/options - description: Retrieve list of attribute options - operationId: GetV1ProductsAttributesAttributeCodeOptions - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/eav-data-attribute-option-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attributes/{attributeCode}/options - post: - tags: - - products/attributes/{attributeCode}/options - description: Add option to attribute - operationId: PostV1ProductsAttributesAttributeCodeOptions - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeCode - in: path - type: string - required: true - - name: PostV1ProductsAttributesAttributeCodeOptionsBody - in: body - schema: - required: - - option - properties: - option: - "$ref": "#/definitions/eav-data-attribute-option-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attributes/{attributeCode}/options - "/V1/products/attributes/{attributeCode}/options/{optionId}": - delete: - tags: - - products/attributes/{attributeCode}/options/{optionId} - description: Delete option from attribute - operationId: DeleteV1ProductsAttributesAttributeCodeOptionsOptionId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeCode - in: path - type: string - required: true - - name: optionId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attributes/{attributeCode}/options/{optionId} - put: - tags: - - products/attributes/{attributeCode}/options/{optionId} - description: Update attribute option - operationId: PutV1ProductsAttributesAttributeCodeOptionsOptionId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeCode - in: path - type: string - required: true - - name: optionId - in: path - type: integer - required: true - - name: PutV1ProductsAttributesAttributeCodeOptionsOptionIdBody - in: body - schema: - required: - - option - properties: - option: - "$ref": "#/definitions/eav-data-attribute-option-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/attributes/{attributeCode}/options/{optionId} - "/V1/products/base-prices": - post: - tags: - - products/base-prices - description: Add or update product prices. Input item should correspond \Magento\Catalog\Api\Data\CostInterface. - If any items will have invalid price, store id or sku, they will be marked - as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] - with problem description will be returned. If there were no failed items during - update empty array will be returned. If error occurred during the update exception - will be thrown. - operationId: PostV1ProductsBaseprices - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsBasepricesBody - in: body - schema: - required: - - prices - properties: - prices: - type: array - items: - "$ref": "#/definitions/catalog-data-base-price-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-price-update-result-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/base-prices - "/V1/products/base-prices-information": - post: - tags: - - products/base-prices-information - description: Return product prices. In case of at least one of skus is not found - exception will be thrown. - operationId: PostV1ProductsBasepricesinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsBasepricesinformationBody - in: body - schema: - required: - - skus - properties: - skus: - type: array - items: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-base-price-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/base-prices-information - "/V1/products/cost": - post: - tags: - - products/cost - description: Add or update product cost. Input item should correspond to \Magento\Catalog\Api\Data\CostInterface. - If any items will have invalid cost, store id or sku, they will be marked - as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] - with problem description will be returned. If there were no failed items during - update empty array will be returned. If error occurred during the update exception - will be thrown. - operationId: PostV1ProductsCost - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsCostBody - in: body - schema: - required: - - prices - properties: - prices: - type: array - items: - "$ref": "#/definitions/catalog-data-cost-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-price-update-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/cost - "/V1/products/cost-delete": - post: - tags: - - products/cost-delete - description: Delete product cost. In case of at least one of skus is not found - exception will be thrown. If error occurred during the delete exception will - be thrown. - operationId: PostV1ProductsCostdelete - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsCostdeleteBody - in: body - schema: - required: - - skus - properties: - skus: - type: array - items: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: Will return True if deleted. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/cost-delete - "/V1/products/cost-information": - post: - tags: - - products/cost-information - description: Return product prices. In case of at least one of skus is not found - exception will be thrown. - operationId: PostV1ProductsCostinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsCostinformationBody - in: body - schema: - required: - - skus - properties: - skus: - type: array - items: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-cost-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/cost-information - "/V1/products/downloadable-links/samples/{id}": - delete: - tags: - - products/downloadable-links/samples/{id} - description: Delete downloadable sample - operationId: DeleteV1ProductsDownloadablelinksSamplesId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/downloadable-links/samples/{id} - "/V1/products/downloadable-links/{id}": - delete: - tags: - - products/downloadable-links/{id} - description: Delete downloadable link - operationId: DeleteV1ProductsDownloadablelinksId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/downloadable-links/{id} - "/V1/products/links/types": - get: - tags: - - products/links/types - description: Retrieve information about available product link types - operationId: GetV1ProductsLinksTypes - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-product-link-type-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/links/types - "/V1/products/links/{type}/attributes": - get: - tags: - - products/links/{type}/attributes - description: Provide a list of the product link type attributes - operationId: GetV1ProductsLinksTypeAttributes - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: type - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-product-link-attribute-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/links/{type}/attributes - "/V1/products/media/types/{attributeSetName}": - get: - tags: - - products/media/types/{attributeSetName} - description: Retrieve the list of media attributes (fronted input type is media_image) - assigned to the given attribute set. - operationId: GetV1ProductsMediaTypesAttributeSetName - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeSetName - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - description: list of media attributes - items: - "$ref": "#/definitions/catalog-data-product-attribute-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/media/types/{attributeSetName} - "/V1/products/options": - post: - tags: - - products/options - description: Save Custom Option - operationId: PostV1ProductsOptions - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsOptionsBody - in: body - schema: - required: - - option - properties: - option: - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/options - "/V1/products/options/types": - get: - tags: - - products/options/types - description: Get custom option types - operationId: GetV1ProductsOptionsTypes - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-product-custom-option-type-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/options/types - "/V1/products/options/{optionId}": - put: - tags: - - products/options/{optionId} - description: Save Custom Option - operationId: PutV1ProductsOptionsOptionId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: optionId - in: path - type: string - required: true - - name: PutV1ProductsOptionsOptionIdBody - in: body - schema: - required: - - option - properties: - option: - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/options/{optionId} - "/V1/products/special-price": - post: - tags: - - products/special-price - description: Add or update product's special price. If any items will have invalid - price, store id, sku or dates, they will be marked as failed and excluded - from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] - with problem description will be returned. If there were no failed items during - update empty array will be returned. If error occurred during the update exception - will be thrown. - operationId: PostV1ProductsSpecialprice - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsSpecialpriceBody - in: body - schema: - required: - - prices - properties: - prices: - type: array - items: - "$ref": "#/definitions/catalog-data-special-price-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-price-update-result-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/special-price - "/V1/products/special-price-delete": - post: - tags: - - products/special-price-delete - description: Delete product's special price. If any items will have invalid - price, store id, sku or dates, they will be marked as failed and excluded - from delete list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] - with problem description will be returned. If there were no failed items during - update empty array will be returned. If error occurred during the delete exception - will be thrown. - operationId: PostV1ProductsSpecialpricedelete - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsSpecialpricedeleteBody - in: body - schema: - required: - - prices - properties: - prices: - type: array - items: - "$ref": "#/definitions/catalog-data-special-price-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-price-update-result-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/special-price-delete - "/V1/products/special-price-information": - post: - tags: - - products/special-price-information - description: Return product's special price. In case of at least one of skus - is not found exception will be thrown. - operationId: PostV1ProductsSpecialpriceinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsSpecialpriceinformationBody - in: body - schema: - required: - - skus - properties: - skus: - type: array - items: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-special-price-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/special-price-information - "/V1/products/tier-prices": - post: - tags: - - products/tier-prices - description: Add or update product prices. If any items will have invalid price, - price type, website id, sku, customer group or quantity, they will be marked - as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] - with problem description will be returned. If there were no failed items during - update empty array will be returned. If error occurred during the update exception - will be thrown. - operationId: PostV1ProductsTierprices - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsTierpricesBody - in: body - schema: - required: - - prices - properties: - prices: - type: array - items: - "$ref": "#/definitions/catalog-data-tier-price-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-price-update-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/tier-prices - put: - tags: - - products/tier-prices - description: Remove existing tier prices and replace them with the new ones. - If any items will have invalid price, price type, website id, sku, customer - group or quantity, they will be marked as failed and excluded from replace - list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem - description will be returned. If there were no failed items during update - empty array will be returned. If error occurred during the update exception - will be thrown. - operationId: PutV1ProductsTierprices - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1ProductsTierpricesBody - in: body - schema: - required: - - prices - properties: - prices: - type: array - items: - "$ref": "#/definitions/catalog-data-tier-price-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-price-update-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/tier-prices - "/V1/products/tier-prices-delete": - post: - tags: - - products/tier-prices-delete - description: Delete product tier prices. If any items will have invalid price, - price type, website id, sku, customer group or quantity, they will be marked - as failed and excluded from delete list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] - with problem description will be returned. If there were no failed items during - update empty array will be returned. If error occurred during the update exception - will be thrown. - operationId: PostV1ProductsTierpricesdelete - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsTierpricesdeleteBody - in: body - schema: - required: - - prices - properties: - prices: - type: array - items: - "$ref": "#/definitions/catalog-data-tier-price-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-price-update-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/tier-prices-delete - "/V1/products/tier-prices-information": - post: - tags: - - products/tier-prices-information - description: Return product prices. In case of at least one of skus is not found - exception will be thrown. - operationId: PostV1ProductsTierpricesinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ProductsTierpricesinformationBody - in: body - schema: - required: - - skus - properties: - skus: - type: array - items: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-tier-price-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/tier-prices-information - "/V1/products/types": - get: - tags: - - products/types - description: Retrieve available product types - operationId: GetV1ProductsTypes - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-product-type-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/types - "/V1/products/{productSku}/stockItems/{itemId}": - put: - tags: - - products/{productSku}/stockItems/{itemId} - description: '' - operationId: PutV1ProductsProductSkuStockItemsItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: productSku - in: path - type: string - required: true - - name: itemId - in: path - type: string - required: true - - name: PutV1ProductsProductSkuStockItemsItemIdBody - in: body - schema: - required: - - stockItem - properties: - stockItem: - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{productSku}/stockItems/{itemId} - "/V1/products/{sku}": - put: - tags: - - products/{sku} - description: Create product - operationId: PutV1ProductsSku - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: PutV1ProductsSkuBody - in: body - schema: - required: - - product - properties: - product: - "$ref": "#/definitions/catalog-data-product-interface" - saveOptions: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku} - delete: - tags: - - products/{sku} - description: '' - operationId: DeleteV1ProductsSku - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: Will returned True if deleted - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku} - get: - tags: - - products/{sku} - description: Get info about product by product SKU - operationId: GetV1ProductsSku - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: editMode - in: query - type: boolean - required: false - - name: storeId - in: query - type: integer - required: false - - name: forceReload - in: query - type: boolean - required: false - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku} - "/V1/products/{sku}/downloadable-links": - get: - tags: - - products/{sku}/downloadable-links - description: List of links with associated samples - operationId: GetV1ProductsSkuDownloadablelinks - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/downloadable-data-link-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/downloadable-links - post: - tags: - - products/{sku}/downloadable-links - description: Update downloadable link of the given product (link type and its - resources cannot be changed) - operationId: PostV1ProductsSkuDownloadablelinks - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: PostV1ProductsSkuDownloadablelinksBody - in: body - schema: - required: - - link - properties: - link: - "$ref": "#/definitions/downloadable-data-link-interface" - isGlobalScopeContent: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/downloadable-links - "/V1/products/{sku}/downloadable-links/samples": - get: - tags: - - products/{sku}/downloadable-links/samples - description: List of samples for downloadable product - operationId: GetV1ProductsSkuDownloadablelinksSamples - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/downloadable-data-sample-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/downloadable-links/samples - post: - tags: - - products/{sku}/downloadable-links/samples - description: Update downloadable sample of the given product - operationId: PostV1ProductsSkuDownloadablelinksSamples - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: PostV1ProductsSkuDownloadablelinksSamplesBody - in: body - schema: - required: - - sample - properties: - sample: - "$ref": "#/definitions/downloadable-data-sample-interface" - isGlobalScopeContent: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/downloadable-links/samples - "/V1/products/{sku}/downloadable-links/samples/{id}": - put: - tags: - - products/{sku}/downloadable-links/samples/{id} - description: Update downloadable sample of the given product - operationId: PutV1ProductsSkuDownloadablelinksSamplesId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: id - in: path - type: string - required: true - - name: PutV1ProductsSkuDownloadablelinksSamplesIdBody - in: body - schema: - required: - - sample - properties: - sample: - "$ref": "#/definitions/downloadable-data-sample-interface" - isGlobalScopeContent: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/downloadable-links/samples/{id} - "/V1/products/{sku}/downloadable-links/{id}": - put: - tags: - - products/{sku}/downloadable-links/{id} - description: Update downloadable link of the given product (link type and its - resources cannot be changed) - operationId: PutV1ProductsSkuDownloadablelinksId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: id - in: path - type: string - required: true - - name: PutV1ProductsSkuDownloadablelinksIdBody - in: body - schema: - required: - - link - properties: - link: - "$ref": "#/definitions/downloadable-data-link-interface" - isGlobalScopeContent: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/downloadable-links/{id} - "/V1/products/{sku}/group-prices/{customerGroupId}/tiers": - get: - tags: - - products/{sku}/group-prices/{customerGroupId}/tiers - description: Get tier price of product - operationId: GetV1ProductsSkuGrouppricesCustomerGroupIdTiers - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: customerGroupId - in: path - type: string - required: true - description: "'all' can be used to specify 'ALL GROUPS'" - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-product-tier-price-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/group-prices/{customerGroupId}/tiers - "/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}": - delete: - tags: - - products/{sku}/group-prices/{customerGroupId}/tiers/{qty} - description: Remove tier price from product - operationId: DeleteV1ProductsSkuGrouppricesCustomerGroupIdTiersQty - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: customerGroupId - in: path - type: string - required: true - description: "'all' can be used to specify 'ALL GROUPS'" - - name: qty - in: path - type: number - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/group-prices/{customerGroupId}/tiers/{qty} - "/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}": - post: - tags: - - products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price} - description: Create tier price for product - operationId: PostV1ProductsSkuGrouppricesCustomerGroupIdTiersQtyPricePrice - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: customerGroupId - in: path - type: string - required: true - description: "'all' can be used to specify 'ALL GROUPS'" - - name: price - in: path - type: number - required: true - - name: qty - in: path - type: number - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price} - "/V1/products/{sku}/links": - post: - tags: - - products/{sku}/links - description: Assign a product link to another product - operationId: PostV1ProductsSkuLinks - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: PostV1ProductsSkuLinksBody - in: body - schema: - required: - - items - properties: - items: - type: array - items: - "$ref": "#/definitions/catalog-data-product-link-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/links - put: - tags: - - products/{sku}/links - description: Save product link - operationId: PutV1ProductsSkuLinks - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: PutV1ProductsSkuLinksBody - in: body - schema: - required: - - entity - properties: - entity: - "$ref": "#/definitions/catalog-data-product-link-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/links - "/V1/products/{sku}/links/{type}": - get: - tags: - - products/{sku}/links/{type} - description: Provide the list of links for a specific product - operationId: GetV1ProductsSkuLinksType - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: type - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-product-link-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/links/{type} - "/V1/products/{sku}/links/{type}/{linkedProductSku}": - delete: - tags: - - products/{sku}/links/{type}/{linkedProductSku} - description: '' - operationId: DeleteV1ProductsSkuLinksTypeLinkedProductSku - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: type - in: path - type: string - required: true - - name: linkedProductSku - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/links/{type}/{linkedProductSku} - "/V1/products/{sku}/media": - post: - tags: - - products/{sku}/media - description: Create new gallery entry - operationId: PostV1ProductsSkuMedia - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: PostV1ProductsSkuMediaBody - in: body - schema: - required: - - entry - properties: - entry: - "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: gallery entry ID - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/media - get: - tags: - - products/{sku}/media - description: Retrieve the list of gallery entries associated with given product - operationId: GetV1ProductsSkuMedia - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/media - "/V1/products/{sku}/media/{entryId}": - get: - tags: - - products/{sku}/media/{entryId} - description: Return information about gallery entry - operationId: GetV1ProductsSkuMediaEntryId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: entryId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/media/{entryId} - put: - tags: - - products/{sku}/media/{entryId} - description: Update gallery entry - operationId: PutV1ProductsSkuMediaEntryId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: entryId - in: path - type: string - required: true - - name: PutV1ProductsSkuMediaEntryIdBody - in: body - schema: - required: - - entry - properties: - entry: - "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/media/{entryId} - delete: - tags: - - products/{sku}/media/{entryId} - description: Remove gallery entry - operationId: DeleteV1ProductsSkuMediaEntryId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: entryId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/media/{entryId} - "/V1/products/{sku}/options": - get: - tags: - - products/{sku}/options - description: Get the list of custom options for a specific product - operationId: GetV1ProductsSkuOptions - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/options - "/V1/products/{sku}/options/{optionId}": - get: - tags: - - products/{sku}/options/{optionId} - description: Get custom option for a specific product - operationId: GetV1ProductsSkuOptionsOptionId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: optionId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/options/{optionId} - delete: - tags: - - products/{sku}/options/{optionId} - description: '' - operationId: DeleteV1ProductsSkuOptionsOptionId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: optionId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/options/{optionId} - "/V1/products/{sku}/websites": - post: - tags: - - products/{sku}/websites - description: Assign a product to the website - operationId: PostV1ProductsSkuWebsites - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: PostV1ProductsSkuWebsitesBody - in: body - schema: - required: - - productWebsiteLink - properties: - productWebsiteLink: - "$ref": "#/definitions/catalog-data-product-website-link-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: will returned True if website successfully assigned to product - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/websites - put: - tags: - - products/{sku}/websites - description: Assign a product to the website - operationId: PutV1ProductsSkuWebsites - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: PutV1ProductsSkuWebsitesBody - in: body - schema: - required: - - productWebsiteLink - properties: - productWebsiteLink: - "$ref": "#/definitions/catalog-data-product-website-link-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: will returned True if website successfully assigned to product - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/websites - "/V1/products/{sku}/websites/{websiteId}": - delete: - tags: - - products/{sku}/websites/{websiteId} - description: Remove the website assignment from the product by product sku - operationId: DeleteV1ProductsSkuWebsitesWebsiteId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sku - in: path - type: string - required: true - - name: websiteId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: will returned True if website successfully unassigned from - product - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products/{sku}/websites/{websiteId} - "/V1/purchase-order-carts/{cartId}/billing-address": - post: - tags: - - purchase-order-carts/{cartId}/billing-address - description: Assigns a specified billing address to a specified cart. - operationId: PostV1PurchaseordercartsCartIdBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - - name: PostV1PurchaseordercartsCartIdBillingaddressBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - useForShipping: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Address ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: purchase-order-carts/{cartId}/billing-address - "/V1/purchase-order-carts/{cartId}/estimate-shipping-methods": - post: - tags: - - purchase-order-carts/{cartId}/estimate-shipping-methods - description: Estimate shipping by address and return list of available shipping - methods - operationId: PostV1PurchaseordercartsCartIdEstimateshippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1PurchaseordercartsCartIdEstimateshippingmethodsBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: purchase-order-carts/{cartId}/estimate-shipping-methods - "/V1/purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id": - post: - tags: - - purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id - description: Estimate shipping - operationId: PostV1PurchaseordercartsCartIdEstimateshippingmethodsbyaddressid - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The shopping cart ID. - - name: PostV1PurchaseordercartsCartIdEstimateshippingmethodsbyaddressidBody - in: body - schema: - required: - - addressId - properties: - addressId: - type: integer - description: The estimate address id - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id - "/V1/purchase-order-carts/{cartId}/giftCards": - post: - tags: - - purchase-order-carts/{cartId}/giftCards - description: Add gift card to the cart. - operationId: PostV1PurchaseordercartsCartIdGiftCards - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1PurchaseordercartsCartIdGiftCardsBody - in: body - schema: - required: - - giftCardAccountData - properties: - giftCardAccountData: - "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: purchase-order-carts/{cartId}/giftCards - "/V1/purchase-order-carts/{cartId}/giftCards/{giftCardCode}": - delete: - tags: - - purchase-order-carts/{cartId}/giftCards/{giftCardCode} - description: Remove GiftCard Account entity - operationId: DeleteV1PurchaseordercartsCartIdGiftCardsGiftCardCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: giftCardCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: purchase-order-carts/{cartId}/giftCards/{giftCardCode} - "/V1/purchase-order-carts/{cartId}/payment-information": - post: - tags: - - purchase-order-carts/{cartId}/payment-information - description: Set payment information and place order for a specified cart. - operationId: PostV1PurchaseordercartsCartIdPaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1PurchaseordercartsCartIdPaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: purchase-order-carts/{cartId}/payment-information - get: - tags: - - purchase-order-carts/{cartId}/payment-information - description: Get payment information - operationId: GetV1PurchaseordercartsCartIdPaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: purchase-order-carts/{cartId}/payment-information - "/V1/purchase-order-carts/{cartId}/set-payment-information": - post: - tags: - - purchase-order-carts/{cartId}/set-payment-information - description: Set payment information for a specified cart. - operationId: PostV1PurchaseordercartsCartIdSetpaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1PurchaseordercartsCartIdSetpaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: purchase-order-carts/{cartId}/set-payment-information - "/V1/purchase-order-carts/{cartId}/totals": - get: - tags: - - purchase-order-carts/{cartId}/totals - description: Returns quote totals data for a specified cart. - operationId: GetV1PurchaseordercartsCartIdTotals - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: purchase-order-carts/{cartId}/totals - "/V1/requisition_lists": - post: - tags: - - requisition_lists - description: Save Requisition List - operationId: PostV1Requisition_lists - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1Requisition_listsBody - in: body - schema: - required: - - requisitionList - properties: - requisitionList: - "$ref": "#/definitions/requisition-list-data-requisition-list-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/requisition-list-data-requisition-list-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: requisition_lists - "/V1/returns": - post: - tags: - - returns - description: Save RMA - operationId: PostV1Returns - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ReturnsBody - in: body - schema: - required: - - rmaDataObject - properties: - rmaDataObject: - "$ref": "#/definitions/rma-data-rma-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/rma-data-rma-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returns - get: - tags: - - returns - description: Return list of rma data objects based on search criteria - operationId: GetV1Returns - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/rma-data-rma-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returns - "/V1/returns/{id}": - get: - tags: - - returns/{id} - description: Return data object for specified RMA id - operationId: GetV1ReturnsId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/rma-data-rma-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returns/{id} - delete: - tags: - - returns/{id} - description: Delete RMA - operationId: DeleteV1ReturnsId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - - name: DeleteV1ReturnsIdBody - in: body - schema: - required: - - rmaDataObject - properties: - rmaDataObject: - "$ref": "#/definitions/rma-data-rma-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returns/{id} - put: - tags: - - returns/{id} - description: Save RMA - operationId: PutV1ReturnsId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - - name: PutV1ReturnsIdBody - in: body - schema: - required: - - rmaDataObject - properties: - rmaDataObject: - "$ref": "#/definitions/rma-data-rma-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/rma-data-rma-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returns/{id} - "/V1/returns/{id}/comments": - post: - tags: - - returns/{id}/comments - description: Add comment - operationId: PostV1ReturnsIdComments - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - - name: PostV1ReturnsIdCommentsBody - in: body - schema: - required: - - data - properties: - data: - "$ref": "#/definitions/rma-data-comment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returns/{id}/comments - get: - tags: - - returns/{id}/comments - description: Comments list - operationId: GetV1ReturnsIdComments - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/rma-data-comment-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returns/{id}/comments - "/V1/returns/{id}/labels": - get: - tags: - - returns/{id}/labels - description: Get shipping label int the PDF format - operationId: GetV1ReturnsIdLabels - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: string - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returns/{id}/labels - "/V1/returns/{id}/tracking-numbers": - post: - tags: - - returns/{id}/tracking-numbers - description: Add track - operationId: PostV1ReturnsIdTrackingnumbers - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - - name: PostV1ReturnsIdTrackingnumbersBody - in: body - schema: - required: - - track - properties: - track: - "$ref": "#/definitions/rma-data-track-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returns/{id}/tracking-numbers - get: - tags: - - returns/{id}/tracking-numbers - description: Get track list - operationId: GetV1ReturnsIdTrackingnumbers - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/rma-data-track-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returns/{id}/tracking-numbers - "/V1/returns/{id}/tracking-numbers/{trackId}": - delete: - tags: - - returns/{id}/tracking-numbers/{trackId} - description: Remove track by id - operationId: DeleteV1ReturnsIdTrackingnumbersTrackId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - - name: trackId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returns/{id}/tracking-numbers/{trackId} - "/V1/returnsAttributeMetadata": - get: - tags: - - returnsAttributeMetadata - description: Get all attribute metadata. - operationId: GetV1ReturnsAttributeMetadata - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returnsAttributeMetadata - "/V1/returnsAttributeMetadata/custom": - get: - tags: - - returnsAttributeMetadata/custom - description: Get custom attribute metadata for the given Data object's attribute - set - operationId: GetV1ReturnsAttributeMetadataCustom - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: dataObjectClassName - in: query - type: string - description: Data object class name - required: false - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/framework-metadata-object-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returnsAttributeMetadata/custom - "/V1/returnsAttributeMetadata/form/{formCode}": - get: - tags: - - returnsAttributeMetadata/form/{formCode} - description: Retrieve all attributes filtered by form code - operationId: GetV1ReturnsAttributeMetadataFormFormCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: formCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returnsAttributeMetadata/form/{formCode} - "/V1/returnsAttributeMetadata/{attributeCode}": - get: - tags: - - returnsAttributeMetadata/{attributeCode} - description: Retrieve attribute metadata. - operationId: GetV1ReturnsAttributeMetadataAttributeCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: attributeCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: returnsAttributeMetadata/{attributeCode} - "/V1/reward/mine/use-reward": - post: - tags: - - reward/mine/use-reward - description: Set reward points to quote - operationId: PostV1RewardMineUsereward - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: reward/mine/use-reward - "/V1/salesRules": - post: - tags: - - salesRules - description: Save sales rule. - operationId: PostV1SalesRules - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1SalesRulesBody - in: body - schema: - required: - - rule - properties: - rule: - "$ref": "#/definitions/sales-rule-data-rule-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-rule-data-rule-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: salesRules - "/V1/salesRules/search": - get: - tags: - - salesRules/search - description: Retrieve sales rules that match te specified criteria. This call - returns an array of objects, but detailed information about each object’s - attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#RuleRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1SalesRulesSearch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-rule-data-rule-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: salesRules/search - "/V1/salesRules/{ruleId}": - get: - tags: - - salesRules/{ruleId} - description: Get rule by ID. - operationId: GetV1SalesRulesRuleId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: ruleId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-rule-data-rule-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: salesRules/{ruleId} - put: - tags: - - salesRules/{ruleId} - description: Save sales rule. - operationId: PutV1SalesRulesRuleId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: ruleId - in: path - type: string - required: true - - name: PutV1SalesRulesRuleIdBody - in: body - schema: - required: - - rule - properties: - rule: - "$ref": "#/definitions/sales-rule-data-rule-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-rule-data-rule-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: salesRules/{ruleId} - delete: - tags: - - salesRules/{ruleId} - description: Delete rule by ID. - operationId: DeleteV1SalesRulesRuleId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: ruleId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: salesRules/{ruleId} - "/V1/search": - get: - tags: - - search - description: Make Full Text Search and return found Documents - operationId: GetV1Search - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[requestName] - in: query - type: string - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/framework-search-search-result-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: search - "/V1/sharedCatalog": - post: - tags: - - sharedCatalog - description: Create or update Shared Catalog service. - operationId: PostV1SharedCatalog - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1SharedCatalogBody - in: body - schema: - required: - - sharedCatalog - properties: - sharedCatalog: - "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog - "/V1/sharedCatalog/": - get: - tags: - - sharedCatalog/ - description: Return the list of shared catalogs and basic properties for each - catalog. - operationId: GetV1SharedCatalog - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/shared-catalog-data-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/ - "/V1/sharedCatalog/{id}": - put: - tags: - - sharedCatalog/{id} - description: Create or update Shared Catalog service. - operationId: PutV1SharedCatalogId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - - name: PutV1SharedCatalogIdBody - in: body - schema: - required: - - sharedCatalog - properties: - sharedCatalog: - "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/{id} - "/V1/sharedCatalog/{id}/assignCategories": - post: - tags: - - sharedCatalog/{id}/assignCategories - description: Add categories into the shared catalog. - operationId: PostV1SharedCatalogIdAssignCategories - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - - name: PostV1SharedCatalogIdAssignCategoriesBody - in: body - schema: - required: - - categories - properties: - categories: - type: array - items: - "$ref": "#/definitions/catalog-data-category-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/{id}/assignCategories - "/V1/sharedCatalog/{id}/assignProducts": - post: - tags: - - sharedCatalog/{id}/assignProducts - description: Add products into the shared catalog. - operationId: PostV1SharedCatalogIdAssignProducts - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - - name: PostV1SharedCatalogIdAssignProductsBody - in: body - schema: - required: - - products - properties: - products: - type: array - items: - "$ref": "#/definitions/catalog-data-product-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/{id}/assignProducts - "/V1/sharedCatalog/{id}/categories": - get: - tags: - - sharedCatalog/{id}/categories - description: Return the list of categories in the selected shared catalog. - operationId: GetV1SharedCatalogIdCategories - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - type: integer - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/{id}/categories - "/V1/sharedCatalog/{id}/products": - get: - tags: - - sharedCatalog/{id}/products - description: Return the list of product SKUs in the selected shared catalog. - operationId: GetV1SharedCatalogIdProducts - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - type: string - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/{id}/products - "/V1/sharedCatalog/{id}/unassignCategories": - post: - tags: - - sharedCatalog/{id}/unassignCategories - description: Remove the specified categories from the shared catalog. - operationId: PostV1SharedCatalogIdUnassignCategories - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - - name: PostV1SharedCatalogIdUnassignCategoriesBody - in: body - schema: - required: - - categories - properties: - categories: - type: array - items: - "$ref": "#/definitions/catalog-data-category-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/{id}/unassignCategories - "/V1/sharedCatalog/{id}/unassignProducts": - post: - tags: - - sharedCatalog/{id}/unassignProducts - description: Remove the specified products from the shared catalog. - operationId: PostV1SharedCatalogIdUnassignProducts - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - - name: PostV1SharedCatalogIdUnassignProductsBody - in: body - schema: - required: - - products - properties: - products: - type: array - items: - "$ref": "#/definitions/catalog-data-product-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/{id}/unassignProducts - "/V1/sharedCatalog/{sharedCatalogId}": - get: - tags: - - sharedCatalog/{sharedCatalogId} - description: 'Return the following properties for the selected shared catalog: - ID, Store Group ID, Name, Type, Description, Customer Group, Tax Class.' - operationId: GetV1SharedCatalogSharedCatalogId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sharedCatalogId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/{sharedCatalogId} - delete: - tags: - - sharedCatalog/{sharedCatalogId} - description: Delete a shared catalog by ID. - operationId: DeleteV1SharedCatalogSharedCatalogId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sharedCatalogId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/{sharedCatalogId} - "/V1/sharedCatalog/{sharedCatalogId}/assignCompanies": - post: - tags: - - sharedCatalog/{sharedCatalogId}/assignCompanies - description: Assign companies to a shared catalog. - operationId: PostV1SharedCatalogSharedCatalogIdAssignCompanies - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sharedCatalogId - in: path - type: integer - required: true - - name: PostV1SharedCatalogSharedCatalogIdAssignCompaniesBody - in: body - schema: - required: - - companies - properties: - companies: - type: array - items: - "$ref": "#/definitions/company-data-company-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/{sharedCatalogId}/assignCompanies - "/V1/sharedCatalog/{sharedCatalogId}/assignTierPrices": - post: - tags: - - sharedCatalog/{sharedCatalogId}/assignTierPrices - description: Assign custom prices - operationId: PostV1SharedCatalogSharedCatalogIdAssignTierPrices - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sharedCatalogId - in: path - type: integer - required: true - - name: PostV1SharedCatalogSharedCatalogIdAssignTierPricesBody - in: body - schema: - required: - - prices - properties: - prices: - type: array - items: - "$ref": "#/definitions/catalog-data-tier-price-interface" - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/{sharedCatalogId}/assignTierPrices - "/V1/sharedCatalog/{sharedCatalogId}/companies": - get: - tags: - - sharedCatalog/{sharedCatalogId}/companies - description: Return the list of company IDs for the companies assigned to the - selected catalog. - operationId: GetV1SharedCatalogSharedCatalogIdCompanies - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sharedCatalogId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: string - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/{sharedCatalogId}/companies - "/V1/sharedCatalog/{sharedCatalogId}/resetTierPrices": - post: - tags: - - sharedCatalog/{sharedCatalogId}/resetTierPrices - description: Reset custom prices - operationId: PostV1SharedCatalogSharedCatalogIdResetTierPrices - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sharedCatalogId - in: path - type: integer - required: true - - name: PostV1SharedCatalogSharedCatalogIdResetTierPricesBody - in: body - schema: - required: - - skus - properties: - skus: - type: array - items: - type: string - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/{sharedCatalogId}/resetTierPrices - "/V1/sharedCatalog/{sharedCatalogId}/unassignCompanies": - post: - tags: - - sharedCatalog/{sharedCatalogId}/unassignCompanies - description: Unassign companies from a shared catalog. - operationId: PostV1SharedCatalogSharedCatalogIdUnassignCompanies - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: sharedCatalogId - in: path - type: integer - required: true - - name: PostV1SharedCatalogSharedCatalogIdUnassignCompaniesBody - in: body - schema: - required: - - companies - properties: - companies: - type: array - items: - "$ref": "#/definitions/company-data-company-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: sharedCatalog/{sharedCatalogId}/unassignCompanies - "/V1/shipment/": - post: - tags: - - shipment/ - description: Performs persist operations for a specified shipment. - operationId: PostV1Shipment - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ShipmentBody - in: body - schema: - required: - - entity - properties: - entity: - "$ref": "#/definitions/sales-data-shipment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-shipment-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: shipment/ - "/V1/shipment/track": - post: - tags: - - shipment/track - description: Performs persist operations for a specified shipment track. - operationId: PostV1ShipmentTrack - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1ShipmentTrackBody - in: body - schema: - required: - - entity - properties: - entity: - "$ref": "#/definitions/sales-data-shipment-track-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-shipment-track-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: shipment/track - "/V1/shipment/track/{id}": - delete: - tags: - - shipment/track/{id} - description: Deletes a specified shipment track by ID. - operationId: DeleteV1ShipmentTrackId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The shipment track ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: shipment/track/{id} - "/V1/shipment/{id}": - get: - tags: - - shipment/{id} - description: Loads a specified shipment. - operationId: GetV1ShipmentId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The shipment ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-shipment-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: shipment/{id} - "/V1/shipment/{id}/comments": - get: - tags: - - shipment/{id}/comments - description: Lists comments for a specified shipment. - operationId: GetV1ShipmentIdComments - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The shipment ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-shipment-comment-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: shipment/{id}/comments - post: - tags: - - shipment/{id}/comments - description: Performs persist operations for a specified shipment comment. - operationId: PostV1ShipmentIdComments - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - - name: PostV1ShipmentIdCommentsBody - in: body - schema: - required: - - entity - properties: - entity: - "$ref": "#/definitions/sales-data-shipment-comment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-shipment-comment-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: shipment/{id}/comments - "/V1/shipment/{id}/emails": - post: - tags: - - shipment/{id}/emails - description: Emails user a specified shipment. - operationId: PostV1ShipmentIdEmails - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The shipment ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: shipment/{id}/emails - "/V1/shipment/{id}/label": - get: - tags: - - shipment/{id}/label - description: Gets a specified shipment label. - operationId: GetV1ShipmentIdLabel - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The shipment label ID. - responses: - '200': - description: 200 Success. - schema: - type: string - description: Shipment label. - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: shipment/{id}/label - "/V1/shipments": - get: - tags: - - shipments - description: Lists shipments that match specified search criteria. This call - returns an array of objects, but detailed information about each object’s - attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#ShipmentRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1Shipments - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-shipment-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: shipments - "/V1/stockItems/lowStock/": - get: - tags: - - stockItems/lowStock/ - description: Retrieves a list of SKU's with low inventory qty - operationId: GetV1StockItemsLowStock - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: scopeId - in: query - type: integer - required: true - - name: qty - in: query - type: number - required: true - - name: currentPage - in: query - type: integer - required: false - - name: pageSize - in: query - type: integer - required: false - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-inventory-data-stock-item-collection-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: stockItems/lowStock/ - "/V1/stockItems/{productSku}": - get: - tags: - - stockItems/{productSku} - description: '' - operationId: GetV1StockItemsProductSku - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: productSku - in: path - type: string - required: true - - name: scopeId - in: query - type: integer - required: false - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: stockItems/{productSku} - "/V1/stockStatuses/{productSku}": - get: - tags: - - stockStatuses/{productSku} - description: '' - operationId: GetV1StockStatusesProductSku - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: productSku - in: path - type: string - required: true - - name: scopeId - in: query - type: integer - required: false - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-inventory-data-stock-status-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: stockStatuses/{productSku} - "/V1/store/storeConfigs": - get: - tags: - - store/storeConfigs - description: '' - operationId: GetV1StoreStoreConfigs - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: storeCodes - in: query - type: array - items: - type: string - required: false - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/store-data-store-config-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: store/storeConfigs - "/V1/store/storeGroups": - get: - tags: - - store/storeGroups - description: Retrieve list of all groups - operationId: GetV1StoreStoreGroups - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/store-data-group-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: store/storeGroups - "/V1/store/storeViews": - get: - tags: - - store/storeViews - description: Retrieve list of all stores - operationId: GetV1StoreStoreViews - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/store-data-store-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: store/storeViews - "/V1/store/websites": - get: - tags: - - store/websites - description: Retrieve list of all websites - operationId: GetV1StoreWebsites - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/store-data-website-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: store/websites - "/V1/taxClasses": - post: - tags: - - taxClasses - description: Create a Tax Class - operationId: PostV1TaxClasses - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TaxClassesBody - in: body - schema: - required: - - taxClass - properties: - taxClass: - "$ref": "#/definitions/tax-data-tax-class-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - description: id for the newly created Tax class - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxClasses - "/V1/taxClasses/search": - get: - tags: - - taxClasses/search - description: Retrieve tax classes which match a specific criteria. This call - returns an array of objects, but detailed information about each object’s - attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#TaxClassRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1TaxClassesSearch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/tax-data-tax-class-search-results-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxClasses/search - "/V1/taxClasses/{classId}": - put: - tags: - - taxClasses/{classId} - description: Create a Tax Class - operationId: PutV1TaxClassesClassId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: classId - in: path - type: string - required: true - - name: PutV1TaxClassesClassIdBody - in: body - schema: - required: - - taxClass - properties: - taxClass: - "$ref": "#/definitions/tax-data-tax-class-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - description: id for the newly created Tax class - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxClasses/{classId} - "/V1/taxClasses/{taxClassId}": - get: - tags: - - taxClasses/{taxClassId} - description: Get a tax class with the given tax class id. - operationId: GetV1TaxClassesTaxClassId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: taxClassId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/tax-data-tax-class-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxClasses/{taxClassId} - delete: - tags: - - taxClasses/{taxClassId} - description: Delete a tax class with the given tax class id. - operationId: DeleteV1TaxClassesTaxClassId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: taxClassId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: True if the tax class was deleted, false otherwise - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxClasses/{taxClassId} - "/V1/taxRates": - post: - tags: - - taxRates - description: Create or update tax rate - operationId: PostV1TaxRates - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TaxRatesBody - in: body - schema: - required: - - taxRate - properties: - taxRate: - "$ref": "#/definitions/tax-data-tax-rate-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/tax-data-tax-rate-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxRates - put: - tags: - - taxRates - description: Create or update tax rate - operationId: PutV1TaxRates - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1TaxRatesBody - in: body - schema: - required: - - taxRate - properties: - taxRate: - "$ref": "#/definitions/tax-data-tax-rate-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/tax-data-tax-rate-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxRates - "/V1/taxRates/search": - get: - tags: - - taxRates/search - description: Search TaxRates This call returns an array of objects, but detailed - information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#TaxRateRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1TaxRatesSearch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/tax-data-tax-rate-search-results-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxRates/search - "/V1/taxRates/{rateId}": - get: - tags: - - taxRates/{rateId} - description: Get tax rate - operationId: GetV1TaxRatesRateId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: rateId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/tax-data-tax-rate-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxRates/{rateId} - delete: - tags: - - taxRates/{rateId} - description: Delete tax rate - operationId: DeleteV1TaxRatesRateId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: rateId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxRates/{rateId} - "/V1/taxRules": - post: - tags: - - taxRules - description: Save TaxRule - operationId: PostV1TaxRules - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TaxRulesBody - in: body - schema: - required: - - rule - properties: - rule: - "$ref": "#/definitions/tax-data-tax-rule-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/tax-data-tax-rule-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxRules - put: - tags: - - taxRules - description: Save TaxRule - operationId: PutV1TaxRules - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1TaxRulesBody - in: body - schema: - required: - - rule - properties: - rule: - "$ref": "#/definitions/tax-data-tax-rule-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/tax-data-tax-rule-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxRules - "/V1/taxRules/search": - get: - tags: - - taxRules/search - description: Search TaxRules This call returns an array of objects, but detailed - information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#TaxRuleRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1TaxRulesSearch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/tax-data-tax-rule-search-results-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxRules/search - "/V1/taxRules/{ruleId}": - delete: - tags: - - taxRules/{ruleId} - description: Delete TaxRule - operationId: DeleteV1TaxRulesRuleId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: ruleId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxRules/{ruleId} - get: - tags: - - taxRules/{ruleId} - description: Get TaxRule - operationId: GetV1TaxRulesRuleId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: ruleId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/tax-data-tax-rule-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: taxRules/{ruleId} - "/V1/team/": - get: - tags: - - team/ - description: Returns the list of teams for the specified search criteria (team - name or description). - operationId: GetV1Team - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-data-team-search-results-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: team/ - "/V1/team/{companyId}": - post: - tags: - - team/{companyId} - description: Create a team in the company structure. - operationId: PostV1TeamCompanyId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: companyId - in: path - type: integer - required: true - - name: PostV1TeamCompanyIdBody - in: body - schema: - required: - - team - properties: - team: - "$ref": "#/definitions/company-data-team-interface" - type: object - xml: - name: request - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: team/{companyId} - "/V1/team/{teamId}": - get: - tags: - - team/{teamId} - description: Returns data for a team in the company, by entity id. - operationId: GetV1TeamTeamId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: teamId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/company-data-team-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: team/{teamId} - delete: - tags: - - team/{teamId} - description: Delete a team from the company structure. - operationId: DeleteV1TeamTeamId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: teamId - in: path - type: integer - required: true - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: team/{teamId} - put: - tags: - - team/{teamId} - description: Update a team in the company structure. - operationId: PutV1TeamTeamId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: teamId - in: path - type: string - required: true - - name: PutV1TeamTeamIdBody - in: body - schema: - required: - - team - properties: - team: - "$ref": "#/definitions/company-data-team-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: team/{teamId} - "/V1/tfa/default-provider-code/{userId}": - put: - tags: - - tfa/default-provider-code/{userId} - description: Set default provider code - operationId: PutV1TfaDefaultprovidercodeUserId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: userId - in: path - type: integer - required: true - - name: PutV1TfaDefaultprovidercodeUserIdBody - in: body - schema: - required: - - providerCode - properties: - providerCode: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/default-provider-code/{userId} - get: - tags: - - tfa/default-provider-code/{userId} - description: Get default provider - operationId: GetV1TfaDefaultprovidercodeUserId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: userId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: string - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/default-provider-code/{userId} - "/V1/tfa/forced-providers": - get: - tags: - - tfa/forced-providers - description: Retrieve forced providers list - operationId: GetV1TfaForcedproviders - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/two-factor-auth-provider-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/forced-providers - "/V1/tfa/installed-providers": - get: - tags: - - tfa/installed-providers - description: Get a list of providers - operationId: GetV1TfaInstalledproviders - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/two-factor-auth-provider-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/installed-providers - "/V1/tfa/provider/authy/activate": - post: - tags: - - tfa/provider/authy/activate - description: Activate the provider and get an admin token - operationId: PostV1TfaProviderAuthyActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderAuthyActivateBody - in: body - schema: - required: - - tfaToken - - otp - properties: - tfaToken: - type: string - otp: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/activate - "/V1/tfa/provider/authy/authenticate": - post: - tags: - - tfa/provider/authy/authenticate - description: Get an admin token using authy 2fa - operationId: PostV1TfaProviderAuthyAuthenticate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderAuthyAuthenticateBody - in: body - schema: - required: - - username - - password - - otp - properties: - username: - type: string - password: - type: string - otp: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - description: "$otp" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/authenticate - "/V1/tfa/provider/authy/authenticate-onetouch": - post: - tags: - - tfa/provider/authy/authenticate-onetouch - description: Authenticate using the present one touch response and get an admin - token - operationId: PostV1TfaProviderAuthyAuthenticateonetouch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderAuthyAuthenticateonetouchBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/authenticate-onetouch - "/V1/tfa/provider/authy/configure": - post: - tags: - - tfa/provider/authy/configure - description: Get the information required to configure google - operationId: PostV1TfaProviderAuthyConfigure - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderAuthyConfigureBody - in: body - schema: - required: - - tfaToken - - deviceData - properties: - tfaToken: - type: string - deviceData: - "$ref": "#/definitions/two-factor-auth-data-authy-device-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/configure - "/V1/tfa/provider/authy/send-token/{via}": - post: - tags: - - tfa/provider/authy/send-token/{via} - description: Send a one time password to a device using authy - operationId: PostV1TfaProviderAuthySendtokenVia - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: via - in: path - type: string - required: true - - name: PostV1TfaProviderAuthySendtokenViaBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/send-token/{via} - "/V1/tfa/provider/duo_security/activate": - post: - tags: - - tfa/provider/duo_security/activate - description: Activate the provider and get an admin token - operationId: PostV1TfaProviderDuo_securityActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderDuo_securityActivateBody - in: body - schema: - required: - - tfaToken - properties: - tfaToken: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/duo_security/activate - "/V1/tfa/provider/duo_security/authenticate": - post: - tags: - - tfa/provider/duo_security/authenticate - description: Authenticate and get an admin token with passcode - operationId: PostV1TfaProviderDuo_securityAuthenticate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderDuo_securityAuthenticateBody - in: body - schema: - required: - - username - - password - - passcode - properties: - username: - type: string - password: - type: string - passcode: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/duo_security/authenticate - "/V1/tfa/provider/duo_security/configure": - post: - tags: - - tfa/provider/duo_security/configure - description: Configure duo for first time user - operationId: PostV1TfaProviderDuo_securityConfigure - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderDuo_securityConfigureBody - in: body - schema: - required: - - tfaToken - properties: - tfaToken: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/duo_security/configure - "/V1/tfa/provider/google/activate": - post: - tags: - - tfa/provider/google/activate - description: Activate the provider and get an admin token - operationId: PostV1TfaProviderGoogleActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderGoogleActivateBody - in: body - schema: - required: - - tfaToken - - otp - properties: - tfaToken: - type: string - otp: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/google/activate - "/V1/tfa/provider/google/authenticate": - post: - tags: - - tfa/provider/google/authenticate - description: Get an admin token by authenticating using google - operationId: PostV1TfaProviderGoogleAuthenticate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderGoogleAuthenticateBody - in: body - schema: - required: - - username - - password - - otp - properties: - username: - type: string - password: - type: string - otp: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/google/authenticate - "/V1/tfa/provider/google/configure": - post: - tags: - - tfa/provider/google/configure - description: Get the information required to configure google - operationId: PostV1TfaProviderGoogleConfigure - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderGoogleConfigureBody - in: body - schema: - required: - - tfaToken - properties: - tfaToken: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/two-factor-auth-data-google-configure-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/google/configure - "/V1/tfa/provider/u2fkey/activate": - post: - tags: - - tfa/provider/u2fkey/activate - description: Activate the provider and get a token - operationId: PostV1TfaProviderU2fkeyActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderU2fkeyActivateBody - in: body - schema: - required: - - tfaToken - - publicKeyCredentialJson - properties: - tfaToken: - type: string - publicKeyCredentialJson: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/u2fkey/activate - "/V1/tfa/provider/u2fkey/authentication-challenge": - post: - tags: - - tfa/provider/u2fkey/authentication-challenge - description: Get the information to initiate a WebAuthn registration ceremony - operationId: PostV1TfaProviderU2fkeyAuthenticationchallenge - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderU2fkeyAuthenticationchallengeBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/u2fkey/authentication-challenge - "/V1/tfa/provider/u2fkey/configure": - post: - tags: - - tfa/provider/u2fkey/configure - description: Get the information to initiate a WebAuthn registration ceremony - operationId: PostV1TfaProviderU2fkeyConfigure - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderU2fkeyConfigureBody - in: body - schema: - required: - - tfaToken - properties: - tfaToken: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/u2fkey/configure - "/V1/tfa/provider/u2fkey/verify": - post: - tags: - - tfa/provider/u2fkey/verify - description: Authenticate with the provider and get a token - operationId: PostV1TfaProviderU2fkeyVerify - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderU2fkeyVerifyBody - in: body - schema: - required: - - username - - password - - publicKeyCredentialJson - properties: - username: - type: string - password: - type: string - publicKeyCredentialJson: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/u2fkey/verify - "/V1/tfa/providers-to-activate/{userId}": - get: - tags: - - tfa/providers-to-activate/{userId} - description: Returns a list of providers to configure/enroll - operationId: GetV1TfaProviderstoactivateUserId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: userId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/two-factor-auth-provider-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/providers-to-activate/{userId} - "/V1/tfa/tfat-providers-to-activate": - get: - tags: - - tfa/tfat-providers-to-activate - description: Get the providers that the user still needs to configure - operationId: GetV1TfaTfatproviderstoactivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: tfaToken - in: query - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/two-factor-auth-provider-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/tfat-providers-to-activate - "/V1/tfa/tfat-user-providers": - get: - tags: - - tfa/tfat-user-providers - description: Get the providers that the user is able to use for 2fa - operationId: GetV1TfaTfatuserproviders - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: tfaToken - in: query - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/two-factor-auth-provider-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/tfat-user-providers - "/V1/tfa/user-providers/{userId}": - get: - tags: - - tfa/user-providers/{userId} - description: Get a user provider - operationId: GetV1TfaUserprovidersUserId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: userId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/two-factor-auth-provider-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/user-providers/{userId} - put: - tags: - - tfa/user-providers/{userId} - description: Set providers - operationId: PutV1TfaUserprovidersUserId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: userId - in: path - type: integer - required: true - - name: PutV1TfaUserprovidersUserIdBody - in: body - schema: - required: - - providersCodes - properties: - providersCodes: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/user-providers/{userId} - "/V1/transactions": - get: - tags: - - transactions - description: Lists transactions that match specified search criteria. This call - returns an array of objects, but detailed information about each object’s - attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#TransactionRepositoryInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1Transactions - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-transaction-search-result-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: transactions - "/V1/transactions/{id}": - get: - tags: - - transactions/{id} - description: Loads a specified transaction. - operationId: GetV1TransactionsId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: integer - required: true - description: The transaction ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/sales-data-transaction-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: transactions/{id} - "/V1/webhooks/list": - get: - tags: - - webhooks/list - description: Returns the list of all subscribed webhooks - operationId: GetV1WebhooksList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: webhooks/list - "/V1/webhooks/subscribe": - post: - tags: - - webhooks/subscribe - description: Subscribes to the webhook. - operationId: PostV1WebhooksSubscribe - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1WebhooksSubscribeBody - in: body - schema: - required: - - webhook - properties: - webhook: - "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface" - type: object - xml: - name: request - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: webhooks/subscribe - "/V1/webhooks/unsubscribe": - post: - tags: - - webhooks/unsubscribe - description: Unsubscribes from the webhook. - operationId: PostV1WebhooksUnsubscribe - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1WebhooksUnsubscribeBody - in: body - schema: - required: - - webhook - properties: - webhook: - "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface" - type: object - xml: - name: request - responses: - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: webhooks/unsubscribe - "/V2/carts/mine/coupons": - get: - tags: - - carts/mine/coupons - description: Returns information for all coupons in a specified cart. - operationId: GetV2CartsMineCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - description: The coupon code data. - items: - type: string - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/coupons - post: - tags: - - carts/mine/coupons - description: Append the coupon code(s) to cart - operationId: PostV2CartsMineCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV2CartsMineCouponsBody - in: body - schema: - required: - - couponCodes - properties: - couponCodes: - type: array - items: - type: string - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/coupons - put: - tags: - - carts/mine/coupons - description: Replace the coupon code(s) in cart with the new code(s) - operationId: PutV2CartsMineCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV2CartsMineCouponsBody - in: body - schema: - required: - - couponCodes - properties: - couponCodes: - type: array - items: - type: string - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/coupons - "/V2/carts/mine/coupons/deleteByCodes": - post: - tags: - - carts/mine/coupons/deleteByCodes - description: Deletes coupon(s) from a specified cart. - operationId: PostV2CartsMineCouponsDeleteByCodes - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV2CartsMineCouponsDeleteByCodesBody - in: body - schema: - properties: - couponCodes: - type: array - description: coupon codes - items: - type: string - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/coupons/deleteByCodes - "/V2/carts/{cartId}/coupons": - get: - tags: - - carts/{cartId}/coupons - description: Returns information for all coupons in a specified cart. - operationId: GetV2CartsCartIdCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: array - description: The coupon code data. - items: - type: string - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/coupons - post: - tags: - - carts/{cartId}/coupons - description: Append the coupon code(s) to cart - operationId: PostV2CartsCartIdCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV2CartsCartIdCouponsBody - in: body - schema: - required: - - couponCodes - properties: - couponCodes: - type: array - items: - type: string - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/coupons - put: - tags: - - carts/{cartId}/coupons - description: Replace the coupon code(s) in cart with the new code(s) - operationId: PutV2CartsCartIdCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PutV2CartsCartIdCouponsBody - in: body - schema: - required: - - couponCodes - properties: - couponCodes: - type: array - items: - type: string - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/coupons - "/V2/carts/{cartId}/coupons/deleteByCodes": - post: - tags: - - carts/{cartId}/coupons/deleteByCodes - description: Deletes coupon(s) from a specified cart. - operationId: PostV2CartsCartIdCouponsDeleteByCodes - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - - name: PostV2CartsCartIdCouponsDeleteByCodesBody - in: body - schema: - properties: - couponCodes: - type: array - description: coupon codes - items: - type: string - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/{cartId}/coupons/deleteByCodes -definitions: - error-response: - type: object - properties: - message: - type: string - description: Error message - errors: - "$ref": "#/definitions/error-errors" - code: - type: integer - description: Error code - parameters: - "$ref": "#/definitions/error-parameters" - trace: - type: string - description: Stack trace - required: - - message - error-errors: - type: array - description: Errors list - items: - "$ref": "#/definitions/error-errors-item" - error-errors-item: - type: object - description: Error details - properties: - message: - type: string - description: Error message - parameters: - "$ref": "#/definitions/error-parameters" - error-parameters: - type: array - description: Error parameters list - items: - "$ref": "#/definitions/error-parameters-item" - error-parameters-item: - type: object - description: Error parameters item - properties: - resources: - type: string - description: ACL resource - fieldName: - type: string - description: Missing or invalid field name - fieldValue: - type: string - description: Incorrect field value - store-data-store-interface: - type: object - description: Store interface - properties: - id: - type: integer - code: - type: string - name: - type: string - description: Store name - website_id: - type: integer - store_group_id: - type: integer - is_active: - type: integer - extension_attributes: - "$ref": "#/definitions/store-data-store-extension-interface" - required: - - id - - code - - name - - website_id - - store_group_id - - is_active - store-data-store-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Store\Api\Data\StoreInterface - store-data-group-interface: - type: object - description: Group interface - properties: - id: - type: integer - website_id: - type: integer - root_category_id: - type: integer - default_store_id: - type: integer - name: - type: string - code: - type: string - description: Group code. - extension_attributes: - "$ref": "#/definitions/store-data-group-extension-interface" - required: - - id - - website_id - - root_category_id - - default_store_id - - name - - code - store-data-group-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Store\Api\Data\GroupInterface - store-data-website-interface: - type: object - description: Website interface - properties: - id: - type: integer - code: - type: string - name: - type: string - description: Website name - default_group_id: - type: integer - extension_attributes: - "$ref": "#/definitions/store-data-website-extension-interface" - required: - - id - - code - - name - - default_group_id - store-data-website-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Store\Api\Data\WebsiteInterface - store-data-store-config-interface: - type: object - description: Interface for store config - properties: - id: - type: integer - description: Store id - code: - type: string - description: Store code - website_id: - type: integer - description: Website id of the store - locale: - type: string - description: Store locale - base_currency_code: - type: string - description: Base currency code - default_display_currency_code: - type: string - description: Default display currency code - timezone: - type: string - description: Timezone of the store - weight_unit: - type: string - description: The unit of weight - base_url: - type: string - description: Base URL for the store - base_link_url: - type: string - description: Base link URL for the store - base_static_url: - type: string - description: Base static URL for the store - base_media_url: - type: string - description: Base media URL for the store - secure_base_url: - type: string - description: Secure base URL for the store - secure_base_link_url: - type: string - description: Secure base link URL for the store - secure_base_static_url: - type: string - description: Secure base static URL for the store - secure_base_media_url: - type: string - description: Secure base media URL for the store - extension_attributes: - "$ref": "#/definitions/store-data-store-config-extension-interface" - required: - - id - - code - - website_id - - locale - - base_currency_code - - default_display_currency_code - - timezone - - weight_unit - - base_url - - base_link_url - - base_static_url - - base_media_url - - secure_base_url - - secure_base_link_url - - secure_base_static_url - - secure_base_media_url - store-data-store-config-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Store\Api\Data\StoreConfigInterface - directory-data-currency-information-interface: - type: object - description: Currency Information interface. - properties: - base_currency_code: - type: string - description: The base currency code for the store. - base_currency_symbol: - type: string - description: The currency symbol of the base currency for the store. - default_display_currency_code: - type: string - description: The default display currency code for the store. - default_display_currency_symbol: - type: string - description: The currency symbol of the default display currency for the store. - available_currency_codes: - type: array - description: The list of allowed currency codes for the store. - items: - type: string - exchange_rates: - type: array - description: The list of exchange rate information for the store. - items: - "$ref": "#/definitions/directory-data-exchange-rate-interface" - extension_attributes: - "$ref": "#/definitions/directory-data-currency-information-extension-interface" - required: - - base_currency_code - - base_currency_symbol - - default_display_currency_code - - default_display_currency_symbol - - available_currency_codes - - exchange_rates - directory-data-exchange-rate-interface: - type: object - description: Exchange Rate interface. - properties: - currency_to: - type: string - description: The currency code associated with the exchange rate. - rate: - type: number - description: The exchange rate for the associated currency and the store's - base currency. - extension_attributes: - "$ref": "#/definitions/directory-data-exchange-rate-extension-interface" - required: - - currency_to - - rate - directory-data-exchange-rate-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Directory\Api\Data\ExchangeRateInterface - directory-data-currency-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CurrencyInformationInterface - directory-data-country-information-interface: - type: object - description: Country Information interface. - properties: - id: - type: string - description: The country id for the store. - two_letter_abbreviation: - type: string - description: The country 2 letter abbreviation for the store. - three_letter_abbreviation: - type: string - description: The country 3 letter abbreviation for the store. - full_name_locale: - type: string - description: The country full name (in store locale) for the store. - full_name_english: - type: string - description: The country full name (in English) for the store. - available_regions: - type: array - description: The available regions for the store. - items: - "$ref": "#/definitions/directory-data-region-information-interface" - extension_attributes: - "$ref": "#/definitions/directory-data-country-information-extension-interface" - required: - - id - - two_letter_abbreviation - - three_letter_abbreviation - - full_name_locale - - full_name_english - directory-data-region-information-interface: - type: object - description: Region Information interface. - properties: - id: - type: string - description: Region id - code: - type: string - description: Region code - name: - type: string - description: Region name - extension_attributes: - "$ref": "#/definitions/directory-data-region-information-extension-interface" - required: - - id - - code - - name - directory-data-region-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Directory\Api\Data\RegionInformationInterface - directory-data-country-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CountryInformationInterface - eav-data-attribute-set-search-results-interface: - type: object - description: Interface AttributeSetSearchResultsInterface - properties: - items: - type: array - description: Attribute sets list. - items: - "$ref": "#/definitions/eav-data-attribute-set-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - eav-data-attribute-set-interface: - type: object - description: Interface AttributeSetInterface - properties: - attribute_set_id: - type: integer - description: Attribute set ID - attribute_set_name: - type: string - description: Attribute set name - sort_order: - type: integer - description: Attribute set sort order index - entity_type_id: - type: integer - description: Attribute set entity type id - extension_attributes: - "$ref": "#/definitions/eav-data-attribute-set-extension-interface" - required: - - attribute_set_name - - sort_order - eav-data-attribute-set-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Eav\Api\Data\AttributeSetInterface - framework-search-criteria-interface: - type: object - description: Search criteria interface. - properties: - filter_groups: - type: array - description: A list of filter groups. - items: - "$ref": "#/definitions/framework-search-filter-group" - sort_orders: - type: array - description: Sort order. - items: - "$ref": "#/definitions/framework-sort-order" - page_size: - type: integer - description: Page size. - current_page: - type: integer - description: Current page. - required: - - filter_groups - framework-search-filter-group: - type: object - description: Groups two or more filters together using a logical OR - properties: - filters: - type: array - description: A list of filters in this group - items: - "$ref": "#/definitions/framework-filter" - framework-filter: - type: object - description: Filter which can be used by any methods from service layer. - properties: - field: - type: string - description: Field - value: - type: string - description: Value - condition_type: - type: string - description: Condition type - required: - - field - - value - framework-sort-order: - type: object - description: Data object for sort order. - properties: - field: - type: string - description: Sorting field. - direction: - type: string - description: Sorting direction. - required: - - field - - direction - adobe-io-events-client-configuration-check-result-interface: - type: object - description: Contains configuration status for each necessary config setting - properties: - status: - type: string - description: Ok/error status of the configuration - technical_service_account_configured: - type: boolean - description: The technical service account is configured - technical_service_account_can_connect_to_io_events: - type: boolean - description: Providers are configured to allow the service account to connect - provider_id_configured: - type: string - description: The provider id if configured - provider_id_valid: - type: boolean - description: A configured provider id is valid - required: - - status - - technical_service_account_configured - - technical_service_account_can_connect_to_io_events - - provider_id_configured - - provider_id_valid - customer-data-group-interface: - type: object - description: Customer group interface. - properties: - id: - type: integer - description: Id - code: - type: string - description: Code - tax_class_id: - type: integer - description: Tax class id - tax_class_name: - type: string - description: Tax class name - extension_attributes: - "$ref": "#/definitions/customer-data-group-extension-interface" - required: - - code - - tax_class_id - customer-data-group-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Customer\Api\Data\GroupInterface - properties: - exclude_website_ids: - type: array - items: - type: integer - customer-data-group-search-results-interface: - type: object - description: Interface for customer groups search results. - properties: - items: - type: array - description: Customer groups list. - items: - "$ref": "#/definitions/customer-data-group-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - customer-data-attribute-metadata-interface: - type: object - description: Customer attribute metadata interface. - properties: - frontend_input: - type: string - description: HTML for input element. - input_filter: - type: string - description: Template used for input (e.g. "date") - store_label: - type: string - description: Label of the store. - validation_rules: - type: array - description: Validation rules. - items: - "$ref": "#/definitions/customer-data-validation-rule-interface" - multiline_count: - type: integer - description: Of lines of the attribute value. - visible: - type: boolean - description: Attribute is visible on frontend. - required: - type: boolean - description: Attribute is required. - data_model: - type: string - description: Data model for attribute. - options: - type: array - description: Options of the attribute (key => value pairs for select) - items: - "$ref": "#/definitions/customer-data-option-interface" - frontend_class: - type: string - description: Class which is used to display the attribute on frontend. - user_defined: - type: boolean - description: Current attribute has been defined by a user. - sort_order: - type: integer - description: Attributes sort order. - frontend_label: - type: string - description: Label which supposed to be displayed on frontend. - note: - type: string - description: The note attribute for the element. - system: - type: boolean - description: This is a system attribute. - backend_type: - type: string - description: Backend type. - is_used_in_grid: - type: boolean - description: It is used in customer grid - is_visible_in_grid: - type: boolean - description: It is visible in customer grid - is_filterable_in_grid: - type: boolean - description: It is filterable in customer grid - is_searchable_in_grid: - type: boolean - description: It is searchable in customer grid - attribute_code: - type: string - description: Code of the attribute. - required: - - frontend_input - - input_filter - - store_label - - validation_rules - - multiline_count - - visible - - required - - data_model - - options - - frontend_class - - user_defined - - sort_order - - frontend_label - - note - - system - - backend_type - - attribute_code - customer-data-validation-rule-interface: - type: object - description: Validation rule interface. - properties: - name: - type: string - description: Validation rule name - value: - type: string - description: Validation rule value - required: - - name - - value - customer-data-option-interface: - type: object - description: Option interface. - properties: - label: - type: string - description: Option label - value: - type: string - description: Option value - options: - type: array - description: Nested options - items: - "$ref": "#/definitions/customer-data-option-interface" - required: - - label - customer-data-customer-interface: - type: object - description: Customer entity interface for API handling. - properties: - id: - type: integer - description: Customer id - group_id: - type: integer - description: Group id - default_billing: - type: string - description: Default billing address id - default_shipping: - type: string - description: Default shipping address id - confirmation: - type: string - description: Confirmation - created_at: - type: string - description: Created at time - updated_at: - type: string - description: Updated at time - created_in: - type: string - description: Created in area - dob: - type: string - description: In keeping with current security and privacy best practices, - be sure you are aware of any potential legal and security risks associated - with the storage of customers’ full date of birth (month, day, year) along - with other personal identifiers (e.g., full name) before collecting or processing - such data. - email: - type: string - description: Email address - firstname: - type: string - description: First name - lastname: - type: string - description: Last name - middlename: - type: string - description: Middle name - prefix: - type: string - description: Prefix - suffix: - type: string - description: Suffix - gender: - type: integer - description: Gender - store_id: - type: integer - description: Store id - taxvat: - type: string - description: Tax Vat - website_id: - type: integer - description: Website id - addresses: - type: array - description: Customer addresses. - items: - "$ref": "#/definitions/customer-data-address-interface" - disable_auto_group_change: - type: integer - description: Disable auto group change flag. - extension_attributes: - "$ref": "#/definitions/customer-data-customer-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - email - - firstname - - lastname - customer-data-address-interface: - type: object - description: Customer address interface. - properties: - id: - type: integer - description: ID - customer_id: - type: integer - description: Customer ID - region: - "$ref": "#/definitions/customer-data-region-interface" - region_id: - type: integer - description: Region ID - country_id: - type: string - description: Country code in ISO_3166-2 format - street: - type: array - description: Street - items: - type: string - company: - type: string - description: Company - telephone: - type: string - description: Telephone number - fax: - type: string - description: Fax number - postcode: - type: string - description: Postcode - city: - type: string - description: City name - firstname: - type: string - description: First name - lastname: - type: string - description: Last name - middlename: - type: string - description: Middle name - prefix: - type: string - description: Prefix - suffix: - type: string - description: Suffix - vat_id: - type: string - description: Vat id - default_shipping: - type: boolean - description: If this address is default shipping address. - default_billing: - type: boolean - description: If this address is default billing address - extension_attributes: - "$ref": "#/definitions/customer-data-address-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - customer-data-region-interface: - type: object - description: Customer address region interface. - properties: - region_code: - type: string - description: Region code - region: - type: string - description: Region - region_id: - type: integer - description: Region id - extension_attributes: - "$ref": "#/definitions/customer-data-region-extension-interface" - required: - - region_code - - region - - region_id - customer-data-region-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface - customer-data-address-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface - framework-attribute-interface: - type: object - description: Interface for custom attribute value. - properties: - attribute_code: - type: string - description: Attribute code - value: - type: string - description: Attribute value - required: - - attribute_code - - value - customer-data-customer-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface - properties: - company_attributes: - "$ref": "#/definitions/company-data-company-customer-interface" - all_company_attributes: - type: array - items: - "$ref": "#/definitions/company-data-company-customer-interface" - is_subscribed: - type: boolean - assistance_allowed: - type: integer - company-data-company-customer-interface: - type: object - description: Extended customer custom attributes interface. - properties: - customer_id: - type: integer - description: Customer ID. - company_id: - type: integer - description: Company ID. - job_title: - type: string - description: Job title. - status: - type: integer - description: Customer status. - telephone: - type: string - description: Telephone. - is_default: - type: boolean - description: Is default - extension_attributes: - "$ref": "#/definitions/company-data-company-customer-extension-interface" - company-data-company-customer-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface - customer-data-customer-search-results-interface: - type: object - description: Interface for customer search results. - properties: - items: - type: array - description: Customers list. - items: - "$ref": "#/definitions/customer-data-customer-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - customer-data-validation-results-interface: - type: object - description: Validation results interface. - properties: - valid: - type: boolean - description: If the provided data is valid. - messages: - type: array - description: Error messages as array in case of validation failure, else return - empty array. - items: - type: string - required: - - valid - - messages - adobe-commerce-events-client-data-event-data-interface: - type: object - description: Interface for event data from webapi requests - properties: - name: - type: string - description: Event name - parent: - type: string - description: Event parent name - fields: - type: array - description: Event fields - items: - "$ref": "#/definitions/adobe-commerce-events-client-data-event-field-interface" - rules: - type: array - description: Event fields - items: - "$ref": "#/definitions/adobe-commerce-events-client-data-event-rule-interface" - destination: - type: string - description: Event destination - priority: - type: boolean - description: Event priority - hipaa_audit_required: - type: boolean - description: If event is required to be HIPAA audited - provider_id: - type: string - description: Event provider id - required: - - name - - parent - - fields - - rules - - destination - - priority - - hipaa_audit_required - - provider_id - adobe-commerce-events-client-data-event-field-interface: - type: object - description: Interface for event field data from webapi requests - properties: - name: - type: string - description: Event field name - converter: - type: string - description: Event field converter - source: - type: string - description: Event field source - required: - - name - - converter - - source - adobe-commerce-events-client-data-event-rule-interface: - type: object - description: Interface for event rule data from webapi requests - properties: - field: - type: string - description: Event rule field name - operator: - type: string - description: Event rule operator - value: - type: string - description: Event rule value - required: - - field - - operator - - value - adobe-commerce-events-client-data-configuration-interface: - type: object - description: Eventing configuration - properties: - enabled: - type: boolean - description: If is enabled - merchant_id: - type: string - description: Merchant id - environment_id: - type: string - description: Environment id - provider_id: - type: string - description: Provider id - instance_id: - type: string - description: Instance id - workspace_configuration: - type: string - description: Workspace configuration - required: - - enabled - - merchant_id - - environment_id - - provider_id - - instance_id - - workspace_configuration - adobe-commerce-events-client-data-event-provider-interface: - type: object - description: Interface for event provider - properties: - id: - type: integer - description: ID of the event provider record - provider_id: - type: string - description: Event provider id - instance_id: - type: string - description: Event provider instance id - label: - type: string - description: Event provider label - description: - type: string - description: Event provider description - workspace_configuration: - type: string - description: Event provider workspace configuration - required: - - provider_id - - instance_id - - label - - description - - workspace_configuration - framework-search-search-result-interface: - type: object - description: Interface SearchResultInterface - properties: - items: - type: array - items: - "$ref": "#/definitions/framework-search-document-interface" - aggregations: - "$ref": "#/definitions/framework-search-aggregation-interface" - search_criteria: - "$ref": "#/definitions/framework-search-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - aggregations - - search_criteria - - total_count - framework-search-document-interface: - type: object - description: Interface Search Document - properties: - id: - type: integer - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - id - framework-search-aggregation-interface: - type: object - description: Interface Aggregation to get faceted data - properties: - buckets: - type: array - description: All Document fields - items: - "$ref": "#/definitions/framework-search-bucket-interface" - bucket_names: - type: array - description: Document field names - items: - type: string - required: - - buckets - - bucket_names - framework-search-bucket-interface: - type: object - description: Interface for facet Bucket - properties: - name: - type: string - description: Field name - values: - type: array - description: Field values - items: - "$ref": "#/definitions/framework-search-aggregation-value-interface" - required: - - name - - values - framework-search-aggregation-value-interface: - type: object - description: Interface Aggregation Value - properties: - value: - type: string - description: Aggregation - metrics: - type: array - description: Metrics - items: - type: string - required: - - value - - metrics - framework-search-search-criteria-interface: - type: object - description: Interface SearchCriteriaInterface - properties: - request_name: - type: string - filter_groups: - type: array - description: A list of filter groups. - items: - "$ref": "#/definitions/framework-search-filter-group" - sort_orders: - type: array - description: Sort order. - items: - "$ref": "#/definitions/framework-sort-order" - page_size: - type: integer - description: Page size. - current_page: - type: integer - description: Current page. - required: - - request_name - - filter_groups - cms-data-page-interface: - type: object - description: CMS page interface. - properties: - id: - type: integer - description: ID - identifier: - type: string - description: Identifier - title: - type: string - description: Title - page_layout: - type: string - description: Page layout - meta_title: - type: string - description: Meta title - meta_keywords: - type: string - description: Meta keywords - meta_description: - type: string - description: Meta description - content_heading: - type: string - description: Content heading - content: - type: string - description: Content - creation_time: - type: string - description: Creation time - update_time: - type: string - description: Update time - sort_order: - type: string - description: Sort order - layout_update_xml: - type: string - description: Layout update xml - custom_theme: - type: string - description: Custom theme - custom_root_template: - type: string - description: Custom root template - custom_layout_update_xml: - type: string - description: Custom layout update xml - custom_theme_from: - type: string - description: Custom theme from - custom_theme_to: - type: string - description: Custom theme to - active: - type: boolean - description: Active - required: - - identifier - cms-data-page-search-results-interface: - type: object - description: Interface for cms page search results. - properties: - items: - type: array - description: Pages list. - items: - "$ref": "#/definitions/cms-data-page-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - cms-data-block-interface: - type: object - description: CMS block interface. - properties: - id: - type: integer - description: ID - identifier: - type: string - description: Identifier - title: - type: string - description: Title - content: - type: string - description: Content - creation_time: - type: string - description: Creation time - update_time: - type: string - description: Update time - active: - type: boolean - description: Active - required: - - identifier - cms-data-block-search-results-interface: - type: object - description: Interface for cms block search results. - properties: - items: - type: array - description: Blocks list. - items: - "$ref": "#/definitions/cms-data-block-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - catalog-data-product-interface: - type: object - description: '' - properties: - id: - type: integer - description: Id - sku: - type: string - description: Sku - name: - type: string - description: Name - attribute_set_id: - type: integer - description: Attribute set id - price: - type: number - description: Price - status: - type: integer - description: Status - visibility: - type: integer - description: Visibility - type_id: - type: string - description: Type id - created_at: - type: string - description: Created date - updated_at: - type: string - description: Updated date - weight: - type: number - description: Weight - extension_attributes: - "$ref": "#/definitions/catalog-data-product-extension-interface" - product_links: - type: array - description: Product links info - items: - "$ref": "#/definitions/catalog-data-product-link-interface" - options: - type: array - description: List of product options - items: - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - media_gallery_entries: - type: array - description: Media gallery entries - items: - "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" - tier_prices: - type: array - description: List of product tier prices - items: - "$ref": "#/definitions/catalog-data-product-tier-price-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - sku - catalog-data-product-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductInterface - properties: - website_ids: - type: array - items: - type: integer - category_links: - type: array - items: - "$ref": "#/definitions/catalog-data-category-link-interface" - stock_item: - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - discounts: - type: array - items: - "$ref": "#/definitions/sales-rule-data-rule-discount-interface" - bundle_product_options: - type: array - items: - "$ref": "#/definitions/bundle-data-option-interface" - downloadable_product_links: - type: array - items: - "$ref": "#/definitions/downloadable-data-link-interface" - downloadable_product_samples: - type: array - items: - "$ref": "#/definitions/downloadable-data-sample-interface" - giftcard_amounts: - type: array - items: - "$ref": "#/definitions/gift-card-data-giftcard-amount-interface" - configurable_product_options: - type: array - items: - "$ref": "#/definitions/configurable-product-data-option-interface" - configurable_product_links: - type: array - items: - type: integer - catalog-data-category-link-interface: - type: object - description: '' - properties: - position: - type: integer - category_id: - type: string - description: Category id - extension_attributes: - "$ref": "#/definitions/catalog-data-category-link-extension-interface" - required: - - category_id - catalog-data-category-link-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryLinkInterface - catalog-inventory-data-stock-item-interface: - type: object - description: Interface StockItem - properties: - item_id: - type: integer - product_id: - type: integer - stock_id: - type: integer - description: Stock identifier - qty: - type: number - is_in_stock: - type: boolean - description: Stock Availability - is_qty_decimal: - type: boolean - show_default_notification_message: - type: boolean - use_config_min_qty: - type: boolean - min_qty: - type: number - description: Minimal quantity available for item status in stock - use_config_min_sale_qty: - type: integer - min_sale_qty: - type: number - description: Minimum Qty Allowed in Shopping Cart or NULL when there is no - limitation - use_config_max_sale_qty: - type: boolean - max_sale_qty: - type: number - description: Maximum Qty Allowed in Shopping Cart data wrapper - use_config_backorders: - type: boolean - backorders: - type: integer - description: Backorders status - use_config_notify_stock_qty: - type: boolean - notify_stock_qty: - type: number - description: Notify for Quantity Below data wrapper - use_config_qty_increments: - type: boolean - qty_increments: - type: number - description: Quantity Increments data wrapper - use_config_enable_qty_inc: - type: boolean - enable_qty_increments: - type: boolean - description: Whether Quantity Increments is enabled - use_config_manage_stock: - type: boolean - manage_stock: - type: boolean - description: Can Manage Stock - low_stock_date: - type: string - is_decimal_divided: - type: boolean - stock_status_changed_auto: - type: integer - extension_attributes: - "$ref": "#/definitions/catalog-inventory-data-stock-item-extension-interface" - required: - - qty - - is_in_stock - - is_qty_decimal - - show_default_notification_message - - use_config_min_qty - - min_qty - - use_config_min_sale_qty - - min_sale_qty - - use_config_max_sale_qty - - max_sale_qty - - use_config_backorders - - backorders - - use_config_notify_stock_qty - - notify_stock_qty - - use_config_qty_increments - - qty_increments - - use_config_enable_qty_inc - - enable_qty_increments - - use_config_manage_stock - - manage_stock - - low_stock_date - - is_decimal_divided - - stock_status_changed_auto - catalog-inventory-data-stock-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockItemInterface - sales-rule-data-rule-discount-interface: - type: object - description: Rule discount Interface - properties: - discount_data: - "$ref": "#/definitions/sales-rule-data-discount-data-interface" - rule_label: - type: string - description: Rule Label - rule_i_d: - type: integer - description: Rule ID - required: - - discount_data - - rule_label - - rule_i_d - sales-rule-data-discount-data-interface: - type: object - description: Discount Data Interface - properties: - amount: - type: number - description: Amount - base_amount: - type: number - description: Base Amount - original_amount: - type: number - description: Original Amount - base_original_amount: - type: number - description: Base Original Amount - required: - - amount - - base_amount - - original_amount - - base_original_amount - bundle-data-option-interface: - type: object - description: Interface OptionInterface - properties: - option_id: - type: integer - description: Option id - title: - type: string - description: Option title - required: - type: boolean - description: Is required option - type: - type: string - description: Input type - position: - type: integer - description: Option position - sku: - type: string - description: Product sku - product_links: - type: array - description: Product links - items: - "$ref": "#/definitions/bundle-data-link-interface" - extension_attributes: - "$ref": "#/definitions/bundle-data-option-extension-interface" - bundle-data-link-interface: - type: object - description: Interface LinkInterface - properties: - id: - type: string - description: The identifier - sku: - type: string - description: Linked product sku - option_id: - type: integer - description: Option id - qty: - type: number - description: Qty - position: - type: integer - description: Position - is_default: - type: boolean - description: Is default - price: - type: number - description: Price - price_type: - type: integer - description: Price type - can_change_quantity: - type: integer - description: Whether quantity could be changed - extension_attributes: - "$ref": "#/definitions/bundle-data-link-extension-interface" - required: - - is_default - - price - - price_type - bundle-data-link-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\LinkInterface - bundle-data-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\OptionInterface - downloadable-data-link-interface: - type: object - description: '' - properties: - id: - type: integer - description: Sample(or link) id - title: - type: string - sort_order: - type: integer - is_shareable: - type: integer - description: Shareable status - price: - type: number - description: Price - number_of_downloads: - type: integer - description: Of downloads per user - link_type: - type: string - link_file: - type: string - description: relative file path - link_file_content: - "$ref": "#/definitions/downloadable-data-file-content-interface" - link_url: - type: string - description: Link url or null when type is 'file' - sample_type: - type: string - sample_file: - type: string - description: relative file path - sample_file_content: - "$ref": "#/definitions/downloadable-data-file-content-interface" - sample_url: - type: string - description: file URL - extension_attributes: - "$ref": "#/definitions/downloadable-data-link-extension-interface" - required: - - sort_order - - is_shareable - - price - - link_type - - sample_type - downloadable-data-file-content-interface: - type: object - description: '' - properties: - file_data: - type: string - description: Data (base64 encoded content) - name: - type: string - description: File name - extension_attributes: - "$ref": "#/definitions/downloadable-data-file-content-extension-interface" - required: - - file_data - - name - downloadable-data-file-content-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Downloadable\Api\Data\File\ContentInterface - downloadable-data-link-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Downloadable\Api\Data\LinkInterface - downloadable-data-sample-interface: - type: object - description: '' - properties: - id: - type: integer - description: Sample(or link) id - title: - type: string - description: Title - sort_order: - type: integer - description: Order index for sample - sample_type: - type: string - sample_file: - type: string - description: relative file path - sample_file_content: - "$ref": "#/definitions/downloadable-data-file-content-interface" - sample_url: - type: string - description: file URL - extension_attributes: - "$ref": "#/definitions/downloadable-data-sample-extension-interface" - required: - - title - - sort_order - - sample_type - downloadable-data-sample-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Downloadable\Api\Data\SampleInterface - gift-card-data-giftcard-amount-interface: - type: object - description: 'Interface GiftcardAmountInterface: this interface is used to serialize - and deserialize EAV attribute giftcard_amounts' - properties: - attribute_id: - type: integer - description: AttributeId - website_id: - type: integer - description: WebsiteId - value: - type: number - description: Value - website_value: - type: number - description: WebsiteValue - extension_attributes: - "$ref": "#/definitions/gift-card-data-giftcard-amount-extension-interface" - required: - - attribute_id - - website_id - - value - - website_value - gift-card-data-giftcard-amount-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftcardAmountInterface - configurable-product-data-option-interface: - type: object - description: Interface OptionInterface - properties: - id: - type: integer - attribute_id: - type: string - label: - type: string - position: - type: integer - is_use_default: - type: boolean - values: - type: array - items: - "$ref": "#/definitions/configurable-product-data-option-value-interface" - extension_attributes: - "$ref": "#/definitions/configurable-product-data-option-extension-interface" - product_id: - type: integer - configurable-product-data-option-value-interface: - type: object - description: Interface OptionValueInterface - properties: - value_index: - type: integer - extension_attributes: - "$ref": "#/definitions/configurable-product-data-option-value-extension-interface" - required: - - value_index - configurable-product-data-option-value-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\OptionValueInterface - configurable-product-data-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\OptionInterface - catalog-data-product-link-interface: - type: object - description: '' - properties: - sku: - type: string - description: SKU - link_type: - type: string - description: Link type - linked_product_sku: - type: string - description: Linked product sku - linked_product_type: - type: string - description: Linked product type (simple, virtual, etc) - position: - type: integer - description: Linked item position - extension_attributes: - "$ref": "#/definitions/catalog-data-product-link-extension-interface" - required: - - sku - - link_type - - linked_product_sku - - linked_product_type - - position - catalog-data-product-link-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductLinkInterface - properties: - qty: - type: number - catalog-data-product-custom-option-interface: - type: object - description: '' - properties: - product_sku: - type: string - description: Product SKU - option_id: - type: integer - description: Option id - title: - type: string - description: Option title - type: - type: string - description: Option type - sort_order: - type: integer - description: Sort order - is_require: - type: boolean - description: Is require - price: - type: number - description: Price - price_type: - type: string - description: Price type - sku: - type: string - description: Sku - file_extension: - type: string - description: File extension - max_characters: - type: integer - description: Max characters - image_size_x: - type: integer - description: Image x size - image_size_y: - type: integer - description: Image Y size - values: - type: array - description: Values - items: - "$ref": "#/definitions/catalog-data-product-custom-option-values-interface" - extension_attributes: - "$ref": "#/definitions/catalog-data-product-custom-option-extension-interface" - required: - - product_sku - - title - - type - - sort_order - - is_require - catalog-data-product-custom-option-values-interface: - type: object - description: '' - properties: - title: - type: string - description: Option title - sort_order: - type: integer - description: Sort order - price: - type: number - description: Price - price_type: - type: string - description: Price type - sku: - type: string - description: Sku - option_type_id: - type: integer - description: Option type id - required: - - title - - sort_order - - price - - price_type - catalog-data-product-custom-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductCustomOptionInterface - catalog-data-product-attribute-media-gallery-entry-interface: - type: object - description: '' - properties: - id: - type: integer - description: Gallery entry ID - media_type: - type: string - description: Media type - label: - type: string - description: Gallery entry alternative text - position: - type: integer - description: Gallery entry position (sort order) - disabled: - type: boolean - description: If gallery entry is hidden from product page - types: - type: array - description: Gallery entry image types (thumbnail, image, small_image etc) - items: - type: string - file: - type: string - description: File path - content: - "$ref": "#/definitions/framework-data-image-content-interface" - extension_attributes: - "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-extension-interface" - required: - - media_type - - label - - position - - disabled - - types - framework-data-image-content-interface: - type: object - description: Image Content data interface - properties: - base64_encoded_data: - type: string - description: Media data (base64 encoded content) - type: - type: string - description: MIME type - name: - type: string - description: Image name - required: - - base64_encoded_data - - type - - name - catalog-data-product-attribute-media-gallery-entry-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryInterface - properties: - video_content: - "$ref": "#/definitions/framework-data-video-content-interface" - framework-data-video-content-interface: - type: object - description: Video Content data interface - properties: - media_type: - type: string - description: MIME type - video_provider: - type: string - description: Provider - video_url: - type: string - description: Video URL - video_title: - type: string - description: Title - video_description: - type: string - description: Video Description - video_metadata: - type: string - description: Metadata - required: - - media_type - - video_provider - - video_url - - video_title - - video_description - - video_metadata - catalog-data-product-tier-price-interface: - type: object - description: '' - properties: - customer_group_id: - type: integer - description: Customer group id - qty: - type: number - description: Tier qty - value: - type: number - description: Price value - extension_attributes: - "$ref": "#/definitions/catalog-data-product-tier-price-extension-interface" - required: - - customer_group_id - - qty - - value - catalog-data-product-tier-price-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductTierPriceInterface - properties: - percentage_value: - type: number - website_id: - type: integer - catalog-data-product-search-results-interface: - type: object - description: '' - properties: - items: - type: array - description: Attributes list. - items: - "$ref": "#/definitions/catalog-data-product-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - catalog-data-product-attribute-type-interface: - type: object - description: '' - properties: - value: - type: string - description: Value - label: - type: string - description: Type label - extension_attributes: - "$ref": "#/definitions/catalog-data-product-attribute-type-extension-interface" - required: - - value - - label - catalog-data-product-attribute-type-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductAttributeTypeInterface - catalog-data-product-attribute-interface: - type: object - description: '' - properties: - extension_attributes: - "$ref": "#/definitions/eav-data-attribute-extension-interface" - is_wysiwyg_enabled: - type: boolean - description: WYSIWYG flag - is_html_allowed_on_front: - type: boolean - description: The HTML tags are allowed on the frontend - used_for_sort_by: - type: boolean - description: It is used for sorting in product listing - is_filterable: - type: boolean - description: It used in layered navigation - is_filterable_in_search: - type: boolean - description: It is used in search results layered navigation - is_used_in_grid: - type: boolean - description: It is used in catalog product grid - is_visible_in_grid: - type: boolean - description: It is visible in catalog product grid - is_filterable_in_grid: - type: boolean - description: It is filterable in catalog product grid - position: - type: integer - description: Position - apply_to: - type: array - description: Apply to value for the element - items: - type: string - is_searchable: - type: string - description: The attribute can be used in Quick Search - is_visible_in_advanced_search: - type: string - description: The attribute can be used in Advanced Search - is_comparable: - type: string - description: The attribute can be compared on the frontend - is_used_for_promo_rules: - type: string - description: The attribute can be used for promo rules - is_visible_on_front: - type: string - description: The attribute is visible on the frontend - used_in_product_listing: - type: string - description: The attribute can be used in product listing - is_visible: - type: boolean - description: Attribute is visible on frontend. - scope: - type: string - description: Attribute scope - attribute_id: - type: integer - description: Id of the attribute. - attribute_code: - type: string - description: Code of the attribute. - frontend_input: - type: string - description: HTML for input element. - entity_type_id: - type: string - description: Entity type id - is_required: - type: boolean - description: Attribute is required. - options: - type: array - description: Options of the attribute (key => value pairs for select) - items: - "$ref": "#/definitions/eav-data-attribute-option-interface" - is_user_defined: - type: boolean - description: Current attribute has been defined by a user. - default_frontend_label: - type: string - description: Frontend label for default store - frontend_labels: - type: array - description: Frontend label for each store - items: - "$ref": "#/definitions/eav-data-attribute-frontend-label-interface" - note: - type: string - description: The note attribute for the element. - backend_type: - type: string - description: Backend type. - backend_model: - type: string - description: Backend model - source_model: - type: string - description: Source model - default_value: - type: string - description: Default value for the element. - is_unique: - type: string - description: This is a unique attribute - frontend_class: - type: string - description: Frontend class of attribute - validation_rules: - type: array - description: Validation rules. - items: - "$ref": "#/definitions/eav-data-attribute-validation-rule-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - attribute_code - - frontend_input - - entity_type_id - - is_required - - frontend_labels - eav-data-attribute-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Eav\Api\Data\AttributeInterface - properties: - is_pagebuilder_enabled: - type: boolean - eav-data-attribute-option-interface: - type: object - description: 'Created from:' - properties: - label: - type: string - description: Option label - value: - type: string - description: Option value - sort_order: - type: integer - description: Option order - is_default: - type: boolean - description: Default - store_labels: - type: array - description: Option label for store scopes - items: - "$ref": "#/definitions/eav-data-attribute-option-label-interface" - required: - - label - - value - eav-data-attribute-option-label-interface: - type: object - description: Interface AttributeOptionLabelInterface - properties: - store_id: - type: integer - description: Store id - label: - type: string - description: Option label - eav-data-attribute-frontend-label-interface: - type: object - description: Interface AttributeFrontendLabelInterface - properties: - store_id: - type: integer - description: Store id - label: - type: string - description: Option label - eav-data-attribute-validation-rule-interface: - type: object - description: Interface AttributeValidationRuleInterface - properties: - key: - type: string - description: Object key - value: - type: string - description: Object value - required: - - key - - value - catalog-data-product-attribute-search-results-interface: - type: object - description: '' - properties: - items: - type: array - description: Attributes list. - items: - "$ref": "#/definitions/catalog-data-product-attribute-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - catalog-data-category-attribute-interface: - type: object - description: '' - properties: - is_wysiwyg_enabled: - type: boolean - description: WYSIWYG flag - is_html_allowed_on_front: - type: boolean - description: The HTML tags are allowed on the frontend - used_for_sort_by: - type: boolean - description: It is used for sorting in product listing - is_filterable: - type: boolean - description: It used in layered navigation - is_filterable_in_search: - type: boolean - description: It is used in search results layered navigation - is_used_in_grid: - type: boolean - description: It is used in catalog product grid - is_visible_in_grid: - type: boolean - description: It is visible in catalog product grid - is_filterable_in_grid: - type: boolean - description: It is filterable in catalog product grid - position: - type: integer - description: Position - apply_to: - type: array - description: Apply to value for the element - items: - type: string - is_searchable: - type: string - description: The attribute can be used in Quick Search - is_visible_in_advanced_search: - type: string - description: The attribute can be used in Advanced Search - is_comparable: - type: string - description: The attribute can be compared on the frontend - is_used_for_promo_rules: - type: string - description: The attribute can be used for promo rules - is_visible_on_front: - type: string - description: The attribute is visible on the frontend - used_in_product_listing: - type: string - description: The attribute can be used in product listing - is_visible: - type: boolean - description: Attribute is visible on frontend. - scope: - type: string - description: Attribute scope - extension_attributes: - "$ref": "#/definitions/catalog-data-eav-attribute-extension-interface" - attribute_id: - type: integer - description: Id of the attribute. - attribute_code: - type: string - description: Code of the attribute. - frontend_input: - type: string - description: HTML for input element. - entity_type_id: - type: string - description: Entity type id - is_required: - type: boolean - description: Attribute is required. - options: - type: array - description: Options of the attribute (key => value pairs for select) - items: - "$ref": "#/definitions/eav-data-attribute-option-interface" - is_user_defined: - type: boolean - description: Current attribute has been defined by a user. - default_frontend_label: - type: string - description: Frontend label for default store - frontend_labels: - type: array - description: Frontend label for each store - items: - "$ref": "#/definitions/eav-data-attribute-frontend-label-interface" - note: - type: string - description: The note attribute for the element. - backend_type: - type: string - description: Backend type. - backend_model: - type: string - description: Backend model - source_model: - type: string - description: Source model - default_value: - type: string - description: Default value for the element. - is_unique: - type: string - description: This is a unique attribute - frontend_class: - type: string - description: Frontend class of attribute - validation_rules: - type: array - description: Validation rules. - items: - "$ref": "#/definitions/eav-data-attribute-validation-rule-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - attribute_code - - frontend_input - - entity_type_id - - is_required - - frontend_labels - catalog-data-eav-attribute-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\EavAttributeInterface - catalog-data-category-attribute-search-results-interface: - type: object - description: '' - properties: - items: - type: array - description: Attributes list. - items: - "$ref": "#/definitions/catalog-data-category-attribute-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - catalog-data-product-type-interface: - type: object - description: Product type details - properties: - name: - type: string - description: Product type code - label: - type: string - description: Product type label - extension_attributes: - "$ref": "#/definitions/catalog-data-product-type-extension-interface" - required: - - name - - label - catalog-data-product-type-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductTypeInterface - eav-data-attribute-group-search-results-interface: - type: object - description: Interface AttributeGroupSearchResultsInterface - properties: - items: - type: array - description: Attribute sets list. - items: - "$ref": "#/definitions/eav-data-attribute-group-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - eav-data-attribute-group-interface: - type: object - description: Interface AttributeGroupInterface - properties: - attribute_group_id: - type: string - description: Id - attribute_group_name: - type: string - description: Name - attribute_set_id: - type: integer - description: Attribute set id - extension_attributes: - "$ref": "#/definitions/eav-data-attribute-group-extension-interface" - eav-data-attribute-group-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Eav\Api\Data\AttributeGroupInterface - properties: - attribute_group_code: - type: string - sort_order: - type: string - catalog-data-tier-price-interface: - type: object - description: Tier price interface. - properties: - price: - type: number - description: Tier price. - price_type: - type: string - description: Tier price type. - website_id: - type: integer - description: Website id. - sku: - type: string - description: SKU. - customer_group: - type: string - description: Customer group. - quantity: - type: number - description: Quantity. - extension_attributes: - "$ref": "#/definitions/catalog-data-tier-price-extension-interface" - required: - - price - - price_type - - website_id - - sku - - customer_group - - quantity - catalog-data-tier-price-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\TierPriceInterface - catalog-data-price-update-result-interface: - type: object - description: Interface returned in case of incorrect price passed to efficient - price API. - properties: - message: - type: string - description: Error message, that contains description of error occurred during - price update. - parameters: - type: array - description: Parameters, that could be displayed in error message placeholders. - items: - type: string - extension_attributes: - "$ref": "#/definitions/catalog-data-price-update-result-extension-interface" - required: - - message - - parameters - catalog-data-price-update-result-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\PriceUpdateResultInterface - catalog-data-base-price-interface: - type: object - description: Price interface. - properties: - price: - type: number - description: Price. - store_id: - type: integer - description: Store id. - sku: - type: string - description: SKU. - extension_attributes: - "$ref": "#/definitions/catalog-data-base-price-extension-interface" - required: - - price - - store_id - - sku - catalog-data-base-price-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\BasePriceInterface - catalog-data-cost-interface: - type: object - description: Cost interface. - properties: - cost: - type: number - description: Cost value. - store_id: - type: integer - description: Store id. - sku: - type: string - description: SKU. - extension_attributes: - "$ref": "#/definitions/catalog-data-cost-extension-interface" - required: - - cost - - store_id - - sku - catalog-data-cost-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CostInterface - catalog-data-special-price-interface: - type: object - description: Product Special Price Interface is used to encapsulate data that - can be processed by efficient price API. - properties: - price: - type: number - description: Product special price value. - store_id: - type: integer - description: ID of store, that contains special price value. - sku: - type: string - description: SKU of product, that contains special price value. - price_from: - type: string - description: Start date for special price in Y-m-d H:i:s format. - price_to: - type: string - description: End date for special price in Y-m-d H:i:s format. - extension_attributes: - "$ref": "#/definitions/catalog-data-special-price-extension-interface" - required: - - price - - store_id - - sku - - price_from - - price_to - catalog-data-special-price-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\SpecialPriceInterface - catalog-data-category-interface: - type: object - description: Category data interface. - properties: - id: - type: integer - description: Category id. - parent_id: - type: integer - description: Parent category ID - name: - type: string - description: Category name - is_active: - type: boolean - description: Whether category is active - position: - type: integer - description: Category position - level: - type: integer - description: Category level - children: - type: string - description: Children ids comma separated. - created_at: - type: string - description: Category creation date and time. - updated_at: - type: string - description: Category last update date and time. - path: - type: string - description: Category full path. - available_sort_by: - type: array - description: Available sort by for category. - items: - type: string - include_in_menu: - type: boolean - description: Category is included in menu. - extension_attributes: - "$ref": "#/definitions/catalog-data-category-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - catalog-data-category-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryInterface - catalog-data-category-tree-interface: - type: object - description: '' - properties: - id: - type: integer - description: Id - parent_id: - type: integer - description: Parent category ID - name: - type: string - description: Category name - is_active: - type: boolean - description: Whether category is active - position: - type: integer - description: Category position - level: - type: integer - description: Category level - product_count: - type: integer - description: Product count - children_data: - type: array - description: Children Data - items: - "$ref": "#/definitions/catalog-data-category-tree-interface" - required: - - parent_id - - name - - is_active - - position - - level - - product_count - - children_data - catalog-data-category-search-results-interface: - type: object - description: '' - properties: - items: - type: array - description: Categories - items: - "$ref": "#/definitions/catalog-data-category-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - catalog-data-product-custom-option-type-interface: - type: object - description: '' - properties: - label: - type: string - description: Option type label - code: - type: string - description: Option type code - group: - type: string - description: Option type group - extension_attributes: - "$ref": "#/definitions/catalog-data-product-custom-option-type-extension-interface" - required: - - label - - code - - group - catalog-data-product-custom-option-type-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductCustomOptionTypeInterface - catalog-data-product-link-type-interface: - type: object - description: '' - properties: - code: - type: integer - description: Link type code - name: - type: string - description: Link type name - extension_attributes: - "$ref": "#/definitions/catalog-data-product-link-type-extension-interface" - required: - - code - - name - catalog-data-product-link-type-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductLinkTypeInterface - catalog-data-product-link-attribute-interface: - type: object - description: '' - properties: - code: - type: string - description: Attribute code - type: - type: string - description: Attribute type - extension_attributes: - "$ref": "#/definitions/catalog-data-product-link-attribute-extension-interface" - required: - - code - - type - catalog-data-product-link-attribute-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductLinkAttributeInterface - catalog-data-category-product-link-interface: - type: object - description: '' - properties: - sku: - type: string - position: - type: integer - category_id: - type: string - description: Category id - extension_attributes: - "$ref": "#/definitions/catalog-data-category-product-link-extension-interface" - required: - - category_id - catalog-data-category-product-link-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryProductLinkInterface - catalog-data-product-website-link-interface: - type: object - description: '' - properties: - sku: - type: string - website_id: - type: integer - description: Website ids - required: - - sku - - website_id - catalog-data-product-render-search-results-interface: - type: object - description: Dto that holds render information about products - properties: - items: - type: array - description: List of products rendered information - items: - "$ref": "#/definitions/catalog-data-product-render-interface" - required: - - items - catalog-data-product-render-interface: - type: object - description: Represents Data Object which holds enough information to render product - This information is put into part as Add To Cart or Add to Compare Data or Price - Data - properties: - add_to_cart_button: - "$ref": "#/definitions/catalog-data-product-render-button-interface" - add_to_compare_button: - "$ref": "#/definitions/catalog-data-product-render-button-interface" - price_info: - "$ref": "#/definitions/catalog-data-product-render-price-info-interface" - images: - type: array - description: Enough information, that needed to render image on front - items: - "$ref": "#/definitions/catalog-data-product-render-image-interface" - url: - type: string - description: Product url - id: - type: integer - description: Product identifier - name: - type: string - description: Product name - type: - type: string - description: Product type. Such as bundle, grouped, simple, etc... - is_salable: - type: string - description: Information about product saleability (In Stock) - store_id: - type: integer - description: Information about current store id or requested store id - currency_code: - type: string - description: Current or desired currency code to product - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-extension-interface" - required: - - add_to_cart_button - - add_to_compare_button - - price_info - - images - - url - - id - - name - - type - - is_salable - - store_id - - currency_code - - extension_attributes - catalog-data-product-render-button-interface: - type: object - description: 'Button interface. This interface represents all manner of product - buttons: add to cart, add to compare, etc... The buttons describes by this interface - should have interaction with backend' - properties: - post_data: - type: string - description: Post data - url: - type: string - description: Url, needed to add product to cart - required_options: - type: boolean - description: Flag whether a product has options or not - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-button-extension-interface" - required: - - post_data - - url - - required_options - catalog-data-product-render-button-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface - catalog-data-product-render-price-info-interface: - type: object - description: Price interface. - properties: - final_price: - type: number - description: Final price - max_price: - type: number - description: Max price of a product - max_regular_price: - type: number - description: Max regular price - minimal_regular_price: - type: number - description: Minimal regular price - special_price: - type: number - description: Special price - minimal_price: - type: number - description: Minimal price - regular_price: - type: number - description: Regular price - formatted_prices: - "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-interface" - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-price-info-extension-interface" - required: - - final_price - - max_price - - max_regular_price - - minimal_regular_price - - special_price - - minimal_price - - regular_price - - formatted_prices - catalog-data-product-render-formatted-price-info-interface: - type: object - description: 'Formatted Price interface. Aggregate formatted html with price representations. - E.g.: $9.00 Consider currency, rounding and html' - properties: - final_price: - type: string - description: Html with final price - max_price: - type: string - description: Max price of a product - minimal_price: - type: string - description: The minimal price of the product or variation - max_regular_price: - type: string - description: Max regular price - minimal_regular_price: - type: string - description: Minimal regular price - special_price: - type: string - description: Special price - regular_price: - type: string - description: Price - is price of product without discounts and special price - with taxes and fixed product tax - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-extension-interface" - required: - - final_price - - max_price - - minimal_price - - max_regular_price - - minimal_regular_price - - special_price - - regular_price - catalog-data-product-render-formatted-price-info-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\FormattedPriceInfoInterface - catalog-data-product-render-price-info-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface - properties: - msrp: - "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-interface" - tax_adjustments: - "$ref": "#/definitions/catalog-data-product-render-price-info-interface" - weee_attributes: - type: array - items: - "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-interface" - weee_adjustment: - type: string - msrp-data-product-render-msrp-price-info-interface: - type: object - description: Price interface. - properties: - msrp_price: - type: string - is_applicable: - type: string - is_shown_price_on_gesture: - type: string - msrp_message: - type: string - explanation_message: - type: string - extension_attributes: - "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-extension-interface" - required: - - msrp_price - - is_applicable - - is_shown_price_on_gesture - - msrp_message - - explanation_message - msrp-data-product-render-msrp-price-info-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface - weee-data-product-render-weee-adjustment-attribute-interface: - type: object - description: List of all weee attributes, their amounts, etc.., that product has - properties: - amount: - type: string - description: Weee attribute amount - tax_amount: - type: string - description: Tax which is calculated to fixed product tax attribute - tax_amount_incl_tax: - type: string - description: Tax amount of weee attribute - amount_excl_tax: - type: string - description: Product amount exclude tax - attribute_code: - type: string - description: Weee attribute code - extension_attributes: - "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface" - required: - - amount - - tax_amount - - tax_amount_incl_tax - - amount_excl_tax - - attribute_code - - extension_attributes - weee-data-product-render-weee-adjustment-attribute-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Weee\Api\Data\ProductRender\WeeeAdjustmentAttributeInterface - catalog-data-product-render-image-interface: - type: object - description: Product Render image interface. Represents physical characteristics - of image, that can be used in product listing or product view - properties: - url: - type: string - description: Image url - code: - type: string - description: Image code - height: - type: number - description: Image height - width: - type: number - description: Image width in px - label: - type: string - description: Image label - resized_width: - type: number - description: Resize width - resized_height: - type: number - description: Resize height - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-image-extension-interface" - required: - - url - - code - - height - - width - - label - - resized_width - - resized_height - catalog-data-product-render-image-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ImageInterface - catalog-data-product-render-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRenderInterface - properties: - wishlist_button: - "$ref": "#/definitions/catalog-data-product-render-button-interface" - review_html: - type: string - quote-data-cart-interface: - type: object - description: Interface CartInterface - properties: - id: - type: integer - description: Cart/quote ID. - created_at: - type: string - description: Cart creation date and time. Otherwise, null. - updated_at: - type: string - description: Cart last update date and time. Otherwise, null. - converted_at: - type: string - description: Cart conversion date and time. Otherwise, null. - is_active: - type: boolean - description: Active status flag value. Otherwise, null. - is_virtual: - type: boolean - description: Virtual flag value. Otherwise, null. - items: - type: array - description: Array of items. Otherwise, null. - items: - "$ref": "#/definitions/quote-data-cart-item-interface" - items_count: - type: integer - description: Number of different items or products in the cart. Otherwise, - null. - items_qty: - type: number - description: Total quantity of all cart items. Otherwise, null. - customer: - "$ref": "#/definitions/customer-data-customer-interface" - billing_address: - "$ref": "#/definitions/quote-data-address-interface" - reserved_order_id: - type: string - description: Reserved order ID. Otherwise, null. - orig_order_id: - type: integer - description: Original order ID. Otherwise, null. - currency: - "$ref": "#/definitions/quote-data-currency-interface" - customer_is_guest: - type: boolean - description: For guest customers, false for logged in customers - customer_note: - type: string - description: Notice text - customer_note_notify: - type: boolean - description: Customer notification flag - customer_tax_class_id: - type: integer - description: Customer tax class ID. - store_id: - type: integer - description: Store identifier - extension_attributes: - "$ref": "#/definitions/quote-data-cart-extension-interface" - required: - - id - - customer - - store_id - quote-data-cart-item-interface: - type: object - description: Interface CartItemInterface - properties: - item_id: - type: integer - description: Item ID. Otherwise, null. - sku: - type: string - description: Product SKU. Otherwise, null. - qty: - type: number - description: Product quantity. - name: - type: string - description: Product name. Otherwise, null. - price: - type: number - description: Product price. Otherwise, null. - product_type: - type: string - description: Product type. Otherwise, null. - quote_id: - type: string - description: Quote id. - product_option: - "$ref": "#/definitions/quote-data-product-option-interface" - extension_attributes: - "$ref": "#/definitions/quote-data-cart-item-extension-interface" - required: - - qty - - quote_id - quote-data-product-option-interface: - type: object - description: Product option interface - properties: - extension_attributes: - "$ref": "#/definitions/quote-data-product-option-extension-interface" - quote-data-product-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface - properties: - custom_options: - type: array - items: - "$ref": "#/definitions/catalog-data-custom-option-interface" - bundle_options: - type: array - items: - "$ref": "#/definitions/bundle-data-bundle-option-interface" - downloadable_option: - "$ref": "#/definitions/downloadable-data-downloadable-option-interface" - giftcard_item_option: - "$ref": "#/definitions/gift-card-data-gift-card-option-interface" - configurable_item_options: - type: array - items: - "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-interface" - grouped_options: - type: array - items: - "$ref": "#/definitions/grouped-product-data-grouped-options-interface" - catalog-data-custom-option-interface: - type: object - description: Interface CustomOptionInterface - properties: - option_id: - type: string - description: Option id - option_value: - type: string - description: Option value - extension_attributes: - "$ref": "#/definitions/catalog-data-custom-option-extension-interface" - required: - - option_id - - option_value - catalog-data-custom-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface - properties: - file_info: - "$ref": "#/definitions/framework-data-image-content-interface" - bundle-data-bundle-option-interface: - type: object - description: Interface BundleOptionInterface - properties: - option_id: - type: integer - description: Bundle option id. - option_qty: - type: integer - description: Bundle option quantity. - option_selections: - type: array - description: Bundle option selection ids. - items: - type: integer - extension_attributes: - "$ref": "#/definitions/bundle-data-bundle-option-extension-interface" - required: - - option_id - - option_qty - - option_selections - bundle-data-bundle-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface - downloadable-data-downloadable-option-interface: - type: object - description: Downloadable Option - properties: - downloadable_links: - type: array - description: The list of downloadable links - items: - type: integer - required: - - downloadable_links - gift-card-data-gift-card-option-interface: - type: object - description: Interface GiftCardOptionInterface - properties: - giftcard_amount: - type: string - description: Gift card amount. - custom_giftcard_amount: - type: number - description: Gift card open amount value. - giftcard_sender_name: - type: string - description: Gift card sender name. - giftcard_recipient_name: - type: string - description: Gift card recipient name. - giftcard_sender_email: - type: string - description: Gift card sender email. - giftcard_recipient_email: - type: string - description: Gift card recipient email. - giftcard_message: - type: string - description: Giftcard message. - extension_attributes: - "$ref": "#/definitions/gift-card-data-gift-card-option-extension-interface" - required: - - giftcard_amount - - giftcard_sender_name - - giftcard_recipient_name - - giftcard_sender_email - - giftcard_recipient_email - gift-card-data-gift-card-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface - properties: - giftcard_created_codes: - type: array - items: - type: string - configurable-product-data-configurable-item-option-value-interface: - type: object - description: Interface ConfigurableItemOptionValueInterface - properties: - option_id: - type: string - description: Option SKU - option_value: - type: integer - description: Item id - extension_attributes: - "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-extension-interface" - required: - - option_id - configurable-product-data-configurable-item-option-value-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface - grouped-product-data-grouped-options-interface: - type: object - description: Represents `product item id with qty` of a grouped product. - properties: - id: - type: integer - description: Associated product id - qty: - type: integer - description: Associated product qty - extension_attributes: - "$ref": "#/definitions/grouped-product-data-grouped-options-extension-interface" - grouped-product-data-grouped-options-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface - quote-data-cart-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface - properties: - discounts: - type: array - items: - "$ref": "#/definitions/sales-rule-data-rule-discount-interface" - negotiable_quote_item: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-interface" - negotiable-quote-data-negotiable-quote-item-interface: - type: object - description: Interface CompanyQuoteConfigInterface - properties: - item_id: - type: integer - description: Quote item id - original_price: - type: number - description: Quote item original price - original_tax_amount: - type: number - description: Quote item original tax amount - original_discount_amount: - type: number - description: Quote item original discount amount - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-extension-interface" - required: - - item_id - - original_price - - original_tax_amount - - original_discount_amount - negotiable-quote-data-negotiable-quote-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface - properties: - negotiated_price_type: - type: integer - negotiated_price_value: - type: number - last_item_notes: - type: array - items: - "$ref": "#/definitions/negotiable-quote-data-item-note-interface" - is_discounting_locked: - type: boolean - min_qty: - type: number - max_qty: - type: number - negotiable-quote-data-item-note-interface: - type: object - description: Interface ItemNoteInterface - properties: - note_id: - type: integer - description: Note ID. - negotiable_quote_item_id: - type: integer - description: Negotiable quote item Id - creator_type: - type: integer - description: The note creator type. - creator_id: - type: integer - description: Note creator ID. - note: - type: string - description: Note. - created_at: - type: string - description: Comment created at. - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-item-note-extension-interface" - required: - - negotiable_quote_item_id - - creator_type - - creator_id - - note - negotiable-quote-data-item-note-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\ItemNoteInterface - quote-data-address-interface: - type: object - description: Interface AddressInterface - properties: - id: - type: integer - description: Id - region: - type: string - description: Region name - region_id: - type: integer - description: Region id - region_code: - type: string - description: Region code - country_id: - type: string - description: Country id - street: - type: array - description: Street - items: - type: string - company: - type: string - description: Company - telephone: - type: string - description: Telephone number - fax: - type: string - description: Fax number - postcode: - type: string - description: Postcode - city: - type: string - description: City name - firstname: - type: string - description: First name - lastname: - type: string - description: Last name - middlename: - type: string - description: Middle name - prefix: - type: string - description: Prefix - suffix: - type: string - description: Suffix - vat_id: - type: string - description: Vat id - customer_id: - type: integer - description: Customer id - email: - type: string - description: Billing/shipping email - same_as_billing: - type: integer - description: Same as billing flag - customer_address_id: - type: integer - description: Customer address id - save_in_address_book: - type: integer - description: Save in address book flag - extension_attributes: - "$ref": "#/definitions/quote-data-address-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - region - - region_id - - region_code - - country_id - - street - - telephone - - postcode - - city - - firstname - - lastname - - email - quote-data-address-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface - properties: - discounts: - type: array - items: - "$ref": "#/definitions/sales-rule-data-rule-discount-interface" - gift_registry_id: - type: integer - pickup_location_code: - type: string - quote-data-currency-interface: - type: object - description: Interface CurrencyInterface - properties: - global_currency_code: - type: string - description: Global currency code - base_currency_code: - type: string - description: Base currency code - store_currency_code: - type: string - description: Store currency code - quote_currency_code: - type: string - description: Quote currency code - store_to_base_rate: - type: number - description: Store currency to base currency rate - store_to_quote_rate: - type: number - description: Store currency to quote currency rate - base_to_global_rate: - type: number - description: Base currency to global currency rate - base_to_quote_rate: - type: number - description: Base currency to quote currency rate - extension_attributes: - "$ref": "#/definitions/quote-data-currency-extension-interface" - quote-data-currency-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface - quote-data-cart-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface - properties: - shipping_assignments: - type: array - items: - "$ref": "#/definitions/quote-data-shipping-assignment-interface" - negotiable_quote: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-interface" - company_id: - type: integer - coupon_codes: - type: array - items: - type: string - quote-data-shipping-assignment-interface: - type: object - description: Interface ShippingAssignmentInterface - properties: - shipping: - "$ref": "#/definitions/quote-data-shipping-interface" - items: - type: array - items: - "$ref": "#/definitions/quote-data-cart-item-interface" - extension_attributes: - "$ref": "#/definitions/quote-data-shipping-assignment-extension-interface" - required: - - shipping - - items - quote-data-shipping-interface: - type: object - description: Interface ShippingInterface - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - method: - type: string - description: Shipping method - extension_attributes: - "$ref": "#/definitions/quote-data-shipping-extension-interface" - required: - - address - - method - quote-data-shipping-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface - quote-data-shipping-assignment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface - negotiable-quote-data-negotiable-quote-interface: - type: object - description: Interface NegotiableQuoteInterface - properties: - quote_id: - type: integer - description: Negotiable quote ID. - is_regular_quote: - type: boolean - description: Is regular quote. - status: - type: string - description: Negotiable quote status. - negotiated_price_type: - type: integer - description: Negotiated price type. - negotiated_price_value: - type: number - description: Negotiated price value. - shipping_price: - type: number - description: Proposed shipping price. - quote_name: - type: string - description: Negotiable quote name. - expiration_period: - type: string - description: Expiration period. - email_notification_status: - type: integer - description: Email notification status. - has_unconfirmed_changes: - type: boolean - description: Has unconfirmed changes. - is_shipping_tax_changed: - type: boolean - description: Shipping tax changes. - is_customer_price_changed: - type: boolean - description: Customer price changes. - notifications: - type: integer - description: Quote notifications. - applied_rule_ids: - type: string - description: Quote rules. - is_address_draft: - type: boolean - description: Is address draft. - deleted_sku: - type: string - description: Deleted products sku. - creator_id: - type: integer - description: Quote creator id. - creator_type: - type: integer - description: Quote creator type. - original_total_price: - type: number - description: Quote original total price. - base_original_total_price: - type: number - description: Quote original total price in base currency. - negotiated_total_price: - type: number - description: Quote negotiated total price. - base_negotiated_total_price: - type: number - description: Quote negotiated total price in base currency. - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-extension-interface" - required: - - quote_id - - is_regular_quote - - status - - negotiated_price_type - - negotiated_price_value - - shipping_price - - quote_name - - expiration_period - - email_notification_status - - has_unconfirmed_changes - - is_shipping_tax_changed - - is_customer_price_changed - - notifications - - applied_rule_ids - - is_address_draft - - deleted_sku - - creator_id - - creator_type - negotiable-quote-data-negotiable-quote-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface - quote-data-cart-search-results-interface: - type: object - description: Interface CartSearchResultsInterface - properties: - items: - type: array - description: Carts list. - items: - "$ref": "#/definitions/quote-data-cart-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - quote-data-payment-interface: - type: object - description: Interface PaymentInterface - properties: - po_number: - type: string - description: Purchase order number - method: - type: string - description: Payment method code - additional_data: - type: array - description: Payment additional details - items: - type: string - extension_attributes: - "$ref": "#/definitions/quote-data-payment-extension-interface" - required: - - method - quote-data-payment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface - properties: - agreement_ids: - type: array - items: - type: string - quote-data-shipping-method-interface: - type: object - description: Interface ShippingMethodInterface - properties: - carrier_code: - type: string - description: Shipping carrier code. - method_code: - type: string - description: Shipping method code. - carrier_title: - type: string - description: Shipping carrier title. Otherwise, null. - method_title: - type: string - description: Shipping method title. Otherwise, null. - amount: - type: number - description: Shipping amount in store currency. - base_amount: - type: number - description: Shipping amount in base currency. - available: - type: boolean - description: The value of the availability flag for the current shipping method. - extension_attributes: - "$ref": "#/definitions/quote-data-shipping-method-extension-interface" - error_message: - type: string - description: Shipping Error message. - price_excl_tax: - type: number - description: Shipping price excl tax. - price_incl_tax: - type: number - description: Shipping price incl tax. - required: - - carrier_code - - method_code - - amount - - base_amount - - available - - error_message - - price_excl_tax - - price_incl_tax - quote-data-shipping-method-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface - quote-data-payment-method-interface: - type: object - description: Interface PaymentMethodInterface - properties: - code: - type: string - description: Payment method code - title: - type: string - description: Payment method title - required: - - code - - title - quote-data-totals-interface: - type: object - description: Interface TotalsInterface - properties: - grand_total: - type: number - description: Grand total in quote currency - base_grand_total: - type: number - description: Grand total in base currency - subtotal: - type: number - description: Subtotal in quote currency - base_subtotal: - type: number - description: Subtotal in base currency - discount_amount: - type: number - description: Discount amount in quote currency - base_discount_amount: - type: number - description: Discount amount in base currency - subtotal_with_discount: - type: number - description: Subtotal in quote currency with applied discount - base_subtotal_with_discount: - type: number - description: Subtotal in base currency with applied discount - shipping_amount: - type: number - description: Shipping amount in quote currency - base_shipping_amount: - type: number - description: Shipping amount in base currency - shipping_discount_amount: - type: number - description: Shipping discount amount in quote currency - base_shipping_discount_amount: - type: number - description: Shipping discount amount in base currency - tax_amount: - type: number - description: Tax amount in quote currency - base_tax_amount: - type: number - description: Tax amount in base currency - weee_tax_applied_amount: - type: number - description: Item weee tax applied amount in quote currency. - shipping_tax_amount: - type: number - description: Shipping tax amount in quote currency - base_shipping_tax_amount: - type: number - description: Shipping tax amount in base currency - subtotal_incl_tax: - type: number - description: Subtotal including tax in quote currency - base_subtotal_incl_tax: - type: number - description: Subtotal including tax in base currency - shipping_incl_tax: - type: number - description: Shipping including tax in quote currency - base_shipping_incl_tax: - type: number - description: Shipping including tax in base currency - base_currency_code: - type: string - description: Base currency code - quote_currency_code: - type: string - description: Quote currency code - coupon_code: - type: string - description: Applied coupon code - items_qty: - type: integer - description: Items qty - items: - type: array - description: Totals by items - items: - "$ref": "#/definitions/quote-data-totals-item-interface" - total_segments: - type: array - description: Dynamically calculated totals - items: - "$ref": "#/definitions/quote-data-total-segment-interface" - extension_attributes: - "$ref": "#/definitions/quote-data-totals-extension-interface" - required: - - weee_tax_applied_amount - - total_segments - quote-data-totals-item-interface: - type: object - description: Interface TotalsItemInterface - properties: - item_id: - type: integer - description: Item id - price: - type: number - description: Item price in quote currency. - base_price: - type: number - description: Item price in base currency. - qty: - type: number - description: Item quantity. - row_total: - type: number - description: Row total in quote currency. - base_row_total: - type: number - description: Row total in base currency. - row_total_with_discount: - type: number - description: Row total with discount in quote currency. Otherwise, null. - tax_amount: - type: number - description: Tax amount in quote currency. Otherwise, null. - base_tax_amount: - type: number - description: Tax amount in base currency. Otherwise, null. - tax_percent: - type: number - description: Tax percent. Otherwise, null. - discount_amount: - type: number - description: Discount amount in quote currency. Otherwise, null. - base_discount_amount: - type: number - description: Discount amount in base currency. Otherwise, null. - discount_percent: - type: number - description: Discount percent. Otherwise, null. - price_incl_tax: - type: number - description: Price including tax in quote currency. Otherwise, null. - base_price_incl_tax: - type: number - description: Price including tax in base currency. Otherwise, null. - row_total_incl_tax: - type: number - description: Row total including tax in quote currency. Otherwise, null. - base_row_total_incl_tax: - type: number - description: Row total including tax in base currency. Otherwise, null. - options: - type: string - description: Item price in quote currency. - weee_tax_applied_amount: - type: number - description: Item weee tax applied amount in quote currency. - weee_tax_applied: - type: string - description: Item weee tax applied in quote currency. - extension_attributes: - "$ref": "#/definitions/quote-data-totals-item-extension-interface" - name: - type: string - description: Product name. Otherwise, null. - required: - - item_id - - price - - base_price - - qty - - row_total - - base_row_total - - options - - weee_tax_applied_amount - - weee_tax_applied - quote-data-totals-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface - properties: - negotiable_quote_item_totals: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface" - negotiable-quote-data-negotiable-quote-item-totals-interface: - type: object - description: Extension attribute for quote item totals model. - properties: - cost: - type: number - description: Cost for quote item. - catalog_price: - type: number - description: Catalog price for quote item. - base_catalog_price: - type: number - description: Catalog price for quote item in base currency. - catalog_price_incl_tax: - type: number - description: Catalog price with included tax for quote item. - base_catalog_price_incl_tax: - type: number - description: Catalog price with included tax for quote item in base currency. - cart_price: - type: number - description: Cart price for quote item. - base_cart_price: - type: number - description: Cart price for quote item in base currency. - cart_tax: - type: number - description: Tax from catalog price for quote item. - base_cart_tax: - type: number - description: Tax from catalog price for quote item in base currency. - cart_price_incl_tax: - type: number - description: Cart price with included tax for quote item. - base_cart_price_incl_tax: - type: number - description: Cart price with included tax for quote item in base currency. - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface" - required: - - cost - - catalog_price - - base_catalog_price - - catalog_price_incl_tax - - base_catalog_price_incl_tax - - cart_price - - base_cart_price - - cart_tax - - base_cart_tax - - cart_price_incl_tax - - base_cart_price_incl_tax - negotiable-quote-data-negotiable-quote-item-totals-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface - quote-data-total-segment-interface: - type: object - description: Interface TotalsInterface - properties: - code: - type: string - description: Code - title: - type: string - description: Total title - value: - type: number - description: Total value - area: - type: string - description: Display area code. - extension_attributes: - "$ref": "#/definitions/quote-data-total-segment-extension-interface" - required: - - code - - value - quote-data-total-segment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface - properties: - tax_grandtotal_details: - type: array - items: - "$ref": "#/definitions/tax-data-grand-total-details-interface" - gift_cards: - type: string - gw_order_id: - type: string - gw_item_ids: - type: array - items: - type: string - gw_allow_gift_receipt: - type: string - gw_add_card: - type: string - gw_price: - type: string - gw_base_price: - type: string - gw_items_price: - type: string - gw_items_base_price: - type: string - gw_card_price: - type: string - gw_card_base_price: - type: string - gw_base_tax_amount: - type: string - gw_tax_amount: - type: string - gw_items_base_tax_amount: - type: string - gw_items_tax_amount: - type: string - gw_card_base_tax_amount: - type: string - gw_card_tax_amount: - type: string - gw_price_incl_tax: - type: string - gw_base_price_incl_tax: - type: string - gw_card_price_incl_tax: - type: string - gw_card_base_price_incl_tax: - type: string - gw_items_price_incl_tax: - type: string - gw_items_base_price_incl_tax: - type: string - tax-data-grand-total-details-interface: - type: object - description: Interface GrandTotalDetailsInterface - properties: - amount: - type: number - description: Tax amount value - rates: - type: array - description: Tax rates info - items: - "$ref": "#/definitions/tax-data-grand-total-rates-interface" - group_id: - type: integer - description: Group identifier - required: - - amount - - rates - - group_id - tax-data-grand-total-rates-interface: - type: object - description: Interface GrandTotalRatesInterface - properties: - percent: - type: string - description: Tax percentage value - title: - type: string - description: Rate title - required: - - percent - - title - quote-data-totals-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface - properties: - coupon_label: - type: string - negotiable_quote_totals: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-totals-interface" - base_customer_balance_amount: - type: number - customer_balance_amount: - type: number - coupon_codes: - type: array - items: - type: string - coupons_labels: - type: array - items: - type: string - reward_points_balance: - type: number - reward_currency_amount: - type: number - base_reward_currency_amount: - type: number - negotiable-quote-data-negotiable-quote-totals-interface: - type: object - description: Extension attribute for quote totals model. - properties: - items_count: - type: integer - description: The number of different items or products in the cart. - quote_status: - type: string - description: Negotiable quote status. - created_at: - type: string - description: The cart creation date and time. - updated_at: - type: string - description: The cart last update date and time. - customer_group: - type: integer - description: Customer group id. - base_to_quote_rate: - type: number - description: Base currency to quote currency rate. - cost_total: - type: number - description: Total cost for quote. - base_cost_total: - type: number - description: Total cost for quote in base currency. - original_total: - type: number - description: Original quote total. - base_original_total: - type: number - description: Original quote total in base currency. - original_tax: - type: number - description: Original tax amount for quote. - base_original_tax: - type: number - description: Original tax amount for quote in base currency. - original_price_incl_tax: - type: number - description: Original price with included tax for quote. - base_original_price_incl_tax: - type: number - description: Original price with included tax for quote in base currency. - negotiated_price_type: - type: integer - description: Negotiable quote type. - negotiated_price_value: - type: number - description: Negotiable price value for quote. - required: - - items_count - - quote_status - - created_at - - updated_at - - customer_group - - base_to_quote_rate - - cost_total - - base_cost_total - - original_total - - base_original_total - - original_tax - - base_original_tax - - original_price_incl_tax - - base_original_price_incl_tax - - negotiated_price_type - - negotiated_price_value - quote-data-totals-additional-data-interface: - type: object - description: Additional data for totals collection. - properties: - extension_attributes: - "$ref": "#/definitions/quote-data-totals-additional-data-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - quote-data-totals-additional-data-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface - properties: - gift_messages: - type: array - items: - "$ref": "#/definitions/gift-message-data-message-interface" - gift-message-data-message-interface: - type: object - description: Interface MessageInterface - properties: - gift_message_id: - type: integer - description: Gift message ID. Otherwise, null. - customer_id: - type: integer - description: Customer ID. Otherwise, null. - sender: - type: string - description: Sender name. - recipient: - type: string - description: Recipient name. - message: - type: string - description: Message text. - extension_attributes: - "$ref": "#/definitions/gift-message-data-message-extension-interface" - required: - - sender - - recipient - - message - gift-message-data-message-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface - properties: - entity_id: - type: string - entity_type: - type: string - wrapping_id: - type: integer - wrapping_allow_gift_receipt: - type: boolean - wrapping_add_printed_card: - type: boolean - catalog-inventory-data-stock-item-collection-interface: - type: object - description: Interface StockItemCollectionInterface - properties: - items: - type: array - description: Items - items: - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - search_criteria: - "$ref": "#/definitions/catalog-inventory-stock-item-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - catalog-inventory-stock-item-criteria-interface: - type: object - description: Interface StockItemCriteriaInterface - properties: - mapper_interface_name: - type: string - description: Associated Mapper Interface name - criteria_list: - type: array - description: Criteria objects added to current Composite Criteria - items: - "$ref": "#/definitions/framework-criteria-interface" - filters: - type: array - description: List of filters - items: - type: string - orders: - type: array - description: Ordering criteria - items: - type: string - limit: - type: array - description: Limit - items: - type: string - required: - - mapper_interface_name - - criteria_list - - filters - - orders - - limit - framework-criteria-interface: - type: object - description: Interface CriteriaInterface - properties: - mapper_interface_name: - type: string - description: Associated Mapper Interface name - criteria_list: - type: array - description: Criteria objects added to current Composite Criteria - items: - "$ref": "#/definitions/framework-criteria-interface" - filters: - type: array - description: List of filters - items: - type: string - orders: - type: array - description: Ordering criteria - items: - type: string - limit: - type: array - description: Limit - items: - type: string - required: - - mapper_interface_name - - criteria_list - - filters - - orders - - limit - catalog-inventory-data-stock-status-interface: - type: object - description: Interface StockStatusInterface - properties: - product_id: - type: integer - stock_id: - type: integer - qty: - type: integer - stock_status: - type: integer - stock_item: - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - extension_attributes: - "$ref": "#/definitions/catalog-inventory-data-stock-status-extension-interface" - required: - - product_id - - stock_id - - qty - - stock_status - - stock_item - catalog-inventory-data-stock-status-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockStatusInterface - sales-data-order-interface: - type: object - description: Order interface. An order is a document that a web store issues to - a customer. Magento generates a sales order that lists the product items, billing - and shipping addresses, and shipping and payment methods. A corresponding external - document, known as a purchase order, is emailed to the customer. - properties: - adjustment_negative: - type: number - description: Negative adjustment value. - adjustment_positive: - type: number - description: Positive adjustment value. - applied_rule_ids: - type: string - description: Applied rule IDs. - base_adjustment_negative: - type: number - description: Base negative adjustment value. - base_adjustment_positive: - type: number - description: Base positive adjustment value. - base_currency_code: - type: string - description: Base currency code. - base_discount_amount: - type: number - description: Base discount amount. - base_discount_canceled: - type: number - description: Base discount canceled. - base_discount_invoiced: - type: number - description: Base discount invoiced. - base_discount_refunded: - type: number - description: Base discount refunded. - base_grand_total: - type: number - description: Base grand total. - base_discount_tax_compensation_amount: - type: number - description: Base discount tax compensation amount. - base_discount_tax_compensation_invoiced: - type: number - description: Base discount tax compensation invoiced. - base_discount_tax_compensation_refunded: - type: number - description: Base discount tax compensation refunded. - base_shipping_amount: - type: number - description: Base shipping amount. - base_shipping_canceled: - type: number - description: Base shipping canceled. - base_shipping_discount_amount: - type: number - description: Base shipping discount amount. - base_shipping_discount_tax_compensation_amnt: - type: number - description: Base shipping discount tax compensation amount. - base_shipping_incl_tax: - type: number - description: Base shipping including tax. - base_shipping_invoiced: - type: number - description: Base shipping invoiced. - base_shipping_refunded: - type: number - description: Base shipping refunded. - base_shipping_tax_amount: - type: number - description: Base shipping tax amount. - base_shipping_tax_refunded: - type: number - description: Base shipping tax refunded. - base_subtotal: - type: number - description: Base subtotal. - base_subtotal_canceled: - type: number - description: Base subtotal canceled. - base_subtotal_incl_tax: - type: number - description: Base subtotal including tax. - base_subtotal_invoiced: - type: number - description: Base subtotal invoiced. - base_subtotal_refunded: - type: number - description: Base subtotal refunded. - base_tax_amount: - type: number - description: Base tax amount. - base_tax_canceled: - type: number - description: Base tax canceled. - base_tax_invoiced: - type: number - description: Base tax invoiced. - base_tax_refunded: - type: number - description: Base tax refunded. - base_total_canceled: - type: number - description: Base total canceled. - base_total_due: - type: number - description: Base total due. - base_total_invoiced: - type: number - description: Base total invoiced. - base_total_invoiced_cost: - type: number - description: Base total invoiced cost. - base_total_offline_refunded: - type: number - description: Base total offline refunded. - base_total_online_refunded: - type: number - description: Base total online refunded. - base_total_paid: - type: number - description: Base total paid. - base_total_qty_ordered: - type: number - description: Base total quantity ordered. - base_total_refunded: - type: number - description: Base total refunded. - base_to_global_rate: - type: number - description: Base-to-global rate. - base_to_order_rate: - type: number - description: Base-to-order rate. - billing_address_id: - type: integer - description: Billing address ID. - can_ship_partially: - type: integer - description: Can-ship-partially flag value. - can_ship_partially_item: - type: integer - description: Can-ship-partially-item flag value. - coupon_code: - type: string - description: Coupon code. - created_at: - type: string - description: Created-at timestamp. - customer_dob: - type: string - description: In keeping with current security and privacy best practices, - be sure you are aware of any potential legal and security risks associated - with the storage of customers’ full date of birth (month, day, year) along - with other personal identifiers (e.g., full name) before collecting or processing - such data. - customer_email: - type: string - description: Customer email address. - customer_firstname: - type: string - description: Customer first name. - customer_gender: - type: integer - description: Customer gender. - customer_group_id: - type: integer - description: Customer group ID. - customer_id: - type: integer - description: Customer ID. - customer_is_guest: - type: integer - description: Customer-is-guest flag value. - customer_lastname: - type: string - description: Customer last name. - customer_middlename: - type: string - description: Customer middle name. - customer_note: - type: string - description: Customer note. - customer_note_notify: - type: integer - description: Customer-note-notify flag value. - customer_prefix: - type: string - description: Customer prefix. - customer_suffix: - type: string - description: Customer suffix. - customer_taxvat: - type: string - description: Customer value-added tax (VAT). - discount_amount: - type: number - description: Discount amount. - discount_canceled: - type: number - description: Discount canceled. - discount_description: - type: string - description: Discount description. - discount_invoiced: - type: number - description: Discount invoiced. - discount_refunded: - type: number - description: Discount refunded amount. - edit_increment: - type: integer - description: Edit increment value. - email_sent: - type: integer - description: Email-sent flag value. - entity_id: - type: integer - description: Order ID. - ext_customer_id: - type: string - description: External customer ID. - ext_order_id: - type: string - description: External order ID. - forced_shipment_with_invoice: - type: integer - description: Forced-shipment-with-invoice flag value. - global_currency_code: - type: string - description: Global currency code. - grand_total: - type: number - description: Grand total. - discount_tax_compensation_amount: - type: number - description: Discount tax compensation amount. - discount_tax_compensation_invoiced: - type: number - description: Discount tax compensation invoiced amount. - discount_tax_compensation_refunded: - type: number - description: Discount tax compensation refunded amount. - hold_before_state: - type: string - description: Hold before state. - hold_before_status: - type: string - description: Hold before status. - increment_id: - type: string - description: Increment ID. - is_virtual: - type: integer - description: Is-virtual flag value. - order_currency_code: - type: string - description: Order currency code. - original_increment_id: - type: string - description: Original increment ID. - payment_authorization_amount: - type: number - description: Payment authorization amount. - payment_auth_expiration: - type: integer - description: Payment authorization expiration date. - protect_code: - type: string - description: Protect code. - quote_address_id: - type: integer - description: Quote address ID. - quote_id: - type: integer - description: Quote ID. - relation_child_id: - type: string - description: Relation child ID. - relation_child_real_id: - type: string - description: Relation child real ID. - relation_parent_id: - type: string - description: Relation parent ID. - relation_parent_real_id: - type: string - description: Relation parent real ID. - remote_ip: - type: string - description: Remote IP address. - shipping_amount: - type: number - description: Shipping amount. - shipping_canceled: - type: number - description: Shipping canceled amount. - shipping_description: - type: string - description: Shipping description. - shipping_discount_amount: - type: number - description: Shipping discount amount. - shipping_discount_tax_compensation_amount: - type: number - description: Shipping discount tax compensation amount. - shipping_incl_tax: - type: number - description: Shipping including tax amount. - shipping_invoiced: - type: number - description: Shipping invoiced amount. - shipping_refunded: - type: number - description: Shipping refunded amount. - shipping_tax_amount: - type: number - description: Shipping tax amount. - shipping_tax_refunded: - type: number - description: Shipping tax refunded amount. - state: - type: string - description: State. - status: - type: string - description: Status. - store_currency_code: - type: string - description: Store currency code. - store_id: - type: integer - description: Store ID. - store_name: - type: string - description: Store name. - store_to_base_rate: - type: number - description: Store-to-base rate. - store_to_order_rate: - type: number - description: Store-to-order rate. - subtotal: - type: number - description: Subtotal. - subtotal_canceled: - type: number - description: Subtotal canceled amount. - subtotal_incl_tax: - type: number - description: Subtotal including tax amount. - subtotal_invoiced: - type: number - description: Subtotal invoiced amount. - subtotal_refunded: - type: number - description: Subtotal refunded amount. - tax_amount: - type: number - description: Tax amount. - tax_canceled: - type: number - description: Tax canceled amount. - tax_invoiced: - type: number - description: Tax invoiced amount. - tax_refunded: - type: number - description: Tax refunded amount. - total_canceled: - type: number - description: Total canceled. - total_due: - type: number - description: Total due. - total_invoiced: - type: number - description: Total invoiced amount. - total_item_count: - type: integer - description: Total item count. - total_offline_refunded: - type: number - description: Total offline refunded amount. - total_online_refunded: - type: number - description: Total online refunded amount. - total_paid: - type: number - description: Total paid. - total_qty_ordered: - type: number - description: Total quantity ordered. - total_refunded: - type: number - description: Total amount refunded. - updated_at: - type: string - description: Updated-at timestamp. - weight: - type: number - description: Weight. - x_forwarded_for: - type: string - description: X-Forwarded-For field value. - items: - type: array - description: Array of items. - items: - "$ref": "#/definitions/sales-data-order-item-interface" - billing_address: - "$ref": "#/definitions/sales-data-order-address-interface" - payment: - "$ref": "#/definitions/sales-data-order-payment-interface" - status_histories: - type: array - description: Array of status histories. - items: - "$ref": "#/definitions/sales-data-order-status-history-interface" - extension_attributes: - "$ref": "#/definitions/sales-data-order-extension-interface" - required: - - base_grand_total - - customer_email - - grand_total - - items - sales-data-order-item-interface: - type: object - description: Order item interface. An order is a document that a web store issues - to a customer. Magento generates a sales order that lists the product items, - billing and shipping addresses, and shipping and payment methods. A corresponding - external document, known as a purchase order, is emailed to the customer. - properties: - additional_data: - type: string - description: Additional data. - amount_refunded: - type: number - description: Amount refunded. - applied_rule_ids: - type: string - description: Applied rule IDs. - base_amount_refunded: - type: number - description: Base amount refunded. - base_cost: - type: number - description: Base cost. - base_discount_amount: - type: number - description: Base discount amount. - base_discount_invoiced: - type: number - description: Base discount invoiced. - base_discount_refunded: - type: number - description: Base discount refunded. - base_discount_tax_compensation_amount: - type: number - description: Base discount tax compensation amount. - base_discount_tax_compensation_invoiced: - type: number - description: Base discount tax compensation invoiced. - base_discount_tax_compensation_refunded: - type: number - description: Base discount tax compensation refunded. - base_original_price: - type: number - description: Base original price. - base_price: - type: number - description: Base price. - base_price_incl_tax: - type: number - description: Base price including tax. - base_row_invoiced: - type: number - description: Base row invoiced. - base_row_total: - type: number - description: Base row total. - base_row_total_incl_tax: - type: number - description: Base row total including tax. - base_tax_amount: - type: number - description: Base tax amount. - base_tax_before_discount: - type: number - description: Base tax before discount. - base_tax_invoiced: - type: number - description: Base tax invoiced. - base_tax_refunded: - type: number - description: Base tax refunded. - base_weee_tax_applied_amount: - type: number - description: Base WEEE tax applied amount. - base_weee_tax_applied_row_amnt: - type: number - description: Base WEEE tax applied row amount. - base_weee_tax_disposition: - type: number - description: Base WEEE tax disposition. - base_weee_tax_row_disposition: - type: number - description: Base WEEE tax row disposition. - created_at: - type: string - description: Created-at timestamp. - description: - type: string - description: Description. - discount_amount: - type: number - description: Discount amount. - discount_invoiced: - type: number - description: Discount invoiced. - discount_percent: - type: number - description: Discount percent. - discount_refunded: - type: number - description: Discount refunded. - event_id: - type: integer - description: Event ID. - ext_order_item_id: - type: string - description: External order item ID. - free_shipping: - type: integer - description: Free-shipping flag value. - gw_base_price: - type: number - description: GW base price. - gw_base_price_invoiced: - type: number - description: GW base price invoiced. - gw_base_price_refunded: - type: number - description: GW base price refunded. - gw_base_tax_amount: - type: number - description: GW base tax amount. - gw_base_tax_amount_invoiced: - type: number - description: GW base tax amount invoiced. - gw_base_tax_amount_refunded: - type: number - description: GW base tax amount refunded. - gw_id: - type: integer - description: GW ID. - gw_price: - type: number - description: GW price. - gw_price_invoiced: - type: number - description: GW price invoiced. - gw_price_refunded: - type: number - description: GW price refunded. - gw_tax_amount: - type: number - description: GW tax amount. - gw_tax_amount_invoiced: - type: number - description: GW tax amount invoiced. - gw_tax_amount_refunded: - type: number - description: GW tax amount refunded. - discount_tax_compensation_amount: - type: number - description: Discount tax compensation amount. - discount_tax_compensation_canceled: - type: number - description: Discount tax compensation canceled. - discount_tax_compensation_invoiced: - type: number - description: Discount tax compensation invoiced. - discount_tax_compensation_refunded: - type: number - description: Discount tax compensation refunded. - is_qty_decimal: - type: integer - description: Is-quantity-decimal flag value. - is_virtual: - type: integer - description: Is-virtual flag value. - item_id: - type: integer - description: Item ID. - locked_do_invoice: - type: integer - description: Locked DO invoice flag value. - locked_do_ship: - type: integer - description: Locked DO ship flag value. - name: - type: string - description: Name. - no_discount: - type: integer - description: No-discount flag value. - order_id: - type: integer - description: Order ID. - original_price: - type: number - description: Original price. - parent_item_id: - type: integer - description: Parent item ID. - price: - type: number - description: Price. - price_incl_tax: - type: number - description: Price including tax. - product_id: - type: integer - description: Product ID. - product_type: - type: string - description: Product type. - qty_backordered: - type: number - description: Quantity backordered. - qty_canceled: - type: number - description: Quantity canceled. - qty_invoiced: - type: number - description: Quantity invoiced. - qty_ordered: - type: number - description: Quantity ordered. - qty_refunded: - type: number - description: Quantity refunded. - qty_returned: - type: number - description: Quantity returned. - qty_shipped: - type: number - description: Quantity shipped. - quote_item_id: - type: integer - description: Quote item ID. - row_invoiced: - type: number - description: Row invoiced. - row_total: - type: number - description: Row total. - row_total_incl_tax: - type: number - description: Row total including tax. - row_weight: - type: number - description: Row weight. - sku: - type: string - description: SKU. - store_id: - type: integer - description: Store ID. - tax_amount: - type: number - description: Tax amount. - tax_before_discount: - type: number - description: Tax before discount. - tax_canceled: - type: number - description: Tax canceled. - tax_invoiced: - type: number - description: Tax invoiced. - tax_percent: - type: number - description: Tax percent. - tax_refunded: - type: number - description: Tax refunded. - updated_at: - type: string - description: Updated-at timestamp. - weee_tax_applied: - type: string - description: WEEE tax applied. - weee_tax_applied_amount: - type: number - description: WEEE tax applied amount. - weee_tax_applied_row_amount: - type: number - description: WEEE tax applied row amount. - weee_tax_disposition: - type: number - description: WEEE tax disposition. - weee_tax_row_disposition: - type: number - description: WEEE tax row disposition. - weight: - type: number - description: Weight. - parent_item: - "$ref": "#/definitions/sales-data-order-item-interface" - product_option: - "$ref": "#/definitions/catalog-data-product-option-interface" - extension_attributes: - "$ref": "#/definitions/sales-data-order-item-extension-interface" - required: - - sku - catalog-data-product-option-interface: - type: object - description: Product option interface - properties: - extension_attributes: - "$ref": "#/definitions/catalog-data-product-option-extension-interface" - catalog-data-product-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductOptionInterface - properties: - custom_options: - type: array - items: - "$ref": "#/definitions/catalog-data-custom-option-interface" - bundle_options: - type: array - items: - "$ref": "#/definitions/bundle-data-bundle-option-interface" - downloadable_option: - "$ref": "#/definitions/downloadable-data-downloadable-option-interface" - giftcard_item_option: - "$ref": "#/definitions/gift-card-data-gift-card-option-interface" - configurable_item_options: - type: array - items: - "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-interface" - sales-data-order-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderItemInterface - properties: - itemized_taxes: - type: array - items: - "$ref": "#/definitions/tax-data-order-tax-item-interface" - gift_message: - "$ref": "#/definitions/gift-message-data-message-interface" - gw_id: - type: string - gw_base_price: - type: string - gw_price: - type: string - gw_base_tax_amount: - type: string - gw_tax_amount: - type: string - gw_base_price_invoiced: - type: string - gw_price_invoiced: - type: string - gw_base_tax_amount_invoiced: - type: string - gw_tax_amount_invoiced: - type: string - gw_base_price_refunded: - type: string - gw_price_refunded: - type: string - gw_base_tax_amount_refunded: - type: string - gw_tax_amount_refunded: - type: string - tax-data-order-tax-item-interface: - type: object - description: '' - properties: - tax_item_id: - type: integer - description: Tax item ID - tax_id: - type: integer - description: Tax ID - item_id: - type: integer - description: Order item ID - tax_code: - type: string - description: Tax code - tax_percent: - type: number - description: Tax percent - amount: - type: number - description: Tax amount - base_amount: - type: number - description: Tax amount in base currency - real_amount: - type: number - description: Real tax amount - real_base_amount: - type: number - description: Real tax amount in base currency - associated_item_id: - type: integer - description: Associated order item ID - taxable_item_type: - type: string - description: shipping, product, weee, quote_gw, etc... - extension_attributes: - "$ref": "#/definitions/tax-data-order-tax-item-extension-interface" - required: - - tax_percent - - amount - - base_amount - - real_amount - - real_base_amount - tax-data-order-tax-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Tax\Api\Data\OrderTaxItemInterface - sales-data-order-address-interface: - type: object - description: Order address interface. An order is a document that a web store - issues to a customer. Magento generates a sales order that lists the product - items, billing and shipping addresses, and shipping and payment methods. A corresponding - external document, known as a purchase order, is emailed to the customer. - properties: - address_type: - type: string - description: Address type. - city: - type: string - description: City. - company: - type: string - description: Company. - country_id: - type: string - description: Country ID. - customer_address_id: - type: integer - description: Country address ID. - customer_id: - type: integer - description: Customer ID. - email: - type: string - description: Email address. - entity_id: - type: integer - description: Order address ID. - fax: - type: string - description: Fax number. - firstname: - type: string - description: First name. - lastname: - type: string - description: Last name. - middlename: - type: string - description: Middle name. - parent_id: - type: integer - description: Parent ID. - postcode: - type: string - description: Postal code. - prefix: - type: string - description: Prefix. - region: - type: string - description: Region. - region_code: - type: string - description: Region code. - region_id: - type: integer - description: Region ID. - street: - type: array - description: Array of any street values. Otherwise, null. - items: - type: string - suffix: - type: string - description: Suffix. - telephone: - type: string - description: Telephone number. - vat_id: - type: string - description: VAT ID. - vat_is_valid: - type: integer - description: VAT-is-valid flag value. - vat_request_date: - type: string - description: VAT request date. - vat_request_id: - type: string - description: VAT request ID. - vat_request_success: - type: integer - description: VAT-request-success flag value. - extension_attributes: - "$ref": "#/definitions/sales-data-order-address-extension-interface" - required: - - address_type - - city - - country_id - - firstname - - lastname - - postcode - - telephone - sales-data-order-address-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderAddressInterface - sales-data-order-payment-interface: - type: object - description: Order payment interface. An order is a document that a web store - issues to a customer. Magento generates a sales order that lists the product - items, billing and shipping addresses, and shipping and payment methods. A corresponding - external document, known as a purchase order, is emailed to the customer. - properties: - account_status: - type: string - description: Account status. - additional_data: - type: string - description: Additional data. - additional_information: - type: array - description: Array of additional information. - items: - type: string - address_status: - type: string - description: Address status. - amount_authorized: - type: number - description: Amount authorized. - amount_canceled: - type: number - description: Amount canceled. - amount_ordered: - type: number - description: Amount ordered. - amount_paid: - type: number - description: Amount paid. - amount_refunded: - type: number - description: Amount refunded. - anet_trans_method: - type: string - description: Anet transaction method. - base_amount_authorized: - type: number - description: Base amount authorized. - base_amount_canceled: - type: number - description: Base amount canceled. - base_amount_ordered: - type: number - description: Base amount ordered. - base_amount_paid: - type: number - description: Base amount paid. - base_amount_paid_online: - type: number - description: Base amount paid online. - base_amount_refunded: - type: number - description: Base amount refunded. - base_amount_refunded_online: - type: number - description: Base amount refunded online. - base_shipping_amount: - type: number - description: Base shipping amount. - base_shipping_captured: - type: number - description: Base shipping captured amount. - base_shipping_refunded: - type: number - description: Base shipping refunded amount. - cc_approval: - type: string - description: Credit card approval. - cc_avs_status: - type: string - description: Credit card avs status. - cc_cid_status: - type: string - description: Credit card CID status. - cc_debug_request_body: - type: string - description: Credit card debug request body. - cc_debug_response_body: - type: string - description: Credit card debug response body. - cc_debug_response_serialized: - type: string - description: Credit card debug response serialized. - cc_exp_month: - type: string - description: Credit card expiration month. - cc_exp_year: - type: string - description: Credit card expiration year. - cc_last4: - type: string - description: Last four digits of the credit card. - cc_number_enc: - type: string - description: Encrypted credit card number. - cc_owner: - type: string - description: Credit card number. - cc_secure_verify: - type: string - description: Credit card secure verify. - cc_ss_issue: - type: string - description: Credit card SS issue. - cc_ss_start_month: - type: string - description: Credit card SS start month. - cc_ss_start_year: - type: string - description: Credit card SS start year. - cc_status: - type: string - description: Credit card status. - cc_status_description: - type: string - description: Credit card status description. - cc_trans_id: - type: string - description: Credit card transaction ID. - cc_type: - type: string - description: Credit card type. - echeck_account_name: - type: string - description: eCheck account name. - echeck_account_type: - type: string - description: eCheck account type. - echeck_bank_name: - type: string - description: eCheck bank name. - echeck_routing_number: - type: string - description: eCheck routing number. - echeck_type: - type: string - description: eCheck type. - entity_id: - type: integer - description: Entity ID. - last_trans_id: - type: string - description: Last transaction ID. - method: - type: string - description: Method. - parent_id: - type: integer - description: Parent ID. - po_number: - type: string - description: PO number. - protection_eligibility: - type: string - description: Protection eligibility. - quote_payment_id: - type: integer - description: Quote payment ID. - shipping_amount: - type: number - description: Shipping amount. - shipping_captured: - type: number - description: Shipping captured. - shipping_refunded: - type: number - description: Shipping refunded. - extension_attributes: - "$ref": "#/definitions/sales-data-order-payment-extension-interface" - required: - - account_status - - additional_information - - cc_last4 - - method - sales-data-order-payment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderPaymentInterface - properties: - notification_message: - type: string - vault_payment_token: - "$ref": "#/definitions/vault-data-payment-token-interface" - vault-data-payment-token-interface: - type: object - description: Gateway vault payment token interface. - properties: - entity_id: - type: integer - description: Entity ID. - customer_id: - type: integer - description: Customer ID. - public_hash: - type: string - description: Public hash - payment_method_code: - type: string - description: Payment method code - type: - type: string - description: Type - created_at: - type: string - description: Token creation timestamp - expires_at: - type: string - description: Token expiration timestamp - gateway_token: - type: string - description: Gateway token ID - token_details: - type: string - description: Token details - is_active: - type: boolean - description: Is active. - is_visible: - type: boolean - description: Is visible. - website_id: - type: integer - description: website id. - required: - - public_hash - - payment_method_code - - type - - gateway_token - - token_details - - is_active - - is_visible - - website_id - sales-data-order-status-history-interface: - type: object - description: Order status history interface. An order is a document that a web - store issues to a customer. Magento generates a sales order that lists the product - items, billing and shipping addresses, and shipping and payment methods. A corresponding - external document, known as a purchase order, is emailed to the customer. - properties: - comment: - type: string - description: Comment. - created_at: - type: string - description: Created-at timestamp. - entity_id: - type: integer - description: Order status history ID. - entity_name: - type: string - description: Entity name. - is_customer_notified: - type: integer - description: Is-customer-notified flag value. - is_visible_on_front: - type: integer - description: Is-visible-on-storefront flag value. - parent_id: - type: integer - description: Parent ID. - status: - type: string - description: Status. - extension_attributes: - "$ref": "#/definitions/sales-data-order-status-history-extension-interface" - required: - - comment - - is_customer_notified - - is_visible_on_front - - parent_id - sales-data-order-status-history-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderStatusHistoryInterface - sales-data-order-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderInterface - properties: - shipping_assignments: - type: array - items: - "$ref": "#/definitions/sales-data-shipping-assignment-interface" - payment_additional_info: - type: array - items: - "$ref": "#/definitions/payment-data-payment-additional-info-interface" - company_order_attributes: - "$ref": "#/definitions/company-data-company-order-interface" - custom_fees: - type: array - items: - "$ref": "#/definitions/admin-ui-sdk-custom-fees-data-custom-fees-interface" - applied_taxes: - type: array - items: - "$ref": "#/definitions/tax-data-order-tax-details-applied-tax-interface" - item_applied_taxes: - type: array - items: - "$ref": "#/definitions/tax-data-order-tax-details-item-interface" - converting_from_quote: - type: boolean - taxes: - type: array - items: - "$ref": "#/definitions/tax-data-order-tax-interface" - additional_itemized_taxes: - type: array - items: - "$ref": "#/definitions/tax-data-order-tax-item-interface" - base_customer_balance_amount: - type: number - customer_balance_amount: - type: number - base_customer_balance_invoiced: - type: number - customer_balance_invoiced: - type: number - base_customer_balance_refunded: - type: number - customer_balance_refunded: - type: number - base_customer_balance_total_refunded: - type: number - customer_balance_total_refunded: - type: number - gift_cards: - type: array - items: - "$ref": "#/definitions/gift-card-account-data-gift-card-interface" - base_gift_cards_amount: - type: number - gift_cards_amount: - type: number - base_gift_cards_invoiced: - type: number - gift_cards_invoiced: - type: number - base_gift_cards_refunded: - type: number - gift_cards_refunded: - type: number - gift_message: - "$ref": "#/definitions/gift-message-data-message-interface" - gw_id: - type: string - gw_allow_gift_receipt: - type: string - gw_add_card: - type: string - gw_base_price: - type: string - gw_price: - type: string - gw_items_base_price: - type: string - gw_items_price: - type: string - gw_card_base_price: - type: string - gw_card_price: - type: string - gw_base_tax_amount: - type: string - gw_tax_amount: - type: string - gw_items_base_tax_amount: - type: string - gw_items_tax_amount: - type: string - gw_card_base_tax_amount: - type: string - gw_card_tax_amount: - type: string - gw_base_price_incl_tax: - type: string - gw_price_incl_tax: - type: string - gw_items_base_price_incl_tax: - type: string - gw_items_price_incl_tax: - type: string - gw_card_base_price_incl_tax: - type: string - gw_card_price_incl_tax: - type: string - gw_base_price_invoiced: - type: string - gw_price_invoiced: - type: string - gw_items_base_price_invoiced: - type: string - gw_items_price_invoiced: - type: string - gw_card_base_price_invoiced: - type: string - gw_card_price_invoiced: - type: string - gw_base_tax_amount_invoiced: - type: string - gw_tax_amount_invoiced: - type: string - gw_items_base_tax_invoiced: - type: string - gw_items_tax_invoiced: - type: string - gw_card_base_tax_invoiced: - type: string - gw_card_tax_invoiced: - type: string - gw_base_price_refunded: - type: string - gw_price_refunded: - type: string - gw_items_base_price_refunded: - type: string - gw_items_price_refunded: - type: string - gw_card_base_price_refunded: - type: string - gw_card_price_refunded: - type: string - gw_base_tax_amount_refunded: - type: string - gw_tax_amount_refunded: - type: string - gw_items_base_tax_refunded: - type: string - gw_items_tax_refunded: - type: string - gw_card_base_tax_refunded: - type: string - gw_card_tax_refunded: - type: string - pickup_location_code: - type: string - notification_sent: - type: integer - send_notification: - type: integer - coupon_codes: - type: array - items: - type: string - coupon_discounts: - type: array - items: - type: string - reward_points_balance: - type: integer - reward_currency_amount: - type: number - base_reward_currency_amount: - type: number - sales-data-shipping-assignment-interface: - type: object - description: Interface ShippingAssignmentInterface - properties: - shipping: - "$ref": "#/definitions/sales-data-shipping-interface" - items: - type: array - description: Order items of shipping assignment - items: - "$ref": "#/definitions/sales-data-order-item-interface" - stock_id: - type: integer - description: Stock id - extension_attributes: - "$ref": "#/definitions/sales-data-shipping-assignment-extension-interface" - required: - - shipping - - items - sales-data-shipping-interface: - type: object - description: Interface ShippingInterface - properties: - address: - "$ref": "#/definitions/sales-data-order-address-interface" - method: - type: string - description: Shipping method - total: - "$ref": "#/definitions/sales-data-total-interface" - extension_attributes: - "$ref": "#/definitions/sales-data-shipping-extension-interface" - sales-data-total-interface: - type: object - description: Interface TotalInterface - properties: - base_shipping_amount: - type: number - description: Base shipping amount. - base_shipping_canceled: - type: number - description: Base shipping canceled. - base_shipping_discount_amount: - type: number - description: Base shipping discount amount. - base_shipping_discount_tax_compensation_amnt: - type: number - description: Base shipping discount tax compensation amount. - base_shipping_incl_tax: - type: number - description: Base shipping including tax. - base_shipping_invoiced: - type: number - description: Base shipping invoiced. - base_shipping_refunded: - type: number - description: Base shipping refunded. - base_shipping_tax_amount: - type: number - description: Base shipping tax amount. - base_shipping_tax_refunded: - type: number - description: Base shipping tax refunded. - shipping_amount: - type: number - description: Shipping amount. - shipping_canceled: - type: number - description: Shipping canceled amount. - shipping_discount_amount: - type: number - description: Shipping discount amount. - shipping_discount_tax_compensation_amount: - type: number - description: Shipping discount tax compensation amount. - shipping_incl_tax: - type: number - description: Shipping including tax amount. - shipping_invoiced: - type: number - description: Shipping invoiced amount. - shipping_refunded: - type: number - description: Shipping refunded amount. - shipping_tax_amount: - type: number - description: Shipping tax amount. - shipping_tax_refunded: - type: number - description: Shipping tax refunded amount. - extension_attributes: - "$ref": "#/definitions/sales-data-total-extension-interface" - sales-data-total-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\TotalInterface - sales-data-shipping-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShippingInterface - sales-data-shipping-assignment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShippingAssignmentInterface - payment-data-payment-additional-info-interface: - type: object - description: Payment additional info interface. - properties: - key: - type: string - description: Object key - value: - type: string - description: Object value - required: - - key - - value - company-data-company-order-interface: - type: object - description: Order company extension attributes interface. Adds new company attributes - to orders. - properties: - order_id: - type: integer - description: Order ID. - company_id: - type: integer - description: Company ID. - company_name: - type: string - description: Company name. - extension_attributes: - "$ref": "#/definitions/company-data-company-order-extension-interface" - company-data-company-order-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyOrderInterface - admin-ui-sdk-custom-fees-data-custom-fees-interface: - type: object - description: Interface CustomFeesInterface - properties: - id: - type: string - description: Id. - order_id: - type: string - description: The order id - custom_fee_code: - type: string - description: Custom fee code. - custom_fee_label: - type: string - description: Custom fee label. - custom_fee_amount: - type: number - description: Custom fee amount. - base_custom_fee_amount: - type: number - description: Base custom fee amount. - custom_fee_amount_invoiced: - type: number - description: Custom fee amount invoiced. - base_custom_fee_amount_invoiced: - type: number - description: Base custom fee amount invoiced. - custom_fee_amount_refunded: - type: number - description: Custom fee amount refunded. - base_custom_fee_amount_refunded: - type: number - description: Base custom fee amount refunded. - apply_fee_on_last_invoice: - type: boolean - description: If apply fee is set on last invoice. - apply_fee_on_last_creditmemo: - type: boolean - description: If apply fee is set on last credit memo. - invoice_id: - type: string - description: Invoice id. - creditmemo_id: - type: string - description: Credit memo id. - required: - - order_id - - custom_fee_code - - custom_fee_label - - custom_fee_amount - - base_custom_fee_amount - - custom_fee_amount_invoiced - - base_custom_fee_amount_invoiced - - custom_fee_amount_refunded - - base_custom_fee_amount_refunded - - apply_fee_on_last_invoice - - apply_fee_on_last_creditmemo - tax-data-order-tax-details-applied-tax-interface: - type: object - description: Interface OrderTaxDetailsAppliedTaxInterface - properties: - code: - type: string - description: Code - title: - type: string - description: Title - percent: - type: number - description: Tax Percent - amount: - type: number - description: Tax amount - base_amount: - type: number - description: Tax amount in base currency - extension_attributes: - "$ref": "#/definitions/tax-data-order-tax-details-applied-tax-extension-interface" - required: - - amount - - base_amount - tax-data-order-tax-details-applied-tax-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Tax\Api\Data\OrderTaxDetailsAppliedTaxInterface - properties: - rates: - type: array - items: - "$ref": "#/definitions/tax-data-applied-tax-rate-interface" - tax-data-applied-tax-rate-interface: - type: object - description: Applied tax rate interface. - properties: - code: - type: string - description: Code - title: - type: string - description: Title - percent: - type: number - description: Tax Percent - extension_attributes: - "$ref": "#/definitions/tax-data-applied-tax-rate-extension-interface" - tax-data-applied-tax-rate-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Tax\Api\Data\AppliedTaxRateInterface - tax-data-order-tax-details-item-interface: - type: object - description: Interface OrderTaxDetailsItemInterface - properties: - type: - type: string - description: Type (shipping, product, weee, gift wrapping, etc) - item_id: - type: integer - description: Item id if this item is a product - associated_item_id: - type: integer - description: Associated item id if this item is associated with another item, - null otherwise - applied_taxes: - type: array - description: Applied taxes - items: - "$ref": "#/definitions/tax-data-order-tax-details-applied-tax-interface" - extension_attributes: - "$ref": "#/definitions/tax-data-order-tax-details-item-extension-interface" - tax-data-order-tax-details-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Tax\Api\Data\OrderTaxDetailsItemInterface - tax-data-order-tax-interface: - type: object - description: '' - properties: - tax_id: - type: integer - description: Tax ID - order_id: - type: integer - description: Order ID - code: - type: string - description: Code - title: - type: string - description: Title - percent: - type: number - description: Percent - amount: - type: number - description: Amount - base_amount: - type: number - description: Tax amount in base currency - base_real_amount: - type: number - description: Real tax amount in base currency - priority: - type: integer - description: Priority - position: - type: integer - description: Position - process: - type: integer - description: Process - extension_attributes: - "$ref": "#/definitions/tax-data-order-tax-extension-interface" - required: - - percent - - amount - - base_amount - - base_real_amount - - priority - - position - - process - tax-data-order-tax-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Tax\Api\Data\OrderTaxInterface - gift-card-account-data-gift-card-interface: - type: object - description: Gift Card data - properties: - id: - type: integer - description: Id - code: - type: string - description: Code - amount: - type: number - description: Amount - base_amount: - type: number - description: Base Amount - required: - - id - - code - - amount - - base_amount - sales-data-order-search-result-interface: - type: object - description: Order search result interface. An order is a document that a web - store issues to a customer. Magento generates a sales order that lists the product - items, billing and shipping addresses, and shipping and payment methods. A corresponding - external document, known as a purchase order, is emailed to the customer. - properties: - items: - type: array - description: Array of collection items. - items: - "$ref": "#/definitions/sales-data-order-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - sales-data-order-status-history-search-result-interface: - type: object - description: Order status history search result interface. An order is a document - that a web store issues to a customer. Magento generates a sales order that - lists the product items, billing and shipping addresses, and shipping and payment - methods. A corresponding external document, known as a purchase order, is emailed - to the customer. - properties: - items: - type: array - description: Array of collection items. - items: - "$ref": "#/definitions/sales-data-order-status-history-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - sales-data-order-item-search-result-interface: - type: object - description: Order item search result interface. An order is a document that a - web store issues to a customer. Magento generates a sales order that lists the - product items, billing and shipping addresses, and shipping and payment methods. - A corresponding external document, known as a purchase order, is emailed to - the customer. - properties: - items: - type: array - description: Array of collection items. - items: - "$ref": "#/definitions/sales-data-order-item-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - sales-data-invoice-interface: - type: object - description: Invoice interface. An invoice is a record of the receipt of payment - for an order. - properties: - base_currency_code: - type: string - description: Base currency code. - base_discount_amount: - type: number - description: Base discount amount. - base_grand_total: - type: number - description: Base grand total. - base_discount_tax_compensation_amount: - type: number - description: Base discount tax compensation amount. - base_shipping_amount: - type: number - description: Base shipping amount. - base_shipping_discount_tax_compensation_amnt: - type: number - description: Base shipping discount tax compensation amount. - base_shipping_incl_tax: - type: number - description: Base shipping including tax. - base_shipping_tax_amount: - type: number - description: Base shipping tax amount. - base_subtotal: - type: number - description: Base subtotal. - base_subtotal_incl_tax: - type: number - description: Base subtotal including tax. - base_tax_amount: - type: number - description: Base tax amount. - base_total_refunded: - type: number - description: Base total refunded. - base_to_global_rate: - type: number - description: Base-to-global rate. - base_to_order_rate: - type: number - description: Base-to-order rate. - billing_address_id: - type: integer - description: Billing address ID. - can_void_flag: - type: integer - description: Can void flag value. - created_at: - type: string - description: Created-at timestamp. - discount_amount: - type: number - description: Discount amount. - discount_description: - type: string - description: Discount description. - email_sent: - type: integer - description: Email-sent flag value. - entity_id: - type: integer - description: Invoice ID. - global_currency_code: - type: string - description: Global currency code. - grand_total: - type: number - description: Grand total. - discount_tax_compensation_amount: - type: number - description: Discount tax compensation amount. - increment_id: - type: string - description: Increment ID. - is_used_for_refund: - type: integer - description: Is-used-for-refund flag value. - order_currency_code: - type: string - description: Order currency code. - order_id: - type: integer - description: Order ID. - shipping_address_id: - type: integer - description: Shipping address ID. - shipping_amount: - type: number - description: Shipping amount. - shipping_discount_tax_compensation_amount: - type: number - description: Shipping discount tax compensation amount. - shipping_incl_tax: - type: number - description: Shipping including tax. - shipping_tax_amount: - type: number - description: Shipping tax amount. - state: - type: integer - description: State. - store_currency_code: - type: string - description: Store currency code. - store_id: - type: integer - description: Store ID. - store_to_base_rate: - type: number - description: Store-to-base rate. - store_to_order_rate: - type: number - description: Store-to-order rate. - subtotal: - type: number - description: Subtotal. - subtotal_incl_tax: - type: number - description: Subtotal including tax. - tax_amount: - type: number - description: Tax amount. - total_qty: - type: number - description: Total quantity. - transaction_id: - type: string - description: Transaction ID. - updated_at: - type: string - description: Updated-at timestamp. - items: - type: array - description: Array of invoice items. - items: - "$ref": "#/definitions/sales-data-invoice-item-interface" - comments: - type: array - description: Array of any invoice comments. Otherwise, null. - items: - "$ref": "#/definitions/sales-data-invoice-comment-interface" - extension_attributes: - "$ref": "#/definitions/sales-data-invoice-extension-interface" - required: - - order_id - - total_qty - - items - sales-data-invoice-item-interface: - type: object - description: Invoice item interface. An invoice is a record of the receipt of - payment for an order. An invoice item is a purchased item in an invoice. - properties: - additional_data: - type: string - description: Additional data. - base_cost: - type: number - description: Base cost. - base_discount_amount: - type: number - description: Base discount amount. - base_discount_tax_compensation_amount: - type: number - description: Base discount tax compensation amount. - base_price: - type: number - description: Base price. - base_price_incl_tax: - type: number - description: Base price including tax. - base_row_total: - type: number - description: Base row total. - base_row_total_incl_tax: - type: number - description: Base row total including tax. - base_tax_amount: - type: number - description: Base tax amount. - description: - type: string - description: Description. - discount_amount: - type: number - description: Discount amount. - entity_id: - type: integer - description: Invoice item ID. - discount_tax_compensation_amount: - type: number - description: Discount tax compensation amount. - name: - type: string - description: Name. - parent_id: - type: integer - description: Parent ID. - price: - type: number - description: Price. - price_incl_tax: - type: number - description: Price including tax. - product_id: - type: integer - description: Product ID. - row_total: - type: number - description: Row total. - row_total_incl_tax: - type: number - description: Row total including tax. - sku: - type: string - description: SKU. - tax_amount: - type: number - description: Tax amount. - extension_attributes: - "$ref": "#/definitions/sales-data-invoice-item-extension-interface" - order_item_id: - type: integer - description: Order item ID. - qty: - type: number - description: Quantity. - required: - - sku - - order_item_id - - qty - sales-data-invoice-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceItemInterface - sales-data-invoice-comment-interface: - type: object - description: Invoice comment interface. An invoice is a record of the receipt - of payment for an order. An invoice can include comments that detail the invoice - history. - properties: - is_customer_notified: - type: integer - description: Is-customer-notified flag value. - parent_id: - type: integer - description: Parent ID. - extension_attributes: - "$ref": "#/definitions/sales-data-invoice-comment-extension-interface" - comment: - type: string - description: Comment. - is_visible_on_front: - type: integer - description: Is-visible-on-storefront flag value. - created_at: - type: string - description: Created-at timestamp. - entity_id: - type: integer - description: Invoice ID. - required: - - is_customer_notified - - parent_id - - comment - - is_visible_on_front - sales-data-invoice-comment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCommentInterface - sales-data-invoice-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceInterface - properties: - base_customer_balance_amount: - type: number - customer_balance_amount: - type: number - base_gift_cards_amount: - type: number - gift_cards_amount: - type: number - gw_base_price: - type: string - gw_price: - type: string - gw_items_base_price: - type: string - gw_items_price: - type: string - gw_card_base_price: - type: string - gw_card_price: - type: string - gw_base_tax_amount: - type: string - gw_tax_amount: - type: string - gw_items_base_tax_amount: - type: string - gw_items_tax_amount: - type: string - gw_card_base_tax_amount: - type: string - gw_card_tax_amount: - type: string - sales-data-invoice-search-result-interface: - type: object - description: Invoice search result interface. An invoice is a record of the receipt - of payment for an order. - properties: - items: - type: array - description: Array of collection items. - items: - "$ref": "#/definitions/sales-data-invoice-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - sales-data-invoice-comment-search-result-interface: - type: object - description: Invoice comment search result interface. An invoice is a record of - the receipt of payment for an order. An invoice can include comments that detail - the invoice history. - properties: - items: - type: array - description: Array of collection items. - items: - "$ref": "#/definitions/sales-data-invoice-comment-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - sales-data-creditmemo-item-creation-interface: - type: object - description: Interface CreditmemoItemCreationInterface - properties: - extension_attributes: - "$ref": "#/definitions/sales-data-creditmemo-item-creation-extension-interface" - order_item_id: - type: integer - description: Order item ID. - qty: - type: number - description: Quantity. - required: - - order_item_id - - qty - sales-data-creditmemo-item-creation-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoItemCreationInterface - sales-data-creditmemo-comment-creation-interface: - type: object - description: Interface CreditmemoCommentCreationInterface - properties: - extension_attributes: - "$ref": "#/definitions/sales-data-creditmemo-comment-creation-extension-interface" - comment: - type: string - description: Comment. - is_visible_on_front: - type: integer - description: Is-visible-on-storefront flag value. - required: - - comment - - is_visible_on_front - sales-data-creditmemo-comment-creation-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentCreationInterface - sales-data-creditmemo-creation-arguments-interface: - type: object - description: Interface CreditmemoCreationArgumentsInterface - properties: - shipping_amount: - type: number - description: Credit memo shipping amount. - adjustment_positive: - type: number - description: Credit memo positive adjustment. - adjustment_negative: - type: number - description: Credit memo negative adjustment. - extension_attributes: - "$ref": "#/definitions/sales-data-creditmemo-creation-arguments-extension-interface" - sales-data-creditmemo-creation-arguments-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCreationArgumentsInterface - properties: - return_to_stock_items: - type: array - items: - type: integer - sales-data-creditmemo-comment-search-result-interface: - type: object - description: Credit memo comment search result interface. After a customer places - and pays for an order and an invoice has been issued, the merchant can create - a credit memo to refund all or part of the amount paid for any returned or undelivered - items. The memo restores funds to the customer account so that the customer - can make future purchases. A credit memo usually includes comments that detail - why the credit memo amount was credited to the customer. - properties: - items: - type: array - description: Array of collection items. - items: - "$ref": "#/definitions/sales-data-creditmemo-comment-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - sales-data-creditmemo-comment-interface: - type: object - description: Credit memo comment interface. After a customer places and pays for - an order and an invoice has been issued, the merchant can create a credit memo - to refund all or part of the amount paid for any returned or undelivered items. - The memo restores funds to the customer account so that the customer can make - future purchases. A credit memo usually includes comments that detail why the - credit memo amount was credited to the customer. - properties: - comment: - type: string - description: Comment. - created_at: - type: string - description: Created-at timestamp. - entity_id: - type: integer - description: Credit memo ID. - is_customer_notified: - type: integer - description: Is-customer-notified flag value. - is_visible_on_front: - type: integer - description: Is-visible-on-storefront flag value. - parent_id: - type: integer - description: Parent ID. - extension_attributes: - "$ref": "#/definitions/sales-data-creditmemo-comment-extension-interface" - required: - - comment - - is_customer_notified - - is_visible_on_front - - parent_id - sales-data-creditmemo-comment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentInterface - sales-data-creditmemo-interface: - type: object - description: Credit memo interface. After a customer places and pays for an order - and an invoice has been issued, the merchant can create a credit memo to refund - all or part of the amount paid for any returned or undelivered items. The memo - restores funds to the customer account so that the customer can make future - purchases. - properties: - adjustment: - type: number - description: Credit memo adjustment. - adjustment_negative: - type: number - description: Credit memo negative adjustment. - adjustment_positive: - type: number - description: Credit memo positive adjustment. - base_adjustment: - type: number - description: Credit memo base adjustment. - base_adjustment_negative: - type: number - description: Credit memo negative base adjustment. - base_adjustment_positive: - type: number - description: Credit memo positive base adjustment. - base_currency_code: - type: string - description: Credit memo base currency code. - base_discount_amount: - type: number - description: Credit memo base discount amount. - base_grand_total: - type: number - description: Credit memo base grand total. - base_discount_tax_compensation_amount: - type: number - description: Credit memo base discount tax compensation amount. - base_shipping_amount: - type: number - description: Credit memo base shipping amount. - base_shipping_discount_tax_compensation_amnt: - type: number - description: Credit memo base shipping discount tax compensation amount. - base_shipping_incl_tax: - type: number - description: Credit memo base shipping including tax. - base_shipping_tax_amount: - type: number - description: Credit memo base shipping tax amount. - base_subtotal: - type: number - description: Credit memo base subtotal. - base_subtotal_incl_tax: - type: number - description: Credit memo base subtotal including tax. - base_tax_amount: - type: number - description: Credit memo base tax amount. - base_to_global_rate: - type: number - description: Credit memo base-to-global rate. - base_to_order_rate: - type: number - description: Credit memo base-to-order rate. - billing_address_id: - type: integer - description: Credit memo billing address ID. - created_at: - type: string - description: Credit memo created-at timestamp. - creditmemo_status: - type: integer - description: Credit memo status. - discount_amount: - type: number - description: Credit memo discount amount. - discount_description: - type: string - description: Credit memo discount description. - email_sent: - type: integer - description: Credit memo email sent flag value. - entity_id: - type: integer - description: Credit memo ID. - global_currency_code: - type: string - description: Credit memo global currency code. - grand_total: - type: number - description: Credit memo grand total. - discount_tax_compensation_amount: - type: number - description: Credit memo discount tax compensation amount. - increment_id: - type: string - description: Credit memo increment ID. - invoice_id: - type: integer - description: Credit memo invoice ID. - order_currency_code: - type: string - description: Credit memo order currency code. - order_id: - type: integer - description: Credit memo order ID. - shipping_address_id: - type: integer - description: Credit memo shipping address ID. - shipping_amount: - type: number - description: Credit memo shipping amount. - shipping_discount_tax_compensation_amount: - type: number - description: Credit memo shipping discount tax compensation amount. - shipping_incl_tax: - type: number - description: Credit memo shipping including tax. - shipping_tax_amount: - type: number - description: Credit memo shipping tax amount. - state: - type: integer - description: Credit memo state. - store_currency_code: - type: string - description: Credit memo store currency code. - store_id: - type: integer - description: Credit memo store ID. - store_to_base_rate: - type: number - description: Credit memo store-to-base rate. - store_to_order_rate: - type: number - description: Credit memo store-to-order rate. - subtotal: - type: number - description: Credit memo subtotal. - subtotal_incl_tax: - type: number - description: Credit memo subtotal including tax. - tax_amount: - type: number - description: Credit memo tax amount. - transaction_id: - type: string - description: Credit memo transaction ID. - updated_at: - type: string - description: Credit memo updated-at timestamp. - items: - type: array - description: Array of credit memo items. - items: - "$ref": "#/definitions/sales-data-creditmemo-item-interface" - comments: - type: array - description: Array of any credit memo comments. Otherwise, null. - items: - "$ref": "#/definitions/sales-data-creditmemo-comment-interface" - extension_attributes: - "$ref": "#/definitions/sales-data-creditmemo-extension-interface" - required: - - order_id - - items - sales-data-creditmemo-item-interface: - type: object - description: Credit memo item interface. After a customer places and pays for - an order and an invoice has been issued, the merchant can create a credit memo - to refund all or part of the amount paid for any returned or undelivered items. - The memo restores funds to the customer account so that the customer can make - future purchases. A credit memo item is an invoiced item for which a merchant - creates a credit memo. - properties: - additional_data: - type: string - description: Additional data. - base_cost: - type: number - description: The base cost for a credit memo item. - base_discount_amount: - type: number - description: The base discount amount for a credit memo item. - base_discount_tax_compensation_amount: - type: number - description: The base discount tax compensation amount for a credit memo item. - base_price: - type: number - description: The base price for a credit memo item. - base_price_incl_tax: - type: number - description: Base price including tax. - base_row_total: - type: number - description: Base row total. - base_row_total_incl_tax: - type: number - description: Base row total including tax. - base_tax_amount: - type: number - description: Base tax amount. - base_weee_tax_applied_amount: - type: number - description: Base WEEE tax applied amount. - base_weee_tax_applied_row_amnt: - type: number - description: Base WEEE tax applied row amount. - base_weee_tax_disposition: - type: number - description: Base WEEE tax disposition. - base_weee_tax_row_disposition: - type: number - description: Base WEEE tax row disposition. - description: - type: string - description: Description. - discount_amount: - type: number - description: Discount amount. - entity_id: - type: integer - description: Credit memo item ID. - discount_tax_compensation_amount: - type: number - description: Discount tax compensation amount. - name: - type: string - description: Name. - order_item_id: - type: integer - description: Order item ID. - parent_id: - type: integer - description: Parent ID. - price: - type: number - description: Price. - price_incl_tax: - type: number - description: Price including tax. - product_id: - type: integer - description: Product ID. - qty: - type: number - description: Quantity. - row_total: - type: number - description: Row total. - row_total_incl_tax: - type: number - description: Row total including tax. - sku: - type: string - description: SKU. - tax_amount: - type: number - description: Tax amount. - weee_tax_applied: - type: string - description: WEEE tax applied. - weee_tax_applied_amount: - type: number - description: WEEE tax applied amount. - weee_tax_applied_row_amount: - type: number - description: WEEE tax applied row amount. - weee_tax_disposition: - type: number - description: WEEE tax disposition. - weee_tax_row_disposition: - type: number - description: WEEE tax row disposition. - extension_attributes: - "$ref": "#/definitions/sales-data-creditmemo-item-extension-interface" - required: - - base_cost - - base_price - - entity_id - - order_item_id - - qty - sales-data-creditmemo-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoItemInterface - sales-data-creditmemo-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoInterface - properties: - base_customer_balance_amount: - type: number - customer_balance_amount: - type: number - base_gift_cards_amount: - type: number - gift_cards_amount: - type: number - gw_base_price: - type: string - gw_price: - type: string - gw_items_base_price: - type: string - gw_items_price: - type: string - gw_card_base_price: - type: string - gw_card_price: - type: string - gw_base_tax_amount: - type: string - gw_tax_amount: - type: string - gw_items_base_tax_amount: - type: string - gw_items_tax_amount: - type: string - gw_card_base_tax_amount: - type: string - gw_card_tax_amount: - type: string - sales-data-creditmemo-search-result-interface: - type: object - description: Credit memo search result interface. After a customer places and - pays for an order and an invoice has been issued, the merchant can create a - credit memo to refund all or part of the amount paid for any returned or undelivered - items. The memo restores funds to the customer account so that the customer - can make future purchases. - properties: - items: - type: array - description: Array of collection items. - items: - "$ref": "#/definitions/sales-data-creditmemo-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - sales-data-shipment-interface: - type: object - description: Shipment interface. A shipment is a delivery package that contains - products. A shipment document accompanies the shipment. This document lists - the products and their quantities in the delivery package. This interface creates - shipment record without items quantity (total_qty) validation. To validate total - shipped quantity for each item in the order you must use newer `POST /V1/order/:orderId/ship` - endpoint. - properties: - billing_address_id: - type: integer - description: Billing address ID. - created_at: - type: string - description: Created-at timestamp. - customer_id: - type: integer - description: Customer ID. - email_sent: - type: integer - description: Email-sent flag value. - entity_id: - type: integer - description: Shipment ID. - increment_id: - type: string - description: Increment ID. - order_id: - type: integer - description: Order ID. - packages: - type: array - description: Array of packages, if any. Otherwise, null. - items: - "$ref": "#/definitions/sales-data-shipment-package-interface" - shipment_status: - type: integer - description: Shipment status. - shipping_address_id: - type: integer - description: Shipping address ID. - shipping_label: - type: string - description: Shipping label. - store_id: - type: integer - description: Store ID. - total_qty: - type: number - description: Total quantity. - total_weight: - type: number - description: Total weight. - updated_at: - type: string - description: Updated-at timestamp. - items: - type: array - description: Array of items. - items: - "$ref": "#/definitions/sales-data-shipment-item-interface" - tracks: - type: array - description: Array of tracks. - items: - "$ref": "#/definitions/sales-data-shipment-track-interface" - comments: - type: array - description: Array of comments. - items: - "$ref": "#/definitions/sales-data-shipment-comment-interface" - extension_attributes: - "$ref": "#/definitions/sales-data-shipment-extension-interface" - required: - - order_id - - items - - tracks - - comments - sales-data-shipment-package-interface: - type: object - description: Shipment package interface. A shipment is a delivery package that - contains products. A shipment document accompanies the shipment. This document - lists the products and their quantities in the delivery package. - properties: - extension_attributes: - "$ref": "#/definitions/sales-data-shipment-package-extension-interface" - sales-data-shipment-package-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentPackageInterface - sales-data-shipment-item-interface: - type: object - description: Shipment item interface. A shipment is a delivery package that contains - products. A shipment document accompanies the shipment. This document lists - the products and their quantities in the delivery package. A product is an item - in a shipment. - properties: - additional_data: - type: string - description: Additional data. - description: - type: string - description: Description. - entity_id: - type: integer - description: Shipment item ID. - name: - type: string - description: Name. - parent_id: - type: integer - description: Parent ID. - price: - type: number - description: Price. - product_id: - type: integer - description: Product ID. - row_total: - type: number - description: Row total. - sku: - type: string - description: SKU. - weight: - type: number - description: Weight. - extension_attributes: - "$ref": "#/definitions/sales-data-shipment-item-extension-interface" - order_item_id: - type: integer - description: Order item ID. - qty: - type: number - description: Quantity. - required: - - order_item_id - - qty - sales-data-shipment-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentItemInterface - sales-data-shipment-track-interface: - type: object - description: Shipment track interface. A shipment is a delivery package that contains - products. A shipment document accompanies the shipment. This document lists - the products and their quantities in the delivery package. Merchants and customers - can track shipments. - properties: - order_id: - type: integer - description: The order_id for the shipment package. - created_at: - type: string - description: Created-at timestamp. - entity_id: - type: integer - description: Shipment package ID. - parent_id: - type: integer - description: Parent ID. - updated_at: - type: string - description: Updated-at timestamp. - weight: - type: number - description: Weight. - qty: - type: number - description: Quantity. - description: - type: string - description: Description. - extension_attributes: - "$ref": "#/definitions/sales-data-shipment-track-extension-interface" - track_number: - type: string - description: Track number. - title: - type: string - description: Title. - carrier_code: - type: string - description: Carrier code. - required: - - order_id - - parent_id - - weight - - qty - - description - - track_number - - title - - carrier_code - sales-data-shipment-track-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentTrackInterface - sales-data-shipment-comment-interface: - type: object - description: Shipment comment interface. A shipment is a delivery package that - contains products. A shipment document accompanies the shipment. This document - lists the products and their quantities in the delivery package. A shipment - document can contain comments. - properties: - is_customer_notified: - type: integer - description: Is-customer-notified flag value. - parent_id: - type: integer - description: Parent ID. - extension_attributes: - "$ref": "#/definitions/sales-data-shipment-comment-extension-interface" - comment: - type: string - description: Comment. - is_visible_on_front: - type: integer - description: Is-visible-on-storefront flag value. - created_at: - type: string - description: Created-at timestamp. - entity_id: - type: integer - description: Invoice ID. - required: - - is_customer_notified - - parent_id - - comment - - is_visible_on_front - sales-data-shipment-comment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentCommentInterface - sales-data-shipment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentInterface - properties: - source_code: - type: string - sales-data-shipment-search-result-interface: - type: object - description: Shipment search result interface. A shipment is a delivery package - that contains products. A shipment document accompanies the shipment. This document - lists the products and their quantities in the delivery package. - properties: - items: - type: array - description: Array of collection items. - items: - "$ref": "#/definitions/sales-data-shipment-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - sales-data-shipment-comment-search-result-interface: - type: object - description: Shipment comment search result interface. A shipment is a delivery - package that contains products. A shipment document accompanies the shipment. - This document lists the products and their quantities in the delivery package. - A shipment document can contain comments. - properties: - items: - type: array - description: Array of collection items. - items: - "$ref": "#/definitions/sales-data-shipment-comment-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - sales-data-shipment-item-creation-interface: - type: object - description: Input argument for shipment item creation Interface ShipmentItemCreationInterface - properties: - extension_attributes: - "$ref": "#/definitions/sales-data-shipment-item-creation-extension-interface" - order_item_id: - type: integer - description: Order item ID. - qty: - type: number - description: Quantity. - required: - - order_item_id - - qty - sales-data-shipment-item-creation-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentItemCreationInterface - sales-data-shipment-comment-creation-interface: - type: object - description: Interface ShipmentCommentCreationInterface - properties: - extension_attributes: - "$ref": "#/definitions/sales-data-shipment-comment-creation-extension-interface" - comment: - type: string - description: Comment. - is_visible_on_front: - type: integer - description: Is-visible-on-storefront flag value. - required: - - comment - - is_visible_on_front - sales-data-shipment-comment-creation-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentCommentCreationInterface - sales-data-shipment-track-creation-interface: - type: object - description: Shipment Track Creation interface. - properties: - extension_attributes: - "$ref": "#/definitions/sales-data-shipment-track-creation-extension-interface" - track_number: - type: string - description: Track number. - title: - type: string - description: Title. - carrier_code: - type: string - description: Carrier code. - required: - - track_number - - title - - carrier_code - sales-data-shipment-track-creation-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentTrackCreationInterface - sales-data-shipment-package-creation-interface: - type: object - description: Shipment package interface. A shipment is a delivery package that - contains products. A shipment document accompanies the shipment. This document - lists the products and their quantities in the delivery package. - properties: - extension_attributes: - "$ref": "#/definitions/sales-data-shipment-package-creation-extension-interface" - sales-data-shipment-package-creation-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentPackageCreationInterface - sales-data-shipment-creation-arguments-interface: - type: object - description: Interface for creation arguments for Shipment. - properties: - extension_attributes: - "$ref": "#/definitions/sales-data-shipment-creation-arguments-extension-interface" - sales-data-shipment-creation-arguments-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface - properties: - source_code: - type: string - sales-data-transaction-interface: - type: object - description: Transaction interface. A transaction is an interaction between a - merchant and a customer such as a purchase, a credit, a refund, and so on. - properties: - transaction_id: - type: integer - description: Transaction ID. - parent_id: - type: integer - description: The parent ID for the transaction. Otherwise, null. - order_id: - type: integer - description: Order ID. - payment_id: - type: integer - description: Payment ID. - txn_id: - type: string - description: Transaction business ID. - parent_txn_id: - type: string - description: Parent transaction business ID. - txn_type: - type: string - description: Transaction type. - is_closed: - type: integer - description: Is-closed flag value. - additional_information: - type: array - description: Array of additional information. Otherwise, null. - items: - type: string - created_at: - type: string - description: Created-at timestamp. - child_transactions: - type: array - description: Array of child transactions. - items: - "$ref": "#/definitions/sales-data-transaction-interface" - extension_attributes: - "$ref": "#/definitions/sales-data-transaction-extension-interface" - required: - - transaction_id - - order_id - - payment_id - - txn_id - - parent_txn_id - - txn_type - - is_closed - - created_at - - child_transactions - sales-data-transaction-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\TransactionInterface - sales-data-transaction-search-result-interface: - type: object - description: Transaction search result interface. A transaction is an interaction - between a merchant and a customer such as a purchase, a credit, a refund, and - so on. - properties: - items: - type: array - description: Array of collection items. - items: - "$ref": "#/definitions/sales-data-transaction-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - sales-data-invoice-item-creation-interface: - type: object - description: Input argument for invoice creation Interface InvoiceItemCreationInterface - properties: - extension_attributes: - "$ref": "#/definitions/sales-data-invoice-item-creation-extension-interface" - order_item_id: - type: integer - description: Order item ID. - qty: - type: number - description: Quantity. - required: - - order_item_id - - qty - sales-data-invoice-item-creation-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceItemCreationInterface - sales-data-invoice-comment-creation-interface: - type: object - description: Interface InvoiceCommentCreationInterface - properties: - extension_attributes: - "$ref": "#/definitions/sales-data-invoice-comment-creation-extension-interface" - comment: - type: string - description: Comment. - is_visible_on_front: - type: integer - description: Is-visible-on-storefront flag value. - required: - - comment - - is_visible_on_front - sales-data-invoice-comment-creation-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCommentCreationInterface - sales-data-invoice-creation-arguments-interface: - type: object - description: Interface for creation arguments for Invoice. - properties: - extension_attributes: - "$ref": "#/definitions/sales-data-invoice-creation-arguments-extension-interface" - sales-data-invoice-creation-arguments-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCreationArgumentsInterface - sales-rule-data-rule-interface: - type: object - description: Interface RuleInterface - properties: - rule_id: - type: integer - description: Rule id - name: - type: string - description: Rule name - store_labels: - type: array - description: Display label - items: - "$ref": "#/definitions/sales-rule-data-rule-label-interface" - description: - type: string - description: Description - website_ids: - type: array - description: A list of websites the rule applies to - items: - type: integer - customer_group_ids: - type: array - description: Ids of customer groups that the rule applies to - items: - type: integer - from_date: - type: string - description: The start date when the coupon is active - to_date: - type: string - description: The end date when the coupon is active - uses_per_customer: - type: integer - description: Number of uses per customer - is_active: - type: boolean - description: The coupon is active - condition: - "$ref": "#/definitions/sales-rule-data-condition-interface" - action_condition: - "$ref": "#/definitions/sales-rule-data-condition-interface" - stop_rules_processing: - type: boolean - description: To stop rule processing - is_advanced: - type: boolean - description: Is this field needed - product_ids: - type: array - description: Product ids - items: - type: integer - sort_order: - type: integer - description: Sort order - simple_action: - type: string - description: Simple action of the rule - discount_amount: - type: number - description: Discount amount - discount_qty: - type: number - description: Maximum qty discount is applied - discount_step: - type: integer - description: Discount step - apply_to_shipping: - type: boolean - description: The rule applies to shipping - times_used: - type: integer - description: How many times the rule has been used - is_rss: - type: boolean - description: Whether the rule is in RSS - coupon_type: - type: string - description: Coupon type - use_auto_generation: - type: boolean - description: To auto generate coupon - uses_per_coupon: - type: integer - description: Limit of uses per coupon - simple_free_shipping: - type: string - description: To grant free shipping - extension_attributes: - "$ref": "#/definitions/sales-rule-data-rule-extension-interface" - required: - - website_ids - - customer_group_ids - - uses_per_customer - - is_active - - stop_rules_processing - - is_advanced - - sort_order - - discount_amount - - discount_step - - apply_to_shipping - - times_used - - is_rss - - coupon_type - - use_auto_generation - - uses_per_coupon - sales-rule-data-rule-label-interface: - type: object - description: Interface RuleLabelInterface - properties: - store_id: - type: integer - description: StoreId - store_label: - type: string - description: The label for the store - extension_attributes: - "$ref": "#/definitions/sales-rule-data-rule-label-extension-interface" - required: - - store_id - - store_label - sales-rule-data-rule-label-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\RuleLabelInterface - sales-rule-data-condition-interface: - type: object - description: Interface ConditionInterface - properties: - condition_type: - type: string - description: Condition type - conditions: - type: array - description: List of conditions - items: - "$ref": "#/definitions/sales-rule-data-condition-interface" - aggregator_type: - type: string - description: The aggregator type - operator: - type: string - description: The operator of the condition - attribute_name: - type: string - description: The attribute name of the condition - value: - type: string - description: The value of the condition - extension_attributes: - "$ref": "#/definitions/sales-rule-data-condition-extension-interface" - required: - - condition_type - - operator - - value - sales-rule-data-condition-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\ConditionInterface - sales-rule-data-rule-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\RuleInterface - properties: - reward_points_delta: - type: integer - sales-rule-data-rule-search-result-interface: - type: object - description: '' - properties: - items: - type: array - description: Rules. - items: - "$ref": "#/definitions/sales-rule-data-rule-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - sales-rule-data-coupon-interface: - type: object - description: Interface CouponInterface - properties: - coupon_id: - type: integer - description: Coupon id - rule_id: - type: integer - description: The id of the rule associated with the coupon - code: - type: string - description: Coupon code - usage_limit: - type: integer - description: Usage limit - usage_per_customer: - type: integer - description: Usage limit per customer - times_used: - type: integer - description: The number of times the coupon has been used - expiration_date: - type: string - description: Expiration date - is_primary: - type: boolean - description: The coupon is primary coupon for the rule that it's associated - with - created_at: - type: string - description: When the coupon is created - type: - type: integer - description: Of coupon - extension_attributes: - "$ref": "#/definitions/sales-rule-data-coupon-extension-interface" - required: - - rule_id - - times_used - - is_primary - sales-rule-data-coupon-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\CouponInterface - sales-rule-data-coupon-search-result-interface: - type: object - description: '' - properties: - items: - type: array - description: Rules. - items: - "$ref": "#/definitions/sales-rule-data-coupon-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - sales-rule-data-coupon-generation-spec-interface: - type: object - description: CouponGenerationSpecInterface - properties: - rule_id: - type: integer - description: The id of the rule associated with the coupon - format: - type: string - description: Format of generated coupon code - quantity: - type: integer - description: Of coupons to generate - length: - type: integer - description: Length of coupon code - prefix: - type: string - description: The prefix - suffix: - type: string - description: The suffix - delimiter_at_every: - type: integer - description: The spacing where the delimiter should exist - delimiter: - type: string - description: The delimiter - extension_attributes: - "$ref": "#/definitions/sales-rule-data-coupon-generation-spec-extension-interface" - required: - - rule_id - - format - - quantity - - length - sales-rule-data-coupon-generation-spec-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\CouponGenerationSpecInterface - sales-rule-data-coupon-mass-delete-result-interface: - type: object - description: Coupon mass delete results interface. - properties: - failed_items: - type: array - description: List of failed items. - items: - type: string - missing_items: - type: array - description: List of missing items. - items: - type: string - required: - - failed_items - - missing_items - bundle-data-option-type-interface: - type: object - description: Interface OptionTypeInterface - properties: - label: - type: string - description: Type label - code: - type: string - description: Type code - extension_attributes: - "$ref": "#/definitions/bundle-data-option-type-extension-interface" - required: - - label - - code - bundle-data-option-type-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\OptionTypeInterface - requisition-list-data-requisition-list-interface: - type: object - description: Interface RequisitionListInterface - properties: - id: - type: integer - description: Requisition List ID - customer_id: - type: integer - description: Customer ID - name: - type: string - description: Requisition List Name - updated_at: - type: string - description: Requisition List Update Time - description: - type: string - description: Requisition List Description - items: - type: array - description: Requisition List Items - items: - "$ref": "#/definitions/requisition-list-data-requisition-list-item-interface" - extension_attributes: - "$ref": "#/definitions/requisition-list-data-requisition-list-extension-interface" - required: - - id - - customer_id - - name - - updated_at - - description - - items - requisition-list-data-requisition-list-item-interface: - type: object - description: Interface RequisitionListItemInterface - properties: - id: - type: integer - description: Requisition List ID. - sku: - type: string - description: Product SKU. - requisition_list_id: - type: integer - description: Requisition List ID. - qty: - type: number - description: Product Qty. - options: - type: array - description: Requisition list item options. - items: - type: string - store_id: - type: integer - description: Store ID. - added_at: - type: string - description: Added_at value. - extension_attributes: - "$ref": "#/definitions/requisition-list-data-requisition-list-item-extension-interface" - required: - - id - - sku - - requisition_list_id - - qty - - options - - store_id - - added_at - requisition-list-data-requisition-list-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListItemInterface - requisition-list-data-requisition-list-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListInterface - checkout-data-shipping-information-interface: - type: object - description: Interface ShippingInformationInterface - properties: - shipping_address: - "$ref": "#/definitions/quote-data-address-interface" - billing_address: - "$ref": "#/definitions/quote-data-address-interface" - shipping_method_code: - type: string - description: Shipping method code - shipping_carrier_code: - type: string - description: Carrier code - extension_attributes: - "$ref": "#/definitions/checkout-data-shipping-information-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - shipping_address - - shipping_method_code - - shipping_carrier_code - checkout-data-shipping-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface - checkout-data-payment-details-interface: - type: object - description: Interface PaymentDetailsInterface - properties: - payment_methods: - type: array - items: - "$ref": "#/definitions/quote-data-payment-method-interface" - totals: - "$ref": "#/definitions/quote-data-totals-interface" - extension_attributes: - "$ref": "#/definitions/checkout-data-payment-details-extension-interface" - required: - - payment_methods - - totals - checkout-data-payment-details-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface - checkout-data-totals-information-interface: - type: object - description: Interface TotalsInformationInterface - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - shipping_method_code: - type: string - description: Shipping method code - shipping_carrier_code: - type: string - description: Carrier code - extension_attributes: - "$ref": "#/definitions/checkout-data-totals-information-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - address - checkout-data-totals-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface - commerce-backend-uix-data-mass-action-failed-request-interface: - type: object - description: Defines the mass actions failed requests database model - properties: - id: - type: string - description: Internal id - request_id: - type: string - description: Request id - action_id: - type: string - description: Action id - grid_type: - type: string - description: Ui grid type - error_status: - type: string - description: Error status - error_message: - type: string - description: Error message - request_timestamp: - type: string - description: Request timestamp - selected_ids: - type: string - description: Selected ids - required: - - request_id - - action_id - - grid_type - - error_status - - error_message - - request_timestamp - - selected_ids - commerce-backend-uix-data-order-view-button-failed-request-interface: - type: object - description: Defines the order view button failed requests database model - properties: - id: - type: string - description: Internal id - request_id: - type: string - description: Request id - button_id: - type: string - description: Button id - order_id: - type: string - description: Order id - error_status: - type: string - description: Error status - error_message: - type: string - description: Error message - request_timestamp: - type: string - description: Request timestamp - required: - - request_id - - button_id - - order_id - - error_status - - error_message - - request_timestamp - commerce-backend-uix-data-app-management-validation-result-interface: - type: object - description: App Management User Validation Result Interface - properties: - authorized: - type: boolean - description: Authorization status - required: - - authorized - company-data-company-search-results-interface: - type: object - description: Interface for company search results - properties: - items: - type: array - description: Companies list - items: - "$ref": "#/definitions/company-data-company-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - company-data-company-interface: - type: object - description: Interface for Company entity. - properties: - id: - type: integer - description: Id. - status: - type: integer - description: Status. - company_name: - type: string - description: Company name. - legal_name: - type: string - description: Legal name. - company_email: - type: string - description: Company email. - vat_tax_id: - type: string - description: Vat tax id. - reseller_id: - type: string - description: Reseller Id. - comment: - type: string - description: Comment. - street: - type: array - description: Street. - items: - type: string - city: - type: string - description: City. - country_id: - type: string - description: Country. - region: - type: string - description: Region. - region_id: - type: string - description: Region Id. - postcode: - type: string - description: Postcode. - telephone: - type: string - description: Telephone. - customer_group_id: - type: integer - description: Customer Group Id. - sales_representative_id: - type: integer - description: Sales Representative Id. - reject_reason: - type: string - description: Reject Reason. - rejected_at: - type: string - description: Rejected at time. - super_user_id: - type: integer - description: Company admin customer id. - extension_attributes: - "$ref": "#/definitions/company-data-company-extension-interface" - required: - - street - - customer_group_id - - sales_representative_id - - reject_reason - - rejected_at - - super_user_id - company-data-company-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyInterface - properties: - applicable_payment_method: - type: integer - available_payment_methods: - type: string - use_config_settings: - type: integer - quote_config: - "$ref": "#/definitions/negotiable-quote-data-company-quote-config-interface" - is_purchase_order_enabled: - type: boolean - applicable_shipping_method: - type: integer - available_shipping_methods: - type: string - use_config_settings_shipping: - type: integer - negotiable-quote-data-company-quote-config-interface: - type: object - description: Interface CompanyQuoteConfigInterface - properties: - company_id: - type: string - description: Company id - is_quote_enabled: - type: boolean - description: Quote enabled for company - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-company-quote-config-extension-interface" - required: - - is_quote_enabled - negotiable-quote-data-company-quote-config-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CompanyQuoteConfigInterface - company-data-team-search-results-interface: - type: object - description: Interface for company team search results - properties: - items: - type: array - description: Teams list - items: - "$ref": "#/definitions/company-data-team-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - company-data-team-interface: - type: object - description: Team custom attributes management - properties: - id: - type: integer - description: ID - name: - type: string - description: Name - description: - type: string - description: Description - extension_attributes: - "$ref": "#/definitions/company-data-team-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - company-data-team-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Company\Api\Data\TeamInterface - company-data-hierarchy-interface: - type: object - description: Company hierarchy DTO interface for WebAPI. - properties: - structure_id: - type: integer - description: Structure ID. - entity_id: - type: integer - description: Entity ID. - entity_type: - type: string - description: Entity type. - structure_parent_id: - type: integer - description: Structure parent ID. - extension_attributes: - "$ref": "#/definitions/company-data-hierarchy-extension-interface" - company-data-hierarchy-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Company\Api\Data\HierarchyInterface - company-data-role-search-results-interface: - type: object - description: Interface for role search results. - properties: - items: - type: array - description: Roles list. - items: - "$ref": "#/definitions/company-data-role-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - company-data-role-interface: - type: object - description: Role data transfer object interface. - properties: - id: - type: integer - description: Role id. - role_name: - type: string - description: Role name. - permissions: - type: array - description: Permissions. - items: - "$ref": "#/definitions/company-data-permission-interface" - company_id: - type: integer - description: Company id. - extension_attributes: - "$ref": "#/definitions/company-data-role-extension-interface" - required: - - permissions - company-data-permission-interface: - type: object - description: Permission management - properties: - id: - type: integer - description: Id. - role_id: - type: integer - description: Role id. - resource_id: - type: string - description: Resource id. - permission: - type: string - description: Permission. - required: - - resource_id - - permission - company-data-role-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Company\Api\Data\RoleInterface - company-data-company-customer-search-results-interface: - type: object - description: Interface for company customer attributes search results - properties: - items: - type: array - description: Company customer attributes list - items: - "$ref": "#/definitions/company-data-company-customer-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - checkout-agreements-data-agreement-interface: - type: object - description: Interface AgreementInterface - properties: - agreement_id: - type: integer - description: Agreement ID. - name: - type: string - description: Agreement name. - content: - type: string - description: Agreement content. - content_height: - type: string - description: Agreement content height. Otherwise, null. - checkbox_text: - type: string - description: Agreement checkbox text. - is_active: - type: boolean - description: Agreement status. - is_html: - type: boolean - description: "* true - HTML. * false - plain text." - mode: - type: integer - description: The agreement applied mode. - extension_attributes: - "$ref": "#/definitions/checkout-agreements-data-agreement-extension-interface" - required: - - agreement_id - - name - - content - - checkbox_text - - is_active - - is_html - - mode - checkout-agreements-data-agreement-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\CheckoutAgreements\Api\Data\AgreementInterface - tax-data-tax-rate-interface: - type: object - description: Tax rate interface. - properties: - id: - type: integer - description: Id - tax_country_id: - type: string - description: Country id - tax_region_id: - type: integer - description: Region id - region_name: - type: string - description: Region name - tax_postcode: - type: string - description: Postcode - zip_is_range: - type: integer - description: Zip is range - zip_from: - type: integer - description: Zip range from - zip_to: - type: integer - description: Zip range to - rate: - type: number - description: Tax rate in percentage - code: - type: string - description: Tax rate code - titles: - type: array - description: Tax rate titles - items: - "$ref": "#/definitions/tax-data-tax-rate-title-interface" - extension_attributes: - "$ref": "#/definitions/tax-data-tax-rate-extension-interface" - required: - - tax_country_id - - rate - - code - tax-data-tax-rate-title-interface: - type: object - description: Tax rate title interface. - properties: - store_id: - type: string - description: Store id - value: - type: string - description: Title value - extension_attributes: - "$ref": "#/definitions/tax-data-tax-rate-title-extension-interface" - required: - - store_id - - value - tax-data-tax-rate-title-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Tax\Api\Data\TaxRateTitleInterface - tax-data-tax-rate-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Tax\Api\Data\TaxRateInterface - tax-data-tax-rate-search-results-interface: - type: object - description: Interface for tax rate search results. - properties: - items: - type: array - description: Items - items: - "$ref": "#/definitions/tax-data-tax-rate-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - tax-data-tax-rule-interface: - type: object - description: Tax rule interface. - properties: - id: - type: integer - description: Id - code: - type: string - description: Tax rule code - priority: - type: integer - description: Priority - position: - type: integer - description: Sort order. - customer_tax_class_ids: - type: array - description: Customer tax class id - items: - type: integer - product_tax_class_ids: - type: array - description: Product tax class id - items: - type: integer - tax_rate_ids: - type: array - description: Tax rate ids - items: - type: integer - calculate_subtotal: - type: boolean - description: Calculate subtotal. - extension_attributes: - "$ref": "#/definitions/tax-data-tax-rule-extension-interface" - required: - - code - - priority - - position - - customer_tax_class_ids - - product_tax_class_ids - - tax_rate_ids - tax-data-tax-rule-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Tax\Api\Data\TaxRuleInterface - tax-data-tax-rule-search-results-interface: - type: object - description: Interface for tax rule search results. - properties: - items: - type: array - description: Items - items: - "$ref": "#/definitions/tax-data-tax-rule-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - tax-data-tax-class-interface: - type: object - description: Tax class interface. - properties: - class_id: - type: integer - description: Tax class ID. - class_name: - type: string - description: Tax class name. - class_type: - type: string - description: Tax class type. - extension_attributes: - "$ref": "#/definitions/tax-data-tax-class-extension-interface" - required: - - class_name - - class_type - tax-data-tax-class-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Tax\Api\Data\TaxClassInterface - tax-data-tax-class-search-results-interface: - type: object - description: Interface for tax class search results. - properties: - items: - type: array - description: Items - items: - "$ref": "#/definitions/tax-data-tax-class-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - company-credit-data-credit-limit-search-results-interface: - type: object - description: Interface for Credit Limit search results. - properties: - items: - type: array - description: Credit Limit list. - items: - "$ref": "#/definitions/company-credit-data-credit-data-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - company-credit-data-credit-data-interface: - type: object - description: Credit Data interface. - properties: - id: - type: integer - description: ID. - company_id: - type: integer - description: Company id. - credit_limit: - type: number - description: Credit Limit. - balance: - type: number - description: Balance. - currency_code: - type: string - description: Currency Code. - exceed_limit: - type: boolean - description: Exceed Limit. - available_limit: - type: number - description: Available Limit. - required: - - exceed_limit - company-credit-data-credit-limit-interface: - type: object - description: Credit Limit data transfer object interface. - properties: - id: - type: integer - description: ID. - company_id: - type: integer - description: Company id. - credit_limit: - type: number - description: Credit Limit. - balance: - type: number - description: Balance. - currency_code: - type: string - description: Currency Code. - exceed_limit: - type: boolean - description: Exceed Limit. - available_limit: - type: number - description: Available Limit. - credit_comment: - type: string - description: Credit comment for company credit history. - extension_attributes: - "$ref": "#/definitions/company-credit-data-credit-limit-extension-interface" - required: - - exceed_limit - company-credit-data-credit-limit-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\CompanyCredit\Api\Data\CreditLimitInterface - company-credit-data-credit-balance-options-interface: - type: object - description: Credit balance data transfer object interface. - properties: - purchase_order: - type: string - description: Purchase order number. - custom_reference_number: - type: string - description: Custom Reference number. - order_increment: - type: string - description: Order increment. - currency_display: - type: string - description: Currency display. - currency_base: - type: string - description: Currency base. - required: - - purchase_order - - order_increment - - currency_display - - currency_base - company-credit-data-history-search-results-interface: - type: object - description: Interface for History search results. - properties: - items: - type: array - description: History list. - items: - "$ref": "#/definitions/company-credit-data-history-data-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - company-credit-data-history-data-interface: - type: object - description: History data transfer object interface. - properties: - id: - type: integer - description: ID. - company_credit_id: - type: integer - description: Company credit id. - user_id: - type: integer - description: User Id. - user_type: - type: integer - description: 'User type: integration, admin, customer.' - currency_credit: - type: string - description: Currency code of credit. - currency_operation: - type: string - description: Currency code of operation. - rate: - type: number - description: Currency rate between credit and operation currencies. - rate_credit: - type: number - description: Rate between credit and base currencies. - amount: - type: number - description: Amount. - balance: - type: number - description: Outstanding balance. - credit_limit: - type: number - description: Credit limit. - available_limit: - type: number - description: Available limit. - type: - type: integer - description: Type of operation. - datetime: - type: string - description: Operation datetime. - purchase_order: - type: string - description: Purchase Order number. - custom_reference_number: - type: string - description: Custom Reference number. - comment: - type: string - description: Comment. - required: - - rate - - amount - - balance - - credit_limit - negotiable-quote-data-attachment-content-interface: - type: object - description: Attachment files content interface. - properties: - base64_encoded_data: - type: string - description: Media data (base64 encoded content). - type: - type: string - description: MIME type. - name: - type: string - description: File name. - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-attachment-content-extension-interface" - required: - - base64_encoded_data - - type - - name - negotiable-quote-data-attachment-content-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\AttachmentContentInterface - negotiable-quote-data-comment-interface: - type: object - description: Interface CommentInterface - properties: - entity_id: - type: integer - description: Comment ID. - parent_id: - type: integer - description: Negotiable quote ID, that this comment belongs to. - creator_type: - type: integer - description: The comment creator type. - is_decline: - type: integer - description: Is quote was declined by seller. - is_draft: - type: integer - description: Is quote draft flag. - creator_id: - type: integer - description: Comment creator ID. - comment: - type: string - description: Comment. - created_at: - type: string - description: Comment created at. - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-comment-extension-interface" - attachments: - type: array - description: Existing attachments. - items: - "$ref": "#/definitions/negotiable-quote-data-comment-attachment-interface" - required: - - entity_id - - parent_id - - creator_type - - is_decline - - is_draft - - creator_id - - comment - - created_at - - attachments - negotiable-quote-data-comment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CommentInterface - negotiable-quote-data-comment-attachment-interface: - type: object - description: Interface for quote comment attachment. - properties: - attachment_id: - type: integer - description: Attachment ID. - comment_id: - type: integer - description: Comment ID. - file_name: - type: string - description: File name. - file_path: - type: string - description: File path. - file_type: - type: string - description: File type. - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-comment-attachment-extension-interface" - required: - - attachment_id - - comment_id - - file_name - - file_path - - file_type - negotiable-quote-data-comment-attachment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CommentAttachmentInterface - gift-card-account-data-gift-card-account-interface: - type: object - description: Gift Card Account data - properties: - gift_cards: - type: array - description: Cards codes. - items: - type: string - gift_cards_amount: - type: number - description: Cards amount in quote currency. - base_gift_cards_amount: - type: number - description: Cards amount in base currency. - gift_cards_amount_used: - type: number - description: Cards amount used in quote currency. - base_gift_cards_amount_used: - type: number - description: Cards amount used in base currency. - extension_attributes: - "$ref": "#/definitions/gift-card-account-data-gift-card-account-extension-interface" - required: - - gift_cards_amount - - base_gift_cards_amount - - gift_cards_amount_used - - base_gift_cards_amount_used - gift-card-account-data-gift-card-account-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface - negotiable-quote-data-item-note-search-results-interface: - type: object - description: Interface for Negotiable Quote Item Notes search results. - properties: - items: - type: array - description: Negotiable Quote Item Notes list. - items: - "$ref": "#/definitions/negotiable-quote-data-item-note-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - negotiable-quote-template-data-template-interface: - type: object - description: Interface TemplateInterface - properties: - template_id: - type: integer - description: Negotiable quote ID. - parent_quote_id: - type: integer - description: Negotiable quote ID. - template_name: - type: string - description: Negotiable quote template name. - status: - type: string - description: Negotiable quote template status - expiration_date: - type: string - description: Expiration period. - creator_id: - type: integer - description: Quote template creator id. - creator_type: - type: integer - description: Quote creator type. - min_orders: - type: integer - description: Min orders for purchase - max_orders: - type: integer - description: Min orders for purchase - is_min_max_qty_used: - type: boolean - description: Is min/max qty used. - activated_at: - type: string - description: Activated at time - last_shared_at: - type: string - description: Last shared at - inactivated_at: - type: string - description: Inactivated at time - created_at: - type: string - description: Created at time - updated_at: - type: string - description: Updated at time - extension_attributes: - "$ref": "#/definitions/negotiable-quote-template-data-template-extension-interface" - required: - - template_id - - parent_quote_id - - template_name - - status - - expiration_date - - creator_id - - creator_type - - min_orders - - max_orders - - is_min_max_qty_used - - activated_at - - last_shared_at - - inactivated_at - - created_at - - updated_at - - extension_attributes - negotiable-quote-template-data-template-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuoteTemplate\Api\Data\TemplateInterface - framework-search-results-interface: - type: object - description: Search results interface. - properties: - items: - type: array - description: Items list. - items: - "$ref": "#/definitions/framework-extensible-data-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - framework-extensible-data-interface: - type: object - description: Interface for entities which can be extended with extension attributes. - negotiable-quote-template-data-reference-document-link-interface: - type: object - description: Interface ReferenceDocumentLinkInterface - properties: - link_id: - type: integer - description: Link ID. - template_id: - type: integer - description: Negotiable quote ID. - document_name: - type: string - description: Document name - document_identifier: - type: string - description: Document identifier - reference_document_url: - type: string - description: Reference document url - created_at: - type: string - description: Created at time - extension_attributes: - "$ref": "#/definitions/negotiable-quote-template-data-reference-document-link-extension-interface" - required: - - link_id - - template_id - - document_name - - document_identifier - - reference_document_url - - created_at - - extension_attributes - negotiable-quote-template-data-reference-document-link-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuoteTemplate\Api\Data\ReferenceDocumentLinkInterface - company-relation-data-relation-search-result-interface: - type: object - description: Interface for company relation search results - properties: - items: - type: array - description: Company relations - items: - "$ref": "#/definitions/company-relation-data-relation-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - company-relation-data-relation-interface: - type: object - description: Company relation data interface. - properties: - company_id: - type: integer - description: Company id. - parent_id: - type: integer - description: Parent company id. - required: - - company_id - - parent_id - two-factor-auth-provider-interface: - type: object - description: 2FA provider interface - properties: - enabled: - type: boolean - description: True if this provider has been enabled by admin - engine: - "$ref": "#/definitions/two-factor-auth-engine-interface" - code: - type: string - description: Provider code - name: - type: string - description: Provider name - icon: - type: string - description: Icon - reset_allowed: - type: boolean - description: True if this provider configuration can be reset - configure_action: - type: string - description: Configure action - auth_action: - type: string - description: Auth action - extra_actions: - type: array - description: Allowed extra actions - items: - type: string - required: - - enabled - - engine - - code - - name - - icon - - reset_allowed - - configure_action - - auth_action - - extra_actions - two-factor-auth-engine-interface: - type: object - description: 2FA engine interface - properties: - enabled: - type: boolean - description: True if this provider has been enabled by admin - required: - - enabled - two-factor-auth-data-google-configure-interface: - type: object - description: Google configuration data interface - properties: - qr_code_base64: - type: string - description: Value for QR code base 64 - secret_code: - type: string - description: Value for secret code - extension_attributes: - "$ref": "#/definitions/two-factor-auth-data-google-configure-extension-interface" - required: - - qr_code_base64 - - secret_code - two-factor-auth-data-google-configure-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface - two-factor-auth-data-authy-device-interface: - type: object - description: Authy device data interface - properties: - country: - type: string - description: The country - phone_number: - type: string - description: The phone number - method: - type: string - description: The method to authenticate with - extension_attributes: - "$ref": "#/definitions/two-factor-auth-data-authy-device-extension-interface" - required: - - country - - phone_number - - method - two-factor-auth-data-authy-device-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyDeviceInterface - two-factor-auth-data-authy-registration-prompt-response-interface: - type: object - description: Response for device registration prompt - properties: - message: - type: string - description: The message - expiration_seconds: - type: string - description: The seconds to expire - extension_attributes: - "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-extension-interface" - required: - - message - - expiration_seconds - two-factor-auth-data-authy-registration-prompt-response-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface - two-factor-auth-data-u2f-web-authn-request-interface: - type: object - description: Represents a WebAuthn dataset - properties: - credential_request_options_json: - type: string - description: The needed data to initiate a WebAuthn registration ceremony - extension_attributes: - "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-extension-interface" - required: - - credential_request_options_json - two-factor-auth-data-u2f-web-authn-request-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestInterface - shared-catalog-data-shared-catalog-interface: - type: object - description: SharedCatalogInterface interface. - properties: - id: - type: integer - description: ID. - name: - type: string - description: Shared Catalog name. - description: - type: string - description: Shared Catalog description. - customer_group_id: - type: integer - description: Customer Group Id. - type: - type: integer - description: Shared Catalog type. - created_at: - type: string - description: Created time for Shared Catalog. - created_by: - type: integer - description: Admin id for Shared Catalog. - store_id: - type: integer - description: Store group id for Shared Catalog. - tax_class_id: - type: integer - description: Tax class id. - required: - - name - - description - - customer_group_id - - type - - created_at - - created_by - - store_id - - tax_class_id - shared-catalog-data-search-results-interface: - type: object - description: Interface for Shared Catalog search results. - properties: - items: - type: array - description: Shared Catalog list. - items: - "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - adobe-commerce-webhooks-data-webhook-data-interface: - type: object - description: Interface for webhook data from webapi requests - properties: - webhook_method: - type: string - description: Webhook method name - webhook_type: - type: string - description: Webhook type - batch_name: - type: string - description: Webhook batch name - batch_order: - type: integer - description: Webhook batch order - hook_name: - type: string - description: Hook name - url: - type: string - description: Hook url - priority: - type: integer - description: Hook priority - required: - type: boolean - description: If hook is required - soft_timeout: - type: integer - description: Hook soft timeout - timeout: - type: integer - description: Hook timeout - method: - type: string - description: Hook method - fallback_error_message: - type: string - description: Hook fallback error message - ttl: - type: integer - description: Hook ttl - fields: - type: array - description: Webhook fields - items: - "$ref": "#/definitions/adobe-commerce-webhooks-data-hook-field-interface" - rules: - type: array - description: Webhook rules - items: - "$ref": "#/definitions/adobe-commerce-webhooks-data-hook-rule-interface" - headers: - type: array - description: Webhook headers - items: - "$ref": "#/definitions/adobe-commerce-webhooks-data-hook-header-interface" - developer_console_oauth: - "$ref": "#/definitions/adobe-commerce-webhooks-data-developer-console-oauth-interface" - required: - - webhook_method - - webhook_type - - batch_name - - batch_order - - hook_name - - url - - priority - - required - - soft_timeout - - timeout - - method - - fallback_error_message - - ttl - - fields - - rules - - headers - adobe-commerce-webhooks-data-hook-field-interface: - type: object - description: Interface for hook field data from webapi requests - properties: - name: - type: string - description: Field name. - source: - type: string - description: Field source. - required: - - name - - source - adobe-commerce-webhooks-data-hook-rule-interface: - type: object - description: Interface for hook rule data from webapi requests - properties: - field: - type: string - description: Field name. - operator: - type: string - description: Operator. - value: - type: string - description: Value. - required: - - field - - operator - - value - adobe-commerce-webhooks-data-hook-header-interface: - type: object - description: Interface for hook header data from webapi requests - properties: - name: - type: string - description: Header name. - value: - type: string - description: Header value. - required: - - name - - value - adobe-commerce-webhooks-data-developer-console-oauth-interface: - type: object - description: Interface for Developer Console OAuth data from webapi requests. - properties: - client_id: - type: string - description: The Developer Console OAuth client ID. - client_secret: - type: string - description: The Developer Console OAuth client secret. - org_id: - type: string - description: The Developer Console OAuth org ID. - environment: - type: string - description: The Developer Console OAuth environment. - required: - - client_id - - client_secret - - org_id - - environment - analytics-data-link-interface: - type: object - description: Represents link with collected data and initialized vector for decryption. - properties: - url: - type: string - description: Url - initialization_vector: - type: string - description: Initialization vector - required: - - url - - initialization_vector - gift-wrapping-data-wrapping-interface: - type: object - description: Interface WrappingInterface - properties: - wrapping_id: - type: integer - description: Wrapping ID - design: - type: string - description: Design - status: - type: integer - description: Status - base_price: - type: number - description: Base price - image_name: - type: string - description: Image name - image_base64_content: - type: string - description: Image base64 encode - base_currency_code: - type: string - description: Base currency code - website_ids: - type: array - description: Website ids - items: - type: integer - image_url: - type: string - description: Wrapping image URL. - extension_attributes: - "$ref": "#/definitions/gift-wrapping-data-wrapping-extension-interface" - required: - - wrapping_id - - design - - status - - base_price - gift-wrapping-data-wrapping-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GiftWrapping\Api\Data\WrappingInterface - gift-wrapping-data-wrapping-search-results-interface: - type: object - description: Interface WrappingSearchResultsInterface - properties: - items: - type: array - description: Items - items: - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - import-csv-api-data-localized-source-data-interface: - type: object - description: "{@inheritdoc} Adds locale field in source data" - properties: - locale: - type: string - description: Import content locale - entity: - type: string - description: Entity - behavior: - type: string - description: Behavior - validation_strategy: - type: string - description: Validation Strategy - allowed_error_count: - type: string - description: Allowed Error Count - csv_data: - type: string - description: CSV data as string - import_field_separator: - type: string - description: Import's Field Separator for CSV - import_multiple_value_separator: - type: string - description: Import's Multiple Value Field Separator for CSV - import_empty_attribute_value_constant: - type: string - description: Import's Empty Attribute Value Constant - import_images_file_dir: - type: string - description: Import's Images File Directory - required: - - entity - - behavior - - validation_strategy - - allowed_error_count - - csv_data - import-json-api-data-source-data-interface: - type: object - description: Import JSON source data interface. - properties: - entity: - type: string - description: Entity - behavior: - type: string - description: Behavior - validation_strategy: - type: string - description: Validation Strategy - allowed_error_count: - type: string - description: Allowed Error Count - items: - "$ref": "#/definitions/unstructured-array" - import_images_file_dir: - type: string - description: Import's Images File Directory - locale: - type: string - description: Import content locale - required: - - entity - - behavior - - validation_strategy - - allowed_error_count - - items - unstructured-array: - type: object - description: '' - inventory-api-data-source-search-results-interface: - type: object - description: Search results of Repository::getList method Used fully qualified - namespaces in annotations for proper work of WebApi request parser - properties: - items: - type: array - description: Sources list - items: - "$ref": "#/definitions/inventory-api-data-source-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - inventory-api-data-source-interface: - type: object - description: Represents physical storage, i.e. brick and mortar store or warehouse - Used fully qualified namespaces in annotations for proper work of WebApi request - parser - properties: - source_code: - type: string - description: Source code - name: - type: string - description: Source name - email: - type: string - description: Source email - contact_name: - type: string - description: Source contact name - enabled: - type: boolean - description: If source is enabled. For new entity can be null - description: - type: string - description: Source description - latitude: - type: number - description: Source latitude - longitude: - type: number - description: Source longitude - country_id: - type: string - description: Source country id - region_id: - type: integer - description: Region id if source has registered region. - region: - type: string - description: Region title if source has custom region - city: - type: string - description: Source city - street: - type: string - description: Source street name - postcode: - type: string - description: Source post code - phone: - type: string - description: Source phone number - fax: - type: string - description: Source fax - use_default_carrier_config: - type: boolean - description: Is need to use default config - carrier_links: - type: array - description: Carrier links for the source as an array of SourceCarrierLinkInterface - objects or null. - items: - "$ref": "#/definitions/inventory-api-data-source-carrier-link-interface" - extension_attributes: - "$ref": "#/definitions/inventory-api-data-source-extension-interface" - inventory-api-data-source-carrier-link-interface: - type: object - description: Represents relation between some physical storage and shipping method - Used fully qualified namespaces in annotations for proper work of WebApi request - parser - properties: - carrier_code: - type: string - description: Carrier code - position: - type: integer - description: Position - extension_attributes: - "$ref": "#/definitions/inventory-api-data-source-carrier-link-extension-interface" - inventory-api-data-source-carrier-link-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\SourceCarrierLinkInterface - inventory-api-data-source-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\SourceInterface - properties: - is_pickup_location_active: - type: boolean - frontend_name: - type: string - frontend_description: - type: string - inventory-api-data-stock-search-results-interface: - type: object - description: Search results of Repository::getList method Used fully qualified - namespaces in annotations for proper work of WebApi request parser - properties: - items: - type: array - description: Stocks list - items: - "$ref": "#/definitions/inventory-api-data-stock-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - inventory-api-data-stock-interface: - type: object - description: Represents product aggregation among some different physical storages - (in technical words, it is an index) Used fully qualified namespaces in annotations - for proper work of WebApi request parser - properties: - stock_id: - type: integer - description: Stock id - name: - type: string - description: Stock name - extension_attributes: - "$ref": "#/definitions/inventory-api-data-stock-extension-interface" - inventory-api-data-stock-extension-interface: - type: object - description: 'TODO: temporal fix of extension classes generation during installation - ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\StockInterface' - properties: - sales_channels: - type: array - description: Stock extension attributes like sales channels for a stock entity - as an array of SalesChannelInterface. - items: - "$ref": "#/definitions/inventory-sales-api-data-sales-channel-interface" - inventory-sales-api-data-sales-channel-interface: - type: object - description: Represents sales channels (which are a linkage between stocks and - websites, customer groups, etc.) Used fully qualified namespaces in annotations - for proper work of WebApi request parser - properties: - type: - type: string - description: Sales channel type - code: - type: string - description: Sales channel code - extension_attributes: - "$ref": "#/definitions/inventory-sales-api-data-sales-channel-extension-interface" - inventory-sales-api-data-sales-channel-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\SalesChannelInterface - inventory-api-data-stock-source-link-search-results-interface: - type: object - description: Search results of Repository::getList method Used fully qualified - namespaces in annotations for proper work of WebApi request parser - properties: - items: - type: array - description: StockSourceLink list - items: - "$ref": "#/definitions/inventory-api-data-stock-source-link-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - inventory-api-data-stock-source-link-interface: - type: object - description: Represents relation between Stock and Source entities. Used fully - qualified namespaces in annotations for proper work of WebApi request parser - properties: - stock_id: - type: integer - description: Stock id - source_code: - type: string - description: Source code of the link - priority: - type: integer - description: Priority of the link - extension_attributes: - "$ref": "#/definitions/inventory-api-data-stock-source-link-extension-interface" - inventory-api-data-stock-source-link-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\StockSourceLinkInterface - properties: - source_name: - type: string - inventory-api-data-source-item-search-results-interface: - type: object - description: Search results of Repository::getList method Used fully qualified - namespaces in annotations for proper work of WebApi request parser - properties: - items: - type: array - description: Source items list - items: - "$ref": "#/definitions/inventory-api-data-source-item-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - inventory-api-data-source-item-interface: - type: object - description: Represents amount of product on physical storage Entity id getter - is missed because entity identifies by compound identifier (sku and source_code) - Used fully qualified namespaces in annotations for proper work of WebApi request - parser - properties: - sku: - type: string - description: Source item sku - source_code: - type: string - description: Source code - quantity: - type: number - description: Source item quantity - status: - type: integer - description: Source item status (One of self::STATUS_*) - extension_attributes: - "$ref": "#/definitions/inventory-api-data-source-item-extension-interface" - inventory-api-data-source-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\SourceItemInterface - inventory-catalog-api-data-partial-inventory-transfer-item-interface: - type: object - description: Specifies item and quantity for partial inventory transfer. - properties: - sku: - type: string - description: The SKU of the partial inventory transfer item. - qty: - type: number - description: The quantity of the partial inventory transfer item. - required: - - sku - - qty - inventory-distance-based-source-selection-api-data-lat-lng-interface: - type: object - description: DTO for latitude and longitude request - properties: - lat: - type: number - description: Latitude - lng: - type: number - description: Longitude - required: - - lat - - lng - inventory-export-stock-api-data-export-stock-salable-qty-search-result-interface: - type: object - description: Interface for ExportStockSalableQtySearchResult - properties: - items: - type: array - items: - "$ref": "#/definitions/framework-extensible-data-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - inventory-export-stock-api-data-product-stock-index-data-interface: - type: object - description: Class ExportStockIndexDataResultInterface for result Inventory stock - index dump export - properties: - sku: - type: string - description: Product SKU - qty: - type: number - description: Product QTY - is_salable: - type: boolean - description: Product is salable flag - required: - - sku - - qty - - is_salable - inventory-sales-api-data-is-product-salable-result-interface: - type: object - description: Represents "is product salable" result interface. - properties: - sku: - type: string - description: Product sku from result. - stock_id: - type: integer - description: Stock id from result. - salable: - type: boolean - description: Is salable result. - extension_attributes: - "$ref": "#/definitions/inventory-sales-api-data-is-product-salable-result-extension-interface" - required: - - sku - - stock_id - - salable - inventory-sales-api-data-is-product-salable-result-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\IsProductSalableResultInterface - inventory-sales-api-data-product-salable-result-interface: - type: object - description: Represents result of service Magento\InventorySalesApi\Api\IsProductSalableForRequestedQtyInterface::execute - properties: - salable: - type: boolean - description: If the product is salable based on its availability and conditions. - errors: - type: array - description: A list of errors related to product salability. - items: - "$ref": "#/definitions/inventory-sales-api-data-product-salability-error-interface" - extension_attributes: - "$ref": "#/definitions/inventory-sales-api-data-product-salable-result-extension-interface" - required: - - salable - - errors - inventory-sales-api-data-product-salability-error-interface: - type: object - description: '' - properties: - code: - type: string - description: The error code related to product salability, returning it as - a string value. - message: - type: string - description: The error message related to product salability, returning it - as a string value. - extension_attributes: - "$ref": "#/definitions/inventory-sales-api-data-product-salability-error-extension-interface" - required: - - code - - message - inventory-sales-api-data-product-salability-error-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\ProductSalabilityErrorInterface - inventory-sales-api-data-product-salable-result-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\ProductSalableResultInterface - inventory-sales-api-data-is-product-salable-for-requested-qty-result-interface: - type: object - description: Represents "is product salable for requested quantity" result interface. - properties: - sku: - type: string - description: Product sku from result. - stock_id: - type: integer - description: Stock id from result. - salable: - type: boolean - description: Is salable result. - errors: - type: array - description: Errors from result. - items: - "$ref": "#/definitions/inventory-sales-api-data-product-salability-error-interface" - extension_attributes: - "$ref": "#/definitions/inventory-sales-api-data-is-product-salable-for-requested-qty-result-extension-interface" - required: - - sku - - stock_id - - salable - - errors - inventory-sales-api-data-is-product-salable-for-requested-qty-result-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\IsProductSalableForRequestedQtyResultInterface - inventory-in-store-pickup-api-data-search-result-interface: - type: object - description: Search results for providing pickup locations. - properties: - items: - type: array - description: Items list. - items: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-interface" - search_request: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_request - - total_count - inventory-in-store-pickup-api-data-pickup-location-interface: - type: object - description: Represents sources projection on In-Store Pickup context. Realisation - must follow immutable DTO concept. Partial immutability done according to restriction - of current Extension Attributes implementation. - properties: - pickup_location_code: - type: string - description: Source code of Pickup Location. - name: - type: string - description: Pickup Location name. - email: - type: string - description: Pickup Location contact email. - fax: - type: string - description: Fax contact info. - contact_name: - type: string - description: Pickup Location contact name. - description: - type: string - description: Pickup Location description. - latitude: - type: number - description: Pickup Location latitude. - longitude: - type: number - description: Pickup Location longitude. - country_id: - type: string - description: Pickup Location country ID. - region_id: - type: integer - description: Pickup Location region ID. - region: - type: string - description: Pickup Location region. - city: - type: string - description: Pickup Location city. - street: - type: string - description: Pickup Location street. - postcode: - type: string - description: Pickup Location postcode. - phone: - type: string - description: Pickup Location phone. - extension_attributes: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-extension-interface" - required: - - pickup_location_code - inventory-in-store-pickup-api-data-pickup-location-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface - inventory-in-store-pickup-api-data-search-request-interface: - type: object - description: 'Endpoint used to search Pickup Locations by different parameters: - - by attribute filters fields @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\FiltersInterface - - by distance to the address @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\AreaInterface - Also, endpoint supports paging and sort orders.' - properties: - area: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-area-interface" - filters: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filters-interface" - page_size: - type: integer - description: Page size. - current_page: - type: integer - description: Current page. - scope_type: - type: string - description: Sales Channel Type. - scope_code: - type: string - description: Sales Channel code. - sort: - type: array - description: Sort Order. - items: - "$ref": "#/definitions/framework-sort-order" - extension_attributes: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-extension-interface" - required: - - current_page - - scope_type - - scope_code - inventory-in-store-pickup-api-data-search-request-area-interface: - type: object - description: 'Filter by Distance to the Address. Pickup Locations will be filtered - by distance according to the geo-position of the entered address. Required fields - for the address are country and one of the field: region or city or postcode.' - properties: - radius: - type: integer - description: Search radius in KM. - search_term: - type: string - description: Search term string. - required: - - radius - - search_term - inventory-in-store-pickup-api-data-search-request-filters-interface: - type: object - description: Filter to filter by Fields. Each field may be filtered with different - condition type. Supported condition types restricted by @see \Magento\Framework\Api\SearchCriteriaInterface - properties: - country: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - postcode: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - region: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - region_id: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - city: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - street: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - name: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - pickup_location_code: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - inventory-in-store-pickup-api-data-search-request-filter-interface: - type: object - description: Filter for Pickup Location search. - properties: - value: - type: string - description: Value. - condition_type: - type: string - description: Condition Type. - required: - - value - - condition_type - inventory-in-store-pickup-api-data-search-request-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequestInterface - properties: - products_info: - type: array - items: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-interface" - inventory-in-store-pickup-api-data-search-request-product-info-interface: - type: object - description: Product Info Data Transfer Object. - properties: - sku: - type: string - description: Product SKU. - extension_attributes: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-extension-interface" - required: - - sku - inventory-in-store-pickup-api-data-search-request-product-info-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\ProductInfoInterface - inventory-source-selection-api-data-source-selection-algorithm-interface: - type: object - description: Data Interface representing particular Source Selection Algorithm - properties: - code: - type: string - description: The code of the Source Selection Algorithm as a string. - title: - type: string - description: The title of the Source Selection Algorithm as a string. - description: - type: string - description: The description of the Source Selection Algorithm as a string. - extension_attributes: - "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-algorithm-extension-interface" - required: - - code - - title - - description - inventory-source-selection-api-data-source-selection-algorithm-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\SourceSelectionAlgorithmInterface - inventory-source-selection-api-data-inventory-request-interface: - type: object - description: Request products in a given Qty and StockId - properties: - stock_id: - type: integer - description: Stock Id - items: - type: array - description: Items - items: - "$ref": "#/definitions/inventory-source-selection-api-data-item-request-interface" - extension_attributes: - "$ref": "#/definitions/inventory-source-selection-api-data-inventory-request-extension-interface" - required: - - stock_id - - items - inventory-source-selection-api-data-item-request-interface: - type: object - description: Represents requested quantity for particular product - properties: - sku: - type: string - description: SKU - qty: - type: number - description: Product Quantity - extension_attributes: - "$ref": "#/definitions/inventory-source-selection-api-data-item-request-extension-interface" - required: - - sku - - qty - inventory-source-selection-api-data-item-request-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\ItemRequestInterface - inventory-source-selection-api-data-inventory-request-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\InventoryRequestInterface - properties: - destination_address: - "$ref": "#/definitions/inventory-source-selection-api-data-address-interface" - inventory-source-selection-api-data-address-interface: - type: object - description: Data interface for shipping source or shipping destination - properties: - country: - type: string - description: Shipping country - postcode: - type: string - description: Shipping postcode - street: - type: string - description: Shipping street address - region: - type: string - description: Shipping region - city: - type: string - description: Shipping city - required: - - country - - postcode - - street - - region - - city - inventory-source-selection-api-data-source-selection-result-interface: - type: object - description: Result of how we will deduct product qty from different Sources - properties: - source_selection_items: - type: array - description: The list of source selection items representing how product quantities - are deducted from sources. - items: - "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-item-interface" - shippable: - type: boolean - description: If the source selection result is eligible for shipping. - extension_attributes: - "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-result-extension-interface" - required: - - source_selection_items - - shippable - inventory-source-selection-api-data-source-selection-item-interface: - type: object - description: Represents source selection result for the specific source and SKU - properties: - source_code: - type: string - description: Source code - sku: - type: string - description: Item SKU - qty_to_deduct: - type: number - description: Quantity which will be deducted for this source - qty_available: - type: number - description: Available quantity for this source - extension_attributes: - "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-item-extension-interface" - required: - - source_code - - sku - - qty_to_deduct - - qty_available - inventory-source-selection-api-data-source-selection-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\SourceSelectionItemInterface - inventory-source-selection-api-data-source-selection-result-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\SourceSelectionResultInterface - inventory-in-store-pickup-sales-api-data-result-interface: - type: object - description: Operation result object that contains status of the operation. - properties: - successful: - type: boolean - description: Operation result successful. - errors: - type: array - description: Error information for failed operations. - items: - type: string - extension_attributes: - "$ref": "#/definitions/inventory-in-store-pickup-sales-api-data-result-extension-interface" - required: - - successful - - errors - inventory-in-store-pickup-sales-api-data-result-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryInStorePickupSalesApi\Api\Data\ResultInterface - inventory-low-quantity-notification-api-data-source-item-configuration-interface: - type: object - description: Represents a Source Item Configuration object Used fully qualified - namespaces in annotations for proper work of WebApi request parser phpcs:disable - Generic.Files.LineLength.TooLong - properties: - source_code: - type: string - description: Source code - notify_stock_qty: - type: number - description: Notify stock qty - sku: - type: string - description: SKU - extension_attributes: - "$ref": "#/definitions/inventory-low-quantity-notification-api-data-source-item-configuration-extension-interface" - inventory-low-quantity-notification-api-data-source-item-configuration-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryLowQuantityNotificationApi\Api\Data\SourceItemConfigurationInterface - adobe-stock-asset-api-data-asset-interface: - type: object - description: Adobe Stock Asset data class interface - properties: - id: - type: integer - description: ID - media_gallery_id: - type: integer - description: Media gallery asset id - category_id: - type: integer - description: Category - category: - "$ref": "#/definitions/adobe-stock-asset-api-data-category-interface" - creator_id: - type: integer - description: The creator - creator: - "$ref": "#/definitions/adobe-stock-asset-api-data-creator-interface" - is_licensed: - type: integer - description: Licensed - creation_date: - type: string - description: Creation date - extension_attributes: - "$ref": "#/definitions/adobe-stock-asset-api-data-asset-extension-interface" - required: - - media_gallery_id - - is_licensed - - creation_date - adobe-stock-asset-api-data-category-interface: - type: object - description: Adobe Stock asset Category data class - properties: - id: - type: integer - description: The id - name: - type: string - description: The category name - extension_attributes: - "$ref": "#/definitions/adobe-stock-asset-api-data-category-extension-interface" - required: - - name - - extension_attributes - adobe-stock-asset-api-data-category-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\AdobeStockAssetApi\Api\Data\CategoryInterface - adobe-stock-asset-api-data-creator-interface: - type: object - description: Adobe Stock creator data class - properties: - id: - type: integer - description: The id - name: - type: string - description: The creator name - extension_attributes: - "$ref": "#/definitions/adobe-stock-asset-api-data-creator-extension-interface" - required: - - extension_attributes - adobe-stock-asset-api-data-creator-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\AdobeStockAssetApi\Api\Data\CreatorInterface - adobe-stock-asset-api-data-asset-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\AdobeStockAssetApi\Api\Data\AssetInterface - adobe-stock-asset-api-data-asset-search-results-interface: - type: object - description: Interface AssetSearchResultsInterface - properties: - items: - type: array - description: Assets list. - items: - "$ref": "#/definitions/adobe-stock-asset-api-data-asset-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - asynchronous-operations-data-detailed-bulk-operations-status-interface: - type: object - description: Interface BulkStatusInterface Bulk summary data with list of operations - items full data. - properties: - operations_list: - type: array - description: Operations list. - items: - "$ref": "#/definitions/asynchronous-operations-data-operation-interface" - extension_attributes: - "$ref": "#/definitions/asynchronous-operations-data-bulk-summary-extension-interface" - user_type: - type: integer - description: User type - bulk_id: - type: string - description: Bulk uuid - description: - type: string - description: Bulk description - start_time: - type: string - description: Bulk scheduled time - user_id: - type: integer - description: User id - operation_count: - type: integer - description: Total number of operations scheduled in scope of this bulk - required: - - operations_list - - user_type - - bulk_id - - description - - start_time - - user_id - - operation_count - asynchronous-operations-data-operation-interface: - type: object - description: Class OperationInterface - properties: - extension_attributes: - "$ref": "#/definitions/asynchronous-operations-data-operation-extension-interface" - id: - type: integer - description: Id - bulk_uuid: - type: string - description: Bulk uuid - topic_name: - type: string - description: Queue Topic - serialized_data: - type: string - description: Data - result_serialized_data: - type: string - description: Serialized Data - status: - type: integer - description: Operation status - result_message: - type: string - description: Result message - error_code: - type: integer - description: Error code - required: - - id - - bulk_uuid - - topic_name - - serialized_data - - result_serialized_data - - status - - result_message - - error_code - asynchronous-operations-data-operation-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\AsynchronousOperations\Api\Data\OperationInterface - properties: - start_time: - type: string - asynchronous-operations-data-bulk-summary-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\AsynchronousOperations\Api\Data\BulkSummaryInterface - asynchronous-operations-data-bulk-operations-status-interface: - type: object - description: Interface BulkStatusInterface Bulk summary data with list of operations - items summary data. - properties: - operations_list: - type: array - description: List of operation with statuses (short data). - items: - "$ref": "#/definitions/asynchronous-operations-data-summary-operation-status-interface" - extension_attributes: - "$ref": "#/definitions/asynchronous-operations-data-bulk-summary-extension-interface" - user_type: - type: integer - description: User type - bulk_id: - type: string - description: Bulk uuid - description: - type: string - description: Bulk description - start_time: - type: string - description: Bulk scheduled time - user_id: - type: integer - description: User id - operation_count: - type: integer - description: Total number of operations scheduled in scope of this bulk - required: - - operations_list - - user_type - - bulk_id - - description - - start_time - - user_id - - operation_count - asynchronous-operations-data-summary-operation-status-interface: - type: object - description: Getter Class OperationsStatusInterface Instead of OperationInterface - this class don't provide all operation data and not responsive to set any data, - just to get operation data without serialized_data and result_serialized_data - properties: - id: - type: integer - description: Id - status: - type: integer - description: Operation status - result_message: - type: string - description: Result message - error_code: - type: integer - description: Error code - required: - - id - - status - - result_message - - error_code - asynchronous-operations-data-operation-search-results-interface: - type: object - description: Bulk operation search result interface. An bulk is a group of queue - messages. An bulk operation item is a queue message. - properties: - items: - type: array - description: List of operations. - items: - "$ref": "#/definitions/asynchronous-operations-data-operation-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - rma-data-track-interface: - type: object - description: Interface TrackInterface - properties: - entity_id: - type: integer - description: Entity id - rma_entity_id: - type: integer - description: Rma entity id - track_number: - type: string - description: Track number - carrier_title: - type: string - description: Carrier title - carrier_code: - type: string - description: Carrier code - extension_attributes: - "$ref": "#/definitions/rma-data-track-extension-interface" - required: - - entity_id - - rma_entity_id - - track_number - - carrier_title - - carrier_code - rma-data-track-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Rma\Api\Data\TrackInterface - rma-data-track-search-result-interface: - type: object - description: Interface TrackSearchResultInterface - properties: - items: - type: array - description: Rma list - items: - "$ref": "#/definitions/rma-data-track-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - rma-data-rma-interface: - type: object - description: Interface RmaInterface - properties: - increment_id: - type: string - description: Entity_id - entity_id: - type: integer - description: Entity_id - order_id: - type: integer - description: Order_id - order_increment_id: - type: string - description: Order_increment_id - store_id: - type: integer - description: Store_id - customer_id: - type: integer - description: Customer_id - date_requested: - type: string - description: Date_requested - customer_custom_email: - type: string - description: Customer_custom_email - items: - type: array - description: Items - items: - "$ref": "#/definitions/rma-data-item-interface" - status: - type: string - description: Status - comments: - type: array - description: Comments list - items: - "$ref": "#/definitions/rma-data-comment-interface" - tracks: - type: array - description: Tracks list - items: - "$ref": "#/definitions/rma-data-track-interface" - extension_attributes: - "$ref": "#/definitions/rma-data-rma-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - increment_id - - entity_id - - order_id - - order_increment_id - - store_id - - customer_id - - date_requested - - customer_custom_email - - items - - status - - comments - - tracks - rma-data-item-interface: - type: object - description: Interface CategoryInterface - properties: - entity_id: - type: integer - description: Id - rma_entity_id: - type: integer - description: RMA id - order_item_id: - type: integer - description: Order_item_id - qty_requested: - type: integer - description: Qty_requested - qty_authorized: - type: integer - description: Qty_authorized - qty_approved: - type: integer - description: Qty_approved - qty_returned: - type: integer - description: Qty_returned - reason: - type: string - description: Reason - condition: - type: string - description: Condition - resolution: - type: string - description: Resolution - status: - type: string - description: Status - extension_attributes: - "$ref": "#/definitions/rma-data-item-extension-interface" - required: - - entity_id - - rma_entity_id - - order_item_id - - qty_requested - - qty_authorized - - qty_approved - - qty_returned - - reason - - condition - - resolution - - status - rma-data-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Rma\Api\Data\ItemInterface - rma-data-comment-interface: - type: object - description: Interface CommentInterface - properties: - comment: - type: string - description: Comment - rma_entity_id: - type: integer - description: Rma Id - created_at: - type: string - description: Created_at - entity_id: - type: integer - description: Entity_id - customer_notified: - type: boolean - description: Is_customer_notified - visible_on_front: - type: boolean - description: Is_visible_on_front - status: - type: string - description: Status - admin: - type: boolean - description: Is_admin - extension_attributes: - "$ref": "#/definitions/rma-data-comment-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - comment - - rma_entity_id - - created_at - - entity_id - - customer_notified - - visible_on_front - - status - - admin - rma-data-comment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Rma\Api\Data\CommentInterface - rma-data-rma-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Rma\Api\Data\RmaInterface - rma-data-comment-search-result-interface: - type: object - description: Interface CommentSearchResultInterface - properties: - items: - type: array - description: Rma Status History list - items: - "$ref": "#/definitions/rma-data-comment-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - rma-data-rma-search-result-interface: - type: object - description: Interface RmaSearchResultInterface - properties: - items: - type: array - description: Rma list - items: - "$ref": "#/definitions/rma-data-rma-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - framework-metadata-object-interface: - type: object - description: Provides metadata about an attribute. - properties: - attribute_code: - type: string - description: Code of the attribute. - required: - - attribute_code - payment-services-paypal-payment-config-response-interface: - type: object - description: '' - properties: - apple_pay: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface" - google_pay: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface" - hosted_fields: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface" - smart_buttons: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface" - required: - - apple_pay - - google_pay - - hosted_fields - - smart_buttons - payment-services-paypal-data-payment-config-apple-pay-interface: - type: object - description: '' - properties: - button_styles: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface" - payment_source: - type: string - description: PaymentSource - code: - type: string - description: Code - sdk_params: - type: array - description: SDK params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - is_visible: - type: boolean - description: Visible - sort_order: - type: string - description: Sort Order - payment_intent: - type: string - description: Payment intent - title: - type: string - description: Title - required: - - button_styles - - payment_source - - code - - sdk_params - - is_visible - - sort_order - - payment_intent - - title - payment-services-paypal-data-payment-config-button-styles-interface: - type: object - description: '' - properties: - layout: - type: string - description: Layout - color: - type: string - description: Color - shape: - type: string - description: Shape - label: - type: string - description: Label - tagline: - type: boolean - description: ShowTagline - height: - type: integer - description: Height - use_default_height: - type: boolean - description: Height - required: - - layout - - color - - shape - - label - - tagline - - height - - use_default_height - payment-services-paypal-data-payment-config-sdk-params-interface: - type: object - description: '' - properties: - name: - type: string - description: Code - value: - type: string - description: Config - required: - - name - - value - payment-services-paypal-data-payment-config-google-pay-interface: - type: object - description: '' - properties: - button_styles: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-button-styles-interface" - payment_source: - type: string - description: PaymentSource - three_d_s: - type: string - description: ThreeDS - code: - type: string - description: Code - sdk_params: - type: array - description: SDK params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - is_visible: - type: boolean - description: Visible - sort_order: - type: string - description: Sort Order - payment_intent: - type: string - description: Payment intent - title: - type: string - description: Title - required: - - button_styles - - payment_source - - three_d_s - - code - - sdk_params - - is_visible - - sort_order - - payment_intent - - title - payment-services-paypal-data-payment-config-google-pay-button-styles-interface: - type: object - description: '' - properties: - color: - type: string - description: Color - height: - type: integer - description: Height - type: - type: string - description: Type - required: - - color - - height - - type - payment-services-paypal-data-payment-config-hosted-fields-interface: - type: object - description: '' - properties: - payment_source: - type: string - description: Payment Source - three_d_s: - type: string - description: ThreeDS - is_vault_enabled: - type: boolean - description: HasIsVaultEnabled - cc_vault_code: - type: string - description: CcVaultCode - requires_card_details: - type: boolean - description: RequiresCardDetails - code: - type: string - description: Code - sdk_params: - type: array - description: SDK params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - is_visible: - type: boolean - description: Visible - sort_order: - type: string - description: Sort Order - payment_intent: - type: string - description: Payment intent - title: - type: string - description: Title - required: - - payment_source - - three_d_s - - is_vault_enabled - - cc_vault_code - - requires_card_details - - code - - sdk_params - - is_visible - - sort_order - - payment_intent - - title - payment-services-paypal-data-payment-config-smart-buttons-interface: - type: object - description: '' - properties: - display_message: - type: boolean - description: CanDisplayMessage - display_venmo: - type: boolean - description: Venmo - message_styles: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface" - button_styles: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface" - app_switch_when_available: - type: boolean - description: AppSwitchWhenAvailable - code: - type: string - description: Code - sdk_params: - type: array - description: SDK params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - is_visible: - type: boolean - description: Visible - sort_order: - type: string - description: Sort Order - payment_intent: - type: string - description: Payment intent - title: - type: string - description: Title - required: - - display_message - - display_venmo - - message_styles - - button_styles - - app_switch_when_available - - code - - sdk_params - - is_visible - - sort_order - - payment_intent - - title - payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface: - type: object - description: '' - properties: - layout: - type: string - description: CanDisplayMessage - logo: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-logo-interface" - required: - - layout - - logo - payment-services-paypal-data-payment-config-smart-buttons-logo-interface: - type: object - description: '' - properties: - type: - type: string - description: CanDisplayMessage - required: - - type - payment-services-paypal-data-payment-order-interface: - type: object - description: Interface PaymentOrderInterface - properties: - id: - type: string - description: Payment order id - mp_order_id: - type: string - description: Payment order mpOrderId - status: - type: string - description: Payment order status - amount: - type: number - description: Payment order amount - currency_code: - type: string - description: Payment order currency code - required: - - id - - mp_order_id - - status - - amount - - currency_code - payment-services-paypal-data-payment-order-details-interface: - type: object - description: Interface PaymentOrderDetailsInterface - properties: - payment_source_details: - "$ref": "#/definitions/payment-services-paypal-data-payment-source-details-interface" - id: - type: string - description: Payment order id - mp_order_id: - type: string - description: Payment order mpOrderId - status: - type: string - description: Payment order status - amount: - type: number - description: Payment order amount - currency_code: - type: string - description: Payment order currency code - required: - - payment_source_details - - id - - mp_order_id - - status - - amount - - currency_code - payment-services-paypal-data-payment-source-details-interface: - type: object - description: '' - properties: - card: - "$ref": "#/definitions/payment-services-paypal-data-payment-card-details-interface" - required: - - card - payment-services-paypal-data-payment-card-details-interface: - type: object - description: '' - properties: - name: - type: string - description: Name - last_digits: - type: string - description: Last digits - card_expiry_month: - type: string - description: Card expiry month - card_expiry_year: - type: string - description: Card expiry year - bin_details: - "$ref": "#/definitions/payment-services-paypal-data-payment-card-bin-details-interface" - required: - - name - - last_digits - - card_expiry_month - - card_expiry_year - - bin_details - payment-services-paypal-data-payment-card-bin-details-interface: - type: object - description: '' - properties: - bin: - type: string - description: Bin - required: - - bin - payment-services-paypal-data-payment-sdk-params-interface: - type: object - description: '' - properties: - code: - type: string - description: The payments sdk code - params: - type: array - description: The payments sdk params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - required: - - code - - params - pay-pal-braintree-data-auth-data-interface: - type: object - description: Interface AuthDataInterface - properties: - client_token: - type: string - description: Client token - display_name: - type: string - description: Display name - action_success: - type: string - description: To success page - logged_in: - type: boolean - description: Logged in - store_code: - type: string - description: Current store code - required: - - display_name - - action_success - - logged_in - - store_code - pay-pal-braintree-data-payment-interface: - type: object - description: '' - properties: - payment_method_code: - type: string - description: The payment method code. - payment_method_nonce: - type: string - description: The payment method nonce. - device_data: - type: string - description: The device data. -x-tagGroups: -- name: addresses - tags: - - addresses/{addressId} -- name: adminuisdk - tags: - - adminuisdk/appmanagement/validate - - adminuisdk/massaction/{request_id} - - adminuisdk/orderviewbutton/{request_id} -- name: adobe_io_events - tags: - - adobe_io_events/check_configuration -- name: adobestock - tags: - - adobestock/asset/list - - adobestock/asset/search - - adobestock/asset/{id} - - adobestock/search -- name: analytics - tags: - - analytics/link -- name: applepay - tags: - - applepay/auth -- name: attributeMetadata - tags: - - attributeMetadata/customer - - attributeMetadata/customer/attribute/{attributeCode} - - attributeMetadata/customer/custom - - attributeMetadata/customer/form/{formCode} - - attributeMetadata/customerAddress - - attributeMetadata/customerAddress/attribute/{attributeCode} - - attributeMetadata/customerAddress/custom - - attributeMetadata/customerAddress/form/{formCode} -- name: braintree - tags: - - braintree/mine/payment/vault -- name: bulk - tags: - - bulk - - bulk/{bulkUuid}/detailed-status - - bulk/{bulkUuid}/operation-status/{status} - - bulk/{bulkUuid}/status -- name: bundle products - tags: - - bundle-products/options/add - - bundle-products/options/types - - bundle-products/options/{optionId} - - bundle-products/{productSku}/children - - bundle-products/{sku}/links/{id} - - bundle-products/{sku}/links/{optionId} - - bundle-products/{sku}/options/all - - bundle-products/{sku}/options/{optionId} - - bundle-products/{sku}/options/{optionId}/children/{childSku} -- name: carts - tags: - - carts/ - - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} - - carts/guest-carts/{cartId}/giftCards - - carts/guest-carts/{cartId}/giftCards/{giftCardCode} - - carts/licence - - carts/licence/list - - carts/mine - - carts/mine/balance/apply - - carts/mine/billing-address - - carts/mine/checkGiftCard/{giftCardCode} - - carts/mine/collect-totals - - carts/mine/coupons - - carts/mine/coupons/deleteByCodes - - carts/mine/coupons/{couponCode} - - carts/mine/estimate-shipping-methods - - carts/mine/estimate-shipping-methods-by-address-id - - carts/mine/gift-message - - carts/mine/gift-message/{itemId} - - carts/mine/giftCards - - carts/mine/giftCards/{giftCardCode} - - carts/mine/items - - carts/mine/items/{itemId} - - carts/mine/order - - carts/mine/payment-information - - carts/mine/payment-methods - - carts/mine/payment-order - - carts/mine/payment-order/{id} - - carts/mine/po-payment-information - - carts/mine/selected-payment-method - - carts/mine/set-payment-information - - carts/mine/shipping-information - - carts/mine/shipping-methods - - carts/mine/totals - - carts/mine/totals-information - - carts/search - - carts/{cartId} - - carts/{cartId}/billing-address - - carts/{cartId}/coupons - - carts/{cartId}/coupons/deleteByCodes - - carts/{cartId}/coupons/{couponCode} - - carts/{cartId}/estimate-shipping-methods - - carts/{cartId}/estimate-shipping-methods-by-address-id - - carts/{cartId}/gift-message - - carts/{cartId}/gift-message/{itemId} - - carts/{cartId}/giftCards - - carts/{cartId}/giftCards/{giftCardCode} - - carts/{cartId}/items - - carts/{cartId}/items/{itemId} - - carts/{cartId}/order - - carts/{cartId}/payment-methods - - carts/{cartId}/selected-payment-method - - carts/{cartId}/shipping-information - - carts/{cartId}/shipping-methods - - carts/{cartId}/totals - - carts/{cartId}/totals-information - - carts/{quoteId}/giftCards - - carts/{quoteId}/items -- name: categories - tags: - - categories - - categories/attributes - - categories/attributes/{attributeCode} - - categories/attributes/{attributeCode}/options - - categories/list - - categories/{categoryId} - - categories/{categoryId}/move - - categories/{categoryId}/products - - categories/{categoryId}/products/{sku} - - categories/{id} -- name: cmsBlock - tags: - - cmsBlock - - cmsBlock/search - - cmsBlock/{blockId} - - cmsBlock/{id} -- name: cmsPage - tags: - - cmsPage - - cmsPage/search - - cmsPage/{id} - - cmsPage/{pageId} -- name: company - tags: - - company/ - - company/assignRoles - - company/relations - - company/role/ - - company/role/{id} - - company/role/{roleId} - - company/role/{roleId}/users - - company/{companyId} - - company/{parentId}/relations - - company/{parentId}/relations/{companyId} -- name: companyCredits - tags: - - companyCredits/ - - companyCredits/company/{companyId} - - companyCredits/history - - companyCredits/history/{historyId} - - companyCredits/{creditId} - - companyCredits/{creditId}/decreaseBalance - - companyCredits/{creditId}/increaseBalance - - companyCredits/{id} -- name: configurable products - tags: - - configurable-products/variation - - configurable-products/{sku}/child - - configurable-products/{sku}/children - - configurable-products/{sku}/children/{childSku} - - configurable-products/{sku}/options - - configurable-products/{sku}/options/all - - configurable-products/{sku}/options/{id} -- name: coupons - tags: - - coupons - - coupons/deleteByCodes - - coupons/deleteByIds - - coupons/generate - - coupons/search - - coupons/{couponId} -- name: creditmemo - tags: - - creditmemo - - creditmemo/refund - - creditmemo/{id} - - creditmemo/{id}/comments - - creditmemo/{id}/emails -- name: creditmemos - tags: - - creditmemos -- name: customerGroups - tags: - - customerGroups - - customerGroups/default - - customerGroups/default/{id} - - customerGroups/default/{storeId} - - customerGroups/search - - customerGroups/{id} - - customerGroups/{id}/permissions -- name: customers - tags: - - customers - - customers/activate - - customers/addresses/{addressId} - - customers/companies - - customers/confirm - - customers/isEmailAvailable - - customers/me - - customers/me/activate - - customers/me/billingAddress - - customers/me/password - - customers/me/shippingAddress - - customers/password - - customers/resetPassword - - customers/search - - customers/validate - - customers/{customerId} - - customers/{customerId}/billingAddress - - customers/{customerId}/carts - - customers/{customerId}/companies - - customers/{customerId}/companies/{companyId} - - customers/{customerId}/confirm - - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} - - customers/{customerId}/permissions/readonly - - customers/{customerId}/shippingAddress - - customers/{customerId}/token - - customers/{email}/activate -- name: directory - tags: - - directory/countries - - directory/countries/{countryId} - - directory/currency -- name: eav - tags: - - eav/attribute-sets - - eav/attribute-sets/list - - eav/attribute-sets/{attributeSetId} -- name: eventing - tags: - - eventing/eventProvider - - eventing/eventProvider/{providerId} - - eventing/eventSubscribe - - eventing/eventSubscribe/{name} - - eventing/eventUnsubscribe/{name} - - eventing/getEventProviders - - eventing/getEventSubscriptions - - eventing/updateConfiguration -- name: gift wrappings - tags: - - gift-wrappings - - gift-wrappings/{id} - - gift-wrappings/{wrappingId} -- name: giftregistry - tags: - - giftregistry/mine/estimate-shipping-methods -- name: guest carts - tags: - - guest-carts - - guest-carts/{cartId} - - guest-carts/{cartId}/billing-address - - guest-carts/{cartId}/collect-totals - - guest-carts/{cartId}/coupons - - guest-carts/{cartId}/coupons/{couponCode} - - guest-carts/{cartId}/estimate-shipping-methods - - guest-carts/{cartId}/gift-message - - guest-carts/{cartId}/gift-message/{itemId} - - guest-carts/{cartId}/items - - guest-carts/{cartId}/items/{itemId} - - guest-carts/{cartId}/order - - guest-carts/{cartId}/payment-information - - guest-carts/{cartId}/payment-methods - - guest-carts/{cartId}/payment-order - - guest-carts/{cartId}/payment-order/{id} - - guest-carts/{cartId}/selected-payment-method - - guest-carts/{cartId}/set-payment-information - - guest-carts/{cartId}/shipping-information - - guest-carts/{cartId}/shipping-methods - - guest-carts/{cartId}/totals - - guest-carts/{cartId}/totals-information -- name: guest giftregistry - tags: - - guest-giftregistry/{cartId}/estimate-shipping-methods -- name: hierarchy - tags: - - hierarchy/move/{id} - - hierarchy/{id} -- name: import - tags: - - import/csv - - import/json -- name: integration - tags: - - integration/admin/token - - integration/customer/revoke-customer-token - - integration/customer/token -- name: inventory - tags: - - inventory/are-product-salable-for-requested-qty/ - - inventory/are-products-salable - - inventory/bulk-partial-source-transfer - - inventory/bulk-product-source-assign - - inventory/bulk-product-source-transfer - - inventory/bulk-product-source-unassign - - inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode} - - inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode} - - inventory/get-distance - - inventory/get-distance-provider-code - - inventory/get-latlng-from-address - - inventory/get-latslngs-from-address - - inventory/get-product-salable-quantity/{sku}/{stockId} - - inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId} - - inventory/in-store-pickup/pickup-locations/ - - inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty} - - inventory/is-product-salable/{sku}/{stockId} - - inventory/low-quantity-notification - - inventory/low-quantity-notification/{sourceCode}/{sku} - - inventory/low-quantity-notifications-delete - - inventory/source-items - - inventory/source-items-delete - - inventory/source-selection-algorithm-list - - inventory/source-selection-algorithm-result - - inventory/sources - - inventory/sources/{sourceCode} - - inventory/stock-resolver/{type}/{code} - - inventory/stock-source-links - - inventory/stock-source-links-delete - - inventory/stocks - - inventory/stocks/{stockId} -- name: invoice - tags: - - invoice/{invoiceId}/refund -- name: invoices - tags: - - invoices - - invoices/ - - invoices/comments - - invoices/{id} - - invoices/{id}/capture - - invoices/{id}/comments - - invoices/{id}/emails - - invoices/{id}/void -- name: modules - tags: - - modules -- name: negotiable cart item note - tags: - - negotiable-cart-item-note - - negotiable-cart-item-note/search - - negotiable-cart-item-note/{noteId} -- name: negotiable carts - tags: - - negotiable-carts/{cartId}/billing-address - - negotiable-carts/{cartId}/coupons - - negotiable-carts/{cartId}/coupons/{couponCode} - - negotiable-carts/{cartId}/estimate-shipping-methods - - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id - - negotiable-carts/{cartId}/giftCards - - negotiable-carts/{cartId}/giftCards/{giftCardCode} - - negotiable-carts/{cartId}/payment-information - - negotiable-carts/{cartId}/po-payment-information - - negotiable-carts/{cartId}/set-payment-information - - negotiable-carts/{cartId}/shipping-information - - negotiable-carts/{cartId}/totals -- name: negotiableQuote - tags: - - negotiableQuote/attachmentContent - - negotiableQuote/decline - - negotiableQuote/draft - - negotiableQuote/pricesUpdated - - negotiableQuote/request - - negotiableQuote/submitToCustomer - - negotiableQuote/{negotiableQuoteId}/duplicate - - negotiableQuote/{quoteId} - - negotiableQuote/{quoteId}/comments - - negotiableQuote/{quoteId}/shippingMethod -- name: negotiableQuoteTemplate - tags: - - negotiableQuoteTemplate - - negotiableQuoteTemplate/accept - - negotiableQuoteTemplate/cancel - - negotiableQuoteTemplate/cancel/me - - negotiableQuoteTemplate/decline - - negotiableQuoteTemplate/draft - - negotiableQuoteTemplate/generateQuote - - negotiableQuoteTemplate/me - - negotiableQuoteTemplate/me/{templateId} - - negotiableQuoteTemplate/open - - negotiableQuoteTemplate/open/me - - negotiableQuoteTemplate/referenceDocumentLink - - negotiableQuoteTemplate/referenceDocumentLink/{linkId} - - negotiableQuoteTemplate/request - - negotiableQuoteTemplate/request/me - - negotiableQuoteTemplate/submitToCustomer - - negotiableQuoteTemplate/submitToSeller - - negotiableQuoteTemplate/{templateId} -- name: order - tags: - - order/notify-orders-are-ready-for-pickup - - order/{orderId}/invoice - - order/{orderId}/refund - - order/{orderId}/ship -- name: orders - tags: - - orders - - orders/create - - orders/items - - orders/items/{id} - - orders/{id} - - orders/{id}/cancel - - orders/{id}/comments - - orders/{id}/emails - - orders/{id}/hold - - orders/{id}/statuses - - orders/{id}/unhold - - orders/{parent_id} -- name: payment order - tags: - - payment-order/completeOrder -- name: payments config - tags: - - payments-config/apple-pay/{location} - - payments-config/google-pay/{location} - - payments-config/hosted-fields/{location} - - payments-config/smart-buttons/{location} - - payments-config/{location} -- name: payments sdk - tags: - - payments-sdk/{location} - - payments-sdk/{location}/{methodCode} -- name: paypal - tags: - - paypal/lineItems - - paypal/oneClick - - paypal/validatePhoneNumber -- name: products - tags: - - products - - products/attribute-sets - - products/attribute-sets/attributes - - products/attribute-sets/groups - - products/attribute-sets/groups/list - - products/attribute-sets/groups/{groupId} - - products/attribute-sets/sets/list - - products/attribute-sets/{attributeSetId} - - products/attribute-sets/{attributeSetId}/attributes - - products/attribute-sets/{attributeSetId}/attributes/{attributeCode} - - products/attribute-sets/{attributeSetId}/groups - - products/attributes - - products/attributes/types - - products/attributes/{attributeCode} - - products/attributes/{attributeCode}/is-filterable - - products/attributes/{attributeCode}/is-filterable/{isFilterable} - - products/attributes/{attributeCode}/options - - products/attributes/{attributeCode}/options/{optionId} - - products/base-prices - - products/base-prices-information - - products/cost - - products/cost-delete - - products/cost-information - - products/downloadable-links/samples/{id} - - products/downloadable-links/{id} - - products/links/types - - products/links/{type}/attributes - - products/media/types/{attributeSetName} - - products/options - - products/options/types - - products/options/{optionId} - - products/special-price - - products/special-price-delete - - products/special-price-information - - products/tier-prices - - products/tier-prices-delete - - products/tier-prices-information - - products/types - - products/{productSku}/stockItems/{itemId} - - products/{sku} - - products/{sku}/downloadable-links - - products/{sku}/downloadable-links/samples - - products/{sku}/downloadable-links/samples/{id} - - products/{sku}/downloadable-links/{id} - - products/{sku}/group-prices/{customerGroupId}/tiers - - products/{sku}/group-prices/{customerGroupId}/tiers/{qty} - - products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price} - - products/{sku}/links - - products/{sku}/links/{type} - - products/{sku}/links/{type}/{linkedProductSku} - - products/{sku}/media - - products/{sku}/media/{entryId} - - products/{sku}/options - - products/{sku}/options/{optionId} - - products/{sku}/websites - - products/{sku}/websites/{websiteId} -- name: products render info - tags: - - products-render-info -- name: purchase order carts - tags: - - purchase-order-carts/{cartId}/billing-address - - purchase-order-carts/{cartId}/estimate-shipping-methods - - purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id - - purchase-order-carts/{cartId}/giftCards - - purchase-order-carts/{cartId}/giftCards/{giftCardCode} - - purchase-order-carts/{cartId}/payment-information - - purchase-order-carts/{cartId}/set-payment-information - - purchase-order-carts/{cartId}/totals -- name: requisition_lists - tags: - - requisition_lists -- name: returns - tags: - - returns - - returns/{id} - - returns/{id}/comments - - returns/{id}/labels - - returns/{id}/tracking-numbers - - returns/{id}/tracking-numbers/{trackId} -- name: returnsAttributeMetadata - tags: - - returnsAttributeMetadata - - returnsAttributeMetadata/custom - - returnsAttributeMetadata/form/{formCode} - - returnsAttributeMetadata/{attributeCode} -- name: reward - tags: - - reward/mine/use-reward -- name: salesRules - tags: - - salesRules - - salesRules/search - - salesRules/{ruleId} -- name: search - tags: - - search -- name: sharedCatalog - tags: - - sharedCatalog - - sharedCatalog/ - - sharedCatalog/{id} - - sharedCatalog/{id}/assignCategories - - sharedCatalog/{id}/assignProducts - - sharedCatalog/{id}/categories - - sharedCatalog/{id}/products - - sharedCatalog/{id}/unassignCategories - - sharedCatalog/{id}/unassignProducts - - sharedCatalog/{sharedCatalogId} - - sharedCatalog/{sharedCatalogId}/assignCompanies - - sharedCatalog/{sharedCatalogId}/assignTierPrices - - sharedCatalog/{sharedCatalogId}/companies - - sharedCatalog/{sharedCatalogId}/resetTierPrices - - sharedCatalog/{sharedCatalogId}/unassignCompanies -- name: shipment - tags: - - shipment/ - - shipment/track - - shipment/track/{id} - - shipment/{id} - - shipment/{id}/comments - - shipment/{id}/emails - - shipment/{id}/label -- name: shipments - tags: - - shipments -- name: stockItems - tags: - - stockItems/lowStock/ - - stockItems/{productSku} -- name: stockStatuses - tags: - - stockStatuses/{productSku} -- name: store - tags: - - store/storeConfigs - - store/storeGroups - - store/storeViews - - store/websites -- name: taxClasses - tags: - - taxClasses - - taxClasses/search - - taxClasses/{classId} - - taxClasses/{taxClassId} -- name: taxRates - tags: - - taxRates - - taxRates/search - - taxRates/{rateId} -- name: taxRules - tags: - - taxRules - - taxRules/search - - taxRules/{ruleId} -- name: team - tags: - - team/ - - team/{companyId} - - team/{teamId} -- name: tfa - tags: - - tfa/default-provider-code/{userId} - - tfa/forced-providers - - tfa/installed-providers - - tfa/provider/authy/activate - - tfa/provider/authy/authenticate - - tfa/provider/authy/authenticate-onetouch - - tfa/provider/authy/configure - - tfa/provider/authy/send-token/{via} - - tfa/provider/duo_security/activate - - tfa/provider/duo_security/authenticate - - tfa/provider/duo_security/configure - - tfa/provider/google/activate - - tfa/provider/google/authenticate - - tfa/provider/google/configure - - tfa/provider/u2fkey/activate - - tfa/provider/u2fkey/authentication-challenge - - tfa/provider/u2fkey/configure - - tfa/provider/u2fkey/verify - - tfa/providers-to-activate/{userId} - - tfa/tfat-providers-to-activate - - tfa/tfat-user-providers - - tfa/user-providers/{userId} -- name: transactions - tags: - - transactions - - transactions/{id} -- name: webhooks - tags: - - webhooks/list - - webhooks/subscribe - - webhooks/unsubscribe diff --git a/src/openapi/customer-schema-2.4.9-beta-1.yaml b/src/openapi/customer-schema-2.4.9-beta-1.yaml deleted file mode 100644 index 898804cf2..000000000 --- a/src/openapi/customer-schema-2.4.9-beta-1.yaml +++ /dev/null @@ -1,7870 +0,0 @@ ---- -securityDefinitions: - api_key: - type: apiKey - name: api_key - in: header -swagger: '2.0' -info: - version: 2.4.9-beta-1 - title: Commerce Customer REST endpoints - All inclusive - description: - "$ref": "../_includes/redocly-intro.md" -host: example.com -basePath: "/rest/default" -schemes: -- http -tags: -- name: applepay/auth -- name: braintree/mine/payment/vault -- name: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} -- name: carts/guest-carts/{cartId}/giftCards -- name: carts/guest-carts/{cartId}/giftCards/{giftCardCode} -- name: carts/mine -- name: carts/mine/balance/apply -- name: carts/mine/checkGiftCard/{giftCardCode} -- name: carts/mine/collect-totals -- name: carts/mine/payment-information -- name: carts/mine/payment-order -- name: carts/mine/payment-order/{id} -- name: carts/mine/po-payment-information -- name: carts/mine/set-payment-information -- name: customers -- name: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} -- name: customers/isEmailAvailable -- name: customers/me/activate -- name: customers/me/password -- name: customers/password -- name: customers/resetPassword -- name: directory/countries -- name: directory/countries/{countryId} -- name: directory/currency -- name: giftregistry/mine/estimate-shipping-methods -- name: guest-carts -- name: guest-carts/{cartId} -- name: guest-carts/{cartId}/billing-address -- name: guest-carts/{cartId}/collect-totals -- name: guest-carts/{cartId}/coupons -- name: guest-carts/{cartId}/coupons/{couponCode} -- name: guest-carts/{cartId}/estimate-shipping-methods -- name: guest-carts/{cartId}/gift-message -- name: guest-carts/{cartId}/gift-message/{itemId} -- name: guest-carts/{cartId}/items -- name: guest-carts/{cartId}/items/{itemId} -- name: guest-carts/{cartId}/order -- name: guest-carts/{cartId}/payment-information -- name: guest-carts/{cartId}/payment-methods -- name: guest-carts/{cartId}/payment-order -- name: guest-carts/{cartId}/payment-order/{id} -- name: guest-carts/{cartId}/selected-payment-method -- name: guest-carts/{cartId}/set-payment-information -- name: guest-carts/{cartId}/shipping-information -- name: guest-carts/{cartId}/shipping-methods -- name: guest-carts/{cartId}/totals -- name: guest-carts/{cartId}/totals-information -- name: guest-giftregistry/{cartId}/estimate-shipping-methods -- name: integration/admin/token -- name: integration/customer/revoke-customer-token -- name: integration/customer/token -- name: inventory/in-store-pickup/pickup-locations/ -- name: negotiable-carts/{cartId}/billing-address -- name: negotiable-carts/{cartId}/coupons -- name: negotiable-carts/{cartId}/coupons/{couponCode} -- name: negotiable-carts/{cartId}/estimate-shipping-methods -- name: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id -- name: negotiable-carts/{cartId}/giftCards -- name: negotiable-carts/{cartId}/giftCards/{giftCardCode} -- name: negotiable-carts/{cartId}/payment-information -- name: negotiable-carts/{cartId}/po-payment-information -- name: negotiable-carts/{cartId}/set-payment-information -- name: negotiable-carts/{cartId}/shipping-information -- name: negotiable-carts/{cartId}/totals -- name: negotiableQuoteTemplate/accept -- name: negotiableQuoteTemplate/generateQuote -- name: negotiableQuoteTemplate/submitToSeller -- name: payment-order/completeOrder -- name: payments-config/{location} -- name: payments-config/apple-pay/{location} -- name: payments-config/google-pay/{location} -- name: payments-config/hosted-fields/{location} -- name: payments-config/smart-buttons/{location} -- name: payments-sdk/{location} -- name: payments-sdk/{location}/{methodCode} -- name: paypal/lineItems -- name: paypal/oneClick -- name: paypal/validatePhoneNumber -- name: products-render-info -- name: purchase-order-carts/{cartId}/payment-information -- name: purchase-order-carts/{cartId}/set-payment-information -- name: requisition_lists -- name: reward/mine/use-reward -- name: search -- name: tfa/provider/authy/activate -- name: tfa/provider/authy/authenticate -- name: tfa/provider/authy/authenticate-onetouch -- name: tfa/provider/authy/configure -- name: tfa/provider/authy/send-token/{via} -- name: tfa/provider/duo_security/activate -- name: tfa/provider/duo_security/authenticate -- name: tfa/provider/duo_security/configure -- name: tfa/provider/google/activate -- name: tfa/provider/google/authenticate -- name: tfa/provider/google/configure -- name: tfa/provider/u2fkey/activate -- name: tfa/provider/u2fkey/authentication-challenge -- name: tfa/provider/u2fkey/configure -- name: tfa/provider/u2fkey/verify -- name: tfa/tfat-providers-to-activate -- name: tfa/tfat-user-providers -paths: - "/V1/applepay/auth": - get: - tags: - - applepay/auth - description: Returns details required to be able to submit a payment with Apple - Pay - operationId: GetV1ApplepayAuth - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/pay-pal-braintree-data-auth-data-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: applepay/auth - "/V1/braintree/mine/payment/vault": - post: - tags: - - braintree/mine/payment/vault - description: Vault a Payment nonce for a customer. Billing address is optional - but advised for Card vaulting. - operationId: PostV1BraintreeMinePaymentVault - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1BraintreeMinePaymentVaultBody - in: body - schema: - required: - - payment - properties: - payment: - "$ref": "#/definitions/pay-pal-braintree-data-payment-interface" - billingAddress: - "$ref": "#/definitions/customer-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: braintree/mine/payment/vault - "/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}": - get: - tags: - - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} - description: Check gift card balance if added to the cart. - operationId: GetV1CartsGuestcartsCartIdCheckGiftCardGiftCardCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: giftCardCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: number - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} - "/V1/carts/guest-carts/{cartId}/giftCards": - post: - tags: - - carts/guest-carts/{cartId}/giftCards - description: Add gift card to the cart. - operationId: PostV1CartsGuestcartsCartIdGiftCards - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1CartsGuestcartsCartIdGiftCardsBody - in: body - schema: - required: - - giftCardAccountData - properties: - giftCardAccountData: - "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/guest-carts/{cartId}/giftCards - "/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}": - delete: - tags: - - carts/guest-carts/{cartId}/giftCards/{giftCardCode} - description: Remove GiftCard Account entity. - operationId: DeleteV1CartsGuestcartsCartIdGiftCardsGiftCardCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: giftCardCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/guest-carts/{cartId}/giftCards/{giftCardCode} - "/V1/carts/mine": - put: - tags: - - carts/mine - description: Save quote - operationId: PutV1CartsMine - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CartsMineBody - in: body - schema: - required: - - quote - properties: - quote: - "$ref": "#/definitions/quote-data-cart-interface" - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine - get: - tags: - - carts/mine - description: Returns information for the cart for a specified customer. - operationId: GetV1CartsMine - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine - "/V1/carts/mine/balance/apply": - post: - tags: - - carts/mine/balance/apply - description: Apply store credit - operationId: PostV1CartsMineBalanceApply - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/balance/apply - "/V1/carts/mine/checkGiftCard/{giftCardCode}": - get: - tags: - - carts/mine/checkGiftCard/{giftCardCode} - description: Check gift card balance if applied to given cart. - operationId: GetV1CartsMineCheckGiftCardGiftCardCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: giftCardCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: number - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/checkGiftCard/{giftCardCode} - "/V1/carts/mine/collect-totals": - put: - tags: - - carts/mine/collect-totals - description: Set shipping/billing methods and additional data for cart and collect - totals. - operationId: PutV1CartsMineCollecttotals - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CartsMineCollecttotalsBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - shippingCarrierCode: - type: string - description: The carrier code. - shippingMethodCode: - type: string - description: The shipping method code. - additionalData: - "$ref": "#/definitions/quote-data-totals-additional-data-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/collect-totals - "/V1/carts/mine/payment-information": - post: - tags: - - carts/mine/payment-information - description: Set payment information and place order for a specified cart. - operationId: PostV1CartsMinePaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMinePaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/payment-information - get: - tags: - - carts/mine/payment-information - description: Get payment information - operationId: GetV1CartsMinePaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/payment-information - "/V1/carts/mine/payment-order": - post: - tags: - - carts/mine/payment-order - description: Create a payment order for logged in customer - operationId: PostV1CartsMinePaymentorder - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMinePaymentorderBody - in: body - schema: - required: - - methodCode - - paymentSource - - location - properties: - methodCode: - type: string - paymentSource: - type: string - location: - type: string - vaultIntent: - type: boolean - threeDSMode: - type: string - description: "| null $threeDSMode" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/payment-order - "/V1/carts/mine/payment-order/{id}": - get: - tags: - - carts/mine/payment-order/{id} - description: Get payment order for logged in customer - operationId: GetV1CartsMinePaymentorderId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/payment-order/{id} - post: - tags: - - carts/mine/payment-order/{id} - description: Sync payment order for logged in customer - operationId: PostV1CartsMinePaymentorderId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: id - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/payment-order/{id} - "/V1/carts/mine/po-payment-information": - post: - tags: - - carts/mine/po-payment-information - description: Set payment information and place purchase order for a specified - cart. - operationId: PostV1CartsMinePopaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMinePopaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Purchase Order ID. - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/po-payment-information - "/V1/carts/mine/set-payment-information": - post: - tags: - - carts/mine/set-payment-information - description: Set payment information for a specified cart. - operationId: PostV1CartsMineSetpaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CartsMineSetpaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/mine/set-payment-information - "/V1/customers": - post: - tags: - - customers - description: Create customer account. Perform necessary business operations - like sending email. - operationId: PostV1Customers - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CustomersBody - in: body - schema: - required: - - customer - properties: - customer: - "$ref": "#/definitions/customer-data-customer-interface" - password: - type: string - redirectUrl: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-customer-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers - "/V1/customers/isEmailAvailable": - post: - tags: - - customers/isEmailAvailable - description: Check if given email is associated with a customer account in given - website. - operationId: PostV1CustomersIsEmailAvailable - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CustomersIsEmailAvailableBody - in: body - schema: - required: - - customerEmail - properties: - customerEmail: - type: string - websiteId: - type: integer - description: If not set, will use the current websiteId - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/isEmailAvailable - "/V1/customers/me/activate": - put: - tags: - - customers/me/activate - description: Activate a customer account using a key that was sent in a confirmation - email. - operationId: PutV1CustomersMeActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CustomersMeActivateBody - in: body - schema: - required: - - confirmationKey - properties: - confirmationKey: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-customer-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/me/activate - "/V1/customers/me/password": - put: - tags: - - customers/me/password - description: Change customer password. - operationId: PutV1CustomersMePassword - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CustomersMePasswordBody - in: body - schema: - required: - - currentPassword - - newPassword - properties: - currentPassword: - type: string - newPassword: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/me/password - "/V1/customers/password": - put: - tags: - - customers/password - description: Send an email to the customer with a password reset link. - operationId: PutV1CustomersPassword - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CustomersPasswordBody - in: body - schema: - required: - - email - - template - properties: - email: - type: string - template: - type: string - websiteId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/password - "/V1/customers/resetPassword": - post: - tags: - - customers/resetPassword - description: Reset customer password. - operationId: PostV1CustomersResetPassword - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CustomersResetPasswordBody - in: body - schema: - required: - - email - - resetToken - - newPassword - properties: - email: - type: string - description: If empty value given then the customer will be matched - by the RP token. - resetToken: - type: string - newPassword: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/resetPassword - "/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}": - get: - tags: - - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} - description: Check if password reset token is valid. - operationId: GetV1CustomersCustomerIdPasswordResetLinkTokenResetPasswordLinkToken - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: customerId - in: path - type: integer - required: true - description: If null is given then a customer will be matched by the RP token. - - name: resetPasswordLinkToken - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: True if the token is valid - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} - "/V1/directory/countries": - get: - tags: - - directory/countries - description: Get all countries and regions information for the store. - operationId: GetV1DirectoryCountries - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/directory-data-country-information-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: directory/countries - "/V1/directory/countries/{countryId}": - get: - tags: - - directory/countries/{countryId} - description: Get country and region information for the store. - operationId: GetV1DirectoryCountriesCountryId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: countryId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/directory-data-country-information-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: directory/countries/{countryId} - "/V1/directory/currency": - get: - tags: - - directory/currency - description: Get currency information for the store. - operationId: GetV1DirectoryCurrency - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/directory-data-currency-information-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: directory/currency - "/V1/giftregistry/mine/estimate-shipping-methods": - post: - tags: - - giftregistry/mine/estimate-shipping-methods - description: Estimate shipping - operationId: PostV1GiftregistryMineEstimateshippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1GiftregistryMineEstimateshippingmethodsBody - in: body - schema: - required: - - registryId - properties: - registryId: - type: integer - description: The estimate registry id - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: giftregistry/mine/estimate-shipping-methods - "/V1/guest-carts": - post: - tags: - - guest-carts - description: Enable an customer or guest user to create an empty cart and quote - for an anonymous customer. - operationId: PostV1Guestcarts - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: string - description: Cart ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts - "/V1/guest-carts/{cartId}": - get: - tags: - - guest-carts/{cartId} - description: Enable a guest user to return information for a specified cart. - operationId: GetV1GuestcartsCartId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId} - put: - tags: - - guest-carts/{cartId} - description: Assign a specified customer to a specified shopping cart. - operationId: PutV1GuestcartsCartId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PutV1GuestcartsCartIdBody - in: body - schema: - required: - - storeId - properties: - storeId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId} - "/V1/guest-carts/{cartId}/billing-address": - get: - tags: - - guest-carts/{cartId}/billing-address - description: Return the billing address for a specified quote. - operationId: GetV1GuestcartsCartIdBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-address-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/billing-address - post: - tags: - - guest-carts/{cartId}/billing-address - description: Assign a specified billing address to a specified cart. - operationId: PostV1GuestcartsCartIdBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PostV1GuestcartsCartIdBillingaddressBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - useForShipping: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Address ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/billing-address - "/V1/guest-carts/{cartId}/collect-totals": - put: - tags: - - guest-carts/{cartId}/collect-totals - description: Set shipping/billing methods and additional data for cart and collect - totals for guest. - operationId: PutV1GuestcartsCartIdCollecttotals - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PutV1GuestcartsCartIdCollecttotalsBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - shippingCarrierCode: - type: string - description: The carrier code. - shippingMethodCode: - type: string - description: The shipping method code. - additionalData: - "$ref": "#/definitions/quote-data-totals-additional-data-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/collect-totals - "/V1/guest-carts/{cartId}/coupons": - get: - tags: - - guest-carts/{cartId}/coupons - description: Return information for a coupon in a specified cart. - operationId: GetV1GuestcartsCartIdCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: string - description: The coupon code data. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/coupons - delete: - tags: - - guest-carts/{cartId}/coupons - description: Delete a coupon from a specified cart. - operationId: DeleteV1GuestcartsCartIdCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/coupons - "/V1/guest-carts/{cartId}/coupons/{couponCode}": - put: - tags: - - guest-carts/{cartId}/coupons/{couponCode} - description: Add a coupon by code to a specified cart. - operationId: PutV1GuestcartsCartIdCouponsCouponCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: couponCode - in: path - type: string - required: true - description: The coupon code data. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/coupons/{couponCode} - "/V1/guest-carts/{cartId}/estimate-shipping-methods": - post: - tags: - - guest-carts/{cartId}/estimate-shipping-methods - description: Estimate shipping by address and return list of available shipping - methods - operationId: PostV1GuestcartsCartIdEstimateshippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdEstimateshippingmethodsBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/estimate-shipping-methods - "/V1/guest-carts/{cartId}/gift-message": - get: - tags: - - guest-carts/{cartId}/gift-message - description: Return the gift message for a specified order. - operationId: GetV1GuestcartsCartIdGiftmessage - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The shopping cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-message-data-message-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/gift-message - post: - tags: - - guest-carts/{cartId}/gift-message - description: Set the gift message for an entire order. - operationId: PostV1GuestcartsCartIdGiftmessage - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PostV1GuestcartsCartIdGiftmessageBody - in: body - schema: - required: - - giftMessage - properties: - giftMessage: - "$ref": "#/definitions/gift-message-data-message-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/gift-message - "/V1/guest-carts/{cartId}/gift-message/{itemId}": - get: - tags: - - guest-carts/{cartId}/gift-message/{itemId} - description: Return the gift message for a specified item in a specified shopping - cart. - operationId: GetV1GuestcartsCartIdGiftmessageItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The shopping cart ID. - - name: itemId - in: path - type: integer - required: true - description: The item ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-message-data-message-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/gift-message/{itemId} - post: - tags: - - guest-carts/{cartId}/gift-message/{itemId} - description: Set the gift message for a specified item in a specified shopping - cart. - operationId: PostV1GuestcartsCartIdGiftmessageItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: itemId - in: path - type: integer - required: true - description: The item ID. - - name: PostV1GuestcartsCartIdGiftmessageItemIdBody - in: body - schema: - required: - - giftMessage - properties: - giftMessage: - "$ref": "#/definitions/gift-message-data-message-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/gift-message/{itemId} - "/V1/guest-carts/{cartId}/items": - get: - tags: - - guest-carts/{cartId}/items - description: List items that are assigned to a specified cart. - operationId: GetV1GuestcartsCartIdItems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: array - description: Array of items. - items: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/items - post: - tags: - - guest-carts/{cartId}/items - description: Add/update the specified cart item. - operationId: PostV1GuestcartsCartIdItems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdItemsBody - in: body - schema: - required: - - cartItem - properties: - cartItem: - "$ref": "#/definitions/quote-data-cart-item-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/items - "/V1/guest-carts/{cartId}/items/{itemId}": - put: - tags: - - guest-carts/{cartId}/items/{itemId} - description: Add/update the specified cart item. - operationId: PutV1GuestcartsCartIdItemsItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: itemId - in: path - type: string - required: true - - name: PutV1GuestcartsCartIdItemsItemIdBody - in: body - schema: - required: - - cartItem - properties: - cartItem: - "$ref": "#/definitions/quote-data-cart-item-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/items/{itemId} - delete: - tags: - - guest-carts/{cartId}/items/{itemId} - description: Remove the specified item from the specified cart. - operationId: DeleteV1GuestcartsCartIdItemsItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: itemId - in: path - type: integer - required: true - description: The item ID of the item to be removed. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/items/{itemId} - "/V1/guest-carts/{cartId}/order": - put: - tags: - - guest-carts/{cartId}/order - description: Place an order for a specified cart. - operationId: PutV1GuestcartsCartIdOrder - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PutV1GuestcartsCartIdOrderBody - in: body - schema: - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/order - "/V1/guest-carts/{cartId}/payment-information": - post: - tags: - - guest-carts/{cartId}/payment-information - description: Set payment information and place order for a specified cart. - operationId: PostV1GuestcartsCartIdPaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdPaymentinformationBody - in: body - schema: - required: - - email - - paymentMethod - properties: - email: - type: string - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-information - get: - tags: - - guest-carts/{cartId}/payment-information - description: Get payment information - operationId: GetV1GuestcartsCartIdPaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-information - "/V1/guest-carts/{cartId}/payment-methods": - get: - tags: - - guest-carts/{cartId}/payment-methods - description: List available payment methods for a specified shopping cart. This - call returns an array of objects, but detailed information about each object’s - attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#GuestPaymentMethodManagementInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1GuestcartsCartIdPaymentmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: array - description: Array of payment methods. - items: - "$ref": "#/definitions/quote-data-payment-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-methods - "/V1/guest-carts/{cartId}/payment-order": - post: - tags: - - guest-carts/{cartId}/payment-order - description: Create a payment order for guest customer - operationId: PostV1GuestcartsCartIdPaymentorder - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdPaymentorderBody - in: body - schema: - required: - - methodCode - - paymentSource - - location - properties: - methodCode: - type: string - paymentSource: - type: string - location: - type: string - vaultIntent: - type: boolean - threeDSMode: - type: string - description: "| null $threeDSMode" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-order - "/V1/guest-carts/{cartId}/payment-order/{id}": - get: - tags: - - guest-carts/{cartId}/payment-order/{id} - description: Get payment order for guest customer - operationId: GetV1GuestcartsCartIdPaymentorderId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: id - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-order/{id} - post: - tags: - - guest-carts/{cartId}/payment-order/{id} - description: Sync payment order for guest customer - operationId: PostV1GuestcartsCartIdPaymentorderId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: id - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-order/{id} - "/V1/guest-carts/{cartId}/selected-payment-method": - get: - tags: - - guest-carts/{cartId}/selected-payment-method - description: Return the payment method for a specified shopping cart. - operationId: GetV1GuestcartsCartIdSelectedpaymentmethod - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-payment-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/selected-payment-method - put: - tags: - - guest-carts/{cartId}/selected-payment-method - description: Add a specified payment method to a specified shopping cart. - operationId: PutV1GuestcartsCartIdSelectedpaymentmethod - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PutV1GuestcartsCartIdSelectedpaymentmethodBody - in: body - schema: - required: - - method - properties: - method: - "$ref": "#/definitions/quote-data-payment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Payment method ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/selected-payment-method - "/V1/guest-carts/{cartId}/set-payment-information": - post: - tags: - - guest-carts/{cartId}/set-payment-information - description: Set payment information for a specified cart. - operationId: PostV1GuestcartsCartIdSetpaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdSetpaymentinformationBody - in: body - schema: - required: - - email - - paymentMethod - properties: - email: - type: string - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/set-payment-information - "/V1/guest-carts/{cartId}/shipping-information": - post: - tags: - - guest-carts/{cartId}/shipping-information - description: '' - operationId: PostV1GuestcartsCartIdShippinginformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdShippinginformationBody - in: body - schema: - required: - - addressInformation - properties: - addressInformation: - "$ref": "#/definitions/checkout-data-shipping-information-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/shipping-information - "/V1/guest-carts/{cartId}/shipping-methods": - get: - tags: - - guest-carts/{cartId}/shipping-methods - description: List applicable shipping methods for a specified quote. - operationId: GetV1GuestcartsCartIdShippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The shopping cart ID. - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/shipping-methods - "/V1/guest-carts/{cartId}/totals": - get: - tags: - - guest-carts/{cartId}/totals - description: Return quote totals data for a specified cart. - operationId: GetV1GuestcartsCartIdTotals - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/totals - "/V1/guest-carts/{cartId}/totals-information": - post: - tags: - - guest-carts/{cartId}/totals-information - description: Calculate quote totals based on address and shipping method. - operationId: PostV1GuestcartsCartIdTotalsinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdTotalsinformationBody - in: body - schema: - required: - - addressInformation - properties: - addressInformation: - "$ref": "#/definitions/checkout-data-totals-information-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/totals-information - "/V1/guest-giftregistry/{cartId}/estimate-shipping-methods": - post: - tags: - - guest-giftregistry/{cartId}/estimate-shipping-methods - description: Estimate shipping - operationId: PostV1GuestgiftregistryCartIdEstimateshippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The shopping cart ID. - - name: PostV1GuestgiftregistryCartIdEstimateshippingmethodsBody - in: body - schema: - required: - - registryId - properties: - registryId: - type: integer - description: The estimate registry id - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-giftregistry/{cartId}/estimate-shipping-methods - "/V1/integration/admin/token": - post: - tags: - - integration/admin/token - description: Create access token for admin given the admin credentials. - operationId: PostV1IntegrationAdminToken - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1IntegrationAdminTokenBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - description: Token created - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: integration/admin/token - "/V1/integration/customer/revoke-customer-token": - post: - tags: - - integration/customer/revoke-customer-token - description: Revoke token by customer id. - operationId: PostV1IntegrationCustomerRevokecustomertoken - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: integration/customer/revoke-customer-token - "/V1/integration/customer/token": - post: - tags: - - integration/customer/token - description: Create access token for admin given the customer credentials. - operationId: PostV1IntegrationCustomerToken - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1IntegrationCustomerTokenBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - description: Token created - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: integration/customer/token - "/V1/inventory/in-store-pickup/pickup-locations/": - get: - tags: - - inventory/in-store-pickup/pickup-locations/ - description: Get Pickup Locations according to the results of filtration by - Search Request. - operationId: GetV1InventoryInstorepickupPickuplocations - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchRequest[area][radius] - in: query - type: integer - description: Search radius in KM. - - name: searchRequest[area][searchTerm] - in: query - type: string - description: Search term string. - - name: searchRequest[filters][country][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][country][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][postcode][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][postcode][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][region][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][region][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][regionId][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][regionId][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][city][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][city][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][street][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][street][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][name][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][name][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][pickupLocationCode][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][pickupLocationCode][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[pageSize] - in: query - type: integer - description: Page size. - - name: searchRequest[currentPage] - in: query - type: integer - description: Current page. - - name: searchRequest[scopeType] - in: query - type: string - description: Sales Channel Type. - - name: searchRequest[scopeCode] - in: query - type: string - description: Sales Channel code. - - name: searchRequest[sort][0][field] - in: query - type: string - description: Sorting field. - - name: searchRequest[sort][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchRequest[extensionAttributes][productsInfo][0][sku] - in: query - type: string - description: Product SKU. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/in-store-pickup/pickup-locations/ - post: - tags: - - inventory/in-store-pickup/pickup-locations/ - description: Get Pickup Locations according to the results of filtration by - Search Request. - operationId: PostV1InventoryInstorepickupPickuplocations - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventoryInstorepickupPickuplocationsBody - in: body - schema: - required: - - searchRequest - properties: - searchRequest: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/in-store-pickup/pickup-locations/ - "/V1/negotiable-carts/{cartId}/billing-address": - get: - tags: - - negotiable-carts/{cartId}/billing-address - description: Returns the billing address for a specified quote. - operationId: GetV1NegotiablecartsCartIdBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-address-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/billing-address - post: - tags: - - negotiable-carts/{cartId}/billing-address - description: Assigns a specified billing address to a specified cart. - operationId: PostV1NegotiablecartsCartIdBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - - name: PostV1NegotiablecartsCartIdBillingaddressBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - useForShipping: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Address ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/billing-address - "/V1/negotiable-carts/{cartId}/coupons": - delete: - tags: - - negotiable-carts/{cartId}/coupons - description: Deletes a coupon from a specified cart. - operationId: DeleteV1NegotiablecartsCartIdCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/coupons - "/V1/negotiable-carts/{cartId}/coupons/{couponCode}": - put: - tags: - - negotiable-carts/{cartId}/coupons/{couponCode} - description: Adds a coupon by code to a specified cart. - operationId: PutV1NegotiablecartsCartIdCouponsCouponCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - - name: couponCode - in: path - type: string - required: true - description: The coupon code data. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/coupons/{couponCode} - "/V1/negotiable-carts/{cartId}/estimate-shipping-methods": - post: - tags: - - negotiable-carts/{cartId}/estimate-shipping-methods - description: Estimate shipping by address and return list of available shipping - methods - operationId: PostV1NegotiablecartsCartIdEstimateshippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1NegotiablecartsCartIdEstimateshippingmethodsBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/estimate-shipping-methods - "/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id": - post: - tags: - - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id - description: Estimate shipping - operationId: PostV1NegotiablecartsCartIdEstimateshippingmethodsbyaddressid - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The shopping cart ID. - - name: PostV1NegotiablecartsCartIdEstimateshippingmethodsbyaddressidBody - in: body - schema: - required: - - addressId - properties: - addressId: - type: integer - description: The estimate address id - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id - "/V1/negotiable-carts/{cartId}/giftCards": - post: - tags: - - negotiable-carts/{cartId}/giftCards - description: '' - operationId: PostV1NegotiablecartsCartIdGiftCards - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1NegotiablecartsCartIdGiftCardsBody - in: body - schema: - required: - - giftCardAccountData - properties: - giftCardAccountData: - "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/giftCards - "/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}": - delete: - tags: - - negotiable-carts/{cartId}/giftCards/{giftCardCode} - description: Remove GiftCard Account entity - operationId: DeleteV1NegotiablecartsCartIdGiftCardsGiftCardCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: giftCardCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/giftCards/{giftCardCode} - "/V1/negotiable-carts/{cartId}/payment-information": - post: - tags: - - negotiable-carts/{cartId}/payment-information - description: Set payment information and place order for a specified cart. - operationId: PostV1NegotiablecartsCartIdPaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1NegotiablecartsCartIdPaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/payment-information - get: - tags: - - negotiable-carts/{cartId}/payment-information - description: Get payment information - operationId: GetV1NegotiablecartsCartIdPaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/payment-information - "/V1/negotiable-carts/{cartId}/po-payment-information": - post: - tags: - - negotiable-carts/{cartId}/po-payment-information - description: Set payment information and place purchase order for a specified - negotiable quote. - operationId: PostV1NegotiablecartsCartIdPopaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1NegotiablecartsCartIdPopaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Purchase Order ID. - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/po-payment-information - "/V1/negotiable-carts/{cartId}/set-payment-information": - post: - tags: - - negotiable-carts/{cartId}/set-payment-information - description: Set payment information for a specified cart. - operationId: PostV1NegotiablecartsCartIdSetpaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1NegotiablecartsCartIdSetpaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/set-payment-information - "/V1/negotiable-carts/{cartId}/shipping-information": - post: - tags: - - negotiable-carts/{cartId}/shipping-information - description: '' - operationId: PostV1NegotiablecartsCartIdShippinginformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1NegotiablecartsCartIdShippinginformationBody - in: body - schema: - required: - - addressInformation - properties: - addressInformation: - "$ref": "#/definitions/checkout-data-shipping-information-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/shipping-information - "/V1/negotiable-carts/{cartId}/totals": - get: - tags: - - negotiable-carts/{cartId}/totals - description: Returns quote totals data for a specified cart. - operationId: GetV1NegotiablecartsCartIdTotals - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiable-carts/{cartId}/totals - "/V1/negotiableQuoteTemplate/accept": - post: - tags: - - negotiableQuoteTemplate/accept - description: Create quote template from quote - operationId: PostV1NegotiableQuoteTemplateAccept - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateAcceptBody - in: body - schema: - required: - - templateId - properties: - templateId: - type: integer - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/accept - "/V1/negotiableQuoteTemplate/generateQuote": - post: - tags: - - negotiableQuoteTemplate/generateQuote - description: Generate quote from template - operationId: PostV1NegotiableQuoteTemplateGenerateQuote - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateGenerateQuoteBody - in: body - schema: - required: - - templateId - properties: - templateId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/generateQuote - "/V1/negotiableQuoteTemplate/submitToSeller": - post: - tags: - - negotiableQuoteTemplate/submitToSeller - description: Send template to seller - operationId: PostV1NegotiableQuoteTemplateSubmitToSeller - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1NegotiableQuoteTemplateSubmitToSellerBody - in: body - schema: - required: - - templateId - properties: - templateId: - type: integer - commentText: - type: string - files: - type: array - items: - "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" - type: object - xml: - name: request - responses: - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: negotiableQuoteTemplate/submitToSeller - "/V1/payment-order/completeOrder": - post: - tags: - - payment-order/completeOrder - description: Rest API endpoint to place an order - operationId: PostV1PaymentorderCompleteOrder - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1PaymentorderCompleteOrderBody - in: body - schema: - required: - - orderId - properties: - orderId: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payment-order/completeOrder - "/V1/payments-config/apple-pay/{location}": - get: - tags: - - payments-config/apple-pay/{location} - description: Get Apple Pay Config. - operationId: GetV1PaymentsconfigApplepayLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/apple-pay/{location} - "/V1/payments-config/google-pay/{location}": - get: - tags: - - payments-config/google-pay/{location} - description: Get Google Pay Config. - operationId: GetV1PaymentsconfigGooglepayLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/google-pay/{location} - "/V1/payments-config/hosted-fields/{location}": - get: - tags: - - payments-config/hosted-fields/{location} - description: Get Hosted Fields Config. - operationId: GetV1PaymentsconfigHostedfieldsLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/hosted-fields/{location} - "/V1/payments-config/smart-buttons/{location}": - get: - tags: - - payments-config/smart-buttons/{location} - description: Get Smart Buttons Config. - operationId: GetV1PaymentsconfigSmartbuttonsLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/smart-buttons/{location} - "/V1/payments-config/{location}": - get: - tags: - - payments-config/{location} - description: Get Config. - operationId: GetV1PaymentsconfigLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-payment-config-response-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/{location} - "/V1/payments-sdk/{location}": - get: - tags: - - payments-sdk/{location} - description: Get payment sdk url by location - operationId: GetV1PaymentssdkLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-sdk/{location} - "/V1/payments-sdk/{location}/{methodCode}": - get: - tags: - - payments-sdk/{location}/{methodCode} - description: Get payment sdk url by location and methodCode - operationId: GetV1PaymentssdkLocationMethodCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - - name: methodCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-sdk/{location}/{methodCode} - "/V1/paypal/lineItems": - post: - tags: - - paypal/lineItems - description: Rest endpoint to calculate totals and line items - operationId: PostV1PaypalLineItems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1PaypalLineItemsBody - in: body - schema: - required: - - method - - cartId - properties: - method: - type: string - cartId: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: paypal/lineItems - "/V1/paypal/oneClick": - post: - tags: - - paypal/oneClick - description: Rest endpoint to add product to cart (mainly use for PayPal button - from PDP) - operationId: PostV1PaypalOneClick - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1PaypalOneClickBody - in: body - schema: - required: - - method - - productData - properties: - method: - type: string - productData: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: paypal/oneClick - "/V1/paypal/validatePhoneNumber": - post: - tags: - - paypal/validatePhoneNumber - description: Get & validate phone number and get shipping/billing email address - operationId: PostV1PaypalValidatePhoneNumber - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1PaypalValidatePhoneNumberBody - in: body - schema: - required: - - cartId - properties: - cartId: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: paypal/validatePhoneNumber - "/V1/products-render-info": - get: - tags: - - products-render-info - description: Collect and retrieve the list of product render info. This info - contains raw prices and formatted prices, product name, stock status, store_id, - etc. - operationId: GetV1Productsrenderinfo - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - - name: storeId - in: query - type: integer - required: true - - name: currencyCode - in: query - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-render-search-results-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products-render-info - "/V1/purchase-order-carts/{cartId}/payment-information": - post: - tags: - - purchase-order-carts/{cartId}/payment-information - description: Set payment information and place order for a specified cart. - operationId: PostV1PurchaseordercartsCartIdPaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1PurchaseordercartsCartIdPaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: purchase-order-carts/{cartId}/payment-information - get: - tags: - - purchase-order-carts/{cartId}/payment-information - description: Get payment information - operationId: GetV1PurchaseordercartsCartIdPaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: purchase-order-carts/{cartId}/payment-information - "/V1/purchase-order-carts/{cartId}/set-payment-information": - post: - tags: - - purchase-order-carts/{cartId}/set-payment-information - description: Set payment information for a specified cart. - operationId: PostV1PurchaseordercartsCartIdSetpaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: integer - required: true - - name: PostV1PurchaseordercartsCartIdSetpaymentinformationBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: purchase-order-carts/{cartId}/set-payment-information - "/V1/requisition_lists": - post: - tags: - - requisition_lists - description: Save Requisition List - operationId: PostV1Requisition_lists - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1Requisition_listsBody - in: body - schema: - required: - - requisitionList - properties: - requisitionList: - "$ref": "#/definitions/requisition-list-data-requisition-list-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/requisition-list-data-requisition-list-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: requisition_lists - "/V1/reward/mine/use-reward": - post: - tags: - - reward/mine/use-reward - description: Set reward points to quote - operationId: PostV1RewardMineUsereward - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: boolean - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: reward/mine/use-reward - "/V1/search": - get: - tags: - - search - description: Make Full Text Search and return found Documents - operationId: GetV1Search - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[requestName] - in: query - type: string - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/framework-search-search-result-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: search - "/V1/tfa/provider/authy/activate": - post: - tags: - - tfa/provider/authy/activate - description: Activate the provider and get an admin token - operationId: PostV1TfaProviderAuthyActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderAuthyActivateBody - in: body - schema: - required: - - tfaToken - - otp - properties: - tfaToken: - type: string - otp: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/activate - "/V1/tfa/provider/authy/authenticate": - post: - tags: - - tfa/provider/authy/authenticate - description: Get an admin token using authy 2fa - operationId: PostV1TfaProviderAuthyAuthenticate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderAuthyAuthenticateBody - in: body - schema: - required: - - username - - password - - otp - properties: - username: - type: string - password: - type: string - otp: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - description: "$otp" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/authenticate - "/V1/tfa/provider/authy/authenticate-onetouch": - post: - tags: - - tfa/provider/authy/authenticate-onetouch - description: Authenticate using the present one touch response and get an admin - token - operationId: PostV1TfaProviderAuthyAuthenticateonetouch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderAuthyAuthenticateonetouchBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/authenticate-onetouch - "/V1/tfa/provider/authy/configure": - post: - tags: - - tfa/provider/authy/configure - description: Get the information required to configure google - operationId: PostV1TfaProviderAuthyConfigure - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderAuthyConfigureBody - in: body - schema: - required: - - tfaToken - - deviceData - properties: - tfaToken: - type: string - deviceData: - "$ref": "#/definitions/two-factor-auth-data-authy-device-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/configure - "/V1/tfa/provider/authy/send-token/{via}": - post: - tags: - - tfa/provider/authy/send-token/{via} - description: Send a one time password to a device using authy - operationId: PostV1TfaProviderAuthySendtokenVia - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: via - in: path - type: string - required: true - - name: PostV1TfaProviderAuthySendtokenViaBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/send-token/{via} - "/V1/tfa/provider/duo_security/activate": - post: - tags: - - tfa/provider/duo_security/activate - description: Activate the provider and get an admin token - operationId: PostV1TfaProviderDuo_securityActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderDuo_securityActivateBody - in: body - schema: - required: - - tfaToken - properties: - tfaToken: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/duo_security/activate - "/V1/tfa/provider/duo_security/authenticate": - post: - tags: - - tfa/provider/duo_security/authenticate - description: Authenticate and get an admin token with passcode - operationId: PostV1TfaProviderDuo_securityAuthenticate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderDuo_securityAuthenticateBody - in: body - schema: - required: - - username - - password - - passcode - properties: - username: - type: string - password: - type: string - passcode: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/duo_security/authenticate - "/V1/tfa/provider/duo_security/configure": - post: - tags: - - tfa/provider/duo_security/configure - description: Configure duo for first time user - operationId: PostV1TfaProviderDuo_securityConfigure - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderDuo_securityConfigureBody - in: body - schema: - required: - - tfaToken - properties: - tfaToken: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/duo_security/configure - "/V1/tfa/provider/google/activate": - post: - tags: - - tfa/provider/google/activate - description: Activate the provider and get an admin token - operationId: PostV1TfaProviderGoogleActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderGoogleActivateBody - in: body - schema: - required: - - tfaToken - - otp - properties: - tfaToken: - type: string - otp: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/google/activate - "/V1/tfa/provider/google/authenticate": - post: - tags: - - tfa/provider/google/authenticate - description: Get an admin token by authenticating using google - operationId: PostV1TfaProviderGoogleAuthenticate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderGoogleAuthenticateBody - in: body - schema: - required: - - username - - password - - otp - properties: - username: - type: string - password: - type: string - otp: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/google/authenticate - "/V1/tfa/provider/google/configure": - post: - tags: - - tfa/provider/google/configure - description: Get the information required to configure google - operationId: PostV1TfaProviderGoogleConfigure - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderGoogleConfigureBody - in: body - schema: - required: - - tfaToken - properties: - tfaToken: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/two-factor-auth-data-google-configure-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/google/configure - "/V1/tfa/provider/u2fkey/activate": - post: - tags: - - tfa/provider/u2fkey/activate - description: Activate the provider and get a token - operationId: PostV1TfaProviderU2fkeyActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderU2fkeyActivateBody - in: body - schema: - required: - - tfaToken - - publicKeyCredentialJson - properties: - tfaToken: - type: string - publicKeyCredentialJson: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/u2fkey/activate - "/V1/tfa/provider/u2fkey/authentication-challenge": - post: - tags: - - tfa/provider/u2fkey/authentication-challenge - description: Get the information to initiate a WebAuthn registration ceremony - operationId: PostV1TfaProviderU2fkeyAuthenticationchallenge - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderU2fkeyAuthenticationchallengeBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/u2fkey/authentication-challenge - "/V1/tfa/provider/u2fkey/configure": - post: - tags: - - tfa/provider/u2fkey/configure - description: Get the information to initiate a WebAuthn registration ceremony - operationId: PostV1TfaProviderU2fkeyConfigure - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderU2fkeyConfigureBody - in: body - schema: - required: - - tfaToken - properties: - tfaToken: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/u2fkey/configure - "/V1/tfa/provider/u2fkey/verify": - post: - tags: - - tfa/provider/u2fkey/verify - description: Authenticate with the provider and get a token - operationId: PostV1TfaProviderU2fkeyVerify - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderU2fkeyVerifyBody - in: body - schema: - required: - - username - - password - - publicKeyCredentialJson - properties: - username: - type: string - password: - type: string - publicKeyCredentialJson: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/u2fkey/verify - "/V1/tfa/tfat-providers-to-activate": - get: - tags: - - tfa/tfat-providers-to-activate - description: Get the providers that the user still needs to configure - operationId: GetV1TfaTfatproviderstoactivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: tfaToken - in: query - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/two-factor-auth-provider-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/tfat-providers-to-activate - "/V1/tfa/tfat-user-providers": - get: - tags: - - tfa/tfat-user-providers - description: Get the providers that the user is able to use for 2fa - operationId: GetV1TfaTfatuserproviders - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: tfaToken - in: query - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/two-factor-auth-provider-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/tfat-user-providers -definitions: - error-response: - type: object - properties: - message: - type: string - description: Error message - errors: - "$ref": "#/definitions/error-errors" - code: - type: integer - description: Error code - parameters: - "$ref": "#/definitions/error-parameters" - trace: - type: string - description: Stack trace - required: - - message - error-errors: - type: array - description: Errors list - items: - "$ref": "#/definitions/error-errors-item" - error-errors-item: - type: object - description: Error details - properties: - message: - type: string - description: Error message - parameters: - "$ref": "#/definitions/error-parameters" - error-parameters: - type: array - description: Error parameters list - items: - "$ref": "#/definitions/error-parameters-item" - error-parameters-item: - type: object - description: Error parameters item - properties: - resources: - type: string - description: ACL resource - fieldName: - type: string - description: Missing or invalid field name - fieldValue: - type: string - description: Incorrect field value - directory-data-currency-information-interface: - type: object - description: Currency Information interface. - properties: - base_currency_code: - type: string - description: The base currency code for the store. - base_currency_symbol: - type: string - description: The currency symbol of the base currency for the store. - default_display_currency_code: - type: string - description: The default display currency code for the store. - default_display_currency_symbol: - type: string - description: The currency symbol of the default display currency for the store. - available_currency_codes: - type: array - description: The list of allowed currency codes for the store. - items: - type: string - exchange_rates: - type: array - description: The list of exchange rate information for the store. - items: - "$ref": "#/definitions/directory-data-exchange-rate-interface" - extension_attributes: - "$ref": "#/definitions/directory-data-currency-information-extension-interface" - required: - - base_currency_code - - base_currency_symbol - - default_display_currency_code - - default_display_currency_symbol - - available_currency_codes - - exchange_rates - directory-data-exchange-rate-interface: - type: object - description: Exchange Rate interface. - properties: - currency_to: - type: string - description: The currency code associated with the exchange rate. - rate: - type: number - description: The exchange rate for the associated currency and the store's - base currency. - extension_attributes: - "$ref": "#/definitions/directory-data-exchange-rate-extension-interface" - required: - - currency_to - - rate - directory-data-exchange-rate-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Directory\Api\Data\ExchangeRateInterface - directory-data-currency-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CurrencyInformationInterface - directory-data-country-information-interface: - type: object - description: Country Information interface. - properties: - id: - type: string - description: The country id for the store. - two_letter_abbreviation: - type: string - description: The country 2 letter abbreviation for the store. - three_letter_abbreviation: - type: string - description: The country 3 letter abbreviation for the store. - full_name_locale: - type: string - description: The country full name (in store locale) for the store. - full_name_english: - type: string - description: The country full name (in English) for the store. - available_regions: - type: array - description: The available regions for the store. - items: - "$ref": "#/definitions/directory-data-region-information-interface" - extension_attributes: - "$ref": "#/definitions/directory-data-country-information-extension-interface" - required: - - id - - two_letter_abbreviation - - three_letter_abbreviation - - full_name_locale - - full_name_english - directory-data-region-information-interface: - type: object - description: Region Information interface. - properties: - id: - type: string - description: Region id - code: - type: string - description: Region code - name: - type: string - description: Region name - extension_attributes: - "$ref": "#/definitions/directory-data-region-information-extension-interface" - required: - - id - - code - - name - directory-data-region-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Directory\Api\Data\RegionInformationInterface - directory-data-country-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CountryInformationInterface - customer-data-customer-interface: - type: object - description: Customer entity interface for API handling. - properties: - id: - type: integer - description: Customer id - group_id: - type: integer - description: Group id - default_billing: - type: string - description: Default billing address id - default_shipping: - type: string - description: Default shipping address id - confirmation: - type: string - description: Confirmation - created_at: - type: string - description: Created at time - updated_at: - type: string - description: Updated at time - created_in: - type: string - description: Created in area - dob: - type: string - description: In keeping with current security and privacy best practices, - be sure you are aware of any potential legal and security risks associated - with the storage of customers’ full date of birth (month, day, year) along - with other personal identifiers (e.g., full name) before collecting or processing - such data. - email: - type: string - description: Email address - firstname: - type: string - description: First name - lastname: - type: string - description: Last name - middlename: - type: string - description: Middle name - prefix: - type: string - description: Prefix - suffix: - type: string - description: Suffix - gender: - type: integer - description: Gender - store_id: - type: integer - description: Store id - taxvat: - type: string - description: Tax Vat - website_id: - type: integer - description: Website id - addresses: - type: array - description: Customer addresses. - items: - "$ref": "#/definitions/customer-data-address-interface" - disable_auto_group_change: - type: integer - description: Disable auto group change flag. - extension_attributes: - "$ref": "#/definitions/customer-data-customer-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - email - - firstname - - lastname - customer-data-address-interface: - type: object - description: Customer address interface. - properties: - id: - type: integer - description: ID - customer_id: - type: integer - description: Customer ID - region: - "$ref": "#/definitions/customer-data-region-interface" - region_id: - type: integer - description: Region ID - country_id: - type: string - description: Country code in ISO_3166-2 format - street: - type: array - description: Street - items: - type: string - company: - type: string - description: Company - telephone: - type: string - description: Telephone number - fax: - type: string - description: Fax number - postcode: - type: string - description: Postcode - city: - type: string - description: City name - firstname: - type: string - description: First name - lastname: - type: string - description: Last name - middlename: - type: string - description: Middle name - prefix: - type: string - description: Prefix - suffix: - type: string - description: Suffix - vat_id: - type: string - description: Vat id - default_shipping: - type: boolean - description: If this address is default shipping address. - default_billing: - type: boolean - description: If this address is default billing address - extension_attributes: - "$ref": "#/definitions/customer-data-address-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - customer-data-region-interface: - type: object - description: Customer address region interface. - properties: - region_code: - type: string - description: Region code - region: - type: string - description: Region - region_id: - type: integer - description: Region id - extension_attributes: - "$ref": "#/definitions/customer-data-region-extension-interface" - required: - - region_code - - region - - region_id - customer-data-region-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface - customer-data-address-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface - framework-attribute-interface: - type: object - description: Interface for custom attribute value. - properties: - attribute_code: - type: string - description: Attribute code - value: - type: string - description: Attribute value - required: - - attribute_code - - value - customer-data-customer-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface - properties: - company_attributes: - "$ref": "#/definitions/company-data-company-customer-interface" - all_company_attributes: - type: array - items: - "$ref": "#/definitions/company-data-company-customer-interface" - is_subscribed: - type: boolean - assistance_allowed: - type: integer - company-data-company-customer-interface: - type: object - description: Extended customer custom attributes interface. - properties: - customer_id: - type: integer - description: Customer ID. - company_id: - type: integer - description: Company ID. - job_title: - type: string - description: Job title. - status: - type: integer - description: Customer status. - telephone: - type: string - description: Telephone. - is_default: - type: boolean - description: Is default - extension_attributes: - "$ref": "#/definitions/company-data-company-customer-extension-interface" - company-data-company-customer-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface - catalog-data-product-render-search-results-interface: - type: object - description: Dto that holds render information about products - properties: - items: - type: array - description: List of products rendered information - items: - "$ref": "#/definitions/catalog-data-product-render-interface" - required: - - items - catalog-data-product-render-interface: - type: object - description: Represents Data Object which holds enough information to render product - This information is put into part as Add To Cart or Add to Compare Data or Price - Data - properties: - add_to_cart_button: - "$ref": "#/definitions/catalog-data-product-render-button-interface" - add_to_compare_button: - "$ref": "#/definitions/catalog-data-product-render-button-interface" - price_info: - "$ref": "#/definitions/catalog-data-product-render-price-info-interface" - images: - type: array - description: Enough information, that needed to render image on front - items: - "$ref": "#/definitions/catalog-data-product-render-image-interface" - url: - type: string - description: Product url - id: - type: integer - description: Product identifier - name: - type: string - description: Product name - type: - type: string - description: Product type. Such as bundle, grouped, simple, etc... - is_salable: - type: string - description: Information about product saleability (In Stock) - store_id: - type: integer - description: Information about current store id or requested store id - currency_code: - type: string - description: Current or desired currency code to product - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-extension-interface" - required: - - add_to_cart_button - - add_to_compare_button - - price_info - - images - - url - - id - - name - - type - - is_salable - - store_id - - currency_code - - extension_attributes - catalog-data-product-render-button-interface: - type: object - description: 'Button interface. This interface represents all manner of product - buttons: add to cart, add to compare, etc... The buttons describes by this interface - should have interaction with backend' - properties: - post_data: - type: string - description: Post data - url: - type: string - description: Url, needed to add product to cart - required_options: - type: boolean - description: Flag whether a product has options or not - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-button-extension-interface" - required: - - post_data - - url - - required_options - catalog-data-product-render-button-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface - catalog-data-product-render-price-info-interface: - type: object - description: Price interface. - properties: - final_price: - type: number - description: Final price - max_price: - type: number - description: Max price of a product - max_regular_price: - type: number - description: Max regular price - minimal_regular_price: - type: number - description: Minimal regular price - special_price: - type: number - description: Special price - minimal_price: - type: number - description: Minimal price - regular_price: - type: number - description: Regular price - formatted_prices: - "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-interface" - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-price-info-extension-interface" - required: - - final_price - - max_price - - max_regular_price - - minimal_regular_price - - special_price - - minimal_price - - regular_price - - formatted_prices - catalog-data-product-render-formatted-price-info-interface: - type: object - description: 'Formatted Price interface. Aggregate formatted html with price representations. - E.g.: $9.00 Consider currency, rounding and html' - properties: - final_price: - type: string - description: Html with final price - max_price: - type: string - description: Max price of a product - minimal_price: - type: string - description: The minimal price of the product or variation - max_regular_price: - type: string - description: Max regular price - minimal_regular_price: - type: string - description: Minimal regular price - special_price: - type: string - description: Special price - regular_price: - type: string - description: Price - is price of product without discounts and special price - with taxes and fixed product tax - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-extension-interface" - required: - - final_price - - max_price - - minimal_price - - max_regular_price - - minimal_regular_price - - special_price - - regular_price - catalog-data-product-render-formatted-price-info-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\FormattedPriceInfoInterface - catalog-data-product-render-price-info-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface - properties: - msrp: - "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-interface" - tax_adjustments: - "$ref": "#/definitions/catalog-data-product-render-price-info-interface" - weee_attributes: - type: array - items: - "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-interface" - weee_adjustment: - type: string - msrp-data-product-render-msrp-price-info-interface: - type: object - description: Price interface. - properties: - msrp_price: - type: string - is_applicable: - type: string - is_shown_price_on_gesture: - type: string - msrp_message: - type: string - explanation_message: - type: string - extension_attributes: - "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-extension-interface" - required: - - msrp_price - - is_applicable - - is_shown_price_on_gesture - - msrp_message - - explanation_message - msrp-data-product-render-msrp-price-info-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface - weee-data-product-render-weee-adjustment-attribute-interface: - type: object - description: List of all weee attributes, their amounts, etc.., that product has - properties: - amount: - type: string - description: Weee attribute amount - tax_amount: - type: string - description: Tax which is calculated to fixed product tax attribute - tax_amount_incl_tax: - type: string - description: Tax amount of weee attribute - amount_excl_tax: - type: string - description: Product amount exclude tax - attribute_code: - type: string - description: Weee attribute code - extension_attributes: - "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface" - required: - - amount - - tax_amount - - tax_amount_incl_tax - - amount_excl_tax - - attribute_code - - extension_attributes - weee-data-product-render-weee-adjustment-attribute-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Weee\Api\Data\ProductRender\WeeeAdjustmentAttributeInterface - catalog-data-product-render-image-interface: - type: object - description: Product Render image interface. Represents physical characteristics - of image, that can be used in product listing or product view - properties: - url: - type: string - description: Image url - code: - type: string - description: Image code - height: - type: number - description: Image height - width: - type: number - description: Image width in px - label: - type: string - description: Image label - resized_width: - type: number - description: Resize width - resized_height: - type: number - description: Resize height - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-image-extension-interface" - required: - - url - - code - - height - - width - - label - - resized_width - - resized_height - catalog-data-product-render-image-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ImageInterface - catalog-data-product-render-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRenderInterface - properties: - wishlist_button: - "$ref": "#/definitions/catalog-data-product-render-button-interface" - review_html: - type: string - quote-data-cart-interface: - type: object - description: Interface CartInterface - properties: - id: - type: integer - description: Cart/quote ID. - created_at: - type: string - description: Cart creation date and time. Otherwise, null. - updated_at: - type: string - description: Cart last update date and time. Otherwise, null. - converted_at: - type: string - description: Cart conversion date and time. Otherwise, null. - is_active: - type: boolean - description: Active status flag value. Otherwise, null. - is_virtual: - type: boolean - description: Virtual flag value. Otherwise, null. - items: - type: array - description: Array of items. Otherwise, null. - items: - "$ref": "#/definitions/quote-data-cart-item-interface" - items_count: - type: integer - description: Number of different items or products in the cart. Otherwise, - null. - items_qty: - type: number - description: Total quantity of all cart items. Otherwise, null. - customer: - "$ref": "#/definitions/customer-data-customer-interface" - billing_address: - "$ref": "#/definitions/quote-data-address-interface" - reserved_order_id: - type: string - description: Reserved order ID. Otherwise, null. - orig_order_id: - type: integer - description: Original order ID. Otherwise, null. - currency: - "$ref": "#/definitions/quote-data-currency-interface" - customer_is_guest: - type: boolean - description: For guest customers, false for logged in customers - customer_note: - type: string - description: Notice text - customer_note_notify: - type: boolean - description: Customer notification flag - customer_tax_class_id: - type: integer - description: Customer tax class ID. - store_id: - type: integer - description: Store identifier - extension_attributes: - "$ref": "#/definitions/quote-data-cart-extension-interface" - required: - - id - - customer - - store_id - quote-data-cart-item-interface: - type: object - description: Interface CartItemInterface - properties: - item_id: - type: integer - description: Item ID. Otherwise, null. - sku: - type: string - description: Product SKU. Otherwise, null. - qty: - type: number - description: Product quantity. - name: - type: string - description: Product name. Otherwise, null. - price: - type: number - description: Product price. Otherwise, null. - product_type: - type: string - description: Product type. Otherwise, null. - quote_id: - type: string - description: Quote id. - product_option: - "$ref": "#/definitions/quote-data-product-option-interface" - extension_attributes: - "$ref": "#/definitions/quote-data-cart-item-extension-interface" - required: - - qty - - quote_id - quote-data-product-option-interface: - type: object - description: Product option interface - properties: - extension_attributes: - "$ref": "#/definitions/quote-data-product-option-extension-interface" - quote-data-product-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface - properties: - custom_options: - type: array - items: - "$ref": "#/definitions/catalog-data-custom-option-interface" - bundle_options: - type: array - items: - "$ref": "#/definitions/bundle-data-bundle-option-interface" - downloadable_option: - "$ref": "#/definitions/downloadable-data-downloadable-option-interface" - giftcard_item_option: - "$ref": "#/definitions/gift-card-data-gift-card-option-interface" - configurable_item_options: - type: array - items: - "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-interface" - grouped_options: - type: array - items: - "$ref": "#/definitions/grouped-product-data-grouped-options-interface" - catalog-data-custom-option-interface: - type: object - description: Interface CustomOptionInterface - properties: - option_id: - type: string - description: Option id - option_value: - type: string - description: Option value - extension_attributes: - "$ref": "#/definitions/catalog-data-custom-option-extension-interface" - required: - - option_id - - option_value - catalog-data-custom-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface - properties: - file_info: - "$ref": "#/definitions/framework-data-image-content-interface" - framework-data-image-content-interface: - type: object - description: Image Content data interface - properties: - base64_encoded_data: - type: string - description: Media data (base64 encoded content) - type: - type: string - description: MIME type - name: - type: string - description: Image name - required: - - base64_encoded_data - - type - - name - bundle-data-bundle-option-interface: - type: object - description: Interface BundleOptionInterface - properties: - option_id: - type: integer - description: Bundle option id. - option_qty: - type: integer - description: Bundle option quantity. - option_selections: - type: array - description: Bundle option selection ids. - items: - type: integer - extension_attributes: - "$ref": "#/definitions/bundle-data-bundle-option-extension-interface" - required: - - option_id - - option_qty - - option_selections - bundle-data-bundle-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface - downloadable-data-downloadable-option-interface: - type: object - description: Downloadable Option - properties: - downloadable_links: - type: array - description: The list of downloadable links - items: - type: integer - required: - - downloadable_links - gift-card-data-gift-card-option-interface: - type: object - description: Interface GiftCardOptionInterface - properties: - giftcard_amount: - type: string - description: Gift card amount. - custom_giftcard_amount: - type: number - description: Gift card open amount value. - giftcard_sender_name: - type: string - description: Gift card sender name. - giftcard_recipient_name: - type: string - description: Gift card recipient name. - giftcard_sender_email: - type: string - description: Gift card sender email. - giftcard_recipient_email: - type: string - description: Gift card recipient email. - giftcard_message: - type: string - description: Giftcard message. - extension_attributes: - "$ref": "#/definitions/gift-card-data-gift-card-option-extension-interface" - required: - - giftcard_amount - - giftcard_sender_name - - giftcard_recipient_name - - giftcard_sender_email - - giftcard_recipient_email - gift-card-data-gift-card-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface - properties: - giftcard_created_codes: - type: array - items: - type: string - configurable-product-data-configurable-item-option-value-interface: - type: object - description: Interface ConfigurableItemOptionValueInterface - properties: - option_id: - type: string - description: Option SKU - option_value: - type: integer - description: Item id - extension_attributes: - "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-extension-interface" - required: - - option_id - configurable-product-data-configurable-item-option-value-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface - grouped-product-data-grouped-options-interface: - type: object - description: Represents `product item id with qty` of a grouped product. - properties: - id: - type: integer - description: Associated product id - qty: - type: integer - description: Associated product qty - extension_attributes: - "$ref": "#/definitions/grouped-product-data-grouped-options-extension-interface" - grouped-product-data-grouped-options-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface - quote-data-cart-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface - properties: - discounts: - type: array - items: - "$ref": "#/definitions/sales-rule-data-rule-discount-interface" - negotiable_quote_item: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-interface" - sales-rule-data-rule-discount-interface: - type: object - description: Rule discount Interface - properties: - discount_data: - "$ref": "#/definitions/sales-rule-data-discount-data-interface" - rule_label: - type: string - description: Rule Label - rule_i_d: - type: integer - description: Rule ID - required: - - discount_data - - rule_label - - rule_i_d - sales-rule-data-discount-data-interface: - type: object - description: Discount Data Interface - properties: - amount: - type: number - description: Amount - base_amount: - type: number - description: Base Amount - original_amount: - type: number - description: Original Amount - base_original_amount: - type: number - description: Base Original Amount - required: - - amount - - base_amount - - original_amount - - base_original_amount - negotiable-quote-data-negotiable-quote-item-interface: - type: object - description: Interface CompanyQuoteConfigInterface - properties: - item_id: - type: integer - description: Quote item id - original_price: - type: number - description: Quote item original price - original_tax_amount: - type: number - description: Quote item original tax amount - original_discount_amount: - type: number - description: Quote item original discount amount - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-extension-interface" - required: - - item_id - - original_price - - original_tax_amount - - original_discount_amount - negotiable-quote-data-negotiable-quote-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface - properties: - negotiated_price_type: - type: integer - negotiated_price_value: - type: number - last_item_notes: - type: array - items: - "$ref": "#/definitions/negotiable-quote-data-item-note-interface" - is_discounting_locked: - type: boolean - min_qty: - type: number - max_qty: - type: number - negotiable-quote-data-item-note-interface: - type: object - description: Interface ItemNoteInterface - properties: - note_id: - type: integer - description: Note ID. - negotiable_quote_item_id: - type: integer - description: Negotiable quote item Id - creator_type: - type: integer - description: The note creator type. - creator_id: - type: integer - description: Note creator ID. - note: - type: string - description: Note. - created_at: - type: string - description: Comment created at. - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-item-note-extension-interface" - required: - - negotiable_quote_item_id - - creator_type - - creator_id - - note - negotiable-quote-data-item-note-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\ItemNoteInterface - quote-data-address-interface: - type: object - description: Interface AddressInterface - properties: - id: - type: integer - description: Id - region: - type: string - description: Region name - region_id: - type: integer - description: Region id - region_code: - type: string - description: Region code - country_id: - type: string - description: Country id - street: - type: array - description: Street - items: - type: string - company: - type: string - description: Company - telephone: - type: string - description: Telephone number - fax: - type: string - description: Fax number - postcode: - type: string - description: Postcode - city: - type: string - description: City name - firstname: - type: string - description: First name - lastname: - type: string - description: Last name - middlename: - type: string - description: Middle name - prefix: - type: string - description: Prefix - suffix: - type: string - description: Suffix - vat_id: - type: string - description: Vat id - customer_id: - type: integer - description: Customer id - email: - type: string - description: Billing/shipping email - same_as_billing: - type: integer - description: Same as billing flag - customer_address_id: - type: integer - description: Customer address id - save_in_address_book: - type: integer - description: Save in address book flag - extension_attributes: - "$ref": "#/definitions/quote-data-address-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - region - - region_id - - region_code - - country_id - - street - - telephone - - postcode - - city - - firstname - - lastname - - email - quote-data-address-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface - properties: - discounts: - type: array - items: - "$ref": "#/definitions/sales-rule-data-rule-discount-interface" - gift_registry_id: - type: integer - pickup_location_code: - type: string - quote-data-currency-interface: - type: object - description: Interface CurrencyInterface - properties: - global_currency_code: - type: string - description: Global currency code - base_currency_code: - type: string - description: Base currency code - store_currency_code: - type: string - description: Store currency code - quote_currency_code: - type: string - description: Quote currency code - store_to_base_rate: - type: number - description: Store currency to base currency rate - store_to_quote_rate: - type: number - description: Store currency to quote currency rate - base_to_global_rate: - type: number - description: Base currency to global currency rate - base_to_quote_rate: - type: number - description: Base currency to quote currency rate - extension_attributes: - "$ref": "#/definitions/quote-data-currency-extension-interface" - quote-data-currency-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface - quote-data-cart-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface - properties: - shipping_assignments: - type: array - items: - "$ref": "#/definitions/quote-data-shipping-assignment-interface" - negotiable_quote: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-interface" - company_id: - type: integer - coupon_codes: - type: array - items: - type: string - quote-data-shipping-assignment-interface: - type: object - description: Interface ShippingAssignmentInterface - properties: - shipping: - "$ref": "#/definitions/quote-data-shipping-interface" - items: - type: array - items: - "$ref": "#/definitions/quote-data-cart-item-interface" - extension_attributes: - "$ref": "#/definitions/quote-data-shipping-assignment-extension-interface" - required: - - shipping - - items - quote-data-shipping-interface: - type: object - description: Interface ShippingInterface - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - method: - type: string - description: Shipping method - extension_attributes: - "$ref": "#/definitions/quote-data-shipping-extension-interface" - required: - - address - - method - quote-data-shipping-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface - quote-data-shipping-assignment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface - negotiable-quote-data-negotiable-quote-interface: - type: object - description: Interface NegotiableQuoteInterface - properties: - quote_id: - type: integer - description: Negotiable quote ID. - is_regular_quote: - type: boolean - description: Is regular quote. - status: - type: string - description: Negotiable quote status. - negotiated_price_type: - type: integer - description: Negotiated price type. - negotiated_price_value: - type: number - description: Negotiated price value. - shipping_price: - type: number - description: Proposed shipping price. - quote_name: - type: string - description: Negotiable quote name. - expiration_period: - type: string - description: Expiration period. - email_notification_status: - type: integer - description: Email notification status. - has_unconfirmed_changes: - type: boolean - description: Has unconfirmed changes. - is_shipping_tax_changed: - type: boolean - description: Shipping tax changes. - is_customer_price_changed: - type: boolean - description: Customer price changes. - notifications: - type: integer - description: Quote notifications. - applied_rule_ids: - type: string - description: Quote rules. - is_address_draft: - type: boolean - description: Is address draft. - deleted_sku: - type: string - description: Deleted products sku. - creator_id: - type: integer - description: Quote creator id. - creator_type: - type: integer - description: Quote creator type. - original_total_price: - type: number - description: Quote original total price. - base_original_total_price: - type: number - description: Quote original total price in base currency. - negotiated_total_price: - type: number - description: Quote negotiated total price. - base_negotiated_total_price: - type: number - description: Quote negotiated total price in base currency. - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-extension-interface" - required: - - quote_id - - is_regular_quote - - status - - negotiated_price_type - - negotiated_price_value - - shipping_price - - quote_name - - expiration_period - - email_notification_status - - has_unconfirmed_changes - - is_shipping_tax_changed - - is_customer_price_changed - - notifications - - applied_rule_ids - - is_address_draft - - deleted_sku - - creator_id - - creator_type - negotiable-quote-data-negotiable-quote-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface - quote-data-payment-interface: - type: object - description: Interface PaymentInterface - properties: - po_number: - type: string - description: Purchase order number - method: - type: string - description: Payment method code - additional_data: - type: array - description: Payment additional details - items: - type: string - extension_attributes: - "$ref": "#/definitions/quote-data-payment-extension-interface" - required: - - method - quote-data-payment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface - properties: - agreement_ids: - type: array - items: - type: string - quote-data-shipping-method-interface: - type: object - description: Interface ShippingMethodInterface - properties: - carrier_code: - type: string - description: Shipping carrier code. - method_code: - type: string - description: Shipping method code. - carrier_title: - type: string - description: Shipping carrier title. Otherwise, null. - method_title: - type: string - description: Shipping method title. Otherwise, null. - amount: - type: number - description: Shipping amount in store currency. - base_amount: - type: number - description: Shipping amount in base currency. - available: - type: boolean - description: The value of the availability flag for the current shipping method. - extension_attributes: - "$ref": "#/definitions/quote-data-shipping-method-extension-interface" - error_message: - type: string - description: Shipping Error message. - price_excl_tax: - type: number - description: Shipping price excl tax. - price_incl_tax: - type: number - description: Shipping price incl tax. - required: - - carrier_code - - method_code - - amount - - base_amount - - available - - error_message - - price_excl_tax - - price_incl_tax - quote-data-shipping-method-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface - quote-data-payment-method-interface: - type: object - description: Interface PaymentMethodInterface - properties: - code: - type: string - description: Payment method code - title: - type: string - description: Payment method title - required: - - code - - title - quote-data-totals-additional-data-interface: - type: object - description: Additional data for totals collection. - properties: - extension_attributes: - "$ref": "#/definitions/quote-data-totals-additional-data-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - quote-data-totals-additional-data-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface - properties: - gift_messages: - type: array - items: - "$ref": "#/definitions/gift-message-data-message-interface" - gift-message-data-message-interface: - type: object - description: Interface MessageInterface - properties: - gift_message_id: - type: integer - description: Gift message ID. Otherwise, null. - customer_id: - type: integer - description: Customer ID. Otherwise, null. - sender: - type: string - description: Sender name. - recipient: - type: string - description: Recipient name. - message: - type: string - description: Message text. - extension_attributes: - "$ref": "#/definitions/gift-message-data-message-extension-interface" - required: - - sender - - recipient - - message - gift-message-data-message-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface - properties: - entity_id: - type: string - entity_type: - type: string - wrapping_id: - type: integer - wrapping_allow_gift_receipt: - type: boolean - wrapping_add_printed_card: - type: boolean - quote-data-totals-interface: - type: object - description: Interface TotalsInterface - properties: - grand_total: - type: number - description: Grand total in quote currency - base_grand_total: - type: number - description: Grand total in base currency - subtotal: - type: number - description: Subtotal in quote currency - base_subtotal: - type: number - description: Subtotal in base currency - discount_amount: - type: number - description: Discount amount in quote currency - base_discount_amount: - type: number - description: Discount amount in base currency - subtotal_with_discount: - type: number - description: Subtotal in quote currency with applied discount - base_subtotal_with_discount: - type: number - description: Subtotal in base currency with applied discount - shipping_amount: - type: number - description: Shipping amount in quote currency - base_shipping_amount: - type: number - description: Shipping amount in base currency - shipping_discount_amount: - type: number - description: Shipping discount amount in quote currency - base_shipping_discount_amount: - type: number - description: Shipping discount amount in base currency - tax_amount: - type: number - description: Tax amount in quote currency - base_tax_amount: - type: number - description: Tax amount in base currency - weee_tax_applied_amount: - type: number - description: Item weee tax applied amount in quote currency. - shipping_tax_amount: - type: number - description: Shipping tax amount in quote currency - base_shipping_tax_amount: - type: number - description: Shipping tax amount in base currency - subtotal_incl_tax: - type: number - description: Subtotal including tax in quote currency - base_subtotal_incl_tax: - type: number - description: Subtotal including tax in base currency - shipping_incl_tax: - type: number - description: Shipping including tax in quote currency - base_shipping_incl_tax: - type: number - description: Shipping including tax in base currency - base_currency_code: - type: string - description: Base currency code - quote_currency_code: - type: string - description: Quote currency code - coupon_code: - type: string - description: Applied coupon code - items_qty: - type: integer - description: Items qty - items: - type: array - description: Totals by items - items: - "$ref": "#/definitions/quote-data-totals-item-interface" - total_segments: - type: array - description: Dynamically calculated totals - items: - "$ref": "#/definitions/quote-data-total-segment-interface" - extension_attributes: - "$ref": "#/definitions/quote-data-totals-extension-interface" - required: - - weee_tax_applied_amount - - total_segments - quote-data-totals-item-interface: - type: object - description: Interface TotalsItemInterface - properties: - item_id: - type: integer - description: Item id - price: - type: number - description: Item price in quote currency. - base_price: - type: number - description: Item price in base currency. - qty: - type: number - description: Item quantity. - row_total: - type: number - description: Row total in quote currency. - base_row_total: - type: number - description: Row total in base currency. - row_total_with_discount: - type: number - description: Row total with discount in quote currency. Otherwise, null. - tax_amount: - type: number - description: Tax amount in quote currency. Otherwise, null. - base_tax_amount: - type: number - description: Tax amount in base currency. Otherwise, null. - tax_percent: - type: number - description: Tax percent. Otherwise, null. - discount_amount: - type: number - description: Discount amount in quote currency. Otherwise, null. - base_discount_amount: - type: number - description: Discount amount in base currency. Otherwise, null. - discount_percent: - type: number - description: Discount percent. Otherwise, null. - price_incl_tax: - type: number - description: Price including tax in quote currency. Otherwise, null. - base_price_incl_tax: - type: number - description: Price including tax in base currency. Otherwise, null. - row_total_incl_tax: - type: number - description: Row total including tax in quote currency. Otherwise, null. - base_row_total_incl_tax: - type: number - description: Row total including tax in base currency. Otherwise, null. - options: - type: string - description: Item price in quote currency. - weee_tax_applied_amount: - type: number - description: Item weee tax applied amount in quote currency. - weee_tax_applied: - type: string - description: Item weee tax applied in quote currency. - extension_attributes: - "$ref": "#/definitions/quote-data-totals-item-extension-interface" - name: - type: string - description: Product name. Otherwise, null. - required: - - item_id - - price - - base_price - - qty - - row_total - - base_row_total - - options - - weee_tax_applied_amount - - weee_tax_applied - quote-data-totals-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface - properties: - negotiable_quote_item_totals: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface" - negotiable-quote-data-negotiable-quote-item-totals-interface: - type: object - description: Extension attribute for quote item totals model. - properties: - cost: - type: number - description: Cost for quote item. - catalog_price: - type: number - description: Catalog price for quote item. - base_catalog_price: - type: number - description: Catalog price for quote item in base currency. - catalog_price_incl_tax: - type: number - description: Catalog price with included tax for quote item. - base_catalog_price_incl_tax: - type: number - description: Catalog price with included tax for quote item in base currency. - cart_price: - type: number - description: Cart price for quote item. - base_cart_price: - type: number - description: Cart price for quote item in base currency. - cart_tax: - type: number - description: Tax from catalog price for quote item. - base_cart_tax: - type: number - description: Tax from catalog price for quote item in base currency. - cart_price_incl_tax: - type: number - description: Cart price with included tax for quote item. - base_cart_price_incl_tax: - type: number - description: Cart price with included tax for quote item in base currency. - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface" - required: - - cost - - catalog_price - - base_catalog_price - - catalog_price_incl_tax - - base_catalog_price_incl_tax - - cart_price - - base_cart_price - - cart_tax - - base_cart_tax - - cart_price_incl_tax - - base_cart_price_incl_tax - negotiable-quote-data-negotiable-quote-item-totals-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface - quote-data-total-segment-interface: - type: object - description: Interface TotalsInterface - properties: - code: - type: string - description: Code - title: - type: string - description: Total title - value: - type: number - description: Total value - area: - type: string - description: Display area code. - extension_attributes: - "$ref": "#/definitions/quote-data-total-segment-extension-interface" - required: - - code - - value - quote-data-total-segment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface - properties: - tax_grandtotal_details: - type: array - items: - "$ref": "#/definitions/tax-data-grand-total-details-interface" - gift_cards: - type: string - gw_order_id: - type: string - gw_item_ids: - type: array - items: - type: string - gw_allow_gift_receipt: - type: string - gw_add_card: - type: string - gw_price: - type: string - gw_base_price: - type: string - gw_items_price: - type: string - gw_items_base_price: - type: string - gw_card_price: - type: string - gw_card_base_price: - type: string - gw_base_tax_amount: - type: string - gw_tax_amount: - type: string - gw_items_base_tax_amount: - type: string - gw_items_tax_amount: - type: string - gw_card_base_tax_amount: - type: string - gw_card_tax_amount: - type: string - gw_price_incl_tax: - type: string - gw_base_price_incl_tax: - type: string - gw_card_price_incl_tax: - type: string - gw_card_base_price_incl_tax: - type: string - gw_items_price_incl_tax: - type: string - gw_items_base_price_incl_tax: - type: string - tax-data-grand-total-details-interface: - type: object - description: Interface GrandTotalDetailsInterface - properties: - amount: - type: number - description: Tax amount value - rates: - type: array - description: Tax rates info - items: - "$ref": "#/definitions/tax-data-grand-total-rates-interface" - group_id: - type: integer - description: Group identifier - required: - - amount - - rates - - group_id - tax-data-grand-total-rates-interface: - type: object - description: Interface GrandTotalRatesInterface - properties: - percent: - type: string - description: Tax percentage value - title: - type: string - description: Rate title - required: - - percent - - title - quote-data-totals-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface - properties: - coupon_label: - type: string - negotiable_quote_totals: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-totals-interface" - base_customer_balance_amount: - type: number - customer_balance_amount: - type: number - coupon_codes: - type: array - items: - type: string - coupons_labels: - type: array - items: - type: string - reward_points_balance: - type: number - reward_currency_amount: - type: number - base_reward_currency_amount: - type: number - negotiable-quote-data-negotiable-quote-totals-interface: - type: object - description: Extension attribute for quote totals model. - properties: - items_count: - type: integer - description: The number of different items or products in the cart. - quote_status: - type: string - description: Negotiable quote status. - created_at: - type: string - description: The cart creation date and time. - updated_at: - type: string - description: The cart last update date and time. - customer_group: - type: integer - description: Customer group id. - base_to_quote_rate: - type: number - description: Base currency to quote currency rate. - cost_total: - type: number - description: Total cost for quote. - base_cost_total: - type: number - description: Total cost for quote in base currency. - original_total: - type: number - description: Original quote total. - base_original_total: - type: number - description: Original quote total in base currency. - original_tax: - type: number - description: Original tax amount for quote. - base_original_tax: - type: number - description: Original tax amount for quote in base currency. - original_price_incl_tax: - type: number - description: Original price with included tax for quote. - base_original_price_incl_tax: - type: number - description: Original price with included tax for quote in base currency. - negotiated_price_type: - type: integer - description: Negotiable quote type. - negotiated_price_value: - type: number - description: Negotiable price value for quote. - required: - - items_count - - quote_status - - created_at - - updated_at - - customer_group - - base_to_quote_rate - - cost_total - - base_cost_total - - original_total - - base_original_total - - original_tax - - base_original_tax - - original_price_incl_tax - - base_original_price_incl_tax - - negotiated_price_type - - negotiated_price_value - framework-search-search-result-interface: - type: object - description: Interface SearchResultInterface - properties: - items: - type: array - items: - "$ref": "#/definitions/framework-search-document-interface" - aggregations: - "$ref": "#/definitions/framework-search-aggregation-interface" - search_criteria: - "$ref": "#/definitions/framework-search-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - aggregations - - search_criteria - - total_count - framework-search-document-interface: - type: object - description: Interface Search Document - properties: - id: - type: integer - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - id - framework-search-aggregation-interface: - type: object - description: Interface Aggregation to get faceted data - properties: - buckets: - type: array - description: All Document fields - items: - "$ref": "#/definitions/framework-search-bucket-interface" - bucket_names: - type: array - description: Document field names - items: - type: string - required: - - buckets - - bucket_names - framework-search-bucket-interface: - type: object - description: Interface for facet Bucket - properties: - name: - type: string - description: Field name - values: - type: array - description: Field values - items: - "$ref": "#/definitions/framework-search-aggregation-value-interface" - required: - - name - - values - framework-search-aggregation-value-interface: - type: object - description: Interface Aggregation Value - properties: - value: - type: string - description: Aggregation - metrics: - type: array - description: Metrics - items: - type: string - required: - - value - - metrics - framework-search-search-criteria-interface: - type: object - description: Interface SearchCriteriaInterface - properties: - request_name: - type: string - filter_groups: - type: array - description: A list of filter groups. - items: - "$ref": "#/definitions/framework-search-filter-group" - sort_orders: - type: array - description: Sort order. - items: - "$ref": "#/definitions/framework-sort-order" - page_size: - type: integer - description: Page size. - current_page: - type: integer - description: Current page. - required: - - request_name - - filter_groups - framework-search-filter-group: - type: object - description: Groups two or more filters together using a logical OR - properties: - filters: - type: array - description: A list of filters in this group - items: - "$ref": "#/definitions/framework-filter" - framework-filter: - type: object - description: Filter which can be used by any methods from service layer. - properties: - field: - type: string - description: Field - value: - type: string - description: Value - condition_type: - type: string - description: Condition type - required: - - field - - value - framework-sort-order: - type: object - description: Data object for sort order. - properties: - field: - type: string - description: Sorting field. - direction: - type: string - description: Sorting direction. - required: - - field - - direction - requisition-list-data-requisition-list-interface: - type: object - description: Interface RequisitionListInterface - properties: - id: - type: integer - description: Requisition List ID - customer_id: - type: integer - description: Customer ID - name: - type: string - description: Requisition List Name - updated_at: - type: string - description: Requisition List Update Time - description: - type: string - description: Requisition List Description - items: - type: array - description: Requisition List Items - items: - "$ref": "#/definitions/requisition-list-data-requisition-list-item-interface" - extension_attributes: - "$ref": "#/definitions/requisition-list-data-requisition-list-extension-interface" - required: - - id - - customer_id - - name - - updated_at - - description - - items - requisition-list-data-requisition-list-item-interface: - type: object - description: Interface RequisitionListItemInterface - properties: - id: - type: integer - description: Requisition List ID. - sku: - type: string - description: Product SKU. - requisition_list_id: - type: integer - description: Requisition List ID. - qty: - type: number - description: Product Qty. - options: - type: array - description: Requisition list item options. - items: - type: string - store_id: - type: integer - description: Store ID. - added_at: - type: string - description: Added_at value. - extension_attributes: - "$ref": "#/definitions/requisition-list-data-requisition-list-item-extension-interface" - required: - - id - - sku - - requisition_list_id - - qty - - options - - store_id - - added_at - requisition-list-data-requisition-list-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListItemInterface - requisition-list-data-requisition-list-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListInterface - checkout-data-shipping-information-interface: - type: object - description: Interface ShippingInformationInterface - properties: - shipping_address: - "$ref": "#/definitions/quote-data-address-interface" - billing_address: - "$ref": "#/definitions/quote-data-address-interface" - shipping_method_code: - type: string - description: Shipping method code - shipping_carrier_code: - type: string - description: Carrier code - extension_attributes: - "$ref": "#/definitions/checkout-data-shipping-information-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - shipping_address - - shipping_method_code - - shipping_carrier_code - checkout-data-shipping-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface - checkout-data-payment-details-interface: - type: object - description: Interface PaymentDetailsInterface - properties: - payment_methods: - type: array - items: - "$ref": "#/definitions/quote-data-payment-method-interface" - totals: - "$ref": "#/definitions/quote-data-totals-interface" - extension_attributes: - "$ref": "#/definitions/checkout-data-payment-details-extension-interface" - required: - - payment_methods - - totals - checkout-data-payment-details-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface - checkout-data-totals-information-interface: - type: object - description: Interface TotalsInformationInterface - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - shipping_method_code: - type: string - description: Shipping method code - shipping_carrier_code: - type: string - description: Carrier code - extension_attributes: - "$ref": "#/definitions/checkout-data-totals-information-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - address - checkout-data-totals-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface - gift-card-account-data-gift-card-account-interface: - type: object - description: Gift Card Account data - properties: - gift_cards: - type: array - description: Cards codes. - items: - type: string - gift_cards_amount: - type: number - description: Cards amount in quote currency. - base_gift_cards_amount: - type: number - description: Cards amount in base currency. - gift_cards_amount_used: - type: number - description: Cards amount used in quote currency. - base_gift_cards_amount_used: - type: number - description: Cards amount used in base currency. - extension_attributes: - "$ref": "#/definitions/gift-card-account-data-gift-card-account-extension-interface" - required: - - gift_cards_amount - - base_gift_cards_amount - - gift_cards_amount_used - - base_gift_cards_amount_used - gift-card-account-data-gift-card-account-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface - negotiable-quote-data-attachment-content-interface: - type: object - description: Attachment files content interface. - properties: - base64_encoded_data: - type: string - description: Media data (base64 encoded content). - type: - type: string - description: MIME type. - name: - type: string - description: File name. - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-attachment-content-extension-interface" - required: - - base64_encoded_data - - type - - name - negotiable-quote-data-attachment-content-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\AttachmentContentInterface - two-factor-auth-provider-interface: - type: object - description: 2FA provider interface - properties: - enabled: - type: boolean - description: True if this provider has been enabled by admin - engine: - "$ref": "#/definitions/two-factor-auth-engine-interface" - code: - type: string - description: Provider code - name: - type: string - description: Provider name - icon: - type: string - description: Icon - reset_allowed: - type: boolean - description: True if this provider configuration can be reset - configure_action: - type: string - description: Configure action - auth_action: - type: string - description: Auth action - extra_actions: - type: array - description: Allowed extra actions - items: - type: string - required: - - enabled - - engine - - code - - name - - icon - - reset_allowed - - configure_action - - auth_action - - extra_actions - two-factor-auth-engine-interface: - type: object - description: 2FA engine interface - properties: - enabled: - type: boolean - description: True if this provider has been enabled by admin - required: - - enabled - two-factor-auth-data-google-configure-interface: - type: object - description: Google configuration data interface - properties: - qr_code_base64: - type: string - description: Value for QR code base 64 - secret_code: - type: string - description: Value for secret code - extension_attributes: - "$ref": "#/definitions/two-factor-auth-data-google-configure-extension-interface" - required: - - qr_code_base64 - - secret_code - two-factor-auth-data-google-configure-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface - two-factor-auth-data-authy-device-interface: - type: object - description: Authy device data interface - properties: - country: - type: string - description: The country - phone_number: - type: string - description: The phone number - method: - type: string - description: The method to authenticate with - extension_attributes: - "$ref": "#/definitions/two-factor-auth-data-authy-device-extension-interface" - required: - - country - - phone_number - - method - two-factor-auth-data-authy-device-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyDeviceInterface - two-factor-auth-data-authy-registration-prompt-response-interface: - type: object - description: Response for device registration prompt - properties: - message: - type: string - description: The message - expiration_seconds: - type: string - description: The seconds to expire - extension_attributes: - "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-extension-interface" - required: - - message - - expiration_seconds - two-factor-auth-data-authy-registration-prompt-response-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface - two-factor-auth-data-u2f-web-authn-request-interface: - type: object - description: Represents a WebAuthn dataset - properties: - credential_request_options_json: - type: string - description: The needed data to initiate a WebAuthn registration ceremony - extension_attributes: - "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-extension-interface" - required: - - credential_request_options_json - two-factor-auth-data-u2f-web-authn-request-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestInterface - inventory-in-store-pickup-api-data-search-result-interface: - type: object - description: Search results for providing pickup locations. - properties: - items: - type: array - description: Items list. - items: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-interface" - search_request: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_request - - total_count - inventory-in-store-pickup-api-data-pickup-location-interface: - type: object - description: Represents sources projection on In-Store Pickup context. Realisation - must follow immutable DTO concept. Partial immutability done according to restriction - of current Extension Attributes implementation. - properties: - pickup_location_code: - type: string - description: Source code of Pickup Location. - name: - type: string - description: Pickup Location name. - email: - type: string - description: Pickup Location contact email. - fax: - type: string - description: Fax contact info. - contact_name: - type: string - description: Pickup Location contact name. - description: - type: string - description: Pickup Location description. - latitude: - type: number - description: Pickup Location latitude. - longitude: - type: number - description: Pickup Location longitude. - country_id: - type: string - description: Pickup Location country ID. - region_id: - type: integer - description: Pickup Location region ID. - region: - type: string - description: Pickup Location region. - city: - type: string - description: Pickup Location city. - street: - type: string - description: Pickup Location street. - postcode: - type: string - description: Pickup Location postcode. - phone: - type: string - description: Pickup Location phone. - extension_attributes: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-extension-interface" - required: - - pickup_location_code - inventory-in-store-pickup-api-data-pickup-location-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface - inventory-in-store-pickup-api-data-search-request-interface: - type: object - description: 'Endpoint used to search Pickup Locations by different parameters: - - by attribute filters fields @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\FiltersInterface - - by distance to the address @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\AreaInterface - Also, endpoint supports paging and sort orders.' - properties: - area: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-area-interface" - filters: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filters-interface" - page_size: - type: integer - description: Page size. - current_page: - type: integer - description: Current page. - scope_type: - type: string - description: Sales Channel Type. - scope_code: - type: string - description: Sales Channel code. - sort: - type: array - description: Sort Order. - items: - "$ref": "#/definitions/framework-sort-order" - extension_attributes: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-extension-interface" - required: - - current_page - - scope_type - - scope_code - inventory-in-store-pickup-api-data-search-request-area-interface: - type: object - description: 'Filter by Distance to the Address. Pickup Locations will be filtered - by distance according to the geo-position of the entered address. Required fields - for the address are country and one of the field: region or city or postcode.' - properties: - radius: - type: integer - description: Search radius in KM. - search_term: - type: string - description: Search term string. - required: - - radius - - search_term - inventory-in-store-pickup-api-data-search-request-filters-interface: - type: object - description: Filter to filter by Fields. Each field may be filtered with different - condition type. Supported condition types restricted by @see \Magento\Framework\Api\SearchCriteriaInterface - properties: - country: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - postcode: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - region: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - region_id: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - city: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - street: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - name: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - pickup_location_code: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - inventory-in-store-pickup-api-data-search-request-filter-interface: - type: object - description: Filter for Pickup Location search. - properties: - value: - type: string - description: Value. - condition_type: - type: string - description: Condition Type. - required: - - value - - condition_type - inventory-in-store-pickup-api-data-search-request-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequestInterface - properties: - products_info: - type: array - items: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-interface" - inventory-in-store-pickup-api-data-search-request-product-info-interface: - type: object - description: Product Info Data Transfer Object. - properties: - sku: - type: string - description: Product SKU. - extension_attributes: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-extension-interface" - required: - - sku - inventory-in-store-pickup-api-data-search-request-product-info-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\ProductInfoInterface - payment-services-paypal-payment-config-response-interface: - type: object - description: '' - properties: - apple_pay: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface" - google_pay: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface" - hosted_fields: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface" - smart_buttons: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface" - required: - - apple_pay - - google_pay - - hosted_fields - - smart_buttons - payment-services-paypal-data-payment-config-apple-pay-interface: - type: object - description: '' - properties: - button_styles: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface" - payment_source: - type: string - description: PaymentSource - code: - type: string - description: Code - sdk_params: - type: array - description: SDK params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - is_visible: - type: boolean - description: Visible - sort_order: - type: string - description: Sort Order - payment_intent: - type: string - description: Payment intent - title: - type: string - description: Title - required: - - button_styles - - payment_source - - code - - sdk_params - - is_visible - - sort_order - - payment_intent - - title - payment-services-paypal-data-payment-config-button-styles-interface: - type: object - description: '' - properties: - layout: - type: string - description: Layout - color: - type: string - description: Color - shape: - type: string - description: Shape - label: - type: string - description: Label - tagline: - type: boolean - description: ShowTagline - height: - type: integer - description: Height - use_default_height: - type: boolean - description: Height - required: - - layout - - color - - shape - - label - - tagline - - height - - use_default_height - payment-services-paypal-data-payment-config-sdk-params-interface: - type: object - description: '' - properties: - name: - type: string - description: Code - value: - type: string - description: Config - required: - - name - - value - payment-services-paypal-data-payment-config-google-pay-interface: - type: object - description: '' - properties: - button_styles: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-button-styles-interface" - payment_source: - type: string - description: PaymentSource - three_d_s: - type: string - description: ThreeDS - code: - type: string - description: Code - sdk_params: - type: array - description: SDK params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - is_visible: - type: boolean - description: Visible - sort_order: - type: string - description: Sort Order - payment_intent: - type: string - description: Payment intent - title: - type: string - description: Title - required: - - button_styles - - payment_source - - three_d_s - - code - - sdk_params - - is_visible - - sort_order - - payment_intent - - title - payment-services-paypal-data-payment-config-google-pay-button-styles-interface: - type: object - description: '' - properties: - color: - type: string - description: Color - height: - type: integer - description: Height - type: - type: string - description: Type - required: - - color - - height - - type - payment-services-paypal-data-payment-config-hosted-fields-interface: - type: object - description: '' - properties: - payment_source: - type: string - description: Payment Source - three_d_s: - type: string - description: ThreeDS - is_vault_enabled: - type: boolean - description: HasIsVaultEnabled - cc_vault_code: - type: string - description: CcVaultCode - requires_card_details: - type: boolean - description: RequiresCardDetails - code: - type: string - description: Code - sdk_params: - type: array - description: SDK params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - is_visible: - type: boolean - description: Visible - sort_order: - type: string - description: Sort Order - payment_intent: - type: string - description: Payment intent - title: - type: string - description: Title - required: - - payment_source - - three_d_s - - is_vault_enabled - - cc_vault_code - - requires_card_details - - code - - sdk_params - - is_visible - - sort_order - - payment_intent - - title - payment-services-paypal-data-payment-config-smart-buttons-interface: - type: object - description: '' - properties: - display_message: - type: boolean - description: CanDisplayMessage - display_venmo: - type: boolean - description: Venmo - message_styles: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface" - button_styles: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface" - app_switch_when_available: - type: boolean - description: AppSwitchWhenAvailable - code: - type: string - description: Code - sdk_params: - type: array - description: SDK params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - is_visible: - type: boolean - description: Visible - sort_order: - type: string - description: Sort Order - payment_intent: - type: string - description: Payment intent - title: - type: string - description: Title - required: - - display_message - - display_venmo - - message_styles - - button_styles - - app_switch_when_available - - code - - sdk_params - - is_visible - - sort_order - - payment_intent - - title - payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface: - type: object - description: '' - properties: - layout: - type: string - description: CanDisplayMessage - logo: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-logo-interface" - required: - - layout - - logo - payment-services-paypal-data-payment-config-smart-buttons-logo-interface: - type: object - description: '' - properties: - type: - type: string - description: CanDisplayMessage - required: - - type - payment-services-paypal-data-payment-order-interface: - type: object - description: Interface PaymentOrderInterface - properties: - id: - type: string - description: Payment order id - mp_order_id: - type: string - description: Payment order mpOrderId - status: - type: string - description: Payment order status - amount: - type: number - description: Payment order amount - currency_code: - type: string - description: Payment order currency code - required: - - id - - mp_order_id - - status - - amount - - currency_code - payment-services-paypal-data-payment-order-details-interface: - type: object - description: Interface PaymentOrderDetailsInterface - properties: - payment_source_details: - "$ref": "#/definitions/payment-services-paypal-data-payment-source-details-interface" - id: - type: string - description: Payment order id - mp_order_id: - type: string - description: Payment order mpOrderId - status: - type: string - description: Payment order status - amount: - type: number - description: Payment order amount - currency_code: - type: string - description: Payment order currency code - required: - - payment_source_details - - id - - mp_order_id - - status - - amount - - currency_code - payment-services-paypal-data-payment-source-details-interface: - type: object - description: '' - properties: - card: - "$ref": "#/definitions/payment-services-paypal-data-payment-card-details-interface" - required: - - card - payment-services-paypal-data-payment-card-details-interface: - type: object - description: '' - properties: - name: - type: string - description: Name - last_digits: - type: string - description: Last digits - card_expiry_month: - type: string - description: Card expiry month - card_expiry_year: - type: string - description: Card expiry year - bin_details: - "$ref": "#/definitions/payment-services-paypal-data-payment-card-bin-details-interface" - required: - - name - - last_digits - - card_expiry_month - - card_expiry_year - - bin_details - payment-services-paypal-data-payment-card-bin-details-interface: - type: object - description: '' - properties: - bin: - type: string - description: Bin - required: - - bin - payment-services-paypal-data-payment-sdk-params-interface: - type: object - description: '' - properties: - code: - type: string - description: The payments sdk code - params: - type: array - description: The payments sdk params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - required: - - code - - params - pay-pal-braintree-data-auth-data-interface: - type: object - description: Interface AuthDataInterface - properties: - client_token: - type: string - description: Client token - display_name: - type: string - description: Display name - action_success: - type: string - description: To success page - logged_in: - type: boolean - description: Logged in - store_code: - type: string - description: Current store code - required: - - display_name - - action_success - - logged_in - - store_code - pay-pal-braintree-data-payment-interface: - type: object - description: '' - properties: - payment_method_code: - type: string - description: The payment method code. - payment_method_nonce: - type: string - description: The payment method nonce. - device_data: - type: string - description: The device data. -x-tagGroups: -- name: applepay - tags: - - applepay/auth -- name: braintree - tags: - - braintree/mine/payment/vault -- name: carts - tags: - - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} - - carts/guest-carts/{cartId}/giftCards - - carts/guest-carts/{cartId}/giftCards/{giftCardCode} - - carts/mine - - carts/mine/balance/apply - - carts/mine/checkGiftCard/{giftCardCode} - - carts/mine/collect-totals - - carts/mine/payment-information - - carts/mine/payment-order - - carts/mine/payment-order/{id} - - carts/mine/po-payment-information - - carts/mine/set-payment-information -- name: customers - tags: - - customers - - customers/isEmailAvailable - - customers/me/activate - - customers/me/password - - customers/password - - customers/resetPassword - - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} -- name: directory - tags: - - directory/countries - - directory/countries/{countryId} - - directory/currency -- name: giftregistry - tags: - - giftregistry/mine/estimate-shipping-methods -- name: guest carts - tags: - - guest-carts - - guest-carts/{cartId} - - guest-carts/{cartId}/billing-address - - guest-carts/{cartId}/collect-totals - - guest-carts/{cartId}/coupons - - guest-carts/{cartId}/coupons/{couponCode} - - guest-carts/{cartId}/estimate-shipping-methods - - guest-carts/{cartId}/gift-message - - guest-carts/{cartId}/gift-message/{itemId} - - guest-carts/{cartId}/items - - guest-carts/{cartId}/items/{itemId} - - guest-carts/{cartId}/order - - guest-carts/{cartId}/payment-information - - guest-carts/{cartId}/payment-methods - - guest-carts/{cartId}/payment-order - - guest-carts/{cartId}/payment-order/{id} - - guest-carts/{cartId}/selected-payment-method - - guest-carts/{cartId}/set-payment-information - - guest-carts/{cartId}/shipping-information - - guest-carts/{cartId}/shipping-methods - - guest-carts/{cartId}/totals - - guest-carts/{cartId}/totals-information -- name: guest giftregistry - tags: - - guest-giftregistry/{cartId}/estimate-shipping-methods -- name: integration - tags: - - integration/admin/token - - integration/customer/revoke-customer-token - - integration/customer/token -- name: inventory - tags: - - inventory/in-store-pickup/pickup-locations/ -- name: negotiable carts - tags: - - negotiable-carts/{cartId}/billing-address - - negotiable-carts/{cartId}/coupons - - negotiable-carts/{cartId}/coupons/{couponCode} - - negotiable-carts/{cartId}/estimate-shipping-methods - - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id - - negotiable-carts/{cartId}/giftCards - - negotiable-carts/{cartId}/giftCards/{giftCardCode} - - negotiable-carts/{cartId}/payment-information - - negotiable-carts/{cartId}/po-payment-information - - negotiable-carts/{cartId}/set-payment-information - - negotiable-carts/{cartId}/shipping-information - - negotiable-carts/{cartId}/totals -- name: negotiableQuoteTemplate - tags: - - negotiableQuoteTemplate/accept - - negotiableQuoteTemplate/generateQuote - - negotiableQuoteTemplate/submitToSeller -- name: payment order - tags: - - payment-order/completeOrder -- name: payments config - tags: - - payments-config/apple-pay/{location} - - payments-config/google-pay/{location} - - payments-config/hosted-fields/{location} - - payments-config/smart-buttons/{location} - - payments-config/{location} -- name: payments sdk - tags: - - payments-sdk/{location} - - payments-sdk/{location}/{methodCode} -- name: paypal - tags: - - paypal/lineItems - - paypal/oneClick - - paypal/validatePhoneNumber -- name: products render info - tags: - - products-render-info -- name: purchase order carts - tags: - - purchase-order-carts/{cartId}/payment-information - - purchase-order-carts/{cartId}/set-payment-information -- name: requisition_lists - tags: - - requisition_lists -- name: reward - tags: - - reward/mine/use-reward -- name: search - tags: - - search -- name: tfa - tags: - - tfa/provider/authy/activate - - tfa/provider/authy/authenticate - - tfa/provider/authy/authenticate-onetouch - - tfa/provider/authy/configure - - tfa/provider/authy/send-token/{via} - - tfa/provider/duo_security/activate - - tfa/provider/duo_security/authenticate - - tfa/provider/duo_security/configure - - tfa/provider/google/activate - - tfa/provider/google/authenticate - - tfa/provider/google/configure - - tfa/provider/u2fkey/activate - - tfa/provider/u2fkey/authentication-challenge - - tfa/provider/u2fkey/configure - - tfa/provider/u2fkey/verify - - tfa/tfat-providers-to-activate - - tfa/tfat-user-providers diff --git a/src/openapi/guest-schema-2.4.9-beta-1.yaml b/src/openapi/guest-schema-2.4.9-beta-1.yaml deleted file mode 100644 index dc1df7e0b..000000000 --- a/src/openapi/guest-schema-2.4.9-beta-1.yaml +++ /dev/null @@ -1,6073 +0,0 @@ ---- -securityDefinitions: - api_key: - type: apiKey - name: api_key - in: header -swagger: '2.0' -info: - version: 2.4.9-beta-1 - title: Commerce Guest REST endpoints - All inclusive - description: - "$ref": "../_includes/redocly-intro.md" -host: example.com -basePath: "/rest/default" -schemes: -- http -tags: -- name: applepay/auth -- name: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} -- name: carts/guest-carts/{cartId}/giftCards -- name: carts/guest-carts/{cartId}/giftCards/{giftCardCode} -- name: customers -- name: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} -- name: customers/isEmailAvailable -- name: customers/password -- name: customers/resetPassword -- name: directory/countries -- name: directory/countries/{countryId} -- name: directory/currency -- name: guest-carts -- name: guest-carts/{cartId} -- name: guest-carts/{cartId}/billing-address -- name: guest-carts/{cartId}/collect-totals -- name: guest-carts/{cartId}/coupons -- name: guest-carts/{cartId}/coupons/{couponCode} -- name: guest-carts/{cartId}/estimate-shipping-methods -- name: guest-carts/{cartId}/gift-message -- name: guest-carts/{cartId}/gift-message/{itemId} -- name: guest-carts/{cartId}/items -- name: guest-carts/{cartId}/items/{itemId} -- name: guest-carts/{cartId}/order -- name: guest-carts/{cartId}/payment-information -- name: guest-carts/{cartId}/payment-methods -- name: guest-carts/{cartId}/payment-order -- name: guest-carts/{cartId}/payment-order/{id} -- name: guest-carts/{cartId}/selected-payment-method -- name: guest-carts/{cartId}/set-payment-information -- name: guest-carts/{cartId}/shipping-information -- name: guest-carts/{cartId}/shipping-methods -- name: guest-carts/{cartId}/totals -- name: guest-carts/{cartId}/totals-information -- name: guest-giftregistry/{cartId}/estimate-shipping-methods -- name: integration/admin/token -- name: integration/customer/token -- name: inventory/in-store-pickup/pickup-locations/ -- name: payment-order/completeOrder -- name: payments-config/{location} -- name: payments-config/apple-pay/{location} -- name: payments-config/google-pay/{location} -- name: payments-config/hosted-fields/{location} -- name: payments-config/smart-buttons/{location} -- name: payments-sdk/{location} -- name: payments-sdk/{location}/{methodCode} -- name: paypal/lineItems -- name: paypal/oneClick -- name: paypal/validatePhoneNumber -- name: products-render-info -- name: search -- name: tfa/provider/authy/activate -- name: tfa/provider/authy/authenticate -- name: tfa/provider/authy/authenticate-onetouch -- name: tfa/provider/authy/configure -- name: tfa/provider/authy/send-token/{via} -- name: tfa/provider/duo_security/activate -- name: tfa/provider/duo_security/authenticate -- name: tfa/provider/duo_security/configure -- name: tfa/provider/google/activate -- name: tfa/provider/google/authenticate -- name: tfa/provider/google/configure -- name: tfa/provider/u2fkey/activate -- name: tfa/provider/u2fkey/authentication-challenge -- name: tfa/provider/u2fkey/configure -- name: tfa/provider/u2fkey/verify -- name: tfa/tfat-providers-to-activate -- name: tfa/tfat-user-providers -paths: - "/V1/applepay/auth": - get: - tags: - - applepay/auth - description: Returns details required to be able to submit a payment with Apple - Pay - operationId: GetV1ApplepayAuth - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/pay-pal-braintree-data-auth-data-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: applepay/auth - "/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}": - get: - tags: - - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} - description: Check gift card balance if added to the cart. - operationId: GetV1CartsGuestcartsCartIdCheckGiftCardGiftCardCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: giftCardCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: number - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} - "/V1/carts/guest-carts/{cartId}/giftCards": - post: - tags: - - carts/guest-carts/{cartId}/giftCards - description: Add gift card to the cart. - operationId: PostV1CartsGuestcartsCartIdGiftCards - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1CartsGuestcartsCartIdGiftCardsBody - in: body - schema: - required: - - giftCardAccountData - properties: - giftCardAccountData: - "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/guest-carts/{cartId}/giftCards - "/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}": - delete: - tags: - - carts/guest-carts/{cartId}/giftCards/{giftCardCode} - description: Remove GiftCard Account entity. - operationId: DeleteV1CartsGuestcartsCartIdGiftCardsGiftCardCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: giftCardCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: carts/guest-carts/{cartId}/giftCards/{giftCardCode} - "/V1/customers": - post: - tags: - - customers - description: Create customer account. Perform necessary business operations - like sending email. - operationId: PostV1Customers - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CustomersBody - in: body - schema: - required: - - customer - properties: - customer: - "$ref": "#/definitions/customer-data-customer-interface" - password: - type: string - redirectUrl: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/customer-data-customer-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers - "/V1/customers/isEmailAvailable": - post: - tags: - - customers/isEmailAvailable - description: Check if given email is associated with a customer account in given - website. - operationId: PostV1CustomersIsEmailAvailable - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CustomersIsEmailAvailableBody - in: body - schema: - required: - - customerEmail - properties: - customerEmail: - type: string - websiteId: - type: integer - description: If not set, will use the current websiteId - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/isEmailAvailable - "/V1/customers/password": - put: - tags: - - customers/password - description: Send an email to the customer with a password reset link. - operationId: PutV1CustomersPassword - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PutV1CustomersPasswordBody - in: body - schema: - required: - - email - - template - properties: - email: - type: string - template: - type: string - websiteId: - type: integer - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/password - "/V1/customers/resetPassword": - post: - tags: - - customers/resetPassword - description: Reset customer password. - operationId: PostV1CustomersResetPassword - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1CustomersResetPasswordBody - in: body - schema: - required: - - email - - resetToken - - newPassword - properties: - email: - type: string - description: If empty value given then the customer will be matched - by the RP token. - resetToken: - type: string - newPassword: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: true on success - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/resetPassword - "/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}": - get: - tags: - - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} - description: Check if password reset token is valid. - operationId: GetV1CustomersCustomerIdPasswordResetLinkTokenResetPasswordLinkToken - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: customerId - in: path - type: integer - required: true - description: If null is given then a customer will be matched by the RP token. - - name: resetPasswordLinkToken - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - description: True if the token is valid - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} - "/V1/directory/countries": - get: - tags: - - directory/countries - description: Get all countries and regions information for the store. - operationId: GetV1DirectoryCountries - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/directory-data-country-information-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: directory/countries - "/V1/directory/countries/{countryId}": - get: - tags: - - directory/countries/{countryId} - description: Get country and region information for the store. - operationId: GetV1DirectoryCountriesCountryId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: countryId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/directory-data-country-information-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: directory/countries/{countryId} - "/V1/directory/currency": - get: - tags: - - directory/currency - description: Get currency information for the store. - operationId: GetV1DirectoryCurrency - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/directory-data-currency-information-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: directory/currency - "/V1/guest-carts": - post: - tags: - - guest-carts - description: Enable an customer or guest user to create an empty cart and quote - for an anonymous customer. - operationId: PostV1Guestcarts - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - type: string - description: Cart ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts - "/V1/guest-carts/{cartId}": - get: - tags: - - guest-carts/{cartId} - description: Enable a guest user to return information for a specified cart. - operationId: GetV1GuestcartsCartId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId} - "/V1/guest-carts/{cartId}/billing-address": - get: - tags: - - guest-carts/{cartId}/billing-address - description: Return the billing address for a specified quote. - operationId: GetV1GuestcartsCartIdBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-address-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/billing-address - post: - tags: - - guest-carts/{cartId}/billing-address - description: Assign a specified billing address to a specified cart. - operationId: PostV1GuestcartsCartIdBillingaddress - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PostV1GuestcartsCartIdBillingaddressBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - useForShipping: - type: boolean - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Address ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/billing-address - "/V1/guest-carts/{cartId}/collect-totals": - put: - tags: - - guest-carts/{cartId}/collect-totals - description: Set shipping/billing methods and additional data for cart and collect - totals for guest. - operationId: PutV1GuestcartsCartIdCollecttotals - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PutV1GuestcartsCartIdCollecttotalsBody - in: body - schema: - required: - - paymentMethod - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - shippingCarrierCode: - type: string - description: The carrier code. - shippingMethodCode: - type: string - description: The shipping method code. - additionalData: - "$ref": "#/definitions/quote-data-totals-additional-data-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/collect-totals - "/V1/guest-carts/{cartId}/coupons": - get: - tags: - - guest-carts/{cartId}/coupons - description: Return information for a coupon in a specified cart. - operationId: GetV1GuestcartsCartIdCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: string - description: The coupon code data. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/coupons - delete: - tags: - - guest-carts/{cartId}/coupons - description: Delete a coupon from a specified cart. - operationId: DeleteV1GuestcartsCartIdCoupons - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/coupons - "/V1/guest-carts/{cartId}/coupons/{couponCode}": - put: - tags: - - guest-carts/{cartId}/coupons/{couponCode} - description: Add a coupon by code to a specified cart. - operationId: PutV1GuestcartsCartIdCouponsCouponCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: couponCode - in: path - type: string - required: true - description: The coupon code data. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/coupons/{couponCode} - "/V1/guest-carts/{cartId}/estimate-shipping-methods": - post: - tags: - - guest-carts/{cartId}/estimate-shipping-methods - description: Estimate shipping by address and return list of available shipping - methods - operationId: PostV1GuestcartsCartIdEstimateshippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdEstimateshippingmethodsBody - in: body - schema: - required: - - address - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/estimate-shipping-methods - "/V1/guest-carts/{cartId}/gift-message": - get: - tags: - - guest-carts/{cartId}/gift-message - description: Return the gift message for a specified order. - operationId: GetV1GuestcartsCartIdGiftmessage - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The shopping cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-message-data-message-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/gift-message - post: - tags: - - guest-carts/{cartId}/gift-message - description: Set the gift message for an entire order. - operationId: PostV1GuestcartsCartIdGiftmessage - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PostV1GuestcartsCartIdGiftmessageBody - in: body - schema: - required: - - giftMessage - properties: - giftMessage: - "$ref": "#/definitions/gift-message-data-message-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/gift-message - "/V1/guest-carts/{cartId}/gift-message/{itemId}": - get: - tags: - - guest-carts/{cartId}/gift-message/{itemId} - description: Return the gift message for a specified item in a specified shopping - cart. - operationId: GetV1GuestcartsCartIdGiftmessageItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The shopping cart ID. - - name: itemId - in: path - type: integer - required: true - description: The item ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/gift-message-data-message-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/gift-message/{itemId} - post: - tags: - - guest-carts/{cartId}/gift-message/{itemId} - description: Set the gift message for a specified item in a specified shopping - cart. - operationId: PostV1GuestcartsCartIdGiftmessageItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: itemId - in: path - type: integer - required: true - description: The item ID. - - name: PostV1GuestcartsCartIdGiftmessageItemIdBody - in: body - schema: - required: - - giftMessage - properties: - giftMessage: - "$ref": "#/definitions/gift-message-data-message-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/gift-message/{itemId} - "/V1/guest-carts/{cartId}/items": - get: - tags: - - guest-carts/{cartId}/items - description: List items that are assigned to a specified cart. - operationId: GetV1GuestcartsCartIdItems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: array - description: Array of items. - items: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/items - post: - tags: - - guest-carts/{cartId}/items - description: Add/update the specified cart item. - operationId: PostV1GuestcartsCartIdItems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdItemsBody - in: body - schema: - required: - - cartItem - properties: - cartItem: - "$ref": "#/definitions/quote-data-cart-item-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/items - "/V1/guest-carts/{cartId}/items/{itemId}": - put: - tags: - - guest-carts/{cartId}/items/{itemId} - description: Add/update the specified cart item. - operationId: PutV1GuestcartsCartIdItemsItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: itemId - in: path - type: string - required: true - - name: PutV1GuestcartsCartIdItemsItemIdBody - in: body - schema: - required: - - cartItem - properties: - cartItem: - "$ref": "#/definitions/quote-data-cart-item-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-cart-item-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/items/{itemId} - delete: - tags: - - guest-carts/{cartId}/items/{itemId} - description: Remove the specified item from the specified cart. - operationId: DeleteV1GuestcartsCartIdItemsItemId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: itemId - in: path - type: integer - required: true - description: The item ID of the item to be removed. - responses: - '200': - description: 200 Success. - schema: - type: boolean - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/items/{itemId} - "/V1/guest-carts/{cartId}/order": - put: - tags: - - guest-carts/{cartId}/order - description: Place an order for a specified cart. - operationId: PutV1GuestcartsCartIdOrder - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PutV1GuestcartsCartIdOrderBody - in: body - schema: - properties: - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/order - "/V1/guest-carts/{cartId}/payment-information": - post: - tags: - - guest-carts/{cartId}/payment-information - description: Set payment information and place order for a specified cart. - operationId: PostV1GuestcartsCartIdPaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdPaymentinformationBody - in: body - schema: - required: - - email - - paymentMethod - properties: - email: - type: string - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-information - get: - tags: - - guest-carts/{cartId}/payment-information - description: Get payment information - operationId: GetV1GuestcartsCartIdPaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-information - "/V1/guest-carts/{cartId}/payment-methods": - get: - tags: - - guest-carts/{cartId}/payment-methods - description: List available payment methods for a specified shopping cart. This - call returns an array of objects, but detailed information about each object’s - attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#GuestPaymentMethodManagementInterface - to determine which call to use to get detailed information about all attributes - for an object. - operationId: GetV1GuestcartsCartIdPaymentmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - type: array - description: Array of payment methods. - items: - "$ref": "#/definitions/quote-data-payment-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-methods - "/V1/guest-carts/{cartId}/payment-order": - post: - tags: - - guest-carts/{cartId}/payment-order - description: Create a payment order for guest customer - operationId: PostV1GuestcartsCartIdPaymentorder - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdPaymentorderBody - in: body - schema: - required: - - methodCode - - paymentSource - - location - properties: - methodCode: - type: string - paymentSource: - type: string - location: - type: string - vaultIntent: - type: boolean - threeDSMode: - type: string - description: "| null $threeDSMode" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-order - "/V1/guest-carts/{cartId}/payment-order/{id}": - get: - tags: - - guest-carts/{cartId}/payment-order/{id} - description: Get payment order for guest customer - operationId: GetV1GuestcartsCartIdPaymentorderId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: id - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-order/{id} - post: - tags: - - guest-carts/{cartId}/payment-order/{id} - description: Sync payment order for guest customer - operationId: PostV1GuestcartsCartIdPaymentorderId - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: id - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: boolean - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/payment-order/{id} - "/V1/guest-carts/{cartId}/selected-payment-method": - get: - tags: - - guest-carts/{cartId}/selected-payment-method - description: Return the payment method for a specified shopping cart. - operationId: GetV1GuestcartsCartIdSelectedpaymentmethod - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-payment-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/selected-payment-method - put: - tags: - - guest-carts/{cartId}/selected-payment-method - description: Add a specified payment method to a specified shopping cart. - operationId: PutV1GuestcartsCartIdSelectedpaymentmethod - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - - name: PutV1GuestcartsCartIdSelectedpaymentmethodBody - in: body - schema: - required: - - method - properties: - method: - "$ref": "#/definitions/quote-data-payment-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Payment method ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/selected-payment-method - "/V1/guest-carts/{cartId}/set-payment-information": - post: - tags: - - guest-carts/{cartId}/set-payment-information - description: Set payment information for a specified cart. - operationId: PostV1GuestcartsCartIdSetpaymentinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdSetpaymentinformationBody - in: body - schema: - required: - - email - - paymentMethod - properties: - email: - type: string - paymentMethod: - "$ref": "#/definitions/quote-data-payment-interface" - billingAddress: - "$ref": "#/definitions/quote-data-address-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: integer - description: Order ID. - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/set-payment-information - "/V1/guest-carts/{cartId}/shipping-information": - post: - tags: - - guest-carts/{cartId}/shipping-information - description: '' - operationId: PostV1GuestcartsCartIdShippinginformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdShippinginformationBody - in: body - schema: - required: - - addressInformation - properties: - addressInformation: - "$ref": "#/definitions/checkout-data-shipping-information-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/checkout-data-payment-details-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/shipping-information - "/V1/guest-carts/{cartId}/shipping-methods": - get: - tags: - - guest-carts/{cartId}/shipping-methods - description: List applicable shipping methods for a specified quote. - operationId: GetV1GuestcartsCartIdShippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The shopping cart ID. - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/shipping-methods - "/V1/guest-carts/{cartId}/totals": - get: - tags: - - guest-carts/{cartId}/totals - description: Return quote totals data for a specified cart. - operationId: GetV1GuestcartsCartIdTotals - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The cart ID. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/totals - "/V1/guest-carts/{cartId}/totals-information": - post: - tags: - - guest-carts/{cartId}/totals-information - description: Calculate quote totals based on address and shipping method. - operationId: PostV1GuestcartsCartIdTotalsinformation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - - name: PostV1GuestcartsCartIdTotalsinformationBody - in: body - schema: - required: - - addressInformation - properties: - addressInformation: - "$ref": "#/definitions/checkout-data-totals-information-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/quote-data-totals-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-carts/{cartId}/totals-information - "/V1/guest-giftregistry/{cartId}/estimate-shipping-methods": - post: - tags: - - guest-giftregistry/{cartId}/estimate-shipping-methods - description: Estimate shipping - operationId: PostV1GuestgiftregistryCartIdEstimateshippingmethods - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: cartId - in: path - type: string - required: true - description: The shopping cart ID. - - name: PostV1GuestgiftregistryCartIdEstimateshippingmethodsBody - in: body - schema: - required: - - registryId - properties: - registryId: - type: integer - description: The estimate registry id - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: array - description: An array of shipping methods. - items: - "$ref": "#/definitions/quote-data-shipping-method-interface" - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: guest-giftregistry/{cartId}/estimate-shipping-methods - "/V1/integration/admin/token": - post: - tags: - - integration/admin/token - description: Create access token for admin given the admin credentials. - operationId: PostV1IntegrationAdminToken - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1IntegrationAdminTokenBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - description: Token created - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: integration/admin/token - "/V1/integration/customer/token": - post: - tags: - - integration/customer/token - description: Create access token for admin given the customer credentials. - operationId: PostV1IntegrationCustomerToken - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1IntegrationCustomerTokenBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - description: Token created - '400': - description: 400 Bad Request - schema: - "$ref": "#/definitions/error-response" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: integration/customer/token - "/V1/inventory/in-store-pickup/pickup-locations/": - get: - tags: - - inventory/in-store-pickup/pickup-locations/ - description: Get Pickup Locations according to the results of filtration by - Search Request. - operationId: GetV1InventoryInstorepickupPickuplocations - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchRequest[area][radius] - in: query - type: integer - description: Search radius in KM. - - name: searchRequest[area][searchTerm] - in: query - type: string - description: Search term string. - - name: searchRequest[filters][country][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][country][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][postcode][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][postcode][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][region][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][region][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][regionId][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][regionId][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][city][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][city][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][street][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][street][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][name][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][name][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[filters][pickupLocationCode][value] - in: query - type: string - description: Value. - - name: searchRequest[filters][pickupLocationCode][conditionType] - in: query - type: string - description: Condition Type. - - name: searchRequest[pageSize] - in: query - type: integer - description: Page size. - - name: searchRequest[currentPage] - in: query - type: integer - description: Current page. - - name: searchRequest[scopeType] - in: query - type: string - description: Sales Channel Type. - - name: searchRequest[scopeCode] - in: query - type: string - description: Sales Channel code. - - name: searchRequest[sort][0][field] - in: query - type: string - description: Sorting field. - - name: searchRequest[sort][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchRequest[extensionAttributes][productsInfo][0][sku] - in: query - type: string - description: Product SKU. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/in-store-pickup/pickup-locations/ - post: - tags: - - inventory/in-store-pickup/pickup-locations/ - description: Get Pickup Locations according to the results of filtration by - Search Request. - operationId: PostV1InventoryInstorepickupPickuplocations - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1InventoryInstorepickupPickuplocationsBody - in: body - schema: - required: - - searchRequest - properties: - searchRequest: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: inventory/in-store-pickup/pickup-locations/ - "/V1/payment-order/completeOrder": - post: - tags: - - payment-order/completeOrder - description: Rest API endpoint to place an order - operationId: PostV1PaymentorderCompleteOrder - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1PaymentorderCompleteOrderBody - in: body - schema: - required: - - orderId - properties: - orderId: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payment-order/completeOrder - "/V1/payments-config/apple-pay/{location}": - get: - tags: - - payments-config/apple-pay/{location} - description: Get Apple Pay Config. - operationId: GetV1PaymentsconfigApplepayLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/apple-pay/{location} - "/V1/payments-config/google-pay/{location}": - get: - tags: - - payments-config/google-pay/{location} - description: Get Google Pay Config. - operationId: GetV1PaymentsconfigGooglepayLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/google-pay/{location} - "/V1/payments-config/hosted-fields/{location}": - get: - tags: - - payments-config/hosted-fields/{location} - description: Get Hosted Fields Config. - operationId: GetV1PaymentsconfigHostedfieldsLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/hosted-fields/{location} - "/V1/payments-config/smart-buttons/{location}": - get: - tags: - - payments-config/smart-buttons/{location} - description: Get Smart Buttons Config. - operationId: GetV1PaymentsconfigSmartbuttonsLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/smart-buttons/{location} - "/V1/payments-config/{location}": - get: - tags: - - payments-config/{location} - description: Get Config. - operationId: GetV1PaymentsconfigLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - description: sdk location. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-payment-config-response-interface" - '500': - description: Internal Server error - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-config/{location} - "/V1/payments-sdk/{location}": - get: - tags: - - payments-sdk/{location} - description: Get payment sdk url by location - operationId: GetV1PaymentssdkLocation - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-sdk/{location} - "/V1/payments-sdk/{location}/{methodCode}": - get: - tags: - - payments-sdk/{location}/{methodCode} - description: Get payment sdk url by location and methodCode - operationId: GetV1PaymentssdkLocationMethodCode - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: location - in: path - type: string - required: true - - name: methodCode - in: path - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: payments-sdk/{location}/{methodCode} - "/V1/paypal/lineItems": - post: - tags: - - paypal/lineItems - description: Rest endpoint to calculate totals and line items - operationId: PostV1PaypalLineItems - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1PaypalLineItemsBody - in: body - schema: - required: - - method - - cartId - properties: - method: - type: string - cartId: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: paypal/lineItems - "/V1/paypal/oneClick": - post: - tags: - - paypal/oneClick - description: Rest endpoint to add product to cart (mainly use for PayPal button - from PDP) - operationId: PostV1PaypalOneClick - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1PaypalOneClickBody - in: body - schema: - required: - - method - - productData - properties: - method: - type: string - productData: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: paypal/oneClick - "/V1/paypal/validatePhoneNumber": - post: - tags: - - paypal/validatePhoneNumber - description: Get & validate phone number and get shipping/billing email address - operationId: PostV1PaypalValidatePhoneNumber - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1PaypalValidatePhoneNumberBody - in: body - schema: - required: - - cartId - properties: - cartId: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: paypal/validatePhoneNumber - "/V1/products-render-info": - get: - tags: - - products-render-info - description: Collect and retrieve the list of product render info. This info - contains raw prices and formatted prices, product name, stock status, store_id, - etc. - operationId: GetV1Productsrenderinfo - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - - name: storeId - in: query - type: integer - required: true - - name: currencyCode - in: query - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/catalog-data-product-render-search-results-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: products-render-info - "/V1/search": - get: - tags: - - search - description: Make Full Text Search and return found Documents - operationId: GetV1Search - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: searchCriteria[requestName] - in: query - type: string - - name: searchCriteria[filterGroups][0][filters][0][field] - in: query - type: string - description: Field - - name: searchCriteria[filterGroups][0][filters][0][value] - in: query - type: string - description: Value - - name: searchCriteria[filterGroups][0][filters][0][conditionType] - in: query - type: string - description: Condition type - - name: searchCriteria[sortOrders][0][field] - in: query - type: string - description: Sorting field. - - name: searchCriteria[sortOrders][0][direction] - in: query - type: string - description: Sorting direction. - - name: searchCriteria[pageSize] - in: query - type: integer - description: Page size. - - name: searchCriteria[currentPage] - in: query - type: integer - description: Current page. - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/framework-search-search-result-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: search - "/V1/tfa/provider/authy/activate": - post: - tags: - - tfa/provider/authy/activate - description: Activate the provider and get an admin token - operationId: PostV1TfaProviderAuthyActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderAuthyActivateBody - in: body - schema: - required: - - tfaToken - - otp - properties: - tfaToken: - type: string - otp: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/activate - "/V1/tfa/provider/authy/authenticate": - post: - tags: - - tfa/provider/authy/authenticate - description: Get an admin token using authy 2fa - operationId: PostV1TfaProviderAuthyAuthenticate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderAuthyAuthenticateBody - in: body - schema: - required: - - username - - password - - otp - properties: - username: - type: string - password: - type: string - otp: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - description: "$otp" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/authenticate - "/V1/tfa/provider/authy/authenticate-onetouch": - post: - tags: - - tfa/provider/authy/authenticate-onetouch - description: Authenticate using the present one touch response and get an admin - token - operationId: PostV1TfaProviderAuthyAuthenticateonetouch - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderAuthyAuthenticateonetouchBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/authenticate-onetouch - "/V1/tfa/provider/authy/configure": - post: - tags: - - tfa/provider/authy/configure - description: Get the information required to configure google - operationId: PostV1TfaProviderAuthyConfigure - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderAuthyConfigureBody - in: body - schema: - required: - - tfaToken - - deviceData - properties: - tfaToken: - type: string - deviceData: - "$ref": "#/definitions/two-factor-auth-data-authy-device-interface" - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/configure - "/V1/tfa/provider/authy/send-token/{via}": - post: - tags: - - tfa/provider/authy/send-token/{via} - description: Send a one time password to a device using authy - operationId: PostV1TfaProviderAuthySendtokenVia - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: via - in: path - type: string - required: true - - name: PostV1TfaProviderAuthySendtokenViaBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/authy/send-token/{via} - "/V1/tfa/provider/duo_security/activate": - post: - tags: - - tfa/provider/duo_security/activate - description: Activate the provider and get an admin token - operationId: PostV1TfaProviderDuo_securityActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderDuo_securityActivateBody - in: body - schema: - required: - - tfaToken - properties: - tfaToken: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/duo_security/activate - "/V1/tfa/provider/duo_security/authenticate": - post: - tags: - - tfa/provider/duo_security/authenticate - description: Authenticate and get an admin token with passcode - operationId: PostV1TfaProviderDuo_securityAuthenticate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderDuo_securityAuthenticateBody - in: body - schema: - required: - - username - - password - - passcode - properties: - username: - type: string - password: - type: string - passcode: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/duo_security/authenticate - "/V1/tfa/provider/duo_security/configure": - post: - tags: - - tfa/provider/duo_security/configure - description: Configure duo for first time user - operationId: PostV1TfaProviderDuo_securityConfigure - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderDuo_securityConfigureBody - in: body - schema: - required: - - tfaToken - properties: - tfaToken: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/duo_security/configure - "/V1/tfa/provider/google/activate": - post: - tags: - - tfa/provider/google/activate - description: Activate the provider and get an admin token - operationId: PostV1TfaProviderGoogleActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderGoogleActivateBody - in: body - schema: - required: - - tfaToken - - otp - properties: - tfaToken: - type: string - otp: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/google/activate - "/V1/tfa/provider/google/authenticate": - post: - tags: - - tfa/provider/google/authenticate - description: Get an admin token by authenticating using google - operationId: PostV1TfaProviderGoogleAuthenticate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderGoogleAuthenticateBody - in: body - schema: - required: - - username - - password - - otp - properties: - username: - type: string - password: - type: string - otp: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/google/authenticate - "/V1/tfa/provider/google/configure": - post: - tags: - - tfa/provider/google/configure - description: Get the information required to configure google - operationId: PostV1TfaProviderGoogleConfigure - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderGoogleConfigureBody - in: body - schema: - required: - - tfaToken - properties: - tfaToken: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/two-factor-auth-data-google-configure-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/google/configure - "/V1/tfa/provider/u2fkey/activate": - post: - tags: - - tfa/provider/u2fkey/activate - description: Activate the provider and get a token - operationId: PostV1TfaProviderU2fkeyActivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderU2fkeyActivateBody - in: body - schema: - required: - - tfaToken - - publicKeyCredentialJson - properties: - tfaToken: - type: string - publicKeyCredentialJson: - type: string - type: object - xml: - name: request - responses: - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/u2fkey/activate - "/V1/tfa/provider/u2fkey/authentication-challenge": - post: - tags: - - tfa/provider/u2fkey/authentication-challenge - description: Get the information to initiate a WebAuthn registration ceremony - operationId: PostV1TfaProviderU2fkeyAuthenticationchallenge - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderU2fkeyAuthenticationchallengeBody - in: body - schema: - required: - - username - - password - properties: - username: - type: string - password: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/u2fkey/authentication-challenge - "/V1/tfa/provider/u2fkey/configure": - post: - tags: - - tfa/provider/u2fkey/configure - description: Get the information to initiate a WebAuthn registration ceremony - operationId: PostV1TfaProviderU2fkeyConfigure - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderU2fkeyConfigureBody - in: body - schema: - required: - - tfaToken - properties: - tfaToken: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/u2fkey/configure - "/V1/tfa/provider/u2fkey/verify": - post: - tags: - - tfa/provider/u2fkey/verify - description: Authenticate with the provider and get a token - operationId: PostV1TfaProviderU2fkeyVerify - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: PostV1TfaProviderU2fkeyVerifyBody - in: body - schema: - required: - - username - - password - - publicKeyCredentialJson - properties: - username: - type: string - password: - type: string - publicKeyCredentialJson: - type: string - type: object - xml: - name: request - responses: - '200': - description: 200 Success. - schema: - type: string - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/provider/u2fkey/verify - "/V1/tfa/tfat-providers-to-activate": - get: - tags: - - tfa/tfat-providers-to-activate - description: Get the providers that the user still needs to configure - operationId: GetV1TfaTfatproviderstoactivate - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: tfaToken - in: query - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/two-factor-auth-provider-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/tfat-providers-to-activate - "/V1/tfa/tfat-user-providers": - get: - tags: - - tfa/tfat-user-providers - description: Get the providers that the user is able to use for 2fa - operationId: GetV1TfaTfatuserproviders - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - parameters: - - name: tfaToken - in: query - type: string - required: true - responses: - '200': - description: 200 Success. - schema: - type: array - items: - "$ref": "#/definitions/two-factor-auth-provider-interface" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: tfa/tfat-user-providers -definitions: - error-response: - type: object - properties: - message: - type: string - description: Error message - errors: - "$ref": "#/definitions/error-errors" - code: - type: integer - description: Error code - parameters: - "$ref": "#/definitions/error-parameters" - trace: - type: string - description: Stack trace - required: - - message - error-errors: - type: array - description: Errors list - items: - "$ref": "#/definitions/error-errors-item" - error-errors-item: - type: object - description: Error details - properties: - message: - type: string - description: Error message - parameters: - "$ref": "#/definitions/error-parameters" - error-parameters: - type: array - description: Error parameters list - items: - "$ref": "#/definitions/error-parameters-item" - error-parameters-item: - type: object - description: Error parameters item - properties: - resources: - type: string - description: ACL resource - fieldName: - type: string - description: Missing or invalid field name - fieldValue: - type: string - description: Incorrect field value - directory-data-currency-information-interface: - type: object - description: Currency Information interface. - properties: - base_currency_code: - type: string - description: The base currency code for the store. - base_currency_symbol: - type: string - description: The currency symbol of the base currency for the store. - default_display_currency_code: - type: string - description: The default display currency code for the store. - default_display_currency_symbol: - type: string - description: The currency symbol of the default display currency for the store. - available_currency_codes: - type: array - description: The list of allowed currency codes for the store. - items: - type: string - exchange_rates: - type: array - description: The list of exchange rate information for the store. - items: - "$ref": "#/definitions/directory-data-exchange-rate-interface" - extension_attributes: - "$ref": "#/definitions/directory-data-currency-information-extension-interface" - required: - - base_currency_code - - base_currency_symbol - - default_display_currency_code - - default_display_currency_symbol - - available_currency_codes - - exchange_rates - directory-data-exchange-rate-interface: - type: object - description: Exchange Rate interface. - properties: - currency_to: - type: string - description: The currency code associated with the exchange rate. - rate: - type: number - description: The exchange rate for the associated currency and the store's - base currency. - extension_attributes: - "$ref": "#/definitions/directory-data-exchange-rate-extension-interface" - required: - - currency_to - - rate - directory-data-exchange-rate-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Directory\Api\Data\ExchangeRateInterface - directory-data-currency-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CurrencyInformationInterface - directory-data-country-information-interface: - type: object - description: Country Information interface. - properties: - id: - type: string - description: The country id for the store. - two_letter_abbreviation: - type: string - description: The country 2 letter abbreviation for the store. - three_letter_abbreviation: - type: string - description: The country 3 letter abbreviation for the store. - full_name_locale: - type: string - description: The country full name (in store locale) for the store. - full_name_english: - type: string - description: The country full name (in English) for the store. - available_regions: - type: array - description: The available regions for the store. - items: - "$ref": "#/definitions/directory-data-region-information-interface" - extension_attributes: - "$ref": "#/definitions/directory-data-country-information-extension-interface" - required: - - id - - two_letter_abbreviation - - three_letter_abbreviation - - full_name_locale - - full_name_english - directory-data-region-information-interface: - type: object - description: Region Information interface. - properties: - id: - type: string - description: Region id - code: - type: string - description: Region code - name: - type: string - description: Region name - extension_attributes: - "$ref": "#/definitions/directory-data-region-information-extension-interface" - required: - - id - - code - - name - directory-data-region-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Directory\Api\Data\RegionInformationInterface - directory-data-country-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CountryInformationInterface - customer-data-customer-interface: - type: object - description: Customer entity interface for API handling. - properties: - id: - type: integer - description: Customer id - group_id: - type: integer - description: Group id - default_billing: - type: string - description: Default billing address id - default_shipping: - type: string - description: Default shipping address id - confirmation: - type: string - description: Confirmation - created_at: - type: string - description: Created at time - updated_at: - type: string - description: Updated at time - created_in: - type: string - description: Created in area - dob: - type: string - description: In keeping with current security and privacy best practices, - be sure you are aware of any potential legal and security risks associated - with the storage of customers’ full date of birth (month, day, year) along - with other personal identifiers (e.g., full name) before collecting or processing - such data. - email: - type: string - description: Email address - firstname: - type: string - description: First name - lastname: - type: string - description: Last name - middlename: - type: string - description: Middle name - prefix: - type: string - description: Prefix - suffix: - type: string - description: Suffix - gender: - type: integer - description: Gender - store_id: - type: integer - description: Store id - taxvat: - type: string - description: Tax Vat - website_id: - type: integer - description: Website id - addresses: - type: array - description: Customer addresses. - items: - "$ref": "#/definitions/customer-data-address-interface" - disable_auto_group_change: - type: integer - description: Disable auto group change flag. - extension_attributes: - "$ref": "#/definitions/customer-data-customer-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - email - - firstname - - lastname - customer-data-address-interface: - type: object - description: Customer address interface. - properties: - id: - type: integer - description: ID - customer_id: - type: integer - description: Customer ID - region: - "$ref": "#/definitions/customer-data-region-interface" - region_id: - type: integer - description: Region ID - country_id: - type: string - description: Country code in ISO_3166-2 format - street: - type: array - description: Street - items: - type: string - company: - type: string - description: Company - telephone: - type: string - description: Telephone number - fax: - type: string - description: Fax number - postcode: - type: string - description: Postcode - city: - type: string - description: City name - firstname: - type: string - description: First name - lastname: - type: string - description: Last name - middlename: - type: string - description: Middle name - prefix: - type: string - description: Prefix - suffix: - type: string - description: Suffix - vat_id: - type: string - description: Vat id - default_shipping: - type: boolean - description: If this address is default shipping address. - default_billing: - type: boolean - description: If this address is default billing address - extension_attributes: - "$ref": "#/definitions/customer-data-address-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - customer-data-region-interface: - type: object - description: Customer address region interface. - properties: - region_code: - type: string - description: Region code - region: - type: string - description: Region - region_id: - type: integer - description: Region id - extension_attributes: - "$ref": "#/definitions/customer-data-region-extension-interface" - required: - - region_code - - region - - region_id - customer-data-region-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface - customer-data-address-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface - framework-attribute-interface: - type: object - description: Interface for custom attribute value. - properties: - attribute_code: - type: string - description: Attribute code - value: - type: string - description: Attribute value - required: - - attribute_code - - value - customer-data-customer-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface - properties: - company_attributes: - "$ref": "#/definitions/company-data-company-customer-interface" - all_company_attributes: - type: array - items: - "$ref": "#/definitions/company-data-company-customer-interface" - is_subscribed: - type: boolean - assistance_allowed: - type: integer - company-data-company-customer-interface: - type: object - description: Extended customer custom attributes interface. - properties: - customer_id: - type: integer - description: Customer ID. - company_id: - type: integer - description: Company ID. - job_title: - type: string - description: Job title. - status: - type: integer - description: Customer status. - telephone: - type: string - description: Telephone. - is_default: - type: boolean - description: Is default - extension_attributes: - "$ref": "#/definitions/company-data-company-customer-extension-interface" - company-data-company-customer-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface - catalog-data-product-render-search-results-interface: - type: object - description: Dto that holds render information about products - properties: - items: - type: array - description: List of products rendered information - items: - "$ref": "#/definitions/catalog-data-product-render-interface" - required: - - items - catalog-data-product-render-interface: - type: object - description: Represents Data Object which holds enough information to render product - This information is put into part as Add To Cart or Add to Compare Data or Price - Data - properties: - add_to_cart_button: - "$ref": "#/definitions/catalog-data-product-render-button-interface" - add_to_compare_button: - "$ref": "#/definitions/catalog-data-product-render-button-interface" - price_info: - "$ref": "#/definitions/catalog-data-product-render-price-info-interface" - images: - type: array - description: Enough information, that needed to render image on front - items: - "$ref": "#/definitions/catalog-data-product-render-image-interface" - url: - type: string - description: Product url - id: - type: integer - description: Product identifier - name: - type: string - description: Product name - type: - type: string - description: Product type. Such as bundle, grouped, simple, etc... - is_salable: - type: string - description: Information about product saleability (In Stock) - store_id: - type: integer - description: Information about current store id or requested store id - currency_code: - type: string - description: Current or desired currency code to product - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-extension-interface" - required: - - add_to_cart_button - - add_to_compare_button - - price_info - - images - - url - - id - - name - - type - - is_salable - - store_id - - currency_code - - extension_attributes - catalog-data-product-render-button-interface: - type: object - description: 'Button interface. This interface represents all manner of product - buttons: add to cart, add to compare, etc... The buttons describes by this interface - should have interaction with backend' - properties: - post_data: - type: string - description: Post data - url: - type: string - description: Url, needed to add product to cart - required_options: - type: boolean - description: Flag whether a product has options or not - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-button-extension-interface" - required: - - post_data - - url - - required_options - catalog-data-product-render-button-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface - catalog-data-product-render-price-info-interface: - type: object - description: Price interface. - properties: - final_price: - type: number - description: Final price - max_price: - type: number - description: Max price of a product - max_regular_price: - type: number - description: Max regular price - minimal_regular_price: - type: number - description: Minimal regular price - special_price: - type: number - description: Special price - minimal_price: - type: number - description: Minimal price - regular_price: - type: number - description: Regular price - formatted_prices: - "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-interface" - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-price-info-extension-interface" - required: - - final_price - - max_price - - max_regular_price - - minimal_regular_price - - special_price - - minimal_price - - regular_price - - formatted_prices - catalog-data-product-render-formatted-price-info-interface: - type: object - description: 'Formatted Price interface. Aggregate formatted html with price representations. - E.g.: $9.00 Consider currency, rounding and html' - properties: - final_price: - type: string - description: Html with final price - max_price: - type: string - description: Max price of a product - minimal_price: - type: string - description: The minimal price of the product or variation - max_regular_price: - type: string - description: Max regular price - minimal_regular_price: - type: string - description: Minimal regular price - special_price: - type: string - description: Special price - regular_price: - type: string - description: Price - is price of product without discounts and special price - with taxes and fixed product tax - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-extension-interface" - required: - - final_price - - max_price - - minimal_price - - max_regular_price - - minimal_regular_price - - special_price - - regular_price - catalog-data-product-render-formatted-price-info-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\FormattedPriceInfoInterface - catalog-data-product-render-price-info-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface - properties: - msrp: - "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-interface" - tax_adjustments: - "$ref": "#/definitions/catalog-data-product-render-price-info-interface" - weee_attributes: - type: array - items: - "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-interface" - weee_adjustment: - type: string - msrp-data-product-render-msrp-price-info-interface: - type: object - description: Price interface. - properties: - msrp_price: - type: string - is_applicable: - type: string - is_shown_price_on_gesture: - type: string - msrp_message: - type: string - explanation_message: - type: string - extension_attributes: - "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-extension-interface" - required: - - msrp_price - - is_applicable - - is_shown_price_on_gesture - - msrp_message - - explanation_message - msrp-data-product-render-msrp-price-info-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface - weee-data-product-render-weee-adjustment-attribute-interface: - type: object - description: List of all weee attributes, their amounts, etc.., that product has - properties: - amount: - type: string - description: Weee attribute amount - tax_amount: - type: string - description: Tax which is calculated to fixed product tax attribute - tax_amount_incl_tax: - type: string - description: Tax amount of weee attribute - amount_excl_tax: - type: string - description: Product amount exclude tax - attribute_code: - type: string - description: Weee attribute code - extension_attributes: - "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface" - required: - - amount - - tax_amount - - tax_amount_incl_tax - - amount_excl_tax - - attribute_code - - extension_attributes - weee-data-product-render-weee-adjustment-attribute-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Weee\Api\Data\ProductRender\WeeeAdjustmentAttributeInterface - catalog-data-product-render-image-interface: - type: object - description: Product Render image interface. Represents physical characteristics - of image, that can be used in product listing or product view - properties: - url: - type: string - description: Image url - code: - type: string - description: Image code - height: - type: number - description: Image height - width: - type: number - description: Image width in px - label: - type: string - description: Image label - resized_width: - type: number - description: Resize width - resized_height: - type: number - description: Resize height - extension_attributes: - "$ref": "#/definitions/catalog-data-product-render-image-extension-interface" - required: - - url - - code - - height - - width - - label - - resized_width - - resized_height - catalog-data-product-render-image-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ImageInterface - catalog-data-product-render-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRenderInterface - properties: - wishlist_button: - "$ref": "#/definitions/catalog-data-product-render-button-interface" - review_html: - type: string - quote-data-cart-interface: - type: object - description: Interface CartInterface - properties: - id: - type: integer - description: Cart/quote ID. - created_at: - type: string - description: Cart creation date and time. Otherwise, null. - updated_at: - type: string - description: Cart last update date and time. Otherwise, null. - converted_at: - type: string - description: Cart conversion date and time. Otherwise, null. - is_active: - type: boolean - description: Active status flag value. Otherwise, null. - is_virtual: - type: boolean - description: Virtual flag value. Otherwise, null. - items: - type: array - description: Array of items. Otherwise, null. - items: - "$ref": "#/definitions/quote-data-cart-item-interface" - items_count: - type: integer - description: Number of different items or products in the cart. Otherwise, - null. - items_qty: - type: number - description: Total quantity of all cart items. Otherwise, null. - customer: - "$ref": "#/definitions/customer-data-customer-interface" - billing_address: - "$ref": "#/definitions/quote-data-address-interface" - reserved_order_id: - type: string - description: Reserved order ID. Otherwise, null. - orig_order_id: - type: integer - description: Original order ID. Otherwise, null. - currency: - "$ref": "#/definitions/quote-data-currency-interface" - customer_is_guest: - type: boolean - description: For guest customers, false for logged in customers - customer_note: - type: string - description: Notice text - customer_note_notify: - type: boolean - description: Customer notification flag - customer_tax_class_id: - type: integer - description: Customer tax class ID. - store_id: - type: integer - description: Store identifier - extension_attributes: - "$ref": "#/definitions/quote-data-cart-extension-interface" - required: - - id - - customer - - store_id - quote-data-cart-item-interface: - type: object - description: Interface CartItemInterface - properties: - item_id: - type: integer - description: Item ID. Otherwise, null. - sku: - type: string - description: Product SKU. Otherwise, null. - qty: - type: number - description: Product quantity. - name: - type: string - description: Product name. Otherwise, null. - price: - type: number - description: Product price. Otherwise, null. - product_type: - type: string - description: Product type. Otherwise, null. - quote_id: - type: string - description: Quote id. - product_option: - "$ref": "#/definitions/quote-data-product-option-interface" - extension_attributes: - "$ref": "#/definitions/quote-data-cart-item-extension-interface" - required: - - qty - - quote_id - quote-data-product-option-interface: - type: object - description: Product option interface - properties: - extension_attributes: - "$ref": "#/definitions/quote-data-product-option-extension-interface" - quote-data-product-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface - properties: - custom_options: - type: array - items: - "$ref": "#/definitions/catalog-data-custom-option-interface" - bundle_options: - type: array - items: - "$ref": "#/definitions/bundle-data-bundle-option-interface" - downloadable_option: - "$ref": "#/definitions/downloadable-data-downloadable-option-interface" - giftcard_item_option: - "$ref": "#/definitions/gift-card-data-gift-card-option-interface" - configurable_item_options: - type: array - items: - "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-interface" - grouped_options: - type: array - items: - "$ref": "#/definitions/grouped-product-data-grouped-options-interface" - catalog-data-custom-option-interface: - type: object - description: Interface CustomOptionInterface - properties: - option_id: - type: string - description: Option id - option_value: - type: string - description: Option value - extension_attributes: - "$ref": "#/definitions/catalog-data-custom-option-extension-interface" - required: - - option_id - - option_value - catalog-data-custom-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface - properties: - file_info: - "$ref": "#/definitions/framework-data-image-content-interface" - framework-data-image-content-interface: - type: object - description: Image Content data interface - properties: - base64_encoded_data: - type: string - description: Media data (base64 encoded content) - type: - type: string - description: MIME type - name: - type: string - description: Image name - required: - - base64_encoded_data - - type - - name - bundle-data-bundle-option-interface: - type: object - description: Interface BundleOptionInterface - properties: - option_id: - type: integer - description: Bundle option id. - option_qty: - type: integer - description: Bundle option quantity. - option_selections: - type: array - description: Bundle option selection ids. - items: - type: integer - extension_attributes: - "$ref": "#/definitions/bundle-data-bundle-option-extension-interface" - required: - - option_id - - option_qty - - option_selections - bundle-data-bundle-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface - downloadable-data-downloadable-option-interface: - type: object - description: Downloadable Option - properties: - downloadable_links: - type: array - description: The list of downloadable links - items: - type: integer - required: - - downloadable_links - gift-card-data-gift-card-option-interface: - type: object - description: Interface GiftCardOptionInterface - properties: - giftcard_amount: - type: string - description: Gift card amount. - custom_giftcard_amount: - type: number - description: Gift card open amount value. - giftcard_sender_name: - type: string - description: Gift card sender name. - giftcard_recipient_name: - type: string - description: Gift card recipient name. - giftcard_sender_email: - type: string - description: Gift card sender email. - giftcard_recipient_email: - type: string - description: Gift card recipient email. - giftcard_message: - type: string - description: Giftcard message. - extension_attributes: - "$ref": "#/definitions/gift-card-data-gift-card-option-extension-interface" - required: - - giftcard_amount - - giftcard_sender_name - - giftcard_recipient_name - - giftcard_sender_email - - giftcard_recipient_email - gift-card-data-gift-card-option-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface - properties: - giftcard_created_codes: - type: array - items: - type: string - configurable-product-data-configurable-item-option-value-interface: - type: object - description: Interface ConfigurableItemOptionValueInterface - properties: - option_id: - type: string - description: Option SKU - option_value: - type: integer - description: Item id - extension_attributes: - "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-extension-interface" - required: - - option_id - configurable-product-data-configurable-item-option-value-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface - grouped-product-data-grouped-options-interface: - type: object - description: Represents `product item id with qty` of a grouped product. - properties: - id: - type: integer - description: Associated product id - qty: - type: integer - description: Associated product qty - extension_attributes: - "$ref": "#/definitions/grouped-product-data-grouped-options-extension-interface" - grouped-product-data-grouped-options-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface - quote-data-cart-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface - properties: - discounts: - type: array - items: - "$ref": "#/definitions/sales-rule-data-rule-discount-interface" - negotiable_quote_item: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-interface" - sales-rule-data-rule-discount-interface: - type: object - description: Rule discount Interface - properties: - discount_data: - "$ref": "#/definitions/sales-rule-data-discount-data-interface" - rule_label: - type: string - description: Rule Label - rule_i_d: - type: integer - description: Rule ID - required: - - discount_data - - rule_label - - rule_i_d - sales-rule-data-discount-data-interface: - type: object - description: Discount Data Interface - properties: - amount: - type: number - description: Amount - base_amount: - type: number - description: Base Amount - original_amount: - type: number - description: Original Amount - base_original_amount: - type: number - description: Base Original Amount - required: - - amount - - base_amount - - original_amount - - base_original_amount - negotiable-quote-data-negotiable-quote-item-interface: - type: object - description: Interface CompanyQuoteConfigInterface - properties: - item_id: - type: integer - description: Quote item id - original_price: - type: number - description: Quote item original price - original_tax_amount: - type: number - description: Quote item original tax amount - original_discount_amount: - type: number - description: Quote item original discount amount - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-extension-interface" - required: - - item_id - - original_price - - original_tax_amount - - original_discount_amount - negotiable-quote-data-negotiable-quote-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface - properties: - negotiated_price_type: - type: integer - negotiated_price_value: - type: number - last_item_notes: - type: array - items: - "$ref": "#/definitions/negotiable-quote-data-item-note-interface" - is_discounting_locked: - type: boolean - min_qty: - type: number - max_qty: - type: number - negotiable-quote-data-item-note-interface: - type: object - description: Interface ItemNoteInterface - properties: - note_id: - type: integer - description: Note ID. - negotiable_quote_item_id: - type: integer - description: Negotiable quote item Id - creator_type: - type: integer - description: The note creator type. - creator_id: - type: integer - description: Note creator ID. - note: - type: string - description: Note. - created_at: - type: string - description: Comment created at. - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-item-note-extension-interface" - required: - - negotiable_quote_item_id - - creator_type - - creator_id - - note - negotiable-quote-data-item-note-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\ItemNoteInterface - quote-data-address-interface: - type: object - description: Interface AddressInterface - properties: - id: - type: integer - description: Id - region: - type: string - description: Region name - region_id: - type: integer - description: Region id - region_code: - type: string - description: Region code - country_id: - type: string - description: Country id - street: - type: array - description: Street - items: - type: string - company: - type: string - description: Company - telephone: - type: string - description: Telephone number - fax: - type: string - description: Fax number - postcode: - type: string - description: Postcode - city: - type: string - description: City name - firstname: - type: string - description: First name - lastname: - type: string - description: Last name - middlename: - type: string - description: Middle name - prefix: - type: string - description: Prefix - suffix: - type: string - description: Suffix - vat_id: - type: string - description: Vat id - customer_id: - type: integer - description: Customer id - email: - type: string - description: Billing/shipping email - same_as_billing: - type: integer - description: Same as billing flag - customer_address_id: - type: integer - description: Customer address id - save_in_address_book: - type: integer - description: Save in address book flag - extension_attributes: - "$ref": "#/definitions/quote-data-address-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - region - - region_id - - region_code - - country_id - - street - - telephone - - postcode - - city - - firstname - - lastname - - email - quote-data-address-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface - properties: - discounts: - type: array - items: - "$ref": "#/definitions/sales-rule-data-rule-discount-interface" - gift_registry_id: - type: integer - pickup_location_code: - type: string - quote-data-currency-interface: - type: object - description: Interface CurrencyInterface - properties: - global_currency_code: - type: string - description: Global currency code - base_currency_code: - type: string - description: Base currency code - store_currency_code: - type: string - description: Store currency code - quote_currency_code: - type: string - description: Quote currency code - store_to_base_rate: - type: number - description: Store currency to base currency rate - store_to_quote_rate: - type: number - description: Store currency to quote currency rate - base_to_global_rate: - type: number - description: Base currency to global currency rate - base_to_quote_rate: - type: number - description: Base currency to quote currency rate - extension_attributes: - "$ref": "#/definitions/quote-data-currency-extension-interface" - quote-data-currency-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface - quote-data-cart-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface - properties: - shipping_assignments: - type: array - items: - "$ref": "#/definitions/quote-data-shipping-assignment-interface" - negotiable_quote: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-interface" - company_id: - type: integer - coupon_codes: - type: array - items: - type: string - quote-data-shipping-assignment-interface: - type: object - description: Interface ShippingAssignmentInterface - properties: - shipping: - "$ref": "#/definitions/quote-data-shipping-interface" - items: - type: array - items: - "$ref": "#/definitions/quote-data-cart-item-interface" - extension_attributes: - "$ref": "#/definitions/quote-data-shipping-assignment-extension-interface" - required: - - shipping - - items - quote-data-shipping-interface: - type: object - description: Interface ShippingInterface - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - method: - type: string - description: Shipping method - extension_attributes: - "$ref": "#/definitions/quote-data-shipping-extension-interface" - required: - - address - - method - quote-data-shipping-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface - quote-data-shipping-assignment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface - negotiable-quote-data-negotiable-quote-interface: - type: object - description: Interface NegotiableQuoteInterface - properties: - quote_id: - type: integer - description: Negotiable quote ID. - is_regular_quote: - type: boolean - description: Is regular quote. - status: - type: string - description: Negotiable quote status. - negotiated_price_type: - type: integer - description: Negotiated price type. - negotiated_price_value: - type: number - description: Negotiated price value. - shipping_price: - type: number - description: Proposed shipping price. - quote_name: - type: string - description: Negotiable quote name. - expiration_period: - type: string - description: Expiration period. - email_notification_status: - type: integer - description: Email notification status. - has_unconfirmed_changes: - type: boolean - description: Has unconfirmed changes. - is_shipping_tax_changed: - type: boolean - description: Shipping tax changes. - is_customer_price_changed: - type: boolean - description: Customer price changes. - notifications: - type: integer - description: Quote notifications. - applied_rule_ids: - type: string - description: Quote rules. - is_address_draft: - type: boolean - description: Is address draft. - deleted_sku: - type: string - description: Deleted products sku. - creator_id: - type: integer - description: Quote creator id. - creator_type: - type: integer - description: Quote creator type. - original_total_price: - type: number - description: Quote original total price. - base_original_total_price: - type: number - description: Quote original total price in base currency. - negotiated_total_price: - type: number - description: Quote negotiated total price. - base_negotiated_total_price: - type: number - description: Quote negotiated total price in base currency. - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-extension-interface" - required: - - quote_id - - is_regular_quote - - status - - negotiated_price_type - - negotiated_price_value - - shipping_price - - quote_name - - expiration_period - - email_notification_status - - has_unconfirmed_changes - - is_shipping_tax_changed - - is_customer_price_changed - - notifications - - applied_rule_ids - - is_address_draft - - deleted_sku - - creator_id - - creator_type - negotiable-quote-data-negotiable-quote-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface - quote-data-payment-interface: - type: object - description: Interface PaymentInterface - properties: - po_number: - type: string - description: Purchase order number - method: - type: string - description: Payment method code - additional_data: - type: array - description: Payment additional details - items: - type: string - extension_attributes: - "$ref": "#/definitions/quote-data-payment-extension-interface" - required: - - method - quote-data-payment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface - properties: - agreement_ids: - type: array - items: - type: string - quote-data-shipping-method-interface: - type: object - description: Interface ShippingMethodInterface - properties: - carrier_code: - type: string - description: Shipping carrier code. - method_code: - type: string - description: Shipping method code. - carrier_title: - type: string - description: Shipping carrier title. Otherwise, null. - method_title: - type: string - description: Shipping method title. Otherwise, null. - amount: - type: number - description: Shipping amount in store currency. - base_amount: - type: number - description: Shipping amount in base currency. - available: - type: boolean - description: The value of the availability flag for the current shipping method. - extension_attributes: - "$ref": "#/definitions/quote-data-shipping-method-extension-interface" - error_message: - type: string - description: Shipping Error message. - price_excl_tax: - type: number - description: Shipping price excl tax. - price_incl_tax: - type: number - description: Shipping price incl tax. - required: - - carrier_code - - method_code - - amount - - base_amount - - available - - error_message - - price_excl_tax - - price_incl_tax - quote-data-shipping-method-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface - quote-data-payment-method-interface: - type: object - description: Interface PaymentMethodInterface - properties: - code: - type: string - description: Payment method code - title: - type: string - description: Payment method title - required: - - code - - title - quote-data-totals-additional-data-interface: - type: object - description: Additional data for totals collection. - properties: - extension_attributes: - "$ref": "#/definitions/quote-data-totals-additional-data-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - quote-data-totals-additional-data-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface - properties: - gift_messages: - type: array - items: - "$ref": "#/definitions/gift-message-data-message-interface" - gift-message-data-message-interface: - type: object - description: Interface MessageInterface - properties: - gift_message_id: - type: integer - description: Gift message ID. Otherwise, null. - customer_id: - type: integer - description: Customer ID. Otherwise, null. - sender: - type: string - description: Sender name. - recipient: - type: string - description: Recipient name. - message: - type: string - description: Message text. - extension_attributes: - "$ref": "#/definitions/gift-message-data-message-extension-interface" - required: - - sender - - recipient - - message - gift-message-data-message-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface - properties: - entity_id: - type: string - entity_type: - type: string - wrapping_id: - type: integer - wrapping_allow_gift_receipt: - type: boolean - wrapping_add_printed_card: - type: boolean - quote-data-totals-interface: - type: object - description: Interface TotalsInterface - properties: - grand_total: - type: number - description: Grand total in quote currency - base_grand_total: - type: number - description: Grand total in base currency - subtotal: - type: number - description: Subtotal in quote currency - base_subtotal: - type: number - description: Subtotal in base currency - discount_amount: - type: number - description: Discount amount in quote currency - base_discount_amount: - type: number - description: Discount amount in base currency - subtotal_with_discount: - type: number - description: Subtotal in quote currency with applied discount - base_subtotal_with_discount: - type: number - description: Subtotal in base currency with applied discount - shipping_amount: - type: number - description: Shipping amount in quote currency - base_shipping_amount: - type: number - description: Shipping amount in base currency - shipping_discount_amount: - type: number - description: Shipping discount amount in quote currency - base_shipping_discount_amount: - type: number - description: Shipping discount amount in base currency - tax_amount: - type: number - description: Tax amount in quote currency - base_tax_amount: - type: number - description: Tax amount in base currency - weee_tax_applied_amount: - type: number - description: Item weee tax applied amount in quote currency. - shipping_tax_amount: - type: number - description: Shipping tax amount in quote currency - base_shipping_tax_amount: - type: number - description: Shipping tax amount in base currency - subtotal_incl_tax: - type: number - description: Subtotal including tax in quote currency - base_subtotal_incl_tax: - type: number - description: Subtotal including tax in base currency - shipping_incl_tax: - type: number - description: Shipping including tax in quote currency - base_shipping_incl_tax: - type: number - description: Shipping including tax in base currency - base_currency_code: - type: string - description: Base currency code - quote_currency_code: - type: string - description: Quote currency code - coupon_code: - type: string - description: Applied coupon code - items_qty: - type: integer - description: Items qty - items: - type: array - description: Totals by items - items: - "$ref": "#/definitions/quote-data-totals-item-interface" - total_segments: - type: array - description: Dynamically calculated totals - items: - "$ref": "#/definitions/quote-data-total-segment-interface" - extension_attributes: - "$ref": "#/definitions/quote-data-totals-extension-interface" - required: - - weee_tax_applied_amount - - total_segments - quote-data-totals-item-interface: - type: object - description: Interface TotalsItemInterface - properties: - item_id: - type: integer - description: Item id - price: - type: number - description: Item price in quote currency. - base_price: - type: number - description: Item price in base currency. - qty: - type: number - description: Item quantity. - row_total: - type: number - description: Row total in quote currency. - base_row_total: - type: number - description: Row total in base currency. - row_total_with_discount: - type: number - description: Row total with discount in quote currency. Otherwise, null. - tax_amount: - type: number - description: Tax amount in quote currency. Otherwise, null. - base_tax_amount: - type: number - description: Tax amount in base currency. Otherwise, null. - tax_percent: - type: number - description: Tax percent. Otherwise, null. - discount_amount: - type: number - description: Discount amount in quote currency. Otherwise, null. - base_discount_amount: - type: number - description: Discount amount in base currency. Otherwise, null. - discount_percent: - type: number - description: Discount percent. Otherwise, null. - price_incl_tax: - type: number - description: Price including tax in quote currency. Otherwise, null. - base_price_incl_tax: - type: number - description: Price including tax in base currency. Otherwise, null. - row_total_incl_tax: - type: number - description: Row total including tax in quote currency. Otherwise, null. - base_row_total_incl_tax: - type: number - description: Row total including tax in base currency. Otherwise, null. - options: - type: string - description: Item price in quote currency. - weee_tax_applied_amount: - type: number - description: Item weee tax applied amount in quote currency. - weee_tax_applied: - type: string - description: Item weee tax applied in quote currency. - extension_attributes: - "$ref": "#/definitions/quote-data-totals-item-extension-interface" - name: - type: string - description: Product name. Otherwise, null. - required: - - item_id - - price - - base_price - - qty - - row_total - - base_row_total - - options - - weee_tax_applied_amount - - weee_tax_applied - quote-data-totals-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface - properties: - negotiable_quote_item_totals: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface" - negotiable-quote-data-negotiable-quote-item-totals-interface: - type: object - description: Extension attribute for quote item totals model. - properties: - cost: - type: number - description: Cost for quote item. - catalog_price: - type: number - description: Catalog price for quote item. - base_catalog_price: - type: number - description: Catalog price for quote item in base currency. - catalog_price_incl_tax: - type: number - description: Catalog price with included tax for quote item. - base_catalog_price_incl_tax: - type: number - description: Catalog price with included tax for quote item in base currency. - cart_price: - type: number - description: Cart price for quote item. - base_cart_price: - type: number - description: Cart price for quote item in base currency. - cart_tax: - type: number - description: Tax from catalog price for quote item. - base_cart_tax: - type: number - description: Tax from catalog price for quote item in base currency. - cart_price_incl_tax: - type: number - description: Cart price with included tax for quote item. - base_cart_price_incl_tax: - type: number - description: Cart price with included tax for quote item in base currency. - extension_attributes: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface" - required: - - cost - - catalog_price - - base_catalog_price - - catalog_price_incl_tax - - base_catalog_price_incl_tax - - cart_price - - base_cart_price - - cart_tax - - base_cart_tax - - cart_price_incl_tax - - base_cart_price_incl_tax - negotiable-quote-data-negotiable-quote-item-totals-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface - quote-data-total-segment-interface: - type: object - description: Interface TotalsInterface - properties: - code: - type: string - description: Code - title: - type: string - description: Total title - value: - type: number - description: Total value - area: - type: string - description: Display area code. - extension_attributes: - "$ref": "#/definitions/quote-data-total-segment-extension-interface" - required: - - code - - value - quote-data-total-segment-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface - properties: - tax_grandtotal_details: - type: array - items: - "$ref": "#/definitions/tax-data-grand-total-details-interface" - gift_cards: - type: string - gw_order_id: - type: string - gw_item_ids: - type: array - items: - type: string - gw_allow_gift_receipt: - type: string - gw_add_card: - type: string - gw_price: - type: string - gw_base_price: - type: string - gw_items_price: - type: string - gw_items_base_price: - type: string - gw_card_price: - type: string - gw_card_base_price: - type: string - gw_base_tax_amount: - type: string - gw_tax_amount: - type: string - gw_items_base_tax_amount: - type: string - gw_items_tax_amount: - type: string - gw_card_base_tax_amount: - type: string - gw_card_tax_amount: - type: string - gw_price_incl_tax: - type: string - gw_base_price_incl_tax: - type: string - gw_card_price_incl_tax: - type: string - gw_card_base_price_incl_tax: - type: string - gw_items_price_incl_tax: - type: string - gw_items_base_price_incl_tax: - type: string - tax-data-grand-total-details-interface: - type: object - description: Interface GrandTotalDetailsInterface - properties: - amount: - type: number - description: Tax amount value - rates: - type: array - description: Tax rates info - items: - "$ref": "#/definitions/tax-data-grand-total-rates-interface" - group_id: - type: integer - description: Group identifier - required: - - amount - - rates - - group_id - tax-data-grand-total-rates-interface: - type: object - description: Interface GrandTotalRatesInterface - properties: - percent: - type: string - description: Tax percentage value - title: - type: string - description: Rate title - required: - - percent - - title - quote-data-totals-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface - properties: - coupon_label: - type: string - negotiable_quote_totals: - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-totals-interface" - base_customer_balance_amount: - type: number - customer_balance_amount: - type: number - coupon_codes: - type: array - items: - type: string - coupons_labels: - type: array - items: - type: string - reward_points_balance: - type: number - reward_currency_amount: - type: number - base_reward_currency_amount: - type: number - negotiable-quote-data-negotiable-quote-totals-interface: - type: object - description: Extension attribute for quote totals model. - properties: - items_count: - type: integer - description: The number of different items or products in the cart. - quote_status: - type: string - description: Negotiable quote status. - created_at: - type: string - description: The cart creation date and time. - updated_at: - type: string - description: The cart last update date and time. - customer_group: - type: integer - description: Customer group id. - base_to_quote_rate: - type: number - description: Base currency to quote currency rate. - cost_total: - type: number - description: Total cost for quote. - base_cost_total: - type: number - description: Total cost for quote in base currency. - original_total: - type: number - description: Original quote total. - base_original_total: - type: number - description: Original quote total in base currency. - original_tax: - type: number - description: Original tax amount for quote. - base_original_tax: - type: number - description: Original tax amount for quote in base currency. - original_price_incl_tax: - type: number - description: Original price with included tax for quote. - base_original_price_incl_tax: - type: number - description: Original price with included tax for quote in base currency. - negotiated_price_type: - type: integer - description: Negotiable quote type. - negotiated_price_value: - type: number - description: Negotiable price value for quote. - required: - - items_count - - quote_status - - created_at - - updated_at - - customer_group - - base_to_quote_rate - - cost_total - - base_cost_total - - original_total - - base_original_total - - original_tax - - base_original_tax - - original_price_incl_tax - - base_original_price_incl_tax - - negotiated_price_type - - negotiated_price_value - framework-search-search-result-interface: - type: object - description: Interface SearchResultInterface - properties: - items: - type: array - items: - "$ref": "#/definitions/framework-search-document-interface" - aggregations: - "$ref": "#/definitions/framework-search-aggregation-interface" - search_criteria: - "$ref": "#/definitions/framework-search-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - aggregations - - search_criteria - - total_count - framework-search-document-interface: - type: object - description: Interface Search Document - properties: - id: - type: integer - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - id - framework-search-aggregation-interface: - type: object - description: Interface Aggregation to get faceted data - properties: - buckets: - type: array - description: All Document fields - items: - "$ref": "#/definitions/framework-search-bucket-interface" - bucket_names: - type: array - description: Document field names - items: - type: string - required: - - buckets - - bucket_names - framework-search-bucket-interface: - type: object - description: Interface for facet Bucket - properties: - name: - type: string - description: Field name - values: - type: array - description: Field values - items: - "$ref": "#/definitions/framework-search-aggregation-value-interface" - required: - - name - - values - framework-search-aggregation-value-interface: - type: object - description: Interface Aggregation Value - properties: - value: - type: string - description: Aggregation - metrics: - type: array - description: Metrics - items: - type: string - required: - - value - - metrics - framework-search-search-criteria-interface: - type: object - description: Interface SearchCriteriaInterface - properties: - request_name: - type: string - filter_groups: - type: array - description: A list of filter groups. - items: - "$ref": "#/definitions/framework-search-filter-group" - sort_orders: - type: array - description: Sort order. - items: - "$ref": "#/definitions/framework-sort-order" - page_size: - type: integer - description: Page size. - current_page: - type: integer - description: Current page. - required: - - request_name - - filter_groups - framework-search-filter-group: - type: object - description: Groups two or more filters together using a logical OR - properties: - filters: - type: array - description: A list of filters in this group - items: - "$ref": "#/definitions/framework-filter" - framework-filter: - type: object - description: Filter which can be used by any methods from service layer. - properties: - field: - type: string - description: Field - value: - type: string - description: Value - condition_type: - type: string - description: Condition type - required: - - field - - value - framework-sort-order: - type: object - description: Data object for sort order. - properties: - field: - type: string - description: Sorting field. - direction: - type: string - description: Sorting direction. - required: - - field - - direction - checkout-data-shipping-information-interface: - type: object - description: Interface ShippingInformationInterface - properties: - shipping_address: - "$ref": "#/definitions/quote-data-address-interface" - billing_address: - "$ref": "#/definitions/quote-data-address-interface" - shipping_method_code: - type: string - description: Shipping method code - shipping_carrier_code: - type: string - description: Carrier code - extension_attributes: - "$ref": "#/definitions/checkout-data-shipping-information-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - shipping_address - - shipping_method_code - - shipping_carrier_code - checkout-data-shipping-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface - checkout-data-payment-details-interface: - type: object - description: Interface PaymentDetailsInterface - properties: - payment_methods: - type: array - items: - "$ref": "#/definitions/quote-data-payment-method-interface" - totals: - "$ref": "#/definitions/quote-data-totals-interface" - extension_attributes: - "$ref": "#/definitions/checkout-data-payment-details-extension-interface" - required: - - payment_methods - - totals - checkout-data-payment-details-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface - checkout-data-totals-information-interface: - type: object - description: Interface TotalsInformationInterface - properties: - address: - "$ref": "#/definitions/quote-data-address-interface" - shipping_method_code: - type: string - description: Shipping method code - shipping_carrier_code: - type: string - description: Carrier code - extension_attributes: - "$ref": "#/definitions/checkout-data-totals-information-extension-interface" - custom_attributes: - type: array - description: Custom attributes values. - items: - "$ref": "#/definitions/framework-attribute-interface" - required: - - address - checkout-data-totals-information-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface - two-factor-auth-provider-interface: - type: object - description: 2FA provider interface - properties: - enabled: - type: boolean - description: True if this provider has been enabled by admin - engine: - "$ref": "#/definitions/two-factor-auth-engine-interface" - code: - type: string - description: Provider code - name: - type: string - description: Provider name - icon: - type: string - description: Icon - reset_allowed: - type: boolean - description: True if this provider configuration can be reset - configure_action: - type: string - description: Configure action - auth_action: - type: string - description: Auth action - extra_actions: - type: array - description: Allowed extra actions - items: - type: string - required: - - enabled - - engine - - code - - name - - icon - - reset_allowed - - configure_action - - auth_action - - extra_actions - two-factor-auth-engine-interface: - type: object - description: 2FA engine interface - properties: - enabled: - type: boolean - description: True if this provider has been enabled by admin - required: - - enabled - two-factor-auth-data-google-configure-interface: - type: object - description: Google configuration data interface - properties: - qr_code_base64: - type: string - description: Value for QR code base 64 - secret_code: - type: string - description: Value for secret code - extension_attributes: - "$ref": "#/definitions/two-factor-auth-data-google-configure-extension-interface" - required: - - qr_code_base64 - - secret_code - two-factor-auth-data-google-configure-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface - two-factor-auth-data-authy-device-interface: - type: object - description: Authy device data interface - properties: - country: - type: string - description: The country - phone_number: - type: string - description: The phone number - method: - type: string - description: The method to authenticate with - extension_attributes: - "$ref": "#/definitions/two-factor-auth-data-authy-device-extension-interface" - required: - - country - - phone_number - - method - two-factor-auth-data-authy-device-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyDeviceInterface - two-factor-auth-data-authy-registration-prompt-response-interface: - type: object - description: Response for device registration prompt - properties: - message: - type: string - description: The message - expiration_seconds: - type: string - description: The seconds to expire - extension_attributes: - "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-extension-interface" - required: - - message - - expiration_seconds - two-factor-auth-data-authy-registration-prompt-response-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface - two-factor-auth-data-u2f-web-authn-request-interface: - type: object - description: Represents a WebAuthn dataset - properties: - credential_request_options_json: - type: string - description: The needed data to initiate a WebAuthn registration ceremony - extension_attributes: - "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-extension-interface" - required: - - credential_request_options_json - two-factor-auth-data-u2f-web-authn-request-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestInterface - gift-card-account-data-gift-card-account-interface: - type: object - description: Gift Card Account data - properties: - gift_cards: - type: array - description: Cards codes. - items: - type: string - gift_cards_amount: - type: number - description: Cards amount in quote currency. - base_gift_cards_amount: - type: number - description: Cards amount in base currency. - gift_cards_amount_used: - type: number - description: Cards amount used in quote currency. - base_gift_cards_amount_used: - type: number - description: Cards amount used in base currency. - extension_attributes: - "$ref": "#/definitions/gift-card-account-data-gift-card-account-extension-interface" - required: - - gift_cards_amount - - base_gift_cards_amount - - gift_cards_amount_used - - base_gift_cards_amount_used - gift-card-account-data-gift-card-account-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface - inventory-in-store-pickup-api-data-search-result-interface: - type: object - description: Search results for providing pickup locations. - properties: - items: - type: array - description: Items list. - items: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-interface" - search_request: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_request - - total_count - inventory-in-store-pickup-api-data-pickup-location-interface: - type: object - description: Represents sources projection on In-Store Pickup context. Realisation - must follow immutable DTO concept. Partial immutability done according to restriction - of current Extension Attributes implementation. - properties: - pickup_location_code: - type: string - description: Source code of Pickup Location. - name: - type: string - description: Pickup Location name. - email: - type: string - description: Pickup Location contact email. - fax: - type: string - description: Fax contact info. - contact_name: - type: string - description: Pickup Location contact name. - description: - type: string - description: Pickup Location description. - latitude: - type: number - description: Pickup Location latitude. - longitude: - type: number - description: Pickup Location longitude. - country_id: - type: string - description: Pickup Location country ID. - region_id: - type: integer - description: Pickup Location region ID. - region: - type: string - description: Pickup Location region. - city: - type: string - description: Pickup Location city. - street: - type: string - description: Pickup Location street. - postcode: - type: string - description: Pickup Location postcode. - phone: - type: string - description: Pickup Location phone. - extension_attributes: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-extension-interface" - required: - - pickup_location_code - inventory-in-store-pickup-api-data-pickup-location-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface - inventory-in-store-pickup-api-data-search-request-interface: - type: object - description: 'Endpoint used to search Pickup Locations by different parameters: - - by attribute filters fields @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\FiltersInterface - - by distance to the address @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\AreaInterface - Also, endpoint supports paging and sort orders.' - properties: - area: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-area-interface" - filters: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filters-interface" - page_size: - type: integer - description: Page size. - current_page: - type: integer - description: Current page. - scope_type: - type: string - description: Sales Channel Type. - scope_code: - type: string - description: Sales Channel code. - sort: - type: array - description: Sort Order. - items: - "$ref": "#/definitions/framework-sort-order" - extension_attributes: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-extension-interface" - required: - - current_page - - scope_type - - scope_code - inventory-in-store-pickup-api-data-search-request-area-interface: - type: object - description: 'Filter by Distance to the Address. Pickup Locations will be filtered - by distance according to the geo-position of the entered address. Required fields - for the address are country and one of the field: region or city or postcode.' - properties: - radius: - type: integer - description: Search radius in KM. - search_term: - type: string - description: Search term string. - required: - - radius - - search_term - inventory-in-store-pickup-api-data-search-request-filters-interface: - type: object - description: Filter to filter by Fields. Each field may be filtered with different - condition type. Supported condition types restricted by @see \Magento\Framework\Api\SearchCriteriaInterface - properties: - country: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - postcode: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - region: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - region_id: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - city: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - street: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - name: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - pickup_location_code: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" - inventory-in-store-pickup-api-data-search-request-filter-interface: - type: object - description: Filter for Pickup Location search. - properties: - value: - type: string - description: Value. - condition_type: - type: string - description: Condition Type. - required: - - value - - condition_type - inventory-in-store-pickup-api-data-search-request-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequestInterface - properties: - products_info: - type: array - items: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-interface" - inventory-in-store-pickup-api-data-search-request-product-info-interface: - type: object - description: Product Info Data Transfer Object. - properties: - sku: - type: string - description: Product SKU. - extension_attributes: - "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-extension-interface" - required: - - sku - inventory-in-store-pickup-api-data-search-request-product-info-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\ProductInfoInterface - payment-services-paypal-payment-config-response-interface: - type: object - description: '' - properties: - apple_pay: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface" - google_pay: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface" - hosted_fields: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface" - smart_buttons: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface" - required: - - apple_pay - - google_pay - - hosted_fields - - smart_buttons - payment-services-paypal-data-payment-config-apple-pay-interface: - type: object - description: '' - properties: - button_styles: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface" - payment_source: - type: string - description: PaymentSource - code: - type: string - description: Code - sdk_params: - type: array - description: SDK params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - is_visible: - type: boolean - description: Visible - sort_order: - type: string - description: Sort Order - payment_intent: - type: string - description: Payment intent - title: - type: string - description: Title - required: - - button_styles - - payment_source - - code - - sdk_params - - is_visible - - sort_order - - payment_intent - - title - payment-services-paypal-data-payment-config-button-styles-interface: - type: object - description: '' - properties: - layout: - type: string - description: Layout - color: - type: string - description: Color - shape: - type: string - description: Shape - label: - type: string - description: Label - tagline: - type: boolean - description: ShowTagline - height: - type: integer - description: Height - use_default_height: - type: boolean - description: Height - required: - - layout - - color - - shape - - label - - tagline - - height - - use_default_height - payment-services-paypal-data-payment-config-sdk-params-interface: - type: object - description: '' - properties: - name: - type: string - description: Code - value: - type: string - description: Config - required: - - name - - value - payment-services-paypal-data-payment-config-google-pay-interface: - type: object - description: '' - properties: - button_styles: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-button-styles-interface" - payment_source: - type: string - description: PaymentSource - three_d_s: - type: string - description: ThreeDS - code: - type: string - description: Code - sdk_params: - type: array - description: SDK params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - is_visible: - type: boolean - description: Visible - sort_order: - type: string - description: Sort Order - payment_intent: - type: string - description: Payment intent - title: - type: string - description: Title - required: - - button_styles - - payment_source - - three_d_s - - code - - sdk_params - - is_visible - - sort_order - - payment_intent - - title - payment-services-paypal-data-payment-config-google-pay-button-styles-interface: - type: object - description: '' - properties: - color: - type: string - description: Color - height: - type: integer - description: Height - type: - type: string - description: Type - required: - - color - - height - - type - payment-services-paypal-data-payment-config-hosted-fields-interface: - type: object - description: '' - properties: - payment_source: - type: string - description: Payment Source - three_d_s: - type: string - description: ThreeDS - is_vault_enabled: - type: boolean - description: HasIsVaultEnabled - cc_vault_code: - type: string - description: CcVaultCode - requires_card_details: - type: boolean - description: RequiresCardDetails - code: - type: string - description: Code - sdk_params: - type: array - description: SDK params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - is_visible: - type: boolean - description: Visible - sort_order: - type: string - description: Sort Order - payment_intent: - type: string - description: Payment intent - title: - type: string - description: Title - required: - - payment_source - - three_d_s - - is_vault_enabled - - cc_vault_code - - requires_card_details - - code - - sdk_params - - is_visible - - sort_order - - payment_intent - - title - payment-services-paypal-data-payment-config-smart-buttons-interface: - type: object - description: '' - properties: - display_message: - type: boolean - description: CanDisplayMessage - display_venmo: - type: boolean - description: Venmo - message_styles: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface" - button_styles: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface" - app_switch_when_available: - type: boolean - description: AppSwitchWhenAvailable - code: - type: string - description: Code - sdk_params: - type: array - description: SDK params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - is_visible: - type: boolean - description: Visible - sort_order: - type: string - description: Sort Order - payment_intent: - type: string - description: Payment intent - title: - type: string - description: Title - required: - - display_message - - display_venmo - - message_styles - - button_styles - - app_switch_when_available - - code - - sdk_params - - is_visible - - sort_order - - payment_intent - - title - payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface: - type: object - description: '' - properties: - layout: - type: string - description: CanDisplayMessage - logo: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-logo-interface" - required: - - layout - - logo - payment-services-paypal-data-payment-config-smart-buttons-logo-interface: - type: object - description: '' - properties: - type: - type: string - description: CanDisplayMessage - required: - - type - payment-services-paypal-data-payment-order-interface: - type: object - description: Interface PaymentOrderInterface - properties: - id: - type: string - description: Payment order id - mp_order_id: - type: string - description: Payment order mpOrderId - status: - type: string - description: Payment order status - amount: - type: number - description: Payment order amount - currency_code: - type: string - description: Payment order currency code - required: - - id - - mp_order_id - - status - - amount - - currency_code - payment-services-paypal-data-payment-order-details-interface: - type: object - description: Interface PaymentOrderDetailsInterface - properties: - payment_source_details: - "$ref": "#/definitions/payment-services-paypal-data-payment-source-details-interface" - id: - type: string - description: Payment order id - mp_order_id: - type: string - description: Payment order mpOrderId - status: - type: string - description: Payment order status - amount: - type: number - description: Payment order amount - currency_code: - type: string - description: Payment order currency code - required: - - payment_source_details - - id - - mp_order_id - - status - - amount - - currency_code - payment-services-paypal-data-payment-source-details-interface: - type: object - description: '' - properties: - card: - "$ref": "#/definitions/payment-services-paypal-data-payment-card-details-interface" - required: - - card - payment-services-paypal-data-payment-card-details-interface: - type: object - description: '' - properties: - name: - type: string - description: Name - last_digits: - type: string - description: Last digits - card_expiry_month: - type: string - description: Card expiry month - card_expiry_year: - type: string - description: Card expiry year - bin_details: - "$ref": "#/definitions/payment-services-paypal-data-payment-card-bin-details-interface" - required: - - name - - last_digits - - card_expiry_month - - card_expiry_year - - bin_details - payment-services-paypal-data-payment-card-bin-details-interface: - type: object - description: '' - properties: - bin: - type: string - description: Bin - required: - - bin - payment-services-paypal-data-payment-sdk-params-interface: - type: object - description: '' - properties: - code: - type: string - description: The payments sdk code - params: - type: array - description: The payments sdk params - items: - "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" - required: - - code - - params - pay-pal-braintree-data-auth-data-interface: - type: object - description: Interface AuthDataInterface - properties: - client_token: - type: string - description: Client token - display_name: - type: string - description: Display name - action_success: - type: string - description: To success page - logged_in: - type: boolean - description: Logged in - store_code: - type: string - description: Current store code - required: - - display_name - - action_success - - logged_in - - store_code -x-tagGroups: -- name: applepay - tags: - - applepay/auth -- name: carts - tags: - - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} - - carts/guest-carts/{cartId}/giftCards - - carts/guest-carts/{cartId}/giftCards/{giftCardCode} -- name: customers - tags: - - customers - - customers/isEmailAvailable - - customers/password - - customers/resetPassword - - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} -- name: directory - tags: - - directory/countries - - directory/countries/{countryId} - - directory/currency -- name: guest carts - tags: - - guest-carts - - guest-carts/{cartId} - - guest-carts/{cartId}/billing-address - - guest-carts/{cartId}/collect-totals - - guest-carts/{cartId}/coupons - - guest-carts/{cartId}/coupons/{couponCode} - - guest-carts/{cartId}/estimate-shipping-methods - - guest-carts/{cartId}/gift-message - - guest-carts/{cartId}/gift-message/{itemId} - - guest-carts/{cartId}/items - - guest-carts/{cartId}/items/{itemId} - - guest-carts/{cartId}/order - - guest-carts/{cartId}/payment-information - - guest-carts/{cartId}/payment-methods - - guest-carts/{cartId}/payment-order - - guest-carts/{cartId}/payment-order/{id} - - guest-carts/{cartId}/selected-payment-method - - guest-carts/{cartId}/set-payment-information - - guest-carts/{cartId}/shipping-information - - guest-carts/{cartId}/shipping-methods - - guest-carts/{cartId}/totals - - guest-carts/{cartId}/totals-information -- name: guest giftregistry - tags: - - guest-giftregistry/{cartId}/estimate-shipping-methods -- name: integration - tags: - - integration/admin/token - - integration/customer/token -- name: inventory - tags: - - inventory/in-store-pickup/pickup-locations/ -- name: payment order - tags: - - payment-order/completeOrder -- name: payments config - tags: - - payments-config/apple-pay/{location} - - payments-config/google-pay/{location} - - payments-config/hosted-fields/{location} - - payments-config/smart-buttons/{location} - - payments-config/{location} -- name: payments sdk - tags: - - payments-sdk/{location} - - payments-sdk/{location}/{methodCode} -- name: paypal - tags: - - paypal/lineItems - - paypal/oneClick - - paypal/validatePhoneNumber -- name: products render info - tags: - - products-render-info -- name: search - tags: - - search -- name: tfa - tags: - - tfa/provider/authy/activate - - tfa/provider/authy/authenticate - - tfa/provider/authy/authenticate-onetouch - - tfa/provider/authy/configure - - tfa/provider/authy/send-token/{via} - - tfa/provider/duo_security/activate - - tfa/provider/duo_security/authenticate - - tfa/provider/duo_security/configure - - tfa/provider/google/activate - - tfa/provider/google/authenticate - - tfa/provider/google/configure - - tfa/provider/u2fkey/activate - - tfa/provider/u2fkey/authentication-challenge - - tfa/provider/u2fkey/configure - - tfa/provider/u2fkey/verify - - tfa/tfat-providers-to-activate - - tfa/tfat-user-providers diff --git a/src/pages/graphql/reference/index.md b/src/pages/graphql/reference/index.md index 86691b1e9..74dba6195 100644 --- a/src/pages/graphql/reference/index.md +++ b/src/pages/graphql/reference/index.md @@ -12,7 +12,7 @@ The Adobe Commerce and Magento Open Source GraphQL API provides a flexible, powe See the following page for the full reference documentation for the Adobe Commerce and Magento Open Source GraphQL API schema: * ​[GraphQL API reference](../../reference/graphql/saas/) -* ​[2.4.9-beta-1 GraphQL API reference](../../reference/graphql/2.4.9-beta-1/) +* ​[2.4.9 GraphQL API reference](../../reference/graphql/2.4.9/) * ​[2.4.8 GraphQL API reference](../../reference/graphql/2.4.8/) * ​[2.4.7 GraphQL API reference](../../reference/graphql/2.4.7/) * ​[2.4.6 GraphQL API reference](../../reference/graphql/2.4.6/) diff --git a/src/pages/reference/graphql/2.4.8/index.md b/src/pages/reference/graphql/2.4.8/index.md index c4ff6f34a..c487facce 100644 --- a/src/pages/reference/graphql/2.4.8/index.md +++ b/src/pages/reference/graphql/2.4.8/index.md @@ -4,5 +4,5 @@ description: Review comprehensive reference documentation for Adobe Commerce Gra keywords: - GraphQL edition: paas -frameSrc: /graphql-api/index.html +frameSrc: /graphql-api/2.4.8/index.html --- diff --git a/src/pages/reference/graphql/2.4.9-beta-1/index.md b/src/pages/reference/graphql/2.4.9/index.md similarity index 61% rename from src/pages/reference/graphql/2.4.9-beta-1/index.md rename to src/pages/reference/graphql/2.4.9/index.md index 479d98544..51440584e 100644 --- a/src/pages/reference/graphql/2.4.9-beta-1/index.md +++ b/src/pages/reference/graphql/2.4.9/index.md @@ -1,8 +1,8 @@ --- -title: GraphQL API reference (2.4.9-beta-1) +title: GraphQL API reference (2.4.9) description: Review comprehensive reference documentation for older Adobe Commerce GraphQL API schemas. keywords: - GraphQL edition: paas -frameSrc: /graphql-api/2.4.9-beta-1/index.html +frameSrc: /graphql-api/index.html --- diff --git a/static/graphql-api/2.4.9-beta-1/index.html b/static/graphql-api/2.4.8/index.html similarity index 97% rename from static/graphql-api/2.4.9-beta-1/index.html rename to static/graphql-api/2.4.8/index.html index c87093e08..68e03710c 100644 --- a/static/graphql-api/2.4.9-beta-1/index.html +++ b/static/graphql-api/2.4.8/index.html @@ -53,10 +53,8 @@
  • customer
  • customerCart
  • customerDownloadableProducts
    • -
  • customerGroup
  • customerOrders
  • customerPaymentTokens
    • -
  • customerSegments
  • dynamicBlocks
  • getHostedProUrl
  • getPayflowLinkToken
    • @@ -105,7 +103,6 @@
  • addGiftRegistryRegistrants
  • addProductsToCart
  • addProductsToCompareList
    • -
  • addProductsToNewCart
  • addProductsToRequisitionList
  • addProductsToWishlist
  • addPurchaseOrderComment
    • @@ -130,9 +127,7 @@
  • changeCustomerPassword
  • clearCart
  • clearCustomerCart
    • -
  • clearWishlist
  • closeNegotiableQuotes
    • -
  • completeOrder
  • confirmCancelOrder
  • confirmEmail
  • confirmReturn
    • @@ -169,7 +164,6 @@
  • deleteCompareList
  • deleteCustomer
  • deleteCustomerAddress
    • -
  • deleteCustomerAddressV2
  • deleteNegotiableQuoteTemplate
  • deleteNegotiableQuotes
  • deletePaymentToken
    • @@ -180,7 +174,6 @@
  • duplicateNegotiableQuote
  • estimateShippingMethods
  • estimateTotals
    • -
  • exchangeExternalCustomerToken
  • generateCustomerToken
  • generateCustomerTokenAsAdmin
  • generateNegotiableQuoteFromTemplate
    • @@ -225,7 +218,6 @@
  • sendEmailToFriend
  • sendNegotiableQuoteForReview
  • setBillingAddressOnCart
    • -
  • setCartAsInactive
  • setGiftOptionsOnCart
  • setGuestEmailOnCart
  • setLineItemNote
    • @@ -243,6 +235,7 @@
  • submitNegotiableQuoteTemplateForReview
  • subscribeEmailToNewsletter
  • syncPaymentOrder
    • +
  • trackViewedProduct
  • updateCartItems
  • updateCompany
  • updateCompanyRole
    • @@ -251,7 +244,6 @@
  • updateCompanyUser
  • updateCustomer
  • updateCustomerAddress
    • -
  • updateCustomerAddressV2
  • updateCustomerEmail
  • updateCustomerV2
  • updateGiftRegistry
    • @@ -284,7 +276,6 @@

    Types

  • AddGiftRegistryRegistrantsOutput
  • AddProductsToCartOutput
  • AddProductsToCompareListInput
    • -
  • AddProductsToNewCartOutput
  • AddProductsToRequisitionListOutput
  • AddProductsToWishlistOutput
  • AddPurchaseOrderCommentInput
    • @@ -395,12 +386,13 @@

    Types

  • CartItemUpdateInput
  • CartItems
  • CartPrices
    • -
  • CartRuleStorefront
    • +
  • CartRule
  • CartTaxItem
  • CartUserInputError
  • CartUserInputErrorType
  • CatalogAttributeApplyToEnum
  • CatalogAttributeMetadata
    • +
  • CatalogRule
  • CategoryFilterInput
  • CategoryInterface
  • CategoryProducts
    • @@ -465,7 +457,6 @@

    Types

  • ComparableAttribute
  • ComparableItem
  • CompareList
    • -
  • CompleteOrderInput
  • ComplexTextValue
  • ConfigurableAttributeOption
  • ConfigurableCartItem
    • @@ -538,7 +529,7 @@

    Types

  • CustomerCreateInput
  • CustomerDownloadableProduct
  • CustomerDownloadableProducts
    • -
  • CustomerGroupStorefront
    • +
  • CustomerGroup
  • CustomerInput
  • CustomerOrder
  • CustomerOrderSortInput
    • @@ -547,7 +538,8 @@

    Types

  • CustomerOrdersFilterInput
  • CustomerOutput
  • CustomerPaymentTokens
    • -
  • CustomerSegmentStorefront
    • +
  • CustomerSegment
    • +
  • CustomerSegmentApplyTo
  • CustomerStoreCredit
  • CustomerStoreCreditHistory
  • CustomerStoreCreditHistoryItem
    • @@ -620,11 +612,7 @@

    Types

  • EstimateAddressInput
  • EstimateTotalsInput
  • EstimateTotalsOutput
    • -
  • ExchangeExternalCustomerTokenInput
    • -
  • ExchangeExternalCustomerTokenOutput
  • ExchangeRate
    • -
  • FastlaneConfig
    • -
  • FastlaneMethodInput
  • FilterEqualTypeInput
  • FilterMatchTypeEnum
  • FilterMatchTypeInput
    • @@ -653,7 +641,6 @@

    Types

  • GiftCardShipmentItem
  • GiftCardTypeEnum
  • GiftCardWishlistItem
    • -
  • GiftCartAttributeValue
  • GiftMessage
  • GiftMessageInput
  • GiftOptionsPrices
    • @@ -686,7 +673,6 @@

    Types

  • GroupedProductItem
  • GroupedProductWishlistItem
  • GuestOrderCancelInput
    • -
  • GuestOrderInformationInput
  • HostedFieldsConfig
  • HostedFieldsInput
  • HostedProInput
    • @@ -776,6 +762,7 @@

    Types

  • OrderActionType
  • OrderAddress
  • OrderCustomerInfo
    • +
  • OrderInformationInput
  • OrderItem
  • OrderItemInterface
  • OrderItemOption
    • @@ -978,7 +965,6 @@

    Types

  • SendNegotiableQuoteForReviewOutput
  • SetBillingAddressOnCartInput
  • SetBillingAddressOnCartOutput
    • -
  • SetCartAsInactiveOutput
  • SetGiftOptionsOnCartInput
  • SetGiftOptionsOnCartOutput
  • SetGuestEmailOnCartInput
    • @@ -1113,7 +1099,7 @@

    Types

    -

    Adobe Commerce GraphQL API (2.4.9-beta-1)

    +

    Adobe Commerce GraphQL API (2.4.8)

    @@ -1126,7 +1112,7 @@
    API Endpoints
    Version
    -

    2.4.9-beta-1

    +

    2.4.8

    @@ -1441,7 +1427,6 @@
    Query
    braintree_paypal_vault_active cart_expires_in_days cart_gift_wrapping - cart_merge_preference cart_printed_card cart_summary_display_quantity catalog_default_sort_by @@ -1486,6 +1471,7 @@
    Query
    fixed_product_taxes_enable fixed_product_taxes_include_fpt_in_subtotal front + graphql_share_all_customer_groups graphql_share_customer_group grid_per_page grid_per_page_values @@ -1563,8 +1549,10 @@
    Query
    send_friend { ...SendFriendConfigurationFragment } - share_active_segments - share_applied_cart_rule + share_all_catalog_rules + share_all_sales_rule + share_applied_catalog_rules + share_applied_sales_rule shopping_cart_display_full_summary shopping_cart_display_grand_total shopping_cart_display_price @@ -1611,25 +1599,25 @@
    Response
    "availableStores": [ { "absolute_footer": "xyz789", - "allow_gift_receipt": "abc123", - "allow_gift_wrapping_on_order": "xyz789", - "allow_gift_wrapping_on_order_items": "abc123", + "allow_gift_receipt": "xyz789", + "allow_gift_wrapping_on_order": "abc123", + "allow_gift_wrapping_on_order_items": "xyz789", "allow_guests_to_write_product_reviews": "xyz789", - "allow_items": "xyz789", + "allow_items": "abc123", "allow_order": "abc123", "allow_printed_card": "xyz789", - "autocomplete_on_storefront": false, + "autocomplete_on_storefront": true, "base_currency_code": "xyz789", "base_link_url": "xyz789", "base_media_url": "abc123", "base_static_url": "abc123", - "base_url": "xyz789", + "base_url": "abc123", "braintree_3dsecure_allowspecific": true, "braintree_3dsecure_always_request_3ds": false, "braintree_3dsecure_specificcountry": "abc123", "braintree_3dsecure_threshold_amount": "xyz789", - "braintree_3dsecure_verify_3dsecure": false, - "braintree_ach_direct_debit_vault_active": false, + "braintree_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": "abc123", @@ -1638,158 +1626,158 @@
    Response
    "braintree_googlepay_btn_color": "abc123", "braintree_googlepay_cctypes": "xyz789", "braintree_googlepay_merchant_id": "abc123", - "braintree_googlepay_vault_active": true, - "braintree_local_payment_allowed_methods": "abc123", - "braintree_local_payment_fallback_button_text": "abc123", - "braintree_local_payment_redirect_on_fail": "abc123", + "braintree_googlepay_vault_active": false, + "braintree_local_payment_allowed_methods": "xyz789", + "braintree_local_payment_fallback_button_text": "xyz789", + "braintree_local_payment_redirect_on_fail": "xyz789", "braintree_merchant_account_id": "xyz789", "braintree_paypal_button_location_cart_type_credit_color": "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_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": "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_show": true, + "braintree_paypal_button_location_cart_type_messaging_show": false, "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123", - "braintree_paypal_button_location_cart_type_paylater_color": "abc123", - "braintree_paypal_button_location_cart_type_paylater_label": "xyz789", - "braintree_paypal_button_location_cart_type_paylater_shape": "abc123", + "braintree_paypal_button_location_cart_type_paylater_color": "xyz789", + "braintree_paypal_button_location_cart_type_paylater_label": "abc123", + "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789", "braintree_paypal_button_location_cart_type_paylater_show": true, - "braintree_paypal_button_location_cart_type_paypal_color": "xyz789", - "braintree_paypal_button_location_cart_type_paypal_label": "xyz789", + "braintree_paypal_button_location_cart_type_paypal_color": "abc123", + "braintree_paypal_button_location_cart_type_paypal_label": "abc123", "braintree_paypal_button_location_cart_type_paypal_shape": "abc123", - "braintree_paypal_button_location_cart_type_paypal_show": false, + "braintree_paypal_button_location_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_label": "xyz789", "braintree_paypal_button_location_checkout_type_credit_shape": "abc123", "braintree_paypal_button_location_checkout_type_credit_show": false, "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123", "braintree_paypal_button_location_checkout_type_messaging_logo": "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": 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_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_paypal_label": "xyz789", "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789", - "braintree_paypal_button_location_checkout_type_paypal_show": true, - "braintree_paypal_button_location_productpage_type_credit_color": "abc123", + "braintree_paypal_button_location_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_logo": "abc123", + "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123", "braintree_paypal_button_location_productpage_type_messaging_show": false, - "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789", - "braintree_paypal_button_location_productpage_type_paylater_color": "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_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": "abc123", "braintree_paypal_button_location_productpage_type_paypal_label": "abc123", "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123", - "braintree_paypal_button_location_productpage_type_paypal_show": true, + "braintree_paypal_button_location_productpage_type_paypal_show": false, "braintree_paypal_credit_uk_merchant_name": "abc123", "braintree_paypal_display_on_shopping_cart": false, "braintree_paypal_merchant_country": "xyz789", - "braintree_paypal_merchant_name_override": "xyz789", - "braintree_paypal_require_billing_address": true, + "braintree_paypal_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, - "cart_gift_wrapping": "abc123", - "cart_merge_preference": "xyz789", - "cart_printed_card": "abc123", + "braintree_paypal_vault_active": false, + "cart_expires_in_days": 123, + "cart_gift_wrapping": "xyz789", + "cart_printed_card": "xyz789", "cart_summary_display_quantity": 987, - "catalog_default_sort_by": "abc123", + "catalog_default_sort_by": "xyz789", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "category_url_suffix": "abc123", "check_money_order_enable_for_specific_countries": false, - "check_money_order_enabled": true, + "check_money_order_enabled": false, "check_money_order_make_check_payable_to": "xyz789", "check_money_order_max_order_total": "abc123", "check_money_order_min_order_total": "abc123", "check_money_order_new_order_status": "abc123", - "check_money_order_payment_from_specific_countries": "abc123", - "check_money_order_send_check_to": "xyz789", - "check_money_order_sort_order": 123, - "check_money_order_title": "abc123", - "cms_home_page": "abc123", + "check_money_order_payment_from_specific_countries": "xyz789", + "check_money_order_send_check_to": "abc123", + "check_money_order_sort_order": 987, + "check_money_order_title": "xyz789", + "cms_home_page": "xyz789", "cms_no_cookies": "xyz789", - "cms_no_route": "abc123", + "cms_no_route": "xyz789", "code": "abc123", "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "abc123", + "configurable_thumbnail_source": "xyz789", "contact_enabled": true, - "copyright": "abc123", - "countries_with_required_region": "xyz789", - "create_account_confirmation": false, + "copyright": "xyz789", + "countries_with_required_region": "abc123", + "create_account_confirmation": true, "customer_access_token_lifetime": 123.45, - "default_country": "xyz789", + "default_country": "abc123", "default_description": "xyz789", "default_display_currency_code": "abc123", "default_keywords": "xyz789", "default_title": "xyz789", "demonotice": 123, - "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": 123, + "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, + "fixed_product_taxes_display_prices_in_sales_modules": 987, "fixed_product_taxes_display_prices_on_product_view_page": 123, "fixed_product_taxes_enable": true, "fixed_product_taxes_include_fpt_in_subtotal": true, "front": "xyz789", - "graphql_share_customer_group": false, + "graphql_share_all_customer_groups": false, + "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": "abc123", + "head_includes": "abc123", + "head_shortcut_icon": "xyz789", "header_logo_src": "abc123", "id": 987, - "is_checkout_agreements_enabled": false, - "is_default_store": false, - "is_default_store_group": false, + "is_checkout_agreements_enabled": true, + "is_default_store": true, + "is_default_store_group": true, "is_guest_checkout_enabled": true, - "is_negotiable_quote_active": false, + "is_negotiable_quote_active": true, "is_one_page_checkout_enabled": true, - "is_requisition_list_active": "xyz789", + "is_requisition_list_active": "abc123", "list_mode": "abc123", - "list_per_page": 987, + "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": 123, - "magento_reward_general_is_enabled": "abc123", + "magento_reward_general_is_enabled": "xyz789", "magento_reward_general_is_enabled_on_front": "xyz789", "magento_reward_general_min_points_balance": "abc123", "magento_reward_general_publish_history": "abc123", "magento_reward_points_invitation_customer": "xyz789", "magento_reward_points_invitation_customer_limit": "abc123", "magento_reward_points_invitation_order": "xyz789", - "magento_reward_points_invitation_order_limit": "xyz789", + "magento_reward_points_invitation_order_limit": "abc123", "magento_reward_points_newsletter": "xyz789", "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": "xyz789", "magento_wishlist_general_is_enabled": "abc123", "max_items_in_order_summary": 987, "maximum_number_of_wishlists": "abc123", "minicart_display": false, - "minicart_max_items": 987, - "minimum_password_length": "abc123", - "newsletter_enabled": false, + "minicart_max_items": 123, + "minimum_password_length": "xyz789", + "newsletter_enabled": true, "no_route": "abc123", "optional_zip_countries": "abc123", "order_cancellation_enabled": false, @@ -1797,20 +1785,20 @@
    Response
    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": false, + "orders_invoices_credit_memos_display_shipping_amount": 123, + "orders_invoices_credit_memos_display_subtotal": 123, + "orders_invoices_credit_memos_display_zero_tax": true, "payment_payflowpro_cc_vault_active": "abc123", - "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, + "quickorder_active": false, "required_character_classes_number": "xyz789", - "returns_enabled": "xyz789", + "returns_enabled": "abc123", "root_category_id": 987, "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", @@ -1818,40 +1806,42 @@
    Response
    "sales_printed_card": "abc123", "secure_base_link_url": "abc123", "secure_base_media_url": "abc123", - "secure_base_static_url": "xyz789", + "secure_base_static_url": "abc123", "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, - "share_active_segments": true, - "share_applied_cart_rule": false, - "shopping_cart_display_full_summary": false, + "share_all_catalog_rules": false, + "share_all_sales_rule": true, + "share_applied_catalog_rules": false, + "share_applied_sales_rule": false, + "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_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": false, "show_cms_breadcrumbs": 123, "store_code": 4, - "store_group_code": "4", + "store_group_code": 4, "store_group_name": "xyz789", - "store_name": "xyz789", - "store_sort_order": 987, + "store_name": "abc123", + "store_sort_order": 123, "timezone": "abc123", - "title_prefix": "xyz789", + "title_prefix": "abc123", "title_separator": "xyz789", "title_suffix": "abc123", - "use_store_in_url": false, - "website_code": "4", - "website_id": 987, - "website_name": "xyz789", - "weight_unit": "xyz789", + "use_store_in_url": true, + "website_code": 4, + "website_id": 123, + "website_name": "abc123", + "weight_unit": "abc123", "welcome": "xyz789", "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": "abc123", + "zero_subtotal_payment_action": "xyz789", "zero_subtotal_payment_from_specific_countries": "xyz789", - "zero_subtotal_sort_order": 123, + "zero_subtotal_sort_order": 987, "zero_subtotal_title": "abc123" } ] @@ -1955,7 +1945,7 @@
    Query
    } printed_card_included rules { - ...CartRuleStorefrontFragment + ...CartRuleFragment } selected_payment_method { ...SelectedPaymentMethodFragment @@ -1970,7 +1960,7 @@
    Query
    Variables
    - 
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
    @@ -1988,20 +1978,20 @@
    Response
    AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "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, - "rules": [CartRuleStorefront], + "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -2228,41 +2218,41 @@
    Response
    {
   "data": {
     "category": {
-      "automatic_sorting": "xyz789",
+      "automatic_sorting": "abc123",
       "available_sort_by": ["abc123"],
       "breadcrumbs": [Breadcrumb],
       "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": "abc123",
+      "default_sort_by": "abc123",
+      "description": "xyz789",
       "display_mode": "xyz789",
       "filter_price_range": 987.65,
       "id": 987,
-      "image": "abc123",
+      "image": "xyz789",
       "include_in_menu": 123,
       "is_anchor": 987,
       "landing_page": 987,
-      "level": 123,
-      "meta_description": "xyz789",
-      "meta_keywords": "xyz789",
-      "meta_title": "xyz789",
+      "level": 987,
+      "meta_description": "abc123",
+      "meta_keywords": "abc123",
+      "meta_title": "abc123",
       "name": "abc123",
-      "path": "abc123",
+      "path": "xyz789",
       "path_in_store": "xyz789",
       "position": 987,
-      "product_count": 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": "xyz789",
-      "url_key": "xyz789",
+      "url_key": "abc123",
       "url_path": "abc123",
       "url_suffix": "abc123"
     }
@@ -2417,38 +2407,38 @@ 
    Response
    
         "breadcrumbs": [Breadcrumb],
         "canonical_url": "abc123",
         "children": [CategoryTree],
-        "children_count": "xyz789",
+        "children_count": "abc123",
         "cms_block": CmsBlock,
         "created_at": "abc123",
-        "custom_layout_update_file": "abc123",
+        "custom_layout_update_file": "xyz789",
         "default_sort_by": "abc123",
         "description": "xyz789",
-        "display_mode": "abc123",
-        "filter_price_range": 987.65,
-        "id": 987,
-        "image": "xyz789",
+        "display_mode": "xyz789",
+        "filter_price_range": 123.45,
+        "id": 123,
+        "image": "abc123",
         "include_in_menu": 987,
-        "is_anchor": 123,
-        "landing_page": 987,
+        "is_anchor": 987,
+        "landing_page": 123,
         "level": 987,
         "meta_description": "abc123",
         "meta_keywords": "abc123",
         "meta_title": "abc123",
-        "name": "abc123",
+        "name": "xyz789",
         "path": "xyz789",
-        "path_in_store": "xyz789",
+        "path_in_store": "abc123",
         "position": 123,
-        "product_count": 123,
+        "product_count": 987,
         "products": CategoryProducts,
         "redirect_code": 123,
-        "relative_url": "abc123",
-        "staged": true,
+        "relative_url": "xyz789",
+        "staged": false,
         "type": "CMS_PAGE",
-        "uid": "4",
+        "uid": 4,
         "updated_at": "xyz789",
         "url_key": "abc123",
-        "url_path": "abc123",
-        "url_suffix": "abc123"
+        "url_path": "xyz789",
+        "url_suffix": "xyz789"
       }
     ]
   }
@@ -2504,13 +2494,13 @@ 
    Response
    
   "data": {
     "checkoutAgreements": [
       {
-        "agreement_id": 987,
+        "agreement_id": 123,
         "checkbox_text": "xyz789",
         "content": "abc123",
         "content_height": "xyz789",
-        "is_html": true,
+        "is_html": false,
         "mode": "AUTO",
-        "name": "xyz789"
+        "name": "abc123"
       }
     ]
   }
@@ -2666,7 +2656,7 @@ 
    Query
    Variables
    - 
    {"id": 123, "identifier": "xyz789"}
+                  
    {"id": 987, "identifier": "xyz789"}
    @@ -2675,13 +2665,13 @@
    Response
    "data": { "cmsPage": { "content": "abc123", - "content_heading": "abc123", - "identifier": "xyz789", - "meta_description": "xyz789", - "meta_keywords": "xyz789", - "meta_title": "abc123", + "content_heading": "xyz789", + "identifier": "abc123", + "meta_description": "abc123", + "meta_keywords": "abc123", + "meta_title": "xyz789", "page_layout": "xyz789", - "redirect_code": 987, + "redirect_code": 123, "relative_url": "abc123", "title": "abc123", "type": "CMS_PAGE", @@ -2780,12 +2770,12 @@
    Response
    "credit": CompanyCredit, "credit_history": CompanyCreditHistory, "email": "xyz789", - "id": "4", + "id": 4, "legal_address": CompanyLegalAddress, "legal_name": "xyz789", - "name": "abc123", - "payment_methods": ["xyz789"], - "reseller_id": "abc123", + "name": "xyz789", + "payment_methods": ["abc123"], + "reseller_id": "xyz789", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -2793,7 +2783,7 @@
    Response
    "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "abc123" + "vat_tax_id": "xyz789" } } } @@ -2864,7 +2854,7 @@
    Query
    Variables
    - 
    {"uid": 4}
+                  
    {"uid": "4"}
    @@ -2873,9 +2863,9 @@
    Response
    "data": { "compareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -2934,8 +2924,8 @@
    Response
    "available_regions": [Region], "full_name_english": "xyz789", "full_name_locale": "xyz789", - "id": "abc123", - "three_letter_abbreviation": "abc123", + "id": "xyz789", + "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "xyz789" } ] @@ -3009,7 +2999,7 @@
    Query
    Variables
    - 
    {"id": "xyz789"}
+                  
    {"id": "abc123"}
    @@ -3018,9 +3008,9 @@
    Response
    "data": { "country": { "available_regions": [Region], - "full_name_english": "abc123", - "full_name_locale": "abc123", - "id": "xyz789", + "full_name_english": "xyz789", + "full_name_locale": "xyz789", + "id": "abc123", "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "xyz789" } @@ -3086,7 +3076,7 @@
    Response
    "base_currency_symbol": "xyz789", "default_display_currecy_code": "xyz789", "default_display_currecy_symbol": "xyz789", - "default_display_currency_code": "xyz789", + "default_display_currency_code": "abc123", "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } @@ -3316,7 +3306,7 @@
    Query
    ...GiftRegistryFragment } group { - ...CustomerGroupStorefrontFragment + ...CustomerGroupFragment } group_id id @@ -3363,7 +3353,7 @@
    Query
    ...CompanyRoleFragment } segments { - ...CustomerSegmentStorefrontFragment + ...CustomerSegmentFragment } status store_credit { @@ -3396,30 +3386,30 @@
    Response
    "customer": { "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "companies": UserCompaniesOutput, "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", - "created_at": "xyz789", + "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "default_billing": "xyz789", - "default_shipping": "xyz789", - "dob": "xyz789", - "email": "abc123", - "firstname": "abc123", - "gender": 123, + "default_shipping": "abc123", + "dob": "abc123", + "email": "xyz789", + "firstname": "xyz789", + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group": CustomerGroupStorefront, + "group": CustomerGroup, "group_id": 987, - "id": "4", - "is_subscribed": false, + "id": 123, + "is_subscribed": true, "job_title": "abc123", - "lastname": "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, @@ -3432,14 +3422,14 @@
    Response
    "reviews": ProductReviews, "reward_points": RewardPoints, "role": CompanyRole, - "segments": [CustomerSegmentStorefront], + "segments": [CustomerSegment], "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": 4, "suffix": "xyz789", - "taxvat": "xyz789", + "taxvat": "abc123", "team": CompanyTeam, - "telephone": "xyz789", + "telephone": "abc123", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -3525,7 +3515,7 @@
    Query
    }     printed_card_included rules { - ...CartRuleStorefrontFragment + ...CartRuleFragment } selected_payment_method { ...SelectedPaymentMethodFragment @@ -3555,15 +3545,15 @@
    Response
    "billing_address": BillingCartAddress, "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, "printed_card_included": false, - "rules": [CartRuleStorefront], + "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], "total_quantity": 123.45 @@ -3620,48 +3610,6 @@
    Response
    } } } -     -
    - - - -
    -
    - Queries -
    -

    - customerGroup -

    -
    -
    -
    -
    Description
    -

    Provides Customer Group assigned to the Customer or Guest.

    -
    -
    -
    -
    -
    -
    -
    Response
    -

    Returns a CustomerGroupStorefront! -

    -
    -
    -
    -

    Example

    -
    -
    Query
    - 
    query customerGroup {
-  customerGroup {
-    uid
-  }
-}
-
    -
    -
    -
    Response
    - 
    {"data": {"customerGroup": {"uid": "4"}}}
    @@ -3767,76 +3715,6 @@
    Response
    "customerPaymentTokens": {"items": [PaymentToken]} } } -     -
    - - -
    -
    -
    - Queries -
    -

    - customerSegments -

    -
    -
    -
    -
    Description
    -

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

    -
    -
    -
    -
    -
    -
    -
    Response
    -

    Returns [CustomerSegmentStorefront] -

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

    Example

    -
    -
    Query
    - 
    query customerSegments($cartId: String!) {
-  customerSegments(cartId: $cartId) {
-    uid
-  }
-}
-
    -
    -
    -
    Variables
    - 
    {"cartId": "xyz789"}
-
    -
    -
    -
    Response
    - 
    {
-  "data": {
-    "customerSegments": [{"uid": "4"}]
-  }
-}
    @@ -3937,7 +3815,7 @@
    Response
    "dynamicBlocks": { "items": [DynamicBlock], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -4086,7 +3964,7 @@
    Response
    "getPayflowLinkToken": { "mode": "TEST", "paypal_url": "abc123", - "secure_token": "abc123", + "secure_token": "xyz789", "secure_token_id": "abc123" } } @@ -4147,9 +4025,6 @@
    Query
    apple_pay { ...ApplePayConfigFragment } - fastlane { - ...FastlaneConfigFragment - } google_pay { ...GooglePayConfigFragment } @@ -4174,7 +4049,6 @@
    Response
    "data": { "getPaymentConfig": { "apple_pay": ApplePayConfig, - "fastlane": FastlaneConfig, "google_pay": GooglePayConfig, "hosted_fields": HostedFieldsConfig, "smart_buttons": SmartButtonsConfig @@ -4259,8 +4133,8 @@
    Query
    Variables
    {
-  "cartId": "abc123",
-  "id": "abc123"
+  "cartId": "xyz789",
+  "id": "xyz789"
 }
    @@ -4270,9 +4144,9 @@
    Response
    "data": { "getPaymentOrder": { "id": "xyz789", - "mp_order_id": "xyz789", + "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, - "status": "abc123" + "status": "xyz789" } } } @@ -4472,7 +4346,7 @@
    Response
    "giftCardAccount": { "balance": Money, "code": "xyz789", - "expiration_date": "xyz789" + "expiration_date": "abc123" } } } @@ -4557,7 +4431,7 @@
    Query
    Variables
    - 
    {"giftRegistryUid": 4}
+                  
    {"giftRegistryUid": "4"}
    @@ -4565,14 +4439,14 @@
    Response
    {
   "data": {
     "giftRegistry": {
-      "created_at": "xyz789",
+      "created_at": "abc123",
       "dynamic_attributes": [
         GiftRegistryDynamicAttribute
       ],
       "event_name": "abc123",
       "items": [GiftRegistryItemInterface],
       "message": "xyz789",
-      "owner_name": "xyz789",
+      "owner_name": "abc123",
       "privacy_settings": "PRIVATE",
       "registrants": [GiftRegistryRegistrant],
       "shipping_address": CustomerAddress,
@@ -4647,7 +4521,7 @@ 
    Query
    Variables
    - 
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
    @@ -4658,9 +4532,9 @@
    Response
    { "event_date": "xyz789", "event_title": "abc123", - "gift_registry_uid": 4, - "location": "abc123", - "name": "xyz789", + "gift_registry_uid": "4", + "location": "xyz789", + "name": "abc123", "type": "abc123" } ] @@ -4731,7 +4605,7 @@
    Query
    Variables
    - 
    {"giftRegistryUid": "4"}
+                  
    {"giftRegistryUid": 4}
    @@ -4741,11 +4615,11 @@
    Response
    "giftRegistryIdSearch": [ { "event_date": "xyz789", - "event_title": "abc123", + "event_title": "xyz789", "gift_registry_uid": "4", - "location": "xyz789", + "location": "abc123", "name": "abc123", - "type": "xyz789" + "type": "abc123" } ] } @@ -4955,7 +4829,7 @@
    Arguments
    - input - GuestOrderInformationInput! + input - OrderInformationInput! @@ -4968,7 +4842,7 @@
    Arguments

    Example

    Query
    - 
    query guestOrder($input: GuestOrderInformationInput!) {
+                  
    query guestOrder($input: OrderInformationInput!) {
   guestOrder(input: $input) {
     applied_coupons {
       ...AppliedCouponFragment
@@ -5041,7 +4915,7 @@ 
    Query
    Variables
    - 
    {"input": GuestOrderInformationInput}
+                  
    {"input": OrderInformationInput}
    @@ -5053,33 +4927,33 @@
    Response
    "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": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": false, + "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": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "xyz789", - "order_date": "xyz789", + "number": "abc123", + "order_date": "abc123", "order_number": "xyz789", - "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", + "status": "abc123", "token": "xyz789", "total": OrderTotal } @@ -5224,16 +5098,16 @@
    Response
    "billing_address": OrderAddress, "carrier": "abc123", "comments": [SalesCommentItem], - "created_at": "xyz789", + "created_at": "abc123", "credit_memos": [CreditMemo], "customer_info": OrderCustomerInfo, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "grand_total": 123.45, - "id": 4, - "increment_id": "xyz789", + "grand_total": 987.65, + "id": "4", + "increment_id": "abc123", "invoices": [Invoice], "is_virtual": true, "items": [OrderItemInterface], @@ -5382,12 +5256,12 @@
    Query
    Variables
    - 
    {"email": "abc123"}
+                  
    {"email": "xyz789"}
    Response
    - 
    {"data": {"isCompanyEmailAvailable": {"is_email_available": true}}}
+                  
    {"data": {"isCompanyEmailAvailable": {"is_email_available": false}}}
    @@ -5454,7 +5328,7 @@
    Variables
    Response
    - 
    {"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}}
+                  
    {"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}}
    @@ -5521,7 +5395,7 @@
    Variables
    Response
    - 
    {"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}}
+                  
    {"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}}
    @@ -5683,7 +5557,7 @@
    Query
    Variables
    - 
    {"uid": 4}
+                  
    {"uid": "4"}
    @@ -5697,10 +5571,10 @@
    Response
    "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "email": "xyz789", + "created_at": "abc123", + "email": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "name": "abc123", "prices": CartPrices, @@ -5709,7 +5583,7 @@
    Response
    NegotiableQuoteShippingAddress ], "status": "SUBMITTED", - "total_quantity": 123.45, + "total_quantity": 987.65, "uid": 4, "updated_at": "xyz789" } @@ -5808,7 +5682,7 @@
    Query
    Variables
    - 
    {"templateId": 4}
+                  
    {"templateId": "4"}
    @@ -5820,10 +5694,10 @@
    Response
    "comments": [NegotiableQuoteComment], "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": false, - "is_virtual": true, + "is_min_max_qty_used": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, + "max_order_commitment": 987, "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], @@ -5834,9 +5708,9 @@
    Response
    "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": 4, - "total_quantity": 987.65 + "status": "abc123", + "template_id": "4", + "total_quantity": 123.45 } } } @@ -5953,7 +5827,7 @@
    Response
    "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } } } @@ -6070,7 +5944,7 @@
    Response
    "items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } } } @@ -6389,7 +6263,7 @@
    Response
    "page_info": SearchResultPageInfo, "sort_fields": SortFields, "suggestions": [SearchSuggestion], - "total_count": 987 + "total_count": 123 } } } @@ -6518,7 +6392,7 @@
    Response
    "forms": ["PLACE_ORDER"], "is_enabled": false, "language_code": "abc123", - "minimum_score": 123.45, + "minimum_score": 987.65, "theme": "abc123", "website_key": "abc123" } @@ -6586,7 +6460,7 @@
    Query
    Variables
    - 
    {"url": "xyz789"}
+                  
    {"url": "abc123"}
    @@ -6727,7 +6601,6 @@
    Query
    braintree_paypal_vault_active cart_expires_in_days cart_gift_wrapping - cart_merge_preference cart_printed_card cart_summary_display_quantity catalog_default_sort_by @@ -6772,6 +6645,7 @@
    Query
    fixed_product_taxes_enable fixed_product_taxes_include_fpt_in_subtotal front + graphql_share_all_customer_groups graphql_share_customer_group grid_per_page grid_per_page_values @@ -6849,8 +6723,10 @@
    Query
    send_friend { ...SendFriendConfigurationFragment } - share_active_segments - share_applied_cart_rule + share_all_catalog_rules + share_all_sales_rule + share_applied_catalog_rules + share_applied_sales_rule shopping_cart_display_full_summary shopping_cart_display_grand_total shopping_cart_display_price @@ -6894,243 +6770,245 @@
    Response
    "allow_gift_receipt": "xyz789", "allow_gift_wrapping_on_order": "abc123", "allow_gift_wrapping_on_order_items": "abc123", - "allow_guests_to_write_product_reviews": "abc123", - "allow_items": "xyz789", - "allow_order": "abc123", + "allow_guests_to_write_product_reviews": "xyz789", + "allow_items": "abc123", + "allow_order": "xyz789", "allow_printed_card": "abc123", - "autocomplete_on_storefront": true, + "autocomplete_on_storefront": false, "base_currency_code": "abc123", "base_link_url": "abc123", "base_media_url": "xyz789", - "base_static_url": "xyz789", + "base_static_url": "abc123", "base_url": "abc123", - "braintree_3dsecure_allowspecific": false, - "braintree_3dsecure_always_request_3ds": false, - "braintree_3dsecure_specificcountry": "xyz789", + "braintree_3dsecure_allowspecific": true, + "braintree_3dsecure_always_request_3ds": true, + "braintree_3dsecure_specificcountry": "abc123", "braintree_3dsecure_threshold_amount": "abc123", - "braintree_3dsecure_verify_3dsecure": true, + "braintree_3dsecure_verify_3dsecure": false, "braintree_ach_direct_debit_vault_active": false, "braintree_applepay_merchant_name": "abc123", "braintree_applepay_vault_active": false, "braintree_cc_vault_active": "abc123", - "braintree_cc_vault_cvv": false, - "braintree_environment": "xyz789", - "braintree_googlepay_btn_color": "abc123", + "braintree_cc_vault_cvv": true, + "braintree_environment": "abc123", + "braintree_googlepay_btn_color": "xyz789", "braintree_googlepay_cctypes": "abc123", - "braintree_googlepay_merchant_id": "abc123", - "braintree_googlepay_vault_active": true, - "braintree_local_payment_allowed_methods": "xyz789", - "braintree_local_payment_fallback_button_text": "xyz789", - "braintree_local_payment_redirect_on_fail": "xyz789", + "braintree_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": "abc123", - "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": true, - "braintree_paypal_button_location_cart_type_messaging_layout": "abc123", + "braintree_paypal_button_location_cart_type_credit_shape": "abc123", + "braintree_paypal_button_location_cart_type_credit_show": false, + "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789", "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789", "braintree_paypal_button_location_cart_type_messaging_logo_position": "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_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_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_checkout_type_credit_color": "xyz789", "braintree_paypal_button_location_checkout_type_credit_label": "abc123", "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789", - "braintree_paypal_button_location_checkout_type_credit_show": false, - "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123", + "braintree_paypal_button_location_checkout_type_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": "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_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": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_show": true, + "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789", + "braintree_paypal_button_location_checkout_type_paylater_show": false, "braintree_paypal_button_location_checkout_type_paypal_color": "abc123", - "braintree_paypal_button_location_checkout_type_paypal_label": "abc123", + "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789", "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789", "braintree_paypal_button_location_checkout_type_paypal_show": true, - "braintree_paypal_button_location_productpage_type_credit_color": "abc123", + "braintree_paypal_button_location_productpage_type_credit_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_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_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_shape": "abc123", + "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789", + "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789", "braintree_paypal_button_location_productpage_type_paylater_show": false, - "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789", + "braintree_paypal_button_location_productpage_type_paypal_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": "abc123", - "braintree_paypal_display_on_shopping_cart": true, - "braintree_paypal_merchant_country": "abc123", - "braintree_paypal_merchant_name_override": "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_merchant_country": "xyz789", + "braintree_paypal_merchant_name_override": "abc123", "braintree_paypal_require_billing_address": true, "braintree_paypal_send_cart_line_items": true, "braintree_paypal_vault_active": true, - "cart_expires_in_days": 987, - "cart_gift_wrapping": "abc123", - "cart_merge_preference": "xyz789", + "cart_expires_in_days": 123, + "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": 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": "abc123", - "check_money_order_max_order_total": "abc123", - "check_money_order_min_order_total": "xyz789", - "check_money_order_new_order_status": "xyz789", - "check_money_order_payment_from_specific_countries": "abc123", - "check_money_order_send_check_to": "xyz789", - "check_money_order_sort_order": 987, + "check_money_order_max_order_total": "xyz789", + "check_money_order_min_order_total": "abc123", + "check_money_order_new_order_status": "abc123", + "check_money_order_payment_from_specific_countries": "xyz789", + "check_money_order_send_check_to": "abc123", + "check_money_order_sort_order": 123, "check_money_order_title": "xyz789", - "cms_home_page": "xyz789", + "cms_home_page": "abc123", "cms_no_cookies": "abc123", "cms_no_route": "abc123", - "code": "xyz789", + "code": "abc123", "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "xyz789", + "configurable_thumbnail_source": "abc123", "contact_enabled": false, "copyright": "abc123", - "countries_with_required_region": "abc123", + "countries_with_required_region": "xyz789", "create_account_confirmation": true, "customer_access_token_lifetime": 987.65, "default_country": "xyz789", "default_description": "xyz789", "default_display_currency_code": "abc123", "default_keywords": "xyz789", - "default_title": "xyz789", + "default_title": "abc123", "demonotice": 123, - "display_product_prices_in_catalog": 987, + "display_product_prices_in_catalog": 123, "display_shipping_prices": 987, - "display_state_if_optional": false, + "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_emails": 123, "fixed_product_taxes_display_prices_in_product_lists": 987, - "fixed_product_taxes_display_prices_in_sales_modules": 987, - "fixed_product_taxes_display_prices_on_product_view_page": 123, + "fixed_product_taxes_display_prices_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": "abc123", + "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": "abc123", - "header_logo_src": "xyz789", - "id": 987, + "head_includes": "xyz789", + "head_shortcut_icon": "xyz789", + "header_logo_src": "abc123", + "id": 123, "is_checkout_agreements_enabled": false, "is_default_store": false, "is_default_store_group": true, - "is_guest_checkout_enabled": true, - "is_negotiable_quote_active": false, + "is_guest_checkout_enabled": false, + "is_negotiable_quote_active": true, "is_one_page_checkout_enabled": true, - "is_requisition_list_active": "xyz789", - "list_mode": "abc123", + "is_requisition_list_active": "abc123", + "list_mode": "xyz789", "list_per_page": 987, - "list_per_page_values": "abc123", + "list_per_page_values": "xyz789", "locale": "xyz789", - "logo_alt": "abc123", - "logo_height": 987, + "logo_alt": "xyz789", + "logo_height": 123, "logo_width": 123, - "magento_reward_general_is_enabled": "xyz789", - "magento_reward_general_is_enabled_on_front": "xyz789", - "magento_reward_general_min_points_balance": "xyz789", + "magento_reward_general_is_enabled": "abc123", + "magento_reward_general_is_enabled_on_front": "abc123", + "magento_reward_general_min_points_balance": "abc123", "magento_reward_general_publish_history": "xyz789", - "magento_reward_points_invitation_customer": "abc123", - "magento_reward_points_invitation_customer_limit": "abc123", + "magento_reward_points_invitation_customer": "xyz789", + "magento_reward_points_invitation_customer_limit": "xyz789", "magento_reward_points_invitation_order": "xyz789", "magento_reward_points_invitation_order_limit": "abc123", - "magento_reward_points_newsletter": "xyz789", + "magento_reward_points_newsletter": "abc123", "magento_reward_points_order": "abc123", - "magento_reward_points_register": "abc123", - "magento_reward_points_review": "xyz789", - "magento_reward_points_review_limit": "abc123", + "magento_reward_points_register": "xyz789", + "magento_reward_points_review": "abc123", + "magento_reward_points_review_limit": "xyz789", "magento_wishlist_general_is_enabled": "abc123", - "max_items_in_order_summary": 123, + "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, + "minimum_password_length": "abc123", + "newsletter_enabled": true, "no_route": "abc123", "optional_zip_countries": "abc123", - "order_cancellation_enabled": true, + "order_cancellation_enabled": false, "order_cancellation_reasons": [CancellationReason], "orders_invoices_credit_memos_display_full_summary": false, "orders_invoices_credit_memos_display_grandtotal": true, "orders_invoices_credit_memos_display_price": 123, - "orders_invoices_credit_memos_display_shipping_amount": 987, - "orders_invoices_credit_memos_display_subtotal": 123, + "orders_invoices_credit_memos_display_shipping_amount": 123, + "orders_invoices_credit_memos_display_subtotal": 987, "orders_invoices_credit_memos_display_zero_tax": true, "payment_payflowpro_cc_vault_active": "abc123", "printed_card_price": "xyz789", "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_reviews_enabled": "xyz789", - "product_url_suffix": "abc123", - "quickorder_active": true, + "product_reviews_enabled": "abc123", + "product_url_suffix": "xyz789", + "quickorder_active": false, "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": "xyz789", - "sales_printed_card": "abc123", + "sales_printed_card": "xyz789", "secure_base_link_url": "xyz789", "secure_base_media_url": "xyz789", "secure_base_static_url": "abc123", "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, - "share_active_segments": true, - "share_applied_cart_rule": true, + "share_all_catalog_rules": true, + "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": 123, - "shopping_cart_display_shipping": 987, - "shopping_cart_display_subtotal": 987, + "shopping_cart_display_grand_total": false, + "shopping_cart_display_price": 987, + "shopping_cart_display_shipping": 123, + "shopping_cart_display_subtotal": 123, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", - "shopping_cart_display_zero_tax": true, + "shopping_cart_display_zero_tax": false, "show_cms_breadcrumbs": 987, "store_code": 4, "store_group_code": "4", "store_group_name": "abc123", "store_name": "abc123", - "store_sort_order": 123, + "store_sort_order": 987, "timezone": "abc123", - "title_prefix": "xyz789", - "title_separator": "abc123", - "title_suffix": "xyz789", + "title_prefix": "abc123", + "title_separator": "xyz789", + "title_suffix": "abc123", "use_store_in_url": false, - "website_code": 4, + "website_code": "4", "website_id": 123, - "website_name": "xyz789", + "website_name": "abc123", "weight_unit": "abc123", - "welcome": "abc123", + "welcome": "xyz789", "zero_subtotal_enable_for_specific_countries": true, - "zero_subtotal_enabled": true, + "zero_subtotal_enabled": false, "zero_subtotal_new_order_status": "abc123", "zero_subtotal_payment_action": "xyz789", "zero_subtotal_payment_from_specific_countries": "xyz789", - "zero_subtotal_sort_order": 987, - "zero_subtotal_title": "abc123" + "zero_subtotal_sort_order": 123, + "zero_subtotal_title": "xyz789" } } } @@ -7206,7 +7084,7 @@
    Query
    Variables
    - 
    {"url": "xyz789"}
+                  
    {"url": "abc123"}
    @@ -7217,7 +7095,7 @@
    Response
    "canonical_url": "abc123", "entity_uid": "4", "id": 123, - "redirectCode": 123, + "redirectCode": 987, "relative_url": "abc123", "type": "CMS_PAGE" } @@ -7282,7 +7160,7 @@
    Response
    "wishlist": { "items": [WishlistItem], "items_count": 987, - "name": "abc123", + "name": "xyz789", "sharing_code": "abc123", "updated_at": "xyz789" } @@ -7457,11 +7335,11 @@
    Response
    "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": 123, - "min_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -7472,8 +7350,8 @@
    Response
    NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": "4", - "total_quantity": 123.45 + "template_id": 4, + "total_quantity": 987.65 } } } @@ -7947,87 +7825,9 @@
    Response
    "data": { "addProductsToCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": 4 - } - } -} -     -
    - - -
    -
    -
    - Mutations -
    -

    - addProductsToNewCart -

    -
    -
    -
    -
    Description
    -

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

    -
    -
    -
    -
    -
    -
    -
    Response
    -

    Returns an AddProductsToNewCartOutput -

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

    Example

    -
    -
    Query
    - 
    mutation addProductsToNewCart($cartItems: [CartItemInput!]!) {
-  addProductsToNewCart(cartItems: $cartItems) {
-    cart {
-      ...CartFragment
-    }
-    user_errors {
-      ...CartUserInputErrorFragment
-    }
-  }
-}
-
    -
    -
    -
    Variables
    - 
    {"cartItems": [CartItemInput]}
-
    -
    -
    -
    Response
    - 
    {
-  "data": {
-    "addProductsToNewCart": {
-      "cart": Cart,
-      "user_errors": [CartUserInputError]
+      "uid": "4"
     }
   }
 }
@@ -8197,7 +7997,10 @@ 
    Query
    Variables
    - 
    {"wishlistId": 4, "wishlistItems": [WishlistItemInput]}
+                  
    {
+  "wishlistId": "4",
+  "wishlistItems": [WishlistItemInput]
+}
    @@ -8442,7 +8245,10 @@
    Query
    Variables
    - 
    {"requisitionListUid": 4, "requisitionListItemUids": [4]}
+                  
    {
+  "requisitionListUid": "4",
+  "requisitionListItemUids": ["4"]
+}
    @@ -8818,10 +8624,7 @@
    Query
    Variables
    - 
    {
-  "wishlistId": "4",
-  "wishlistItemIds": ["4"]
-}
+                  
    {"wishlistId": 4, "wishlistItemIds": [4]}
    @@ -8832,7 +8635,7 @@
    Response
    "add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": false, + "status": true, "wishlist": Wishlist } } @@ -9432,7 +9235,7 @@
    Query
    } printed_card_included rules { - ...CartRuleStorefrontFragment + ...CartRuleFragment } selected_payment_method { ...SelectedPaymentMethodFragment @@ -9447,7 +9250,7 @@
    Query
    Variables
    - 
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
    @@ -9465,9 +9268,9 @@
    Response
    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, @@ -9475,10 +9278,10 @@
    Response
    "itemsV2": CartItems, "prices": CartPrices, "printed_card_included": true, - "rules": [CartRuleStorefront], + "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -9602,7 +9405,7 @@
    Response
    ], "status": "xyz789", "template_id": 4, - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -9681,7 +9484,7 @@
    Response
    {
   "data": {
     "cancelOrder": {
-      "error": "xyz789",
+      "error": "abc123",
       "errorV2": CancelOrderError,
       "order": CustomerOrder
     }
@@ -9863,7 +9666,7 @@ 
    Query
    
       ...GiftRegistryFragment
     }
     group {
-      ...CustomerGroupStorefrontFragment
+      ...CustomerGroupFragment
     }
     group_id
     id
@@ -9910,7 +9713,7 @@ 
    Query
    
       ...CompanyRoleFragment
     }
     segments {
-      ...CustomerSegmentStorefrontFragment
+      ...CustomerSegmentFragment
     }
     status
     store_credit {
@@ -9940,7 +9743,7 @@ 
    Query
    
                   
    Variables
    
                   
    {
   "currentPassword": "xyz789",
-  "newPassword": "xyz789"
+  "newPassword": "abc123"
 }
    @@ -9957,8 +9760,8 @@
    Response
    "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "xyz789", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", - "default_billing": "abc123", + "date_of_birth": "abc123", + "default_billing": "xyz789", "default_shipping": "xyz789", "dob": "abc123", "email": "abc123", @@ -9966,13 +9769,13 @@
    Response
    "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group": CustomerGroupStorefront, + "group": CustomerGroup, "group_id": 987, - "id": "4", - "is_subscribed": true, + "id": 123, + "is_subscribed": false, "job_title": "abc123", - "lastname": "xyz789", - "middlename": "xyz789", + "lastname": "abc123", + "middlename": "abc123", "orders": CustomerOrders, "prefix": "abc123", "purchase_order": PurchaseOrder, @@ -9987,14 +9790,14 @@
    Response
    "reviews": ProductReviews, "reward_points": RewardPoints, "role": CompanyRole, - "segments": [CustomerSegmentStorefront], + "segments": [CustomerSegment], "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] @@ -10152,84 +9955,6 @@
    Response
    "clearCustomerCart": {"cart": Cart, "status": false} } } -     -
    -
    - -
    -
    -
    - Mutations -
    -

    - clearWishlist -

    -
    -
    -
    -
    Description
    -

    Remove all the products from the specified wish list.

    -
    -
    -
    -
    -
    -
    -
    Response
    -

    Returns a RemoveProductsFromWishlistOutput -

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

    Example

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

    - completeOrder -

    -
    -
    -
    -
    Description
    -

    Synchronizes order details and place the order

    -
    -
    -
    -
    -
    -
    -
    Response
    -

    Returns a PlaceOrderOutput -

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

    Example

    -
    -
    Query
    - 
    mutation completeOrder($input: CompleteOrderInput) {
-  completeOrder(input: $input) {
-    errors {
-      ...PlaceOrderErrorFragment
-    }
-    order {
-      ...OrderFragment
-    }
-    orderV2 {
-      ...CustomerOrderFragment
-    }
-  }
-}
-
    -
    -
    -
    Variables
    - 
    {"input": CompleteOrderInput}
-
    -
    -
    -
    Response
    - 
    {
-  "data": {
-    "completeOrder": {
-      "errors": [PlaceOrderError],
-      "order": Order,
-      "orderV2": CustomerOrder
-    }
-  }
-}
    @@ -10696,7 +10339,7 @@
    Variables
    Response
    - 
    {"data": {"contactUs": {"status": false}}}
+                  
    {"data": {"contactUs": {"status": true}}}
    @@ -10780,7 +10423,7 @@
    Query
    Variables
    {
-  "sourceRequisitionListUid": 4,
+  "sourceRequisitionListUid": "4",
   "destinationRequisitionListUid": "4",
   "requisitionListItem": CopyItemsBetweenRequisitionListsInput
 }
@@ -10885,7 +10528,7 @@ 
    Query
    
                   
    Variables
    
                   
    {
   "sourceWishlistUid": "4",
-  "destinationWishlistUid": 4,
+  "destinationWishlistUid": "4",
   "wishlistItems": [WishlistItemCopyInput]
 }
 
    
@@ -10942,7 +10585,7 @@ 
    Query
    
                   
    Response
    
                   
    {
   "data": {
-    "createBraintreeClientToken": "abc123"
+    "createBraintreeClientToken": "xyz789"
   }
 }
 
    
@@ -11055,7 +10698,7 @@ 
    Variables
    
                   
    Response
    
                   
    {
   "data": {
-    "createBraintreePayPalVaultClientToken": "abc123"
+    "createBraintreePayPalVaultClientToken": "xyz789"
   }
 }
 
    
@@ -11413,7 +11056,7 @@ 
    Response
    
       "attributes": [ComparableAttribute],
       "item_count": 987,
       "items": [ComparableItem],
-      "uid": 4
+      "uid": "4"
     }
   }
 }
@@ -11568,7 +11211,6 @@ 
    Query
    
     street
     suffix
     telephone
-    uid
     vat_id
   }
 }
@@ -11585,29 +11227,28 @@ 
    Response
    
   "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,
-      "default_shipping": false,
+      "default_shipping": true,
       "extension_attributes": [CustomerAddressAttribute],
-      "fax": "abc123",
-      "firstname": "abc123",
-      "id": 987,
-      "lastname": "abc123",
+      "fax": "xyz789",
+      "firstname": "xyz789",
+      "id": 123,
+      "lastname": "xyz789",
       "middlename": "xyz789",
-      "postcode": "abc123",
+      "postcode": "xyz789",
       "prefix": "xyz789",
       "region": CustomerAddressRegion,
-      "region_id": 987,
-      "street": ["abc123"],
+      "region_id": 123,
+      "street": ["xyz789"],
       "suffix": "xyz789",
-      "telephone": "abc123",
-      "uid": 4,
-      "vat_id": "xyz789"
+      "telephone": "xyz789",
+      "vat_id": "abc123"
     }
   }
 }
@@ -11749,7 +11390,7 @@ 
    Variables
    Response
    - 
    {"data": {"createEmptyCart": "abc123"}}
+                  
    {"data": {"createEmptyCart": "xyz789"}}
    @@ -11965,8 +11606,8 @@
    Response
    "createPayflowProToken": { "response_message": "xyz789", "result": 987, - "result_code": 123, - "secure_token": "abc123", + "result_code": 987, + "secure_token": "xyz789", "secure_token_id": "xyz789" } } @@ -12043,10 +11684,10 @@
    Response
    {
   "data": {
     "createPaymentOrder": {
-      "amount": 123.45,
+      "amount": 987.65,
       "currency_code": "abc123",
-      "id": "xyz789",
-      "mp_order_id": "abc123",
+      "id": "abc123",
+      "mp_order_id": "xyz789",
       "status": "xyz789"
     }
   }
@@ -12123,7 +11764,7 @@ 
    Response
    
   "data": {
     "createPaypalExpressToken": {
       "paypal_urls": PaypalExpressUrlList,
-      "token": "xyz789"
+      "token": "abc123"
     }
   }
 }
@@ -12287,12 +11928,12 @@ 
    Response
    
       "approver_roles": [CompanyRole],
       "condition": PurchaseOrderApprovalRuleConditionInterface,
       "created_at": "xyz789",
-      "created_by": "abc123",
-      "description": "xyz789",
-      "name": "abc123",
+      "created_by": "xyz789",
+      "description": "abc123",
+      "name": "xyz789",
       "status": "ENABLED",
       "uid": 4,
-      "updated_at": "abc123"
+      "updated_at": "xyz789"
     }
   }
 }
@@ -12443,7 +12084,7 @@ 
    Response
    
   "data": {
     "createVaultCardPaymentToken": {
       "payment_source": PaymentSourceOutput,
-      "vault_token_id": "xyz789"
+      "vault_token_id": "abc123"
     }
   }
 }
@@ -12515,7 +12156,7 @@ 
    Response
    
                   
    {
   "data": {
     "createVaultCardSetupToken": {
-      "setup_token": "xyz789"
+      "setup_token": "abc123"
     }
   }
 }
@@ -12648,12 +12289,12 @@ 
    Query
    
                 
                 
    
                   
    Variables
    
-                  
    {"id": "4"}
+                  
    {"id": 4}
 
    
                 
    
                 
    
                   
    Response
    
-                  
    {"data": {"deleteCompanyRole": {"success": false}}}
+                  
    {"data": {"deleteCompanyRole": {"success": true}}}
 
    
                 
    
               
@@ -12706,82 +12347,8 @@ 
    Arguments
    
                 
    Example
    
                 
    
                   
    Query
    
-                  
    mutation deleteCompanyTeam($id: ID!) {
-  deleteCompanyTeam(id: $id) {
-    success
-  }
-}
-
    
-                
    
-                
    
-                  
    Variables
    
-                  
    {"id": 4}
-
    
-                
    
-                
    
-                  
    Response
    
-                  
    {"data": {"deleteCompanyTeam": {"success": true}}}
-
    
-                
    
-              
-            
-
    -
    -
    - Mutations -
    -

    - deleteCompanyUser -

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

    Delete the specified company user.

    -
    -
    -
    -
    -
    -
    -
    Response
    -

    Returns a DeleteCompanyUserOutput -

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

    Example

    -
    -
    Query
    - 
    mutation deleteCompanyUser($id: ID!) {
-  deleteCompanyUser(id: $id) {
+                  
    mutation deleteCompanyTeam($id: ID!) {
+  deleteCompanyTeam(id: $id) {
     success
   }
 }
@@ -12789,24 +12356,31 @@ 
    Query
    Variables
    - 
    {"id": "4"}
+                  
    {"id": 4}
    Response
    - 
    {"data": {"deleteCompanyUser": {"success": true}}}
+                  
    {"data": {"deleteCompanyTeam": {"success": true}}}
    -
    +
    Mutations
    -

    - deleteCompanyUserV2 +

    + deleteCompanyUser

    +
    +
    +
    +
    Use deleteCompanyUserV2 instead. The current method only deactivates the user account associated with the company.
    +
    +
    +
    @@ -12847,8 +12421,8 @@
    Arguments

    Example

    Query
    - 
    mutation deleteCompanyUserV2($id: ID!) {
-  deleteCompanyUserV2(id: $id) {
+                  
    mutation deleteCompanyUser($id: ID!) {
+  deleteCompanyUser(id: $id) {
     success
   }
 }
@@ -12856,29 +12430,29 @@ 
    Query
    Variables
    - 
    {"id": "4"}
+                  
    {"id": 4}
    Response
    - 
    {"data": {"deleteCompanyUserV2": {"success": false}}}
+                  
    {"data": {"deleteCompanyUser": {"success": true}}}
    -
    +
    Mutations

    - deleteCompareList + deleteCompanyUserV2

    Description
    -

    Delete the specified compare list.

    +

    Delete the specified company user.

    @@ -12886,7 +12460,7 @@
    Description
    Response
    -

    Returns a DeleteCompareListOutput +

    Returns a DeleteCompanyUserOutput

    @@ -12901,9 +12475,10 @@
    Arguments
    - uid - ID! + id - ID! + + - The unique ID of the compare list to be deleted. @@ -12913,38 +12488,38 @@
    Arguments

    Example

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

    - deleteCustomer + deleteCompareList

    Description
    -

    Delete customer account

    +

    Delete the specified compare list.

    @@ -12952,46 +12527,65 @@
    Description
    Response
    -

    Returns a Boolean +

    Returns a DeleteCompareListOutput

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

    Example

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

    - deleteCustomerAddress +

    + deleteCustomer

    -
    -
    -
    -
    Use deleteCustomerAddressV2 instead.
    -
    -
    -
    Description
    -

    Delete the billing or shipping address of a customer.

    +

    Delete customer account

    @@ -13002,54 +12596,30 @@
    Response

    Returns a Boolean

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

    Example

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

    - deleteCustomerAddressV2 + deleteCustomerAddress

    @@ -13078,9 +12648,9 @@
    Arguments
    - uid - ID! + id - Int! - The unique ID of the customer address to be deleted. + The ID of the customer address to be deleted. @@ -13090,19 +12660,19 @@
    Arguments

    Example

    Query
    - 
    mutation deleteCustomerAddressV2($uid: ID!) {
-  deleteCustomerAddressV2(uid: $uid)
+                  
    mutation deleteCustomerAddress($id: Int!) {
+  deleteCustomerAddress(id: $id)
 }
    Variables
    - 
    {"uid": 4}
+                  
    {"id": 987}
    Response
    - 
    {"data": {"deleteCustomerAddressV2": true}}
+                  
    {"data": {"deleteCustomerAddress": true}}
    @@ -13468,7 +13038,7 @@
    Query
    Variables
    - 
    {"requisitionListUid": "4"}
+                  
    {"requisitionListUid": 4}
    @@ -13556,8 +13126,8 @@
    Query
    Variables
    {
-  "requisitionListUid": "4",
-  "requisitionListItemUids": [4]
+  "requisitionListUid": 4,
+  "requisitionListItemUids": ["4"]
 }
    @@ -13805,12 +13375,12 @@
    Response
    "estimateShippingMethods": [ { "amount": Money, - "available": false, + "available": true, "base_amount": Money, - "carrier_code": "abc123", + "carrier_code": "xyz789", "carrier_title": "xyz789", - "error_message": "xyz789", - "method_code": "xyz789", + "error_message": "abc123", + "method_code": "abc123", "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money @@ -13886,82 +13456,6 @@
    Variables
    Response
    {"data": {"estimateTotals": {"cart": Cart}}}
-
    -
    -
    - -
    -
    -
    - Mutations -
    -

    - exchangeExternalCustomerToken -

    -
    -
    -
    -
    Description
    -

    Generate a token for specified customer.

    -
    -
    -
    -
    -
    -
    -
    Response
    -

    Returns an ExchangeExternalCustomerTokenOutput -

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

    Example

    -
    -
    Query
    - 
    mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInput) {
-  exchangeExternalCustomerToken(input: $input) {
-    customer {
-      ...CustomerFragment
-    }
-    token
-  }
-}
-
    -
    -
    -
    Variables
    - 
    {"input": ExchangeExternalCustomerTokenInput}
-
    -
    -
    -
    Response
    - 
    {
-  "data": {
-    "exchangeExternalCustomerToken": {
-      "customer": Customer,
-      "token": "abc123"
-    }
-  }
-}
    @@ -14035,7 +13529,7 @@
    Query
    Variables
    {
-  "email": "xyz789",
+  "email": "abc123",
   "password": "xyz789"
 }
    @@ -14045,7 +13539,7 @@
    Response
    {
   "data": {
     "generateCustomerToken": {
-      "token": "xyz789"
+      "token": "abc123"
     }
   }
 }
@@ -14365,7 +13859,7 @@ 
    Query
    
     }
     printed_card_included
     rules {
-      ...CartRuleStorefrontFragment
+      ...CartRuleFragment
     }
     selected_payment_method {
       ...SelectedPaymentMethodFragment
@@ -14382,7 +13876,7 @@ 
    Query
    
                   
    Variables
    
                   
    {
   "source_cart_id": "xyz789",
-  "destination_cart_id": "abc123"
+  "destination_cart_id": "xyz789"
 }
    @@ -14403,15 +13897,15 @@
    Response
    "billing_address": BillingCartAddress, "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "id": 4, - "is_virtual": false, + "id": "4", + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, - "rules": [CartRuleStorefront], + "printed_card_included": true, + "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], "total_quantity": 987.65 @@ -14496,7 +13990,7 @@
    Query
    Variables
    - 
    {"cartUid": 4, "giftRegistryUid": 4}
+                  
    {"cartUid": "4", "giftRegistryUid": 4}
    @@ -14596,7 +14090,7 @@
    Query
    Variables
    {
-  "sourceRequisitionListUid": "4",
+  "sourceRequisitionListUid": 4,
   "destinationRequisitionListUid": "4",
   "requisitionListItem": MoveItemsBetweenRequisitionListsInput
 }
@@ -14776,7 +14270,7 @@ 
    Query
    
                   
    Variables
    
                   
    {
   "sourceWishlistUid": "4",
-  "destinationWishlistUid": 4,
+  "destinationWishlistUid": "4",
   "wishlistItems": [WishlistItemMoveInput]
 }
 
    
@@ -14894,13 +14388,13 @@ 
    Response
    
     "openNegotiableQuoteTemplate": {
       "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": 123,
-      "min_order_commitment": 123,
+      "max_order_commitment": 987,
+      "min_order_commitment": 987,
       "name": "xyz789",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
@@ -14910,9 +14404,9 @@ 
    Response
    
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "xyz789",
-      "template_id": 4,
-      "total_quantity": 123.45
+      "status": "abc123",
+      "template_id": "4",
+      "total_quantity": 987.65
     }
   }
 }
@@ -15635,12 +15129,12 @@ 
    Query
    Variables
    - 
    {"giftRegistryUid": 4}
+                  
    {"giftRegistryUid": "4"}
    Response
    - 
    {"data": {"removeGiftRegistry": {"success": false}}}
+                  
    {"data": {"removeGiftRegistry": {"success": true}}}
    @@ -15803,7 +15297,7 @@
    Query
    Variables
    {
   "giftRegistryUid": "4",
-  "registrantsUid": ["4"]
+  "registrantsUid": [4]
 }
    @@ -16060,12 +15554,12 @@
    Response
    "removeNegotiableQuoteTemplateItems": { "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, + "max_order_commitment": 123, "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], @@ -16076,9 +15570,9 @@
    Response
    "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": 4, - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -16158,9 +15652,9 @@
    Response
    "data": { "removeProductsFromCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -16241,10 +15735,7 @@
    Query
    Variables
    - 
    {
-  "wishlistId": "4",
-  "wishlistItemsIds": ["4"]
-}
+                  
    {"wishlistId": 4, "wishlistItemsIds": [4]}
    @@ -16388,7 +15879,7 @@
    Query
    Variables
    - 
    {"cartId": 4}
+                  
    {"cartId": "4"}
    @@ -16940,11 +16431,11 @@
    Response
    "comments": [NegotiableQuoteComment], "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, - "min_order_commitment": 987, + "max_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -16954,9 +16445,9 @@
    Response
    "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": "4", - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -17018,7 +16509,7 @@
    Query
    Variables
    - 
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
    @@ -17160,12 +16651,12 @@
    Query
    Variables
    - 
    {"email": "abc123"}
+                  
    {"email": "xyz789"}
    Response
    - 
    {"data": {"resendConfirmationEmail": true}}
+                  
    {"data": {"resendConfirmationEmail": false}}
    @@ -17246,7 +16737,7 @@
    Query
    Variables
    {
   "email": "xyz789",
-  "resetPasswordToken": "abc123",
+  "resetPasswordToken": "xyz789",
   "newPassword": "abc123"
 }
    @@ -17295,7 +16786,7 @@
    Query
    Response
    - 
    {"data": {"revokeCustomerToken": {"result": true}}}
+                  
    {"data": {"revokeCustomerToken": {"result": false}}}
    @@ -17516,80 +17007,6 @@
    Variables
    Response
    {"data": {"setBillingAddressOnCart": {"cart": Cart}}}
-
    -
    - - -
    -
    -
    - Mutations -
    -

    - setCartAsInactive -

    -
    -
    -
    -
    Description
    -

    Sets the cart as inactive

    -
    -
    -
    -
    -
    -
    -
    Response
    -

    Returns a SetCartAsInactiveOutput -

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

    Example

    -
    -
    Query
    - 
    mutation setCartAsInactive($cartId: String!) {
-  setCartAsInactive(cartId: $cartId) {
-    error
-    success
-  }
-}
-
    -
    -
    -
    Variables
    - 
    {"cartId": "abc123"}
-
    -
    -
    -
    Response
    - 
    {
-  "data": {
-    "setCartAsInactive": {
-      "error": "abc123",
-      "success": false
-    }
-  }
-}
    @@ -18195,7 +17612,7 @@
    Response
    "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, @@ -18209,7 +17626,7 @@
    Response
    NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, + "template_id": "4", "total_quantity": 123.45 } } @@ -18474,14 +17891,14 @@
    Response
    "setQuoteTemplateLineItemNote": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 123, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -18827,7 +18244,7 @@
    Response
    "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 987, @@ -18840,7 +18257,7 @@
    Response
    "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": "4", "total_quantity": 123.45 } @@ -18975,7 +18392,71 @@
    Variables
    Response
    - 
    {"data": {"syncPaymentOrder": false}}
+                  
    {"data": {"syncPaymentOrder": true}}
+
    
+
    + + +
    +
    +
    + Mutations +
    +

    + trackViewedProduct +

    +
    +
    +
    +
    Description
    +

    Track that a product was viewed in adobe commerce

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a Boolean +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + sku - String! + The sku for a ProductInterface object.
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    mutation trackViewedProduct($sku: String!) {
+  trackViewedProduct(sku: $sku)
+}
+
    +
    +
    +
    Variables
    + 
    {"sku": "abc123"}
+
    +
    +
    +
    Response
    + 
    {"data": {"trackViewedProduct": true}}
    @@ -19475,16 +18956,9 @@
    Response
    Mutations
    -

    +

    updateCustomerAddress

    -
    -
    -
    -
    Use updateCustomerAddressV2 instead.
    -
    -
    -
    @@ -19568,7 +19042,6 @@
    Query
    street suffix telephone - uid vat_id } } @@ -19585,169 +19058,27 @@
    Response
    "data": { "updateCustomerAddress": { "city": "abc123", - "company": "xyz789", + "company": "abc123", "country_code": "AF", "country_id": "xyz789", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], "customer_id": 123, - "default_billing": false, - "default_shipping": false, + "default_billing": true, + "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", - "firstname": "abc123", - "id": 123, + "fax": "xyz789", + "firstname": "xyz789", + "id": 987, "lastname": "abc123", "middlename": "xyz789", - "postcode": "abc123", + "postcode": "xyz789", "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 987, "street": ["abc123"], "suffix": "xyz789", - "telephone": "xyz789", - "uid": "4", - "vat_id": "abc123" - } - } -} -     -
    -
    -
    -
    -
    -
    - Mutations -
    -

    - updateCustomerAddressV2 -

    -
    -
    -
    -
    Description
    -

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

    -
    -
    -
    -
    -
    -
    -
    Response
    -

    Returns a CustomerAddress -

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

    Example

    -
    -
    Query
    - 
    mutation updateCustomerAddressV2(
-  $uid: ID!,
-  $input: CustomerAddressInput
-) {
-  updateCustomerAddressV2(
-    uid: $uid,
-    input: $input
-  ) {
-    city
-    company
-    country_code
-    country_id
-    custom_attributes {
-      ...CustomerAddressAttributeFragment
-    }
-    custom_attributesV2 {
-      ...AttributeValueInterfaceFragment
-    }
-    customer_id
-    default_billing
-    default_shipping
-    extension_attributes {
-      ...CustomerAddressAttributeFragment
-    }
-    fax
-    firstname
-    id
-    lastname
-    middlename
-    postcode
-    prefix
-    region {
-      ...CustomerAddressRegionFragment
-    }
-    region_id
-    street
-    suffix
-    telephone
-    uid
-    vat_id
-  }
-}
-
    -
    -
    -
    Variables
    - 
    {
-  "uid": "4",
-  "input": CustomerAddressInput
-}
-
    -
    -
    -
    Response
    - 
    {
-  "data": {
-    "updateCustomerAddressV2": {
-      "city": "abc123",
-      "company": "abc123",
-      "country_code": "AF",
-      "country_id": "abc123",
-      "custom_attributes": [CustomerAddressAttribute],
-      "custom_attributesV2": [AttributeValueInterface],
-      "customer_id": 123,
-      "default_billing": false,
-      "default_shipping": false,
-      "extension_attributes": [CustomerAddressAttribute],
-      "fax": "abc123",
-      "firstname": "xyz789",
-      "id": 987,
-      "lastname": "abc123",
-      "middlename": "abc123",
-      "postcode": "abc123",
-      "prefix": "xyz789",
-      "region": CustomerAddressRegion,
-      "region_id": 123,
-      "street": ["xyz789"],
-      "suffix": "xyz789",
-      "telephone": "xyz789",
-      "uid": 4,
+      "telephone": "abc123",
       "vat_id": "abc123"
     }
   }
@@ -19827,8 +19158,8 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "email": "abc123",
-  "password": "xyz789"
+  "email": "xyz789",
+  "password": "abc123"
 }
 
    
                 
    
@@ -20394,7 +19725,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "wishlistId": "4",
+  "wishlistId": 4,
   "wishlistItems": [WishlistItemUpdateInput]
 }
 
    
@@ -20498,11 +19829,11 @@ 
    Response
    
       "condition": PurchaseOrderApprovalRuleConditionInterface,
       "created_at": "abc123",
       "created_by": "abc123",
-      "description": "abc123",
-      "name": "xyz789",
+      "description": "xyz789",
+      "name": "abc123",
       "status": "ENABLED",
-      "uid": 4,
-      "updated_at": "abc123"
+      "uid": "4",
+      "updated_at": "xyz789"
     }
   }
 }
@@ -20582,7 +19913,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "requisitionListUid": 4,
+  "requisitionListUid": "4",
   "input": UpdateRequisitionListInput
 }
 
    
@@ -20671,7 +20002,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "requisitionListUid": "4",
+  "requisitionListUid": 4,
   "requisitionListItems": [
     UpdateRequisitionListItemsInput
   ]
@@ -20770,8 +20101,8 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "wishlistId": "4",
-  "name": "abc123",
+  "wishlistId": 4,
+  "name": "xyz789",
   "visibility": "PUBLIC"
 }
 
    
@@ -20781,7 +20112,7 @@ 
    Response
    
                   
    {
   "data": {
     "updateWishlist": {
-      "name": "abc123",
+      "name": "xyz789",
       "uid": "4",
       "visibility": "PUBLIC"
     }
@@ -20903,7 +20234,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"template_id": "4"}
+                  
    {"template_id": 4}
 
    
                 
    
               
    
@@ -20950,7 +20281,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "cart_items": [BundleProductCartItemInput]
 }
 
    
@@ -21122,7 +20453,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "cart_items": [DownloadableProductCartItemInput]
 }
 
    
@@ -21226,8 +20557,8 @@ 
    Example
    
     GiftRegistryDynamicAttributeInput
   ],
   "email": "xyz789",
-  "firstname": "abc123",
-  "lastname": "xyz789"
+  "firstname": "xyz789",
+  "lastname": "abc123"
 }
 
    
                 
    
@@ -21360,57 +20691,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {
-  "products": ["4"],
-  "uid": "4"
-}
-
    
-                
    
-              
    
-            
    
-
    -
    -
    - Types -
    -

    AddProductsToNewCartOutput

    -
    -
    -
    -
    Description
    -

    Contains details about the cart after adding products to it.

    -
    -
    -
    Fields
    - - - - - - - - - - - - - - - - - -
    Field NameDescription
    cart - Cart - The cart after products have been added.
    user_errors - [CartUserInputError] - Contains errors encountered while adding an item to the cart.
    -
    -
    -
    -
    -
    Example
    - 
    {
-  "cart": Cart,
-  "user_errors": [CartUserInputError]
-}
+                  
    {"products": [4], "uid": "4"}
    @@ -21543,7 +20824,7 @@
    Fields
    Example
    {
-  "comment": "xyz789",
+  "comment": "abc123",
   "purchase_order_uid": "4"
 }
    @@ -21637,9 +20918,9 @@
    Fields
    Example
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "purchase_order_uid": "4",
-  "replace_existing_cart_items": false
+  "replace_existing_cart_items": true
 }
    @@ -21846,10 +21127,7 @@
    Fields
    Example
    - 
    {
-  "comment_text": "abc123",
-  "return_uid": "4"
-}
+                  
    {"comment_text": "abc123", "return_uid": 4}
    @@ -21941,9 +21219,9 @@
    Fields
    Example
    {
-  "carrier_uid": 4,
-  "return_uid": "4",
-  "tracking_number": "abc123"
+  "carrier_uid": "4",
+  "return_uid": 4,
+  "tracking_number": "xyz789"
 }
    @@ -22126,7 +21404,7 @@
    Fields
    Example
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "cart_items": [VirtualProductCartItemInput]
 }
    @@ -22409,7 +21687,7 @@
    Example
    {
   "count": 987,
   "label": "xyz789",
-  "value": "xyz789"
+  "value": "abc123"
 }
    @@ -22562,7 +21840,7 @@
    Fields
    Example
    {
   "button_styles": ButtonStyles,
-  "code": "xyz789",
+  "code": "abc123",
   "is_visible": false,
   "payment_intent": "xyz789",
   "payment_source": "abc123",
@@ -22622,9 +21900,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "payment_source": "xyz789",
-  "payments_order_id": "abc123",
-  "paypal_order_id": "xyz789"
+  "payment_source": "abc123",
+  "payments_order_id": "xyz789",
+  "paypal_order_id": "abc123"
 }
 
    
                 
    
@@ -22720,9 +21998,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "applied_balance": Money,
-  "code": "xyz789",
+  "code": "abc123",
   "current_balance": Money,
-  "expiration_date": "xyz789"
+  "expiration_date": "abc123"
 }
    @@ -22775,7 +22053,7 @@
    Example
    {
   "applied_balance": Money,
   "current_balance": Money,
-  "enabled": true
+  "enabled": false
 }
    @@ -22823,8 +22101,8 @@
    Fields
    Example
    {
-  "cart_id": "abc123",
-  "coupon_code": "abc123"
+  "cart_id": "xyz789",
+  "coupon_code": "xyz789"
 }
    @@ -22966,7 +22244,7 @@
    Fields
    Example
    {
   "cart_id": "abc123",
-  "coupon_codes": ["abc123"],
+  "coupon_codes": ["xyz789"],
   "type": "APPEND"
 }
    @@ -23102,7 +22380,7 @@
    Fields
    Example
    {
   "applied_balance": Money,
-  "code": "xyz789"
+  "code": "abc123"
 }
    @@ -23182,7 +22460,7 @@
    Fields
    Example
    - 
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}
    @@ -23267,7 +22545,7 @@
    Fields
    Example
    - 
    {"radius": 987, "search_term": "abc123"}
+                  
    {"radius": 123, "search_term": "abc123"}
    @@ -23558,18 +22836,18 @@
    Fields
    Example
    {
-  "is_comparable": true,
+  "is_comparable": false,
   "is_filterable": false,
-  "is_filterable_in_search": true,
-  "is_html_allowed_on_front": true,
+  "is_filterable_in_search": false,
+  "is_html_allowed_on_front": false,
   "is_searchable": false,
   "is_used_for_customer_segment": true,
   "is_used_for_price_rules": false,
-  "is_used_for_promo_rules": true,
-  "is_visible_in_advanced_search": false,
+  "is_used_for_promo_rules": false,
+  "is_visible_in_advanced_search": true,
   "is_visible_on_front": true,
   "is_wysiwyg_enabled": false,
-  "used_in_product_listing": false
+  "used_in_product_listing": true
 }
    @@ -23764,7 +23042,7 @@
    Fields
    Example
    {
   "attribute_code": "xyz789",
-  "entity_type": "xyz789"
+  "entity_type": "abc123"
 }
    @@ -23886,7 +23164,7 @@
    Fields
    Example
    {
   "code": 4,
-  "default_value": "xyz789",
+  "default_value": "abc123",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
@@ -24044,7 +23322,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "label": "xyz789",
+  "label": "abc123",
   "value": "xyz789"
 }
 
    
@@ -24097,7 +23375,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "is_default": true,
-  "label": "xyz789",
+  "label": "abc123",
   "value": "abc123"
 }
 
    
@@ -24140,8 +23418,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "label": "xyz789",
-  "value": "abc123"
+  "label": "abc123",
+  "value": "xyz789"
 }
 
    
                 
    
@@ -24200,8 +23478,8 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "label": "abc123",
-  "value": "abc123"
+  "label": "xyz789",
+  "value": "xyz789"
 }
 
    
                 
    
@@ -24286,10 +23564,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {
-  "code": "4",
-  "value": "abc123"
-}
+                  
    {"code": 4, "value": "abc123"}
 
    
                 
    
               
    
@@ -24344,7 +23619,7 @@ 
    Example
    
                   
    {
   "attribute_code": "abc123",
   "selected_options": [AttributeInputSelectedOption],
-  "value": "abc123"
+  "value": "xyz789"
 }
 
    
                 
    
@@ -24395,11 +23670,6 @@ 
    Possible Types
    
                           
    AttributeSelectedOptions
    
                         
                       
-                      
-                        
-                          
    GiftCartAttributeValue
    
-                        
-                      
                     
                   
                 
@@ -24407,7 +23677,7 @@ 
    Possible Types
    
               
    
                 
    
                   
    Example
    
-                  
    {"code": 4}
+                  
    {"code": "4"}
 
    
                 
    
               
    
@@ -24545,7 +23815,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"code": "AFN", "symbol": "abc123"}
+                  
    {"code": "AFN", "symbol": "xyz789"}
 
    
                 
    
               
    
@@ -24595,9 +23865,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "abc123",
+  "code": "xyz789",
   "is_deferred": false,
-  "title": "abc123"
+  "title": "xyz789"
 }
 
    
                 
    
@@ -24686,13 +23956,13 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "amount": Money,
-  "available": false,
+  "available": true,
   "base_amount": Money,
   "carrier_code": "abc123",
-  "carrier_title": "abc123",
-  "error_message": "abc123",
+  "carrier_title": "xyz789",
+  "error_message": "xyz789",
   "method_code": "abc123",
-  "method_title": "abc123",
+  "method_title": "xyz789",
   "price_excl_tax": Money,
   "price_incl_tax": Money
 }
@@ -24785,12 +24055,6 @@ 
    Fields
    
                         
                          An ID from the customer's address book that uniquely identifies the address to be used for billing. 
                       
-                      
-                        
-                          customer_address_uid - ID
-                        
-                         The unique ID from the customer's address book that uniquely identifies the address to be used for billing. 
-                      
                       
                         
                           same_as_shipping - Boolean
@@ -24812,8 +24076,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "address": CartAddressInput,
-  "customer_address_id": 987,
-  "customer_address_uid": 4,
+  "customer_address_id": 123,
   "same_as_shipping": true,
   "use_for_shipping": true
 }
@@ -24887,12 +24150,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "address_line_1": "xyz789",
+  "address_line_1": "abc123",
   "address_line_2": "abc123",
   "city": "abc123",
-  "country_code": "abc123",
+  "country_code": "xyz789",
   "postal_code": "xyz789",
-  "region": "xyz789"
+  "region": "abc123"
 }
 
    
                 
    
@@ -24940,11 +24203,6 @@ 
    Fields
    
                         
                          The custom attribute values of the billing or shipping address. 
                       
-                      
-                        customer_address_uid - ID
-                        
-                         The unique ID from the customer's address book that uniquely identifies the address. 
-                      
                       
                         customer_notes - String
                         
@@ -24963,10 +24221,9 @@ 
    Fields
    
                          The first name of the customer or guest. 
                       
                       
-                        id - Int
-                        
-                         Id of the customer address. Use customer_address_uid instead.
+                        id - Int
                         
+                         Id of the customer address. 
                       
                       
                         lastname - String!
@@ -25009,9 +24266,9 @@ 
    Fields
    
                          The telephone number for the billing or shipping address. 
                       
                       
-                        uid - ID!
+                        uid - String!
                         
-                         The unique id of the customer cart address. 
+                         The unique id of the customer address. 
                       
                       
                         vat_id - String
@@ -25026,25 +24283,24 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "abc123",
+  "city": "xyz789",
   "company": "abc123",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "customer_address_uid": 4,
   "customer_notes": "abc123",
-  "fax": "abc123",
+  "fax": "xyz789",
   "firstname": "xyz789",
   "id": 987,
-  "lastname": "abc123",
-  "middlename": "abc123",
-  "postcode": "xyz789",
+  "lastname": "xyz789",
+  "middlename": "xyz789",
+  "postcode": "abc123",
   "prefix": "abc123",
   "region": CartAddressRegion,
-  "street": ["xyz789"],
-  "suffix": "abc123",
-  "telephone": "abc123",
-  "uid": 4,
-  "vat_id": "xyz789"
+  "street": ["abc123"],
+  "suffix": "xyz789",
+  "telephone": "xyz789",
+  "uid": "xyz789",
+  "vat_id": "abc123"
 }
 
    
                 
    
@@ -25064,11 +24320,6 @@ 
    Description
    
                 
               
               
    
-                
    
-                  
    Example
    
-                  
    true
-
    
-
    @@ -25164,7 +24415,7 @@
    Example
    {
   "device_data": "xyz789",
   "is_active_payment_token_enabler": false,
-  "payment_method_nonce": "abc123"
+  "payment_method_nonce": "xyz789"
 }
    @@ -25210,7 +24461,7 @@
    Fields
    Example
    {
-  "device_data": "xyz789",
+  "device_data": "abc123",
   "public_hash": "xyz789"
 }
    @@ -25278,12 +24529,12 @@
    Fields
    Example
    {
-  "category_id": 123,
+  "category_id": 987,
   "category_level": 123,
   "category_name": "abc123",
-  "category_uid": 4,
-  "category_url_key": "xyz789",
-  "category_url_path": "abc123"
+  "category_uid": "4",
+  "category_url_key": "abc123",
+  "category_url_path": "xyz789"
 }
    @@ -25418,7 +24669,7 @@
    Example
    "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "abc123", + "id": "xyz789", "is_available": false, "max_qty": 123.45, "min_qty": 123.45, @@ -25427,8 +24678,8 @@
    Example
    "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, - "uid": 4 + "quantity": 123.45, + "uid": "4" }
    @@ -25591,10 +24842,10 @@
    Example
    "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 }     @@ -25678,7 +24929,7 @@
    Example
    {
   "option_id": 987,
   "options": [BundleItemOption],
-  "position": 987,
+  "position": 123,
   "price_range": PriceRange,
   "required": true,
   "sku": "xyz789",
@@ -25777,16 +25028,16 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "can_change_quantity": false,
-  "id": 987,
+  "can_change_quantity": true,
+  "id": 123,
   "is_default": false,
-  "label": "abc123",
+  "label": "xyz789",
   "position": 123,
-  "price": 987.65,
+  "price": 123.45,
   "price_type": "FIXED",
   "product": ProductInterface,
   "qty": 987.65,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": "4"
 }
 
    
@@ -25841,7 +25092,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": 987,
+  "id": 123,
   "quantity": 123.45,
   "value": ["abc123"]
 }
@@ -26006,7 +25257,7 @@ 
    Example
    
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
   "id": 4,
-  "parent_sku": "xyz789",
+  "parent_sku": "abc123",
   "prices": OrderItemPrices,
   "product": ProductInterface,
   "product_name": "abc123",
@@ -26019,10 +25270,10 @@ 
    Example
    
   "quantity_ordered": 123.45,
   "quantity_refunded": 987.65,
   "quantity_return_requested": 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"
 }
 
    
                 
    
@@ -26418,6 +25669,11 @@ 
    currentPage
                         
                       
+                      
+                        rules - [CatalogRule]
+                        
+                         Provides applied catalog rules in the current active cart 
+                      
                       
                         sale - Int
                         
@@ -26605,49 +25861,49 @@ 
    Example
    
                   
    {
   "activity": "abc123",
   "attribute_set_id": 987,
-  "canonical_url": "xyz789",
+  "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "xyz789",
-  "climate": "abc123",
-  "collar": "xyz789",
-  "color": 123,
+  "category_gear": "abc123",
+  "climate": "xyz789",
+  "collar": "abc123",
+  "color": 987,
   "country_of_manufacture": "abc123",
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "dynamic_price": false,
   "dynamic_sku": true,
-  "dynamic_weight": true,
-  "eco_collection": 123,
-  "erin_recommends": 987,
+  "dynamic_weight": false,
+  "eco_collection": 987,
+  "erin_recommends": 123,
   "features_bags": "xyz789",
-  "format": 123,
+  "format": 987,
   "gender": "xyz789",
-  "gift_message_available": false,
-  "gift_wrapping_available": false,
+  "gift_message_available": true,
+  "gift_wrapping_available": true,
   "gift_wrapping_price": Money,
-  "id": 987,
+  "id": 123,
   "image": ProductImage,
   "is_returnable": "xyz789",
   "items": [BundleItem],
-  "manufacturer": 123,
+  "manufacturer": 987,
   "material": "xyz789",
-  "max_sale_qty": 123.45,
+  "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
-  "meta_keyword": "abc123",
+  "meta_description": "xyz789",
+  "meta_keyword": "xyz789",
   "meta_title": "abc123",
   "min_sale_qty": 987.65,
-  "name": "abc123",
+  "name": "xyz789",
   "new": 123,
-  "new_from_date": "abc123",
-  "new_to_date": "xyz789",
-  "only_x_left_in_stock": 987.65,
+  "new_from_date": "xyz789",
+  "new_to_date": "abc123",
+  "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_details": PriceDetails,
@@ -26655,33 +25911,34 @@ 
    Example
    
   "price_tiers": [TierPrice],
   "price_view": "PRICE_RANGE",
   "product_links": [ProductLinksInterface],
-  "purpose": 123,
-  "quantity": 123.45,
-  "rating_summary": 123.45,
+  "purpose": 987,
+  "quantity": 987.65,
+  "rating_summary": 987.65,
   "redirect_code": 987,
   "related_products": [ProductInterface],
-  "relative_url": "xyz789",
-  "review_count": 987,
+  "relative_url": "abc123",
+  "review_count": 123,
   "reviews": ProductReviews,
-  "sale": 123,
+  "rules": [CatalogRule],
+  "sale": 987,
   "ship_bundle_items": "TOGETHER",
   "short_description": ComplexTextValue,
-  "size": 123,
+  "size": 987,
   "sku": "abc123",
   "sleeve": "xyz789",
   "small_image": ProductImage,
   "special_from_date": "abc123",
-  "special_price": 123.45,
+  "special_price": 987.65,
   "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": "abc123",
-  "swatch_image": "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",
@@ -26689,11 +25946,11 @@ 
    Example
    
   "updated_at": "abc123",
   "upsell_products": [ProductInterface],
   "url_key": "abc123",
-  "url_path": "abc123",
+  "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "abc123",
+  "url_suffix": "xyz789",
   "websites": [Website],
-  "weight": 987.65
+  "weight": 123.45
 }
 
    
                 
    
@@ -26890,7 +26147,7 @@ 
    Example
    
   "order_item": OrderItemInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
+  "product_sku": "abc123",
   "quantity_shipped": 987.65
 }
    @@ -26965,10 +26222,10 @@
    Example
    "added_at": "xyz789", "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", + "description": "abc123", + "id": 4, "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 }     @@ -27035,11 +26292,11 @@
    Fields
    Example
    {
-  "color": "xyz789",
+  "color": "abc123",
   "height": 123,
   "label": "xyz789",
-  "layout": "abc123",
-  "shape": "abc123",
+  "layout": "xyz789",
+  "shape": "xyz789",
   "tagline": false,
   "use_default_height": false
 }
@@ -27089,8 +26346,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cancellation_comment": "xyz789",
-  "template_id": "4"
+  "cancellation_comment": "abc123",
+  "template_id": 4
 }
 
    
                 
    
@@ -27252,7 +26509,10 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"order_id": 4, "reason": "abc123"}
+                  
    {
+  "order_id": "4",
+  "reason": "xyz789"
+}
 
    
                 
    
               
    
@@ -27438,7 +26698,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"bin": "abc123"}
+                  
    {"bin": "xyz789"}
 
    
                 
    
               
    
@@ -27537,8 +26797,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "brand": "abc123",
-  "expiry": "abc123",
+  "brand": "xyz789",
+  "expiry": "xyz789",
   "last_digits": "abc123"
 }
 
    
@@ -27683,7 +26943,7 @@ 
    sort Indicates whether the shopper requested a printed card for the cart. 
                       
                       
-                        rules - [CartRuleStorefront]
+                        rules - [CartRule]
                         
                          Provides applied cart rules in the current active cart 
                       
@@ -27718,7 +26978,7 @@ 
    Example
    
   "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,
@@ -27727,11 +26987,11 @@ 
    Example
    
   "items": [CartItemInterface],
   "itemsV2": CartItems,
   "prices": CartPrices,
-  "printed_card_included": true,
-  "rules": [CartRuleStorefront],
+  "printed_card_included": false,
+  "rules": [CartRule],
   "selected_payment_method": SelectedPaymentMethod,
   "shipping_addresses": [ShippingCartAddress],
-  "total_quantity": 123.45
+  "total_quantity": 987.65
 }
    @@ -27898,7 +27158,7 @@
    Fields
    - telephone - String! + telephone - String The telephone number for the billing or shipping address. @@ -27916,23 +27176,23 @@
    Fields
    Example
    {
-  "city": "abc123",
+  "city": "xyz789",
   "company": "abc123",
   "country_code": "xyz789",
   "custom_attributes": [AttributeValueInput],
   "fax": "xyz789",
-  "firstname": "xyz789",
+  "firstname": "abc123",
   "lastname": "xyz789",
   "middlename": "xyz789",
-  "postcode": "xyz789",
-  "prefix": "abc123",
-  "region": "xyz789",
-  "region_id": 123,
-  "save_in_address_book": false,
+  "postcode": "abc123",
+  "prefix": "xyz789",
+  "region": "abc123",
+  "region_id": 987,
+  "save_in_address_book": true,
   "street": ["abc123"],
   "suffix": "xyz789",
-  "telephone": "abc123",
-  "vat_id": "abc123"
+  "telephone": "xyz789",
+  "vat_id": "xyz789"
 }
    @@ -27976,11 +27236,6 @@
    Fields
    The custom attribute values of the billing or shipping address. - - customer_address_uid - ID - - The unique ID from the customer's address book that uniquely identifies the address. - fax - String @@ -27992,10 +27247,9 @@
    Fields
    The first name of the customer or guest. - id - Int - - Id of the customer address. Use customer_address_uid instead. + id - Int + Id of the customer address. lastname - String! @@ -28038,9 +27292,9 @@
    Fields
    The telephone number for the billing or shipping address. - uid - ID! + uid - String! - The unique id of the customer cart address. + The unique id of the customer address. vat_id - String @@ -28078,23 +27332,22 @@
    Possible Types
    Example
    {
   "city": "abc123",
-  "company": "abc123",
+  "company": "xyz789",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "customer_address_uid": 4,
-  "fax": "xyz789",
+  "fax": "abc123",
   "firstname": "xyz789",
-  "id": 123,
-  "lastname": "xyz789",
+  "id": 987,
+  "lastname": "abc123",
   "middlename": "abc123",
   "postcode": "abc123",
-  "prefix": "abc123",
+  "prefix": "xyz789",
   "region": CartAddressRegion,
-  "street": ["abc123"],
+  "street": ["xyz789"],
   "suffix": "abc123",
-  "telephone": "xyz789",
-  "uid": "4",
-  "vat_id": "xyz789"
+  "telephone": "abc123",
+  "uid": "xyz789",
+  "vat_id": "abc123"
 }
    @@ -28145,9 +27398,9 @@
    Fields
    Example
    {
-  "code": "xyz789",
-  "label": "abc123",
-  "region_id": 987
+  "code": "abc123",
+  "label": "xyz789",
+  "region_id": 123
 }
    @@ -28279,7 +27532,7 @@
    Fields
    Example
    - 
    {"code": "UNDEFINED", "message": "abc123"}
+                  
    {"code": "UNDEFINED", "message": "xyz789"}
    @@ -28396,10 +27649,10 @@
    Fields
    Example
    {
   "entered_options": [EnteredOptionInput],
-  "parent_sku": "abc123",
-  "quantity": 987.65,
+  "parent_sku": "xyz789",
+  "quantity": 123.45,
   "selected_options": [4],
-  "sku": "xyz789"
+  "sku": "abc123"
 }
    @@ -28523,12 +27776,12 @@
    Possible Types
    -

    DownloadableCartItem

    +

    BundleCartItem

    -

    BundleCartItem

    +

    DownloadableCartItem

    @@ -28546,11 +27799,11 @@
    Example
    {
   "discount": [Discount],
   "errors": [CartItemError],
-  "id": "xyz789",
+  "id": "abc123",
   "is_available": false,
   "max_qty": 123.45,
   "min_qty": 987.65,
-  "not_available_message": "abc123",
+  "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
@@ -28706,7 +27959,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"cart_item_id": 987, "quantity": 987.65}
+                  
    {"cart_item_id": 123, "quantity": 987.65}
 
    
                 
    
               
    
@@ -28830,12 +28083,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_item_id": 987,
+  "cart_item_id": 123,
   "cart_item_uid": "4",
   "customizable_options": [CustomizableOptionInput],
   "gift_message": GiftMessageInput,
-  "gift_wrapping_id": 4,
-  "quantity": 123.45
+  "gift_wrapping_id": "4",
+  "quantity": 987.65
 }
 
    
                 
    
@@ -28982,11 +28235,11 @@ 
    Example
    -
    +
    Types
    -

    CartRuleStorefront

    +

    CartRule

    @@ -29000,9 +28253,9 @@
    Fields
    - uid - ID! + name - String! - The unique ID for a CartRule object. + Name of the cart price rule @@ -29011,7 +28264,7 @@
    Fields
    Example
    - 
    {"uid": "4"}
+                  
    {"name": "abc123"}
    @@ -29057,7 +28310,7 @@
    Fields
    Example
    {
   "amount": Money,
-  "label": "xyz789"
+  "label": "abc123"
 }
    @@ -29100,7 +28353,7 @@
    Fields
    Example
    {
   "code": "PRODUCT_NOT_FOUND",
-  "message": "abc123"
+  "message": "xyz789"
 }
    @@ -29422,19 +28675,19 @@
    Fields
    Example
    {
   "apply_to": ["SIMPLE"],
-  "code": "4",
-  "default_value": "abc123",
+  "code": 4,
+  "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
-  "is_comparable": false,
+  "is_comparable": true,
   "is_filterable": true,
   "is_filterable_in_search": false,
   "is_html_allowed_on_front": false,
-  "is_required": false,
-  "is_searchable": true,
+  "is_required": true,
+  "is_searchable": false,
   "is_unique": true,
-  "is_used_for_price_rules": true,
+  "is_used_for_price_rules": false,
   "is_used_for_promo_rules": true,
   "is_visible_in_advanced_search": false,
   "is_visible_on_front": false,
@@ -29443,9 +28696,44 @@ 
    Example
    
   "options": [CustomAttributeOptionInterface],
   "swatch_input_type": "BOOLEAN",
   "update_product_preview_image": true,
-  "use_product_image_for_swatch": false,
+  "use_product_image_for_swatch": true,
   "used_in_product_listing": true
 }
+
    +
    + + +
    +
    +
    + Types +
    +

    CatalogRule

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Field NameDescription
    name - String! + Name of the catalog rule
    +
    +
    +
    +
    +
    Example
    + 
    {"name": "xyz789"}
    @@ -29787,37 +29075,37 @@
    Possible Types
    Example
    {
   "automatic_sorting": "xyz789",
-  "available_sort_by": ["xyz789"],
+  "available_sort_by": ["abc123"],
   "breadcrumbs": [Breadcrumb],
-  "canonical_url": "xyz789",
-  "children_count": "xyz789",
+  "canonical_url": "abc123",
+  "children_count": "abc123",
   "cms_block": CmsBlock,
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "custom_layout_update_file": "abc123",
-  "default_sort_by": "abc123",
+  "default_sort_by": "xyz789",
   "description": "xyz789",
-  "display_mode": "abc123",
-  "filter_price_range": 123.45,
+  "display_mode": "xyz789",
+  "filter_price_range": 987.65,
   "id": 123,
-  "image": "xyz789",
+  "image": "abc123",
   "include_in_menu": 987,
   "is_anchor": 123,
   "landing_page": 987,
-  "level": 987,
+  "level": 123,
   "meta_description": "abc123",
-  "meta_keywords": "abc123",
+  "meta_keywords": "xyz789",
   "meta_title": "xyz789",
-  "name": "abc123",
-  "path": "abc123",
+  "name": "xyz789",
+  "path": "xyz789",
   "path_in_store": "abc123",
-  "position": 123,
+  "position": 987,
   "product_count": 123,
   "products": CategoryProducts,
-  "staged": false,
+  "staged": true,
   "uid": 4,
-  "updated_at": "abc123",
-  "url_key": "abc123",
-  "url_path": "xyz789",
+  "updated_at": "xyz789",
+  "url_key": "xyz789",
+  "url_path": "abc123",
   "url_suffix": "abc123"
 }
    @@ -29871,7 +29159,7 @@
    Example
    {
   "items": [ProductInterface],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
    @@ -29924,7 +29212,7 @@
    Example
    {
   "items": [CategoryTree],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
    @@ -30188,40 +29476,40 @@
    Example
    "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": "xyz789", - "display_mode": "xyz789", + "display_mode": "abc123", "filter_price_range": 123.45, "id": 123, "image": "abc123", - "include_in_menu": 123, + "include_in_menu": 987, "is_anchor": 123, "landing_page": 123, - "level": 987, - "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "abc123", - "name": "abc123", + "level": 123, + "meta_description": "xyz789", + "meta_keywords": "xyz789", + "meta_title": "xyz789", + "name": "xyz789", "path": "abc123", "path_in_store": "abc123", "position": 987, "product_count": 123, "products": CategoryProducts, "redirect_code": 123, - "relative_url": "abc123", + "relative_url": "xyz789", "staged": false, "type": "CMS_PAGE", "uid": "4", - "updated_at": "abc123", - "url_key": "xyz789", + "updated_at": "xyz789", + "url_key": "abc123", "url_path": "xyz789", - "url_suffix": "abc123" + "url_suffix": "xyz789" }     @@ -30292,13 +29580,13 @@
    Fields
    Example
    {
-  "agreement_id": 123,
-  "checkbox_text": "xyz789",
+  "agreement_id": 987,
+  "checkbox_text": "abc123",
   "content": "xyz789",
-  "content_height": "xyz789",
-  "is_html": false,
+  "content_height": "abc123",
+  "is_html": true,
   "mode": "AUTO",
-  "name": "abc123"
+  "name": "xyz789"
 }
    @@ -30396,7 +29684,7 @@
    Fields
    Example
    {
   "code": "REORDER_NOT_AVAILABLE",
-  "message": "abc123",
+  "message": "xyz789",
   "path": ["abc123"]
 }
    @@ -30605,7 +29893,7 @@
    Fields
    Example
    - 
    {"uid": "4"}
+                  
    {"uid": 4}
    @@ -30696,7 +29984,7 @@
    Fields
    Example
    - 
    {"cart": Cart, "status": false}
+                  
    {"cart": Cart, "status": true}
    @@ -30866,7 +30154,7 @@
    Fields
    Example
    - 
    {"quote_uids": [4]}
+                  
    {"quote_uids": ["4"]}
    @@ -31007,9 +30295,9 @@
    Fields
    Example
    {
-  "content": "xyz789",
+  "content": "abc123",
   "identifier": "xyz789",
-  "title": "xyz789"
+  "title": "abc123"
 }
    @@ -31145,17 +30433,17 @@
    Fields
    Example
    {
   "content": "abc123",
-  "content_heading": "xyz789",
-  "identifier": "xyz789",
-  "meta_description": "xyz789",
-  "meta_keywords": "xyz789",
+  "content_heading": "abc123",
+  "identifier": "abc123",
+  "meta_description": "abc123",
+  "meta_keywords": "abc123",
   "meta_title": "xyz789",
-  "page_layout": "abc123",
+  "page_layout": "xyz789",
   "redirect_code": 987,
-  "relative_url": "xyz789",
+  "relative_url": "abc123",
   "title": "abc123",
   "type": "CMS_PAGE",
-  "url_key": "abc123"
+  "url_key": "xyz789"
 }
    @@ -31191,7 +30479,7 @@
    Fields
    Example
    - 
    {"value": "xyz789"}
+                  
    {"value": "abc123"}
    @@ -31534,10 +30822,10 @@
    Example
    "credit": CompanyCredit, "credit_history": CompanyCreditHistory, "email": "xyz789", - "id": 4, + "id": "4", "legal_address": CompanyLegalAddress, "legal_name": "abc123", - "name": "xyz789", + "name": "abc123", "payment_methods": ["xyz789"], "reseller_id": "xyz789", "role": CompanyRole, @@ -31605,7 +30893,7 @@
    Example
    {
   "children": [CompanyAclResource],
   "id": 4,
-  "sort_order": 123,
+  "sort_order": 987,
   "text": "xyz789"
 }
    @@ -31685,12 +30973,12 @@
    Fields
    Example
    {
   "custom_attributes": [AttributeValueInput],
-  "email": "xyz789",
-  "firstname": "abc123",
-  "gender": 123,
+  "email": "abc123",
+  "firstname": "xyz789",
+  "gender": 987,
   "job_title": "abc123",
   "lastname": "xyz789",
-  "telephone": "abc123"
+  "telephone": "xyz789"
 }
    @@ -31741,9 +31029,9 @@
    Fields
    Example
    {
-  "id": "4",
+  "id": 4,
   "legal_name": "xyz789",
-  "name": "xyz789"
+  "name": "abc123"
 }
    @@ -31825,9 +31113,9 @@
    Example
    "company_email": "xyz789", "company_name": "abc123", "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "abc123", + "legal_name": "xyz789", "reseller_id": "xyz789", - "vat_tax_id": "abc123" + "vat_tax_id": "xyz789" }     @@ -31989,7 +31277,7 @@
    Example
    {
   "custom_reference_number": "abc123",
   "operation_type": "ALLOCATION",
-  "updated_by": "abc123"
+  "updated_by": "xyz789"
 }
    @@ -32058,7 +31346,7 @@
    Example
    "amount": Money, "balance": CompanyCredit, "custom_reference_number": "xyz789", - "date": "xyz789", + "date": "abc123", "type": "ALLOCATION", "updated_by": CompanyCreditOperationUser } @@ -32177,7 +31465,7 @@
    Fields
    Example
    - 
    {"name": "xyz789", "type": "CUSTOMER"}
+                  
    {"name": "abc123", "type": "CUSTOMER"}
    @@ -32275,7 +31563,7 @@
    Fields
    Example
    {
   "code": "abc123",
-  "role_id": 4,
+  "role_id": "4",
   "user": CompanyInvitationUserInput
 }
    @@ -32383,7 +31671,7 @@
    Example
    {
   "company_id": 4,
   "customer_id": 4,
-  "job_title": "abc123",
+  "job_title": "xyz789",
   "status": "ACTIVE",
   "telephone": "xyz789"
 }
@@ -32451,9 +31739,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "xyz789",
+  "city": "abc123",
   "country_code": "AF",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": CustomerAddressRegion,
   "street": ["abc123"],
   "telephone": "abc123"
@@ -32528,12 +31816,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "abc123",
+  "city": "xyz789",
   "country_id": "AF",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "region": CustomerAddressRegionInput,
-  "street": ["abc123"],
-  "telephone": "abc123"
+  "street": ["xyz789"],
+  "telephone": "xyz789"
 }
 
    
                 
    
@@ -32609,7 +31897,7 @@ 
    Example
    
   "country_id": "AF",
   "postcode": "abc123",
   "region": CustomerAddressRegionInput,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "telephone": "xyz789"
 }
 
    
@@ -32717,8 +32005,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "name": "xyz789",
-  "permissions": ["abc123"]
+  "name": "abc123",
+  "permissions": ["xyz789"]
 }
 
    
                 
    
@@ -32773,8 +32061,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "id": 4,
-  "name": "abc123",
-  "permissions": ["abc123"]
+  "name": "xyz789",
+  "permissions": ["xyz789"]
 }
 
    
                 
    
@@ -32878,9 +32166,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "xyz789",
-  "firstname": "abc123",
-  "lastname": "abc123"
+  "email": "abc123",
+  "firstname": "xyz789",
+  "lastname": "xyz789"
 }
 
    
                 
    
@@ -33008,7 +32296,11 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"entity": CompanyTeam, "id": 4, "parent_id": 4}
+                  
    {
+  "entity": CompanyTeam,
+  "id": 4,
+  "parent_id": "4"
+}
 
    
                 
    
               
    
@@ -33054,7 +32346,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"parent_tree_id": 4, "tree_id": "4"}
+                  
    {"parent_tree_id": 4, "tree_id": 4}
 
    
                 
    
               
    
@@ -33087,7 +32379,7 @@ 
    Fields
    
                          An optional description of the team. 
                       
                       
-                        id - ID
+                        id - ID!
                         
                          The unique ID for a CompanyTeam object. 
                       
@@ -33109,10 +32401,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "description": "abc123",
-  "id": "4",
+  "description": "xyz789",
+  "id": 4,
   "name": "xyz789",
-  "structure_id": "4"
+  "structure_id": 4
 }
 
    
                 
    
@@ -33222,9 +32514,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "description": "abc123",
-  "id": "4",
-  "name": "xyz789"
+  "description": "xyz789",
+  "id": 4,
+  "name": "abc123"
 }
 
    
                 
    
@@ -33297,11 +32589,11 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "company_email": "xyz789",
-  "company_name": "xyz789",
+  "company_name": "abc123",
   "legal_address": CompanyLegalAddressUpdateInput,
   "legal_name": "xyz789",
-  "reseller_id": "abc123",
-  "vat_tax_id": "xyz789"
+  "reseller_id": "xyz789",
+  "vat_tax_id": "abc123"
 }
 
    
                 
@@ -33386,13 +32678,13 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "email": "abc123",
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "job_title": "abc123",
   "lastname": "xyz789",
   "role_id": "4",
   "status": "ACTIVE",
   "target_id": "4",
-  "telephone": "xyz789"
+  "telephone": "abc123"
 }
 
    
                 
@@ -33522,10 +32814,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "xyz789",
+  "email": "abc123",
   "firstname": "abc123",
   "id": 4,
-  "job_title": "xyz789",
+  "job_title": "abc123",
   "lastname": "xyz789",
   "role_id": "4",
   "status": "ACTIVE",
@@ -33722,7 +33014,7 @@ 
    Example
    
                   
    {
   "attributes": [ProductAttribute],
   "product": ProductInterface,
-  "uid": "4"
+  "uid": 4
 }
 
    
                 
    
@@ -33779,59 +33071,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "attributes": [ComparableAttribute],
-  "item_count": 987,
+  "item_count": 123,
   "items": [ComparableItem],
   "uid": "4"
 }
-
    
-                
-              
-            
-
    -
    -
    - Types -
    -

    CompleteOrderInput

    -
    -
    -
    -
    Description
    -

    Update the quote and complete the order

    -
    -
    -
    Fields
    - - - - - - - - - - - - - - - - - -
    Input FieldDescription
    - cartId - String! - The customer cart ID
    - id - String! - PayPal order ID
    -
    -
    -
    -
    -
    Example
    - 
    {
-  "cartId": "xyz789",
-  "id": "xyz789"
-}
    @@ -33921,10 +33164,10 @@
    Fields
    Example
    {
-  "code": "abc123",
+  "code": "xyz789",
   "label": "abc123",
   "uid": "4",
-  "value_index": 987
+  "value_index": 123
 }
    @@ -34066,16 +33309,16 @@
    Example
    "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "xyz789", - "is_available": true, + "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, - "uid": 4 + "quantity": 123.45, + "uid": "4" }
    @@ -34270,28 +33513,28 @@
    Fields
    Example
    {
   "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": "xyz789",
   "product_sale_price": Money,
   "product_sku": "xyz789",
-  "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_return_requested": 987.65,
-  "quantity_returned": 987.65,
-  "quantity_shipped": 123.45,
+  "quantity_ordered": 123.45,
+  "quantity_refunded": 123.45,
+  "quantity_return_requested": 123.45,
+  "quantity_returned": 123.45,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "xyz789"
+  "status": "abc123"
 }
    @@ -34680,6 +33923,11 @@
    currentPage + + rules - [CatalogRule] + + Provides applied catalog rules in the current active cart + sale - Int @@ -34866,12 +34114,12 @@
    currentPageExample
    {
   "activity": "xyz789",
-  "attribute_set_id": 987,
-  "canonical_url": "xyz789",
+  "attribute_set_id": 123,
+  "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "xyz789",
-  "collar": "xyz789",
+  "category_gear": "xyz789",
+  "climate": "abc123",
+  "collar": "abc123",
   "color": 123,
   "configurable_options": [ConfigurableProductOptions],
   "configurable_product_options_selection": ConfigurableProductOptionsSelection,
@@ -34881,74 +34129,75 @@ 
    Example
    
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "eco_collection": 987,
-  "erin_recommends": 123,
+  "erin_recommends": 987,
   "features_bags": "xyz789",
-  "format": 123,
+  "format": 987,
   "gender": "xyz789",
-  "gift_message_available": true,
-  "gift_wrapping_available": true,
+  "gift_message_available": false,
+  "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
   "id": 123,
   "image": ProductImage,
   "is_returnable": "xyz789",
-  "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": "abc123",
-  "meta_keyword": "abc123",
+  "meta_keyword": "xyz789",
   "meta_title": "xyz789",
   "min_sale_qty": 123.45,
-  "name": "xyz789",
-  "new": 123,
+  "name": "abc123",
+  "new": 987,
   "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": "xyz789",
-  "performance_fabric": 123,
+  "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": 123.45,
-  "redirect_code": 123,
+  "redirect_code": 987,
   "related_products": [ProductInterface],
   "relative_url": "xyz789",
-  "review_count": 123,
+  "review_count": 987,
   "reviews": ProductReviews,
-  "sale": 123,
+  "rules": [CatalogRule],
+  "sale": 987,
   "short_description": ComplexTextValue,
   "size": 123,
   "sku": "xyz789",
-  "sleeve": "abc123",
+  "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,
   "stock_status": "IN_STOCK",
-  "strap_bags": "xyz789",
-  "style_bags": "abc123",
-  "style_bottom": "xyz789",
-  "style_general": "xyz789",
+  "strap_bags": "abc123",
+  "style_bags": "xyz789",
+  "style_bottom": "abc123",
+  "style_general": "abc123",
   "swatch_image": "abc123",
   "thumbnail": ProductImage,
   "tier_price": 987.65,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
   "type_id": "xyz789",
-  "uid": 4,
-  "updated_at": "abc123",
+  "uid": "4",
+  "updated_at": "xyz789",
   "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
@@ -35010,7 +34259,7 @@ 
    Example
    
                   
    {
   "customizable_options": [CustomizableOptionInput],
   "data": CartItemInput,
-  "parent_sku": "xyz789",
+  "parent_sku": "abc123",
   "variant_sku": "abc123"
 }
 
    
@@ -35068,8 +34317,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "attribute_code": "abc123",
-  "label": "xyz789",
-  "uid": 4,
+  "label": "abc123",
+  "uid": "4",
   "values": [ConfigurableProductOptionValue]
 }
 
    
@@ -35133,9 +34382,9 @@ 
    Example
    
                   
    {
   "is_available": false,
   "is_use_default": true,
-  "label": "xyz789",
+  "label": "abc123",
   "swatch": SwatchDataInterface,
-  "uid": 4
+  "uid": "4"
 }
 
    
                 
@@ -35232,14 +34481,14 @@ 
    Example
    
                   
    {
   "attribute_code": "abc123",
   "attribute_id": "xyz789",
-  "attribute_id_v2": 123,
+  "attribute_id_v2": 987,
   "attribute_uid": "4",
-  "id": 123,
+  "id": 987,
   "label": "abc123",
-  "position": 987,
-  "product_id": 123,
+  "position": 123,
+  "product_id": 987,
   "uid": 4,
-  "use_default": false,
+  "use_default": true,
   "values": [ConfigurableProductOptionsValues]
 }
 
    
@@ -35373,13 +34622,13 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "default_label": "abc123",
-  "label": "xyz789",
+  "default_label": "xyz789",
+  "label": "abc123",
   "store_label": "abc123",
   "swatch_data": SwatchDataInterface,
   "uid": "4",
-  "use_default_value": true,
-  "value_index": 123
+  "use_default_value": false,
+  "value_index": 987
 }
 
    
                 
    
@@ -35443,7 +34692,7 @@ 
    Example
    
   "configurable_options": [SelectedConfigurableOption],
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": 4
 }
    @@ -35581,7 +34830,7 @@
    Example
    "description": "xyz789", "id": "4", "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 }     @@ -35626,7 +34875,7 @@
    Fields
    Example
    {
   "confirmation_key": "xyz789",
-  "order_id": "4"
+  "order_id": 4
 }
    @@ -35674,7 +34923,7 @@
    Fields
    Example
    {
-  "confirmation_key": "xyz789",
+  "confirmation_key": "abc123",
   "email": "xyz789"
 }
    @@ -35719,8 +34968,8 @@
    Fields
    Example
    {
-  "confirmation_key": "abc123",
-  "order_id": 4
+  "confirmation_key": "xyz789",
+  "order_id": "4"
 }
    @@ -35822,10 +35071,10 @@
    Fields
    Example
    {
-  "comment": "xyz789",
+  "comment": "abc123",
   "email": "abc123",
-  "name": "xyz789",
-  "telephone": "abc123"
+  "name": "abc123",
+  "telephone": "xyz789"
 }
    @@ -35865,7 +35114,7 @@
    Fields
    Example
    - 
    {"status": true}
+                  
    {"status": false}
    @@ -35905,7 +35154,7 @@
    Fields
    Example
    - 
    {"requisitionListItemUids": ["4"]}
+                  
    {"requisitionListItemUids": [4]}
    @@ -36059,10 +35308,10 @@
    Fields
    Example
    {
   "available_regions": [Region],
-  "full_name_english": "xyz789",
-  "full_name_locale": "abc123",
+  "full_name_english": "abc123",
+  "full_name_locale": "xyz789",
   "id": "xyz789",
-  "three_letter_abbreviation": "xyz789",
+  "three_letter_abbreviation": "abc123",
   "two_letter_abbreviation": "abc123"
 }
    @@ -37851,7 +37100,7 @@
    Example
    GiftRegistryDynamicAttributeInput ], "event_name": "xyz789", - "gift_registry_type_uid": 4, + "gift_registry_type_uid": "4", "message": "abc123", "privacy_settings": "PRIVATE", "registrants": [AddGiftRegistryRegistrantInput], @@ -37932,7 +37181,7 @@
    Fields
    Example
    - 
    {"cart_uid": 4}
+                  
    {"cart_uid": "4"}
    @@ -38028,8 +37277,8 @@
    Fields
    Example
    {
   "response_message": "xyz789",
-  "result": 123,
-  "result_code": 987,
+  "result": 987,
+  "result_code": 123,
   "secure_token": "xyz789",
   "secure_token_id": "xyz789"
 }
@@ -38099,7 +37348,7 @@ 
    Example
    
                   
    {
   "cartId": "xyz789",
   "location": "PRODUCT_DETAIL",
-  "methodCode": "abc123",
+  "methodCode": "xyz789",
   "paymentSource": "abc123",
   "vaultIntent": false
 }
@@ -38162,11 +37411,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "amount": 123.45,
+  "amount": 987.65,
   "currency_code": "xyz789",
   "id": "xyz789",
   "mp_order_id": "xyz789",
-  "status": "abc123"
+  "status": "xyz789"
 }
 
    
                 
    
@@ -38232,10 +37481,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "nickname": "abc123",
+  "nickname": "xyz789",
   "ratings": [ProductReviewRatingInput],
-  "sku": "xyz789",
-  "summary": "xyz789",
+  "sku": "abc123",
+  "summary": "abc123",
   "text": "xyz789"
 }
 
    
@@ -38322,7 +37571,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"currency": "AFN", "value": 987.65}
+                  
    {"currency": "AFN", "value": 123.45}
 
    
                 
    
               
    
@@ -38432,8 +37681,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "description": "abc123",
-  "name": "abc123"
+  "description": "xyz789",
+  "name": "xyz789"
 }
 
    
                 
    
@@ -38521,7 +37770,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "card_description": "xyz789",
-  "setup_token_id": "abc123"
+  "setup_token_id": "xyz789"
 }
 
    
                 
    
@@ -38657,7 +37906,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"setup_token": "abc123"}
+                  
    {"setup_token": "xyz789"}
 
    
                 
    
               
    
@@ -38803,8 +38052,8 @@ 
    Example
    
                   
    {
   "cc_exp_month": 987,
   "cc_exp_year": 123,
-  "cc_last_4": 123,
-  "cc_type": "abc123"
+  "cc_last_4": 987,
+  "cc_type": "xyz789"
 }
    @@ -38939,7 +38188,7 @@
    Example
    "discounts": [Discount], "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", "quantity_refunded": 987.65 @@ -39019,12 +38268,12 @@
    Possible Types
    -

    DownloadableCreditMemoItem

    +

    BundleCreditMemoItem

    -

    BundleCreditMemoItem

    +

    DownloadableCreditMemoItem

    @@ -39051,7 +38300,7 @@
    Example
    "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_refunded": 123.45 + "quantity_refunded": 987.65 }     @@ -39217,11 +38466,11 @@
    Fields
    Example
    {
   "available_currency_codes": ["xyz789"],
-  "base_currency_code": "xyz789",
+  "base_currency_code": "abc123",
   "base_currency_symbol": "xyz789",
   "default_display_currecy_code": "xyz789",
-  "default_display_currecy_symbol": "xyz789",
-  "default_display_currency_code": "xyz789",
+  "default_display_currecy_symbol": "abc123",
+  "default_display_currency_code": "abc123",
   "default_display_currency_symbol": "xyz789",
   "exchange_rates": [ExchangeRate]
 }
@@ -40600,12 +39849,12 @@ 
    Possible Types
    
                   
    Example
    
                   
    {
   "code": 4,
-  "default_value": "abc123",
+  "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
   "is_required": true,
-  "is_unique": true,
+  "is_unique": false,
   "label": "xyz789",
   "options": [CustomAttributeOptionInterface]
 }
@@ -40671,7 +39920,7 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "is_default": false,
+  "is_default": true,
   "label": "xyz789",
   "value": "abc123"
 }
@@ -40846,9 +40095,9 @@ 
    giftRegistryUi
                         
                       
                       
-                        group - CustomerGroupStorefront
+                        group - CustomerGroup
                         
-                         Customer group assigned to the customer 
+                         Name of the customer group assigned to the customer 
                       
                       
                         group_id - Int
@@ -40858,9 +40107,10 @@ 
    giftRegistryUi
                         
                       
                       
-                        id - ID!
+                        id - Int
+                        
+                         The ID assigned to the customer. id is not needed as part of Customer, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side.
                         
-                         The unique ID assigned to the customer. 
                       
                       
                         is_subscribed - Boolean
@@ -41127,7 +40377,7 @@ 
    currentPage The role name and permissions assigned to the company user. 
                       
                       
-                        segments - [CustomerSegmentStorefront]
+                        segments - [CustomerSegment]
                         
                          Customer segments associated with the current customer 
                       
@@ -41228,24 +40478,24 @@ 
    Example
    
   "companies": UserCompaniesOutput,
   "compare_list": CompareList,
   "confirmation_status": "ACCOUNT_CONFIRMED",
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "custom_attributes": [AttributeValueInterface],
   "date_of_birth": "xyz789",
   "default_billing": "xyz789",
   "default_shipping": "abc123",
-  "dob": "xyz789",
-  "email": "abc123",
+  "dob": "abc123",
+  "email": "xyz789",
   "firstname": "abc123",
   "gender": 123,
   "gift_registries": [GiftRegistry],
   "gift_registry": GiftRegistry,
-  "group": CustomerGroupStorefront,
+  "group": CustomerGroup,
   "group_id": 123,
-  "id": "4",
-  "is_subscribed": false,
-  "job_title": "abc123",
-  "lastname": "abc123",
-  "middlename": "xyz789",
+  "id": 123,
+  "is_subscribed": true,
+  "job_title": "xyz789",
+  "lastname": "xyz789",
+  "middlename": "abc123",
   "orders": CustomerOrders,
   "prefix": "xyz789",
   "purchase_order": PurchaseOrder,
@@ -41253,21 +40503,21 @@ 
    Example
    
   "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,
   "reviews": ProductReviews,
   "reward_points": RewardPoints,
   "role": CompanyRole,
-  "segments": [CustomerSegmentStorefront],
+  "segments": [CustomerSegment],
   "status": "ACTIVE",
   "store_credit": CustomerStoreCredit,
-  "structure_id": 4,
-  "suffix": "abc123",
+  "structure_id": "4",
+  "suffix": "xyz789",
   "taxvat": "xyz789",
   "team": CompanyTeam,
-  "telephone": "xyz789",
+  "telephone": "abc123",
   "wishlist": Wishlist,
   "wishlist_v2": Wishlist,
   "wishlists": [Wishlist]
@@ -41376,10 +40626,9 @@ 
    attributeCodes
                          The first name of the person associated with the shipping/billing address. 
                       
                       
-                        id - Int
-                        
-                         The ID of a CustomerAddress object. Use uid instead.
+                        id - Int
                         
+                         The ID of a CustomerAddress object. 
                       
                       
                         lastname - String
@@ -41426,11 +40675,6 @@ 
    attributeCodes
                         
                          The customer's telephone number. 
                       
-                      
-                        uid - ID
-                        
-                         The unique ID for a CustomerAddress object. 
-                      
                       
                         vat_id - String
                         
@@ -41444,29 +40688,28 @@ 
    attributeCodes
                 
    
                   
    Example
    
                   
    {
-  "city": "xyz789",
+  "city": "abc123",
   "company": "xyz789",
   "country_code": "AF",
-  "country_id": "abc123",
+  "country_id": "xyz789",
   "custom_attributes": [CustomerAddressAttribute],
   "custom_attributesV2": [AttributeValueInterface],
   "customer_id": 987,
-  "default_billing": true,
-  "default_shipping": true,
+  "default_billing": false,
+  "default_shipping": false,
   "extension_attributes": [CustomerAddressAttribute],
   "fax": "xyz789",
   "firstname": "abc123",
   "id": 987,
-  "lastname": "xyz789",
+  "lastname": "abc123",
   "middlename": "abc123",
   "postcode": "abc123",
-  "prefix": "abc123",
+  "prefix": "xyz789",
   "region": CustomerAddressRegion,
-  "region_id": 987,
+  "region_id": 123,
   "street": ["xyz789"],
   "suffix": "xyz789",
-  "telephone": "abc123",
-  "uid": 4,
+  "telephone": "xyz789",
   "vat_id": "xyz789"
 }
 
    
@@ -41514,7 +40757,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "attribute_code": "abc123",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
    
                 
    
@@ -41563,7 +40806,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "attribute_code": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
    
                 
    
@@ -41715,24 +40958,24 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "abc123",
+  "city": "xyz789",
   "company": "abc123",
   "country_code": "AF",
   "country_id": "AF",
   "custom_attributes": [CustomerAddressAttributeInput],
   "custom_attributesV2": [AttributeValueInput],
-  "default_billing": false,
+  "default_billing": true,
   "default_shipping": false,
   "fax": "xyz789",
-  "firstname": "xyz789",
-  "lastname": "abc123",
-  "middlename": "abc123",
+  "firstname": "abc123",
+  "lastname": "xyz789",
+  "middlename": "xyz789",
   "postcode": "xyz789",
   "prefix": "xyz789",
   "region": CustomerAddressRegionInput,
   "street": ["xyz789"],
-  "suffix": "xyz789",
-  "telephone": "abc123",
+  "suffix": "abc123",
+  "telephone": "xyz789",
   "vat_id": "xyz789"
 }
 
    
@@ -41785,7 +41028,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "region": "abc123",
-  "region_code": "abc123",
+  "region_code": "xyz789",
   "region_id": 987
 }
 
    
@@ -41840,9 +41083,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "region": "abc123",
-  "region_code": "abc123",
-  "region_id": 987
+  "region": "xyz789",
+  "region_code": "xyz789",
+  "region_id": 123
 }
 
    
                 
    
@@ -41995,13 +41238,13 @@ 
    Example
    
   "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,
+  "is_unique": false,
   "label": "abc123",
-  "multiline_count": 123,
+  "multiline_count": 987,
   "options": [CustomAttributeOptionInterface],
   "sort_order": 987,
   "validate_rules": [ValidationRule]
@@ -42129,16 +41372,16 @@ 
    Example
    
   "custom_attributes": [AttributeValueInput],
   "date_of_birth": "xyz789",
   "dob": "abc123",
-  "email": "xyz789",
+  "email": "abc123",
   "firstname": "abc123",
   "gender": 987,
-  "is_subscribed": false,
-  "lastname": "xyz789",
+  "is_subscribed": true,
+  "lastname": "abc123",
   "middlename": "xyz789",
   "password": "abc123",
   "prefix": "abc123",
   "suffix": "abc123",
-  "taxvat": "abc123"
+  "taxvat": "xyz789"
 }
 
    
                 
@@ -42202,8 +41445,8 @@ 
    Example
    
   "date": "abc123",
   "download_url": "xyz789",
   "order_increment_id": "abc123",
-  "remaining_downloads": "abc123",
-  "status": "abc123"
+  "remaining_downloads": "xyz789",
+  "status": "xyz789"
 }
    @@ -42249,11 +41492,11 @@
    Example
    -
    +
    Types
    -

    CustomerGroupStorefront

    +

    CustomerGroup

    @@ -42271,9 +41514,9 @@
    Fields
    - uid - ID! + name - String - The unique ID for a CustomerGroup object. + The name of customer group. @@ -42282,7 +41525,7 @@
    Fields
    Example
    - 
    {"uid": 4}
+                  
    {"name": "xyz789"}
    @@ -42391,17 +41634,17 @@
    Fields
    Example
    {
   "date_of_birth": "xyz789",
-  "dob": "abc123",
-  "email": "abc123",
-  "firstname": "abc123",
+  "dob": "xyz789",
+  "email": "xyz789",
+  "firstname": "xyz789",
   "gender": 987,
-  "is_subscribed": true,
-  "lastname": "xyz789",
+  "is_subscribed": false,
+  "lastname": "abc123",
   "middlename": "xyz789",
   "password": "abc123",
-  "prefix": "abc123",
-  "suffix": "xyz789",
-  "taxvat": "abc123"
+  "prefix": "xyz789",
+  "suffix": "abc123",
+  "taxvat": "xyz789"
 }
    @@ -42635,34 +41878,34 @@
    Example
    "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "xyz789", + "carrier": "abc123", "comments": [SalesCommentItem], "created_at": "xyz789", "credit_memos": [CreditMemo], "customer_info": OrderCustomerInfo, - "email": "xyz789", + "email": "abc123", "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": "xyz789", "invoices": [Invoice], "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "abc123", - "order_date": "abc123", - "order_number": "abc123", + "number": "xyz789", + "order_date": "xyz789", + "order_number": "xyz789", "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], - "printed_card_included": true, + "printed_card_included": false, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "abc123", - "status": "abc123", - "token": "abc123", + "status": "xyz789", + "token": "xyz789", "total": OrderTotal }     @@ -42962,16 +42205,16 @@
    Example
    -
    +
    Types
    -

    CustomerSegmentStorefront

    +

    CustomerSegment

    Description
    -

    Customer segment details

    +

    Customer segment.

    Fields
    @@ -42984,9 +42227,19 @@
    Fields
    - uid - ID! + apply_to - CustomerSegmentApplyTo! + + Customer segment is applicable to visitor, registered customer or both. + + + description - String + + Customer segment description. + + + name - String! - The unique ID for a CustomerSegment object. + Customer segment name. @@ -42995,7 +42248,63 @@
    Fields
    Example
    - 
    {"uid": 4}
+                  
    {
+  "apply_to": "BOTH",
+  "description": "xyz789",
+  "name": "abc123"
+}
+
    
+
    +
    +
    +
    +
    +
    + Types +
    +

    CustomerSegmentApplyTo

    +
    +
    +
    +
    Description
    +

    Customer segment is applicable to visitor, registered customers or both.

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

    BOTH

    +     		Customer segment is applicable to visitor and registered customers.
    +

    REGISTERED

    +     		Customer segment is applicable to registered customers.
    +

    VISITOR

    +     		Customer segment is applicable to visitors/guests.
    +
    +
    +
    +
    +
    Example
    + 
    "BOTH"
    @@ -43175,10 +42484,10 @@
    Fields
    Example
    {
-  "action": "xyz789",
+  "action": "abc123",
   "actual_balance": Money,
   "balance_change": Money,
-  "date_time_changed": "abc123"
+  "date_time_changed": "xyz789"
 }
    @@ -43218,7 +42527,7 @@
    Fields
    Example
    - 
    {"token": "abc123"}
+                  
    {"token": "xyz789"}
    @@ -43326,18 +42635,18 @@
    Fields
    Example
    {
-  "allow_remote_shopping_assistance": false,
+  "allow_remote_shopping_assistance": true,
   "custom_attributes": [AttributeValueInput],
-  "date_of_birth": "abc123",
-  "dob": "abc123",
+  "date_of_birth": "xyz789",
+  "dob": "xyz789",
   "firstname": "xyz789",
-  "gender": 123,
-  "is_subscribed": false,
-  "lastname": "abc123",
+  "gender": 987,
+  "is_subscribed": true,
+  "lastname": "xyz789",
   "middlename": "xyz789",
-  "prefix": "xyz789",
+  "prefix": "abc123",
   "suffix": "xyz789",
-  "taxvat": "abc123"
+  "taxvat": "xyz789"
 }
    @@ -43409,12 +42718,12 @@
    Fields
    Example
    {
-  "option_id": 123,
+  "option_id": 987,
   "product_sku": "abc123",
-  "required": true,
-  "sort_order": 123,
-  "title": "xyz789",
-  "uid": "4",
+  "required": false,
+  "sort_order": 987,
+  "title": "abc123",
+  "uid": 4,
   "value": CustomizableAreaValue
 }
    @@ -43476,11 +42785,11 @@
    Fields
    Example
    {
-  "max_characters": 987,
-  "price": 123.45,
+  "max_characters": 123,
+  "price": 987.65,
   "price_type": "FIXED",
   "sku": "abc123",
-  "uid": "4"
+  "uid": 4
 }
    @@ -43549,8 +42858,8 @@
    Example
    {
   "option_id": 123,
   "required": true,
-  "sort_order": 123,
-  "title": "abc123",
+  "sort_order": 987,
+  "title": "xyz789",
   "uid": "4",
   "value": [CustomizableCheckboxValue]
 }
@@ -43624,12 +42933,12 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "option_type_id": 123,
-  "price": 123.45,
+  "price": 987.65,
   "price_type": "FIXED",
-  "sku": "xyz789",
-  "sort_order": 123,
+  "sku": "abc123",
+  "sort_order": 987,
   "title": "abc123",
-  "uid": "4"
+  "uid": 4
 }
    @@ -43701,12 +43010,12 @@
    Fields
    Example
    {
-  "option_id": 987,
+  "option_id": 123,
   "product_sku": "xyz789",
   "required": true,
-  "sort_order": 123,
+  "sort_order": 987,
   "title": "xyz789",
-  "uid": "4",
+  "uid": 4,
   "value": CustomizableDateValue
 }
    @@ -43897,7 +43206,7 @@
    Example
    "option_id": 987, "required": false, "sort_order": 123, - "title": "xyz789", + "title": "abc123", "uid": 4, "value": [CustomizableDropDownValue] } @@ -43971,11 +43280,11 @@
    Fields
    Example
    {
   "option_type_id": 987,
-  "price": 123.45,
+  "price": 987.65,
   "price_type": "FIXED",
   "sku": "xyz789",
-  "sort_order": 987,
-  "title": "abc123",
+  "sort_order": 123,
+  "title": "xyz789",
   "uid": 4
 }
    @@ -44050,10 +43359,10 @@
    Example
    {
   "option_id": 987,
   "product_sku": "abc123",
-  "required": false,
+  "required": true,
   "sort_order": 123,
   "title": "xyz789",
-  "uid": 4,
+  "uid": "4",
   "value": CustomizableFieldValue
 }
    @@ -44118,7 +43427,7 @@
    Example
    "max_characters": 987, "price": 123.45, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "uid": "4" }     @@ -44193,9 +43502,9 @@
    Example
    {
   "option_id": 987,
   "product_sku": "xyz789",
-  "required": true,
+  "required": false,
   "sort_order": 123,
-  "title": "abc123",
+  "title": "xyz789",
   "uid": 4,
   "value": CustomizableFileValue
 }
@@ -44270,10 +43579,10 @@ 
    Example
    
                   
    {
   "file_extension": "xyz789",
   "image_size_x": 987,
-  "image_size_y": 987,
+  "image_size_y": 123,
   "price": 123.45,
   "price_type": "FIXED",
-  "sku": "abc123",
+  "sku": "xyz789",
   "uid": 4
 }
 
    
@@ -44341,11 +43650,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "option_id": 123,
-  "required": false,
-  "sort_order": 987,
+  "option_id": 987,
+  "required": true,
+  "sort_order": 123,
   "title": "xyz789",
-  "uid": "4",
+  "uid": 4,
   "value": [CustomizableMultipleValue]
 }
 
    
@@ -44418,12 +43727,12 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "option_type_id": 123,
-  "price": 123.45,
+  "price": 987.65,
   "price_type": "FIXED",
-  "sku": "abc123",
+  "sku": "xyz789",
   "sort_order": 987,
   "title": "abc123",
-  "uid": "4"
+  "uid": 4
 }
 
    
                 
    
@@ -44479,7 +43788,7 @@ 
    Example
    
                   
    {
   "id": 123,
   "uid": 4,
-  "value_string": "abc123"
+  "value_string": "xyz789"
 }
    @@ -44595,9 +43904,9 @@
    Example
    {
   "option_id": 123,
   "required": true,
-  "sort_order": 123,
+  "sort_order": 987,
   "title": "abc123",
-  "uid": "4"
+  "uid": 4
 }
    @@ -44659,12 +43968,12 @@
    Possible Types
    -

    DownloadableProduct

    +

    BundleProduct

    -

    BundleProduct

    +

    DownloadableProduct

    @@ -44747,7 +44056,7 @@
    Example
    {
   "option_id": 987,
   "required": false,
-  "sort_order": 987,
+  "sort_order": 123,
   "title": "xyz789",
   "uid": 4,
   "value": [CustomizableRadioValue]
@@ -44822,10 +44131,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "option_type_id": 123,
-  "price": 987.65,
+  "price": 123.45,
   "price_type": "FIXED",
-  "sku": "abc123",
-  "sort_order": 987,
+  "sku": "xyz789",
+  "sort_order": 123,
   "title": "abc123",
   "uid": "4"
 }
@@ -44906,7 +44215,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"success": true}
+                  
    {"success": false}
 
    
                 
    
               
    
@@ -45075,7 +44384,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "errors": [NegotiableQuoteInvalidStateError],
-  "quote_uid": 4
+  "quote_uid": "4"
 }
 
    
                 
@@ -45155,7 +44464,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"template_id": 4}
+                  
    {"template_id": "4"}
 
    
                 
    
               
    
@@ -45191,7 +44500,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"quote_uids": ["4"]}
+                  
    {"quote_uids": [4]}
 
    
                 
    
               
    
@@ -45321,7 +44630,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "customerPaymentTokens": CustomerPaymentTokens,
-  "result": true
+  "result": false
 }
 
    
                 
@@ -45450,7 +44759,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"approval_rule_uids": [4]}
+                  
    {"approval_rule_uids": ["4"]}
 
    
                 
    
               
    
@@ -45616,7 +44925,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"status": true, "wishlists": [Wishlist]}
+                  
    {"status": false, "wishlists": [Wishlist]}
 
    
                 
    
               
    
@@ -45689,10 +44998,10 @@ 
    Example
    
   "amount": Money,
   "applied_to": "ITEM",
   "coupon": AppliedCoupon,
-  "is_discounting_locked": false,
+  "is_discounting_locked": true,
   "label": "abc123",
-  "type": "xyz789",
-  "value": 987.65
+  "type": "abc123",
+  "value": 123.45
 }
 
    
                 
@@ -45813,7 +45122,7 @@ 
    Example
    
   "customizable_options": [SelectedCustomizableOption],
   "discount": [Discount],
   "errors": [CartItemError],
-  "id": "xyz789",
+  "id": "abc123",
   "is_available": false,
   "links": [DownloadableProductLinks],
   "max_qty": 987.65,
@@ -45823,9 +45132,9 @@ 
    Example
    
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "samples": [DownloadableProductSamples],
-  "uid": "4"
+  "uid": 4
 }
    @@ -45903,12 +45212,12 @@
    Example
    {
   "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_refunded": 987.65
+  "product_sku": "abc123",
+  "quantity_refunded": 123.45
 }
    @@ -46032,12 +45341,12 @@
    Example
    {
   "discounts": [Discount],
   "downloadable_links": [DownloadableItemsLinks],
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_invoiced": 987.65
+  "product_sku": "xyz789",
+  "quantity_invoiced": 123.45
 }
    @@ -46090,7 +45399,7 @@
    Example
    {
   "sort_order": 987,
   "title": "xyz789",
-  "uid": 4
+  "uid": "4"
 }
    @@ -46243,7 +45552,7 @@
    Example
    {
   "discounts": [Discount],
   "downloadable_links": [DownloadableItemsLinks],
-  "eligible_for_return": true,
+  "eligible_for_return": false,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
@@ -46252,18 +45561,18 @@ 
    Example
    
   "product": ProductInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "product_type": "abc123",
+  "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": 123.45,
+  "quantity_ordered": 987.65,
+  "quantity_refunded": 987.65,
+  "quantity_return_requested": 987.65,
   "quantity_returned": 987.65,
   "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "abc123"
+  "status": "xyz789"
 }
    @@ -46649,6 +45958,11 @@
    currentPage + + rules - [CatalogRule] + + Provides applied catalog rules in the current active cart + sale - Int @@ -46824,15 +46138,15 @@
    currentPage
    Example
    {
-  "activity": "abc123",
+  "activity": "xyz789",
   "attribute_set_id": 987,
   "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "category_gear": "xyz789",
+  "category_gear": "abc123",
   "climate": "abc123",
-  "collar": "xyz789",
-  "color": 123,
-  "country_of_manufacture": "xyz789",
+  "collar": "abc123",
+  "color": 987,
+  "country_of_manufacture": "abc123",
   "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
@@ -46843,77 +46157,78 @@ 
    Example
    
   "downloadable_product_samples": [
     DownloadableProductSamples
   ],
-  "eco_collection": 123,
-  "erin_recommends": 123,
-  "features_bags": "xyz789",
-  "format": 987,
-  "gender": "xyz789",
+  "eco_collection": 987,
+  "erin_recommends": 987,
+  "features_bags": "abc123",
+  "format": 123,
+  "gender": "abc123",
   "gift_message_available": true,
-  "gift_wrapping_available": true,
+  "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
-  "id": 987,
+  "id": 123,
   "image": ProductImage,
   "is_returnable": "xyz789",
   "links_purchased_separately": 123,
   "links_title": "abc123",
-  "manufacturer": 987,
+  "manufacturer": 123,
   "material": "abc123",
   "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "xyz789",
-  "meta_keyword": "xyz789",
+  "meta_description": "abc123",
+  "meta_keyword": "abc123",
   "meta_title": "abc123",
-  "min_sale_qty": 123.45,
-  "name": "xyz789",
-  "new": 123,
-  "new_from_date": "abc123",
+  "min_sale_qty": 987.65,
+  "name": "abc123",
+  "new": 987,
+  "new_from_date": "xyz789",
   "new_to_date": "abc123",
   "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,
+  "purpose": 123,
   "quantity": 987.65,
-  "rating_summary": 987.65,
+  "rating_summary": 123.45,
   "redirect_code": 123,
   "related_products": [ProductInterface],
   "relative_url": "xyz789",
   "review_count": 987,
   "reviews": ProductReviews,
-  "sale": 987,
+  "rules": [CatalogRule],
+  "sale": 123,
   "short_description": ComplexTextValue,
-  "size": 987,
-  "sku": "abc123",
-  "sleeve": "abc123",
+  "size": 123,
+  "sku": "xyz789",
+  "sleeve": "xyz789",
   "small_image": ProductImage,
   "special_from_date": "abc123",
   "special_price": 123.45,
   "special_to_date": "xyz789",
-  "staged": false,
+  "staged": true,
   "stock_status": "IN_STOCK",
   "strap_bags": "abc123",
   "style_bags": "xyz789",
-  "style_bottom": "abc123",
+  "style_bottom": "xyz789",
   "style_general": "abc123",
   "swatch_image": "abc123",
   "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": "abc123",
+  "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "abc123",
+  "url_suffix": "xyz789",
   "websites": [Website]
 }
    @@ -47075,17 +46390,17 @@
    Fields
    Example
    {
-  "id": 123,
-  "is_shareable": true,
+  "id": 987,
+  "is_shareable": false,
   "link_type": "FILE",
   "number_of_downloads": 123,
-  "price": 987.65,
-  "sample_file": "abc123",
+  "price": 123.45,
+  "sample_file": "xyz789",
   "sample_type": "FILE",
-  "sample_url": "abc123",
+  "sample_url": "xyz789",
   "sort_order": 123,
   "title": "xyz789",
-  "uid": 4
+  "uid": "4"
 }
    @@ -47126,7 +46441,7 @@
    Fields
    Example
    - 
    {"link_id": 987}
+                  
    {"link_id": 123}
    @@ -47197,12 +46512,12 @@
    Fields
    Example
    {
-  "id": 123,
-  "sample_file": "abc123",
+  "id": 987,
+  "sample_file": "xyz789",
   "sample_type": "FILE",
   "sample_url": "abc123",
-  "sort_order": 987,
-  "title": "abc123"
+  "sort_order": 123,
+  "title": "xyz789"
 }
    @@ -47273,7 +46588,7 @@
    Example
    "product": ProductInterface, "quantity": 987.65, "samples": [DownloadableProductSamples], - "uid": 4 + "uid": "4" }     @@ -47349,7 +46664,7 @@
    Fields
    Example
    {
-  "added_at": "xyz789",
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
   "id": "4",
@@ -47404,8 +46719,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "duplicated_quote_uid": "4",
-  "quote_uid": 4
+  "duplicated_quote_uid": 4,
+  "quote_uid": "4"
 }
 
    
                 
    
@@ -47665,7 +46980,7 @@ 
    Example
    
                   
    {
   "items": [DynamicBlock],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
    @@ -47718,11 +47033,7 @@
    Fields
    Example
    - 
    {
-  "dynamic_block_uids": ["4"],
-  "locations": ["CONTENT"],
-  "type": "SPECIFIED"
-}
+                  
    {"dynamic_block_uids": [4], "locations": ["CONTENT"], "type": "SPECIFIED"}
    @@ -47769,8 +47080,8 @@
    Fields
    Example
    {
-  "attribute_code": "xyz789",
-  "value": "xyz789"
+  "attribute_code": "abc123",
+  "value": "abc123"
 }
    @@ -47817,7 +47128,10 @@
    Fields
    Example
    - 
    {"uid": 4, "value": "abc123"}
+                  
    {
+  "uid": "4",
+  "value": "xyz789"
+}
    @@ -47885,9 +47199,9 @@
    Fields
    Example
    {
-  "canonical_url": "xyz789",
-  "entity_uid": 4,
-  "id": 123,
+  "canonical_url": "abc123",
+  "entity_uid": "4",
+  "id": 987,
   "redirectCode": 123,
   "relative_url": "xyz789",
   "type": "CMS_PAGE"
@@ -47959,7 +47273,7 @@ 
    Possible Types
    
                   
    Example
    
                   
    {
   "code": "PRODUCT_NOT_FOUND",
-  "message": "abc123"
+  "message": "xyz789"
 }
    @@ -48022,7 +47336,7 @@
    Possible Types
    Example
    - 
    {"message": "xyz789"}
+                  
    {"message": "abc123"}
    @@ -48076,7 +47390,7 @@
    Fields
    Example
    {
   "country_code": "AF",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": CustomerAddressRegionInput
 }
    @@ -48128,7 +47442,7 @@
    Fields
    Example
    {
   "address": EstimateAddressInput,
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "shipping_method": ShippingMethodInput
 }
    @@ -48170,93 +47484,6 @@
    Fields
    Example
    {"cart": Cart}
-
    -
    - - -
    -
    -
    - Types -
    -

    ExchangeExternalCustomerTokenInput

    -
    -
    -
    -
    Description
    -

    Contains details about external customer.

    -
    -
    -
    Fields
    - - - - - - - - - - - - - -
    Input FieldDescription
    - customer - CustomerCreateInput! - An input object that defines the customer characteristics to update.
    -
    -
    -
    -
    -
    Example
    - 
    {"customer": CustomerCreateInput}
-
    -
    -
    -
    -
    -
    -
    - Types -
    -

    ExchangeExternalCustomerTokenOutput

    -
    -
    -
    -
    Description
    -

    Contains customer token for external customer.

    -
    -
    -
    Fields
    - - - - - - - - - - - - - - - - - -
    Field NameDescription
    customer - Customer! - Return detailed information about a customer account.
    token - String! - The customer authorization token.
    -
    -
    -
    -
    -
    Example
    - 
    {
-  "customer": Customer,
-  "token": "xyz789"
-}
    @@ -48300,135 +47527,7 @@
    Fields
    Example
    - 
    {"currency_to": "xyz789", "rate": 987.65}
-
    -
    -
    -
    -
    -
    -
    - Types -
    -

    FastlaneConfig

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

    FastlaneMethodInput

    -
    -
    -
    -
    Description
    -

    Fastlane Payment inputs

    -
    -
    -
    Fields
    - - - - - - - - - - - - - - - - - -
    Input FieldDescription
    - payment_source - String - The payment source for the payment method
    - paypal_fastlane_token - String - The single use token from Fastlane
    -
    -
    -
    -
    -
    Example
    - 
    {
-  "payment_source": "abc123",
-  "paypal_fastlane_token": "abc123"
-}
+                  
    {"currency_to": "abc123", "rate": 123.45}
    @@ -48475,7 +47574,7 @@
    Fields
    Example
    {
-  "eq": "abc123",
+  "eq": "xyz789",
   "in": ["xyz789"]
 }
    @@ -48567,7 +47666,7 @@
    Fields
    Example
    - 
    {"match": "abc123", "match_type": "FULL"}
+                  
    {"match": "xyz789", "match_type": "FULL"}
    @@ -48614,7 +47713,7 @@
    Fields
    Example
    {
-  "from": "abc123",
+  "from": "xyz789",
   "to": "abc123"
 }
    @@ -48799,20 +47898,20 @@
    Fields
    Example
    {
   "eq": "abc123",
-  "finset": ["abc123"],
-  "from": "abc123",
-  "gt": "xyz789",
-  "gteq": "abc123",
+  "finset": ["xyz789"],
+  "from": "xyz789",
+  "gt": "abc123",
+  "gteq": "xyz789",
   "in": ["xyz789"],
-  "like": "xyz789",
+  "like": "abc123",
   "lt": "abc123",
   "lteq": "xyz789",
-  "moreq": "abc123",
+  "moreq": "xyz789",
   "neq": "xyz789",
-  "nin": ["abc123"],
-  "notnull": "abc123",
-  "null": "xyz789",
-  "to": "xyz789"
+  "nin": ["xyz789"],
+  "notnull": "xyz789",
+  "null": "abc123",
+  "to": "abc123"
 }
    @@ -48945,7 +48044,7 @@
    Description
    Example
    - 
    987.65
+                  
    123.45
    @@ -49064,7 +48163,7 @@
    Fields
    Example
    - 
    {"template_id": 4}
+                  
    {"template_id": "4"}
    @@ -49193,8 +48292,8 @@
    Fields
    Example
    {
   "balance": Money,
-  "code": "abc123",
-  "expiration_date": "xyz789"
+  "code": "xyz789",
+  "expiration_date": "abc123"
 }
    @@ -49235,7 +48334,7 @@
    Fields
    Example
    - 
    {"gift_card_code": "xyz789"}
+                  
    {"gift_card_code": "abc123"}
    @@ -49301,12 +48400,12 @@
    Fields
    Example
    {
-  "attribute_id": 987,
+  "attribute_id": 123,
   "uid": 4,
   "value": 987.65,
   "value_id": 987,
-  "website_id": 123,
-  "website_value": 123.45
+  "website_id": 987,
+  "website_value": 987.65
 }
    @@ -49466,22 +48565,22 @@
    Example
    "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "abc123", - "is_available": true, - "max_qty": 123.45, - "message": "xyz789", - "min_qty": 123.45, - "not_available_message": "xyz789", + "id": "xyz789", + "is_available": false, + "max_qty": 987.65, + "message": "abc123", + "min_qty": 987.65, + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, - "recipient_email": "xyz789", - "recipient_name": "abc123", + "quantity": 987.65, + "recipient_email": "abc123", + "recipient_name": "xyz789", "sender_email": "xyz789", - "sender_name": "xyz789", - "uid": 4 + "sender_name": "abc123", + "uid": "4" }
    @@ -49555,12 +48654,12 @@
    Example
    {
   "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": 123.45
+  "product_sku": "xyz789",
+  "quantity_refunded": 987.65
 }
    @@ -49634,12 +48733,12 @@
    Example
    {
   "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
 }
    @@ -49700,9 +48799,9 @@
    Fields
    Example
    {
-  "message": "abc123",
+  "message": "xyz789",
   "recipient_email": "xyz789",
-  "recipient_name": "abc123",
+  "recipient_name": "xyz789",
   "sender_email": "xyz789",
   "sender_name": "abc123"
 }
@@ -49778,7 +48877,7 @@ 
    Example
    
   "amount": Money,
   "custom_giftcard_amount": Money,
   "message": "abc123",
-  "recipient_email": "abc123",
+  "recipient_email": "xyz789",
   "recipient_name": "abc123",
   "sender_email": "abc123",
   "sender_name": "xyz789"
@@ -49929,7 +49028,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "discounts": [Discount],
-  "eligible_for_return": true,
+  "eligible_for_return": false,
   "entered_options": [OrderItemOption],
   "gift_card": GiftCardItem,
   "gift_message": GiftMessage,
@@ -49939,18 +49038,18 @@ 
    Example
    
   "product": ProductInterface,
   "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": 123.45,
+  "quantity_canceled": 987.65,
   "quantity_invoiced": 987.65,
-  "quantity_ordered": 987.65,
-  "quantity_refunded": 123.45,
+  "quantity_ordered": 123.45,
+  "quantity_refunded": 987.65,
   "quantity_return_requested": 987.65,
-  "quantity_returned": 987.65,
+  "quantity_returned": 123.45,
   "quantity_shipped": 123.45,
   "selected_options": [OrderItemOption],
-  "status": "abc123"
+  "status": "xyz789"
 }
    @@ -50366,6 +49465,11 @@
    currentPage + + rules - [CatalogRule] + + Provides applied catalog rules in the current active cart + sale - Int @@ -50546,15 +49650,15 @@
    currentPage
    Example
    {
-  "activity": "xyz789",
-  "allow_message": false,
-  "allow_open_amount": false,
-  "attribute_set_id": 123,
-  "canonical_url": "xyz789",
+  "activity": "abc123",
+  "allow_message": true,
+  "allow_open_amount": true,
+  "attribute_set_id": 987,
+  "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
+  "category_gear": "xyz789",
   "climate": "abc123",
-  "collar": "abc123",
+  "collar": "xyz789",
   "color": 123,
   "country_of_manufacture": "abc123",
   "created_at": "xyz789",
@@ -50562,9 +49666,9 @@ 
    Example
    
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "eco_collection": 123,
-  "erin_recommends": 987,
-  "features_bags": "abc123",
-  "format": 123,
+  "erin_recommends": 123,
+  "features_bags": "xyz789",
+  "format": 987,
   "gender": "abc123",
   "gift_card_options": [CustomizableOptionInterface],
   "gift_message_available": false,
@@ -50574,7 +49678,7 @@ 
    Example
    
   "giftcard_type": "VIRTUAL",
   "id": 987,
   "image": ProductImage,
-  "is_redeemable": false,
+  "is_redeemable": true,
   "is_returnable": "xyz789",
   "lifetime": 987,
   "manufacturer": 987,
@@ -50583,63 +49687,64 @@ 
    Example
    
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
   "message_max_length": 123,
-  "meta_description": "xyz789",
+  "meta_description": "abc123",
   "meta_keyword": "xyz789",
   "meta_title": "abc123",
-  "min_sale_qty": 123.45,
+  "min_sale_qty": 987.65,
   "name": "xyz789",
-  "new": 123,
+  "new": 987,
   "new_from_date": "xyz789",
-  "new_to_date": "xyz789",
-  "only_x_left_in_stock": 987.65,
-  "open_amount_max": 987.65,
+  "new_to_date": "abc123",
+  "only_x_left_in_stock": 123.45,
+  "open_amount_max": 123.45,
   "open_amount_min": 123.45,
   "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": 123,
+  "purpose": 987,
   "quantity": 123.45,
-  "rating_summary": 987.65,
-  "redirect_code": 123,
+  "rating_summary": 123.45,
+  "redirect_code": 987,
   "related_products": [ProductInterface],
   "relative_url": "abc123",
   "review_count": 987,
   "reviews": ProductReviews,
-  "sale": 123,
+  "rules": [CatalogRule],
+  "sale": 987,
   "short_description": ComplexTextValue,
   "size": 123,
   "sku": "xyz789",
   "sleeve": "xyz789",
   "small_image": ProductImage,
   "special_from_date": "abc123",
-  "special_price": 987.65,
-  "special_to_date": "abc123",
-  "staged": true,
+  "special_price": 123.45,
+  "special_to_date": "xyz789",
+  "staged": false,
   "stock_status": "IN_STOCK",
   "strap_bags": "xyz789",
-  "style_bags": "abc123",
-  "style_bottom": "abc123",
-  "style_general": "abc123",
-  "swatch_image": "xyz789",
+  "style_bags": "xyz789",
+  "style_bottom": "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,
-  "updated_at": "abc123",
+  "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": 123.45
+  "weight": 987.65
 }
    @@ -50703,8 +49808,8 @@
    Example
    "customizable_options": [SelectedCustomizableOption], "gift_card_options": GiftCardOptions, "product": ProductInterface, - "quantity": 123.45, - "uid": "4" + "quantity": 987.65, + "uid": 4 }     @@ -50772,9 +49877,9 @@
    Fields
    Example
    {
   "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": 123.45
@@ -50903,60 +50008,13 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "added_at": "abc123",
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
+  "description": "xyz789",
   "gift_card_options": GiftCardOptions,
   "id": 4,
   "product": ProductInterface,
-  "quantity": 123.45
-}
-
    
-                
    
-              
-            
-
    -
    -
    - Types -
    -

    GiftCartAttributeValue

    -
    -
    -
    -
    Description
    -

    Gift card custom attribute value containing array data.

    -
    -
    -
    Fields
    - - - - - - - - - - - - - - - - - -
    Field NameDescription
    code - ID! - The attribute code.
    options - [String]! - Array of gift card attribute option values.
    -
    -
    -
    -
    -
    Example
    - 
    {
-  "code": "4",
-  "options": ["abc123"]
+  "quantity": 987.65
 }
    @@ -51007,9 +50065,9 @@
    Fields
    Example
    {
-  "from": "xyz789",
+  "from": "abc123",
   "message": "abc123",
-  "to": "abc123"
+  "to": "xyz789"
 }
    @@ -51064,8 +50122,8 @@
    Fields
    Example
    {
   "from": "abc123",
-  "message": "xyz789",
-  "to": "abc123"
+  "message": "abc123",
+  "to": "xyz789"
 }
    @@ -51232,7 +50290,7 @@
    Fields
    Example
    {
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "dynamic_attributes": [GiftRegistryDynamicAttribute],
   "event_name": "abc123",
   "items": [GiftRegistryItemInterface],
@@ -51243,7 +50301,7 @@ 
    Example
    
   "shipping_address": CustomerAddress,
   "status": "ACTIVE",
   "type": GiftRegistryType,
-  "uid": 4
+  "uid": "4"
 }
    @@ -51295,10 +50353,10 @@
    Fields
    Example
    {
-  "code": 4,
+  "code": "4",
   "group": "EVENT_INFORMATION",
   "label": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
    @@ -51492,8 +50550,8 @@
    Possible Types
    Example
    {
-  "code": 4,
-  "label": "abc123",
+  "code": "4",
+  "label": "xyz789",
   "value": "abc123"
 }
    @@ -51556,9 +50614,9 @@
    Fields
    Example
    {
-  "attribute_group": "xyz789",
-  "code": 4,
-  "input_type": "xyz789",
+  "attribute_group": "abc123",
+  "code": "4",
+  "input_type": "abc123",
   "is_required": false,
   "label": "abc123",
   "sort_order": 987
@@ -51640,12 +50698,12 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "attribute_group": "xyz789",
-  "code": "4",
+  "attribute_group": "abc123",
+  "code": 4,
   "input_type": "abc123",
   "is_required": false,
   "label": "abc123",
-  "sort_order": 987
+  "sort_order": 123
 }
 
    
                 
    
@@ -51708,10 +50766,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "created_at": "abc123",
-  "note": "abc123",
+  "note": "xyz789",
   "product": ProductInterface,
   "quantity": 123.45,
-  "quantity_fulfilled": 123.45,
+  "quantity_fulfilled": 987.65,
   "uid": "4"
 }
 
    
@@ -51791,12 +50849,12 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "created_at": "abc123",
-  "note": "xyz789",
+  "created_at": "xyz789",
+  "note": "abc123",
   "product": ProductInterface,
   "quantity": 123.45,
   "quantity_fulfilled": 123.45,
-  "uid": 4
+  "uid": "4"
 }
 
    
                 
    
@@ -51923,7 +50981,7 @@ 
    Example
    
                   
    {
   "code": "OUT_OF_STOCK",
   "gift_registry_item_uid": 4,
-  "gift_registry_uid": 4,
+  "gift_registry_uid": "4",
   "message": "xyz789",
   "product_uid": 4
 }
@@ -52146,9 +51204,9 @@ 
    Example
    
     GiftRegistryRegistrantDynamicAttribute
   ],
   "email": "abc123",
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "lastname": "xyz789",
-  "uid": "4"
+  "uid": 4
 }
    @@ -52195,9 +51253,9 @@
    Fields
    Example
    {
-  "code": "4",
+  "code": 4,
   "label": "abc123",
-  "value": "xyz789"
+  "value": "abc123"
 }
    @@ -52263,12 +51321,12 @@
    Fields
    Example
    {
-  "event_date": "abc123",
-  "event_title": "xyz789",
-  "gift_registry_uid": 4,
-  "location": "xyz789",
-  "name": "xyz789",
-  "type": "abc123"
+  "event_date": "xyz789",
+  "event_title": "abc123",
+  "gift_registry_uid": "4",
+  "location": "abc123",
+  "name": "abc123",
+  "type": "xyz789"
 }
    @@ -52308,12 +51366,6 @@
    Fields
    The ID assigned to this customer address. - - - customer_address_uid - ID - - The unique ID assigned to this customer address. -
    @@ -52321,11 +51373,7 @@
    Fields
    Example
    - 
    {
-  "address_data": CustomerAddressInput,
-  "address_id": 4,
-  "customer_address_uid": 4
-}
+                  
    {"address_data": CustomerAddressInput, "address_id": 4}
    @@ -52489,8 +51537,8 @@
    Fields
    Example
    {
-  "design": "xyz789",
-  "id": "4",
+  "design": "abc123",
+  "id": 4,
   "image": GiftWrappingImage,
   "price": Money,
   "uid": "4"
@@ -52539,8 +51587,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "label": "xyz789",
-  "url": "xyz789"
+  "label": "abc123",
+  "url": "abc123"
 }
 
    
                 
    
@@ -52587,9 +51635,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "color": "abc123",
+  "color": "xyz789",
   "height": 123,
-  "type": "xyz789"
+  "type": "abc123"
 }
 
    
                 
    
@@ -52668,8 +51716,8 @@ 
    Example
    
                   
    {
   "button_styles": GooglePayButtonStyles,
   "code": "abc123",
-  "is_visible": true,
-  "payment_intent": "abc123",
+  "is_visible": false,
+  "payment_intent": "xyz789",
   "payment_source": "abc123",
   "sdk_params": [SDKParams],
   "sort_order": "xyz789",
@@ -52728,7 +51776,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "payment_source": "xyz789",
+  "payment_source": "abc123",
   "payments_order_id": "xyz789",
   "paypal_order_id": "xyz789"
 }
@@ -53096,6 +52144,11 @@ 
    currentPage
                         
                       
+                      
+                        rules - [CatalogRule]
+                        
+                         Provides applied catalog rules in the current active cart 
+                      
                       
                         sale - Int
                         
@@ -53276,83 +52329,84 @@ 
    currentPage
                   
    Example
    
                   
    {
-  "activity": "abc123",
-  "attribute_set_id": 123,
-  "canonical_url": "xyz789",
+  "activity": "xyz789",
+  "attribute_set_id": 987,
+  "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "xyz789",
-  "climate": "abc123",
+  "category_gear": "abc123",
+  "climate": "xyz789",
   "collar": "abc123",
   "color": 987,
-  "country_of_manufacture": "xyz789",
-  "created_at": "abc123",
+  "country_of_manufacture": "abc123",
+  "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "eco_collection": 987,
   "erin_recommends": 987,
-  "features_bags": "xyz789",
+  "features_bags": "abc123",
   "format": 123,
   "gender": "xyz789",
-  "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",
   "items": [GroupedProductItem],
   "manufacturer": 123,
   "material": "xyz789",
-  "max_sale_qty": 987.65,
+  "max_sale_qty": 123.45,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
+  "meta_description": "xyz789",
   "meta_keyword": "xyz789",
-  "meta_title": "xyz789",
-  "min_sale_qty": 987.65,
-  "name": "abc123",
-  "new": 123,
+  "meta_title": "abc123",
+  "min_sale_qty": 123.45,
+  "name": "xyz789",
+  "new": 987,
   "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",
   "pattern": "abc123",
   "performance_fabric": 987,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 987,
-  "quantity": 987.65,
+  "purpose": 123,
+  "quantity": 123.45,
   "rating_summary": 987.65,
-  "redirect_code": 123,
+  "redirect_code": 987,
   "related_products": [ProductInterface],
   "relative_url": "abc123",
-  "review_count": 987,
+  "review_count": 123,
   "reviews": ProductReviews,
-  "sale": 987,
+  "rules": [CatalogRule],
+  "sale": 123,
   "short_description": ComplexTextValue,
   "size": 123,
   "sku": "xyz789",
   "sleeve": "abc123",
   "small_image": ProductImage,
-  "special_from_date": "xyz789",
-  "special_price": 987.65,
-  "special_to_date": "xyz789",
-  "staged": false,
+  "special_from_date": "abc123",
+  "special_price": 123.45,
+  "special_to_date": "abc123",
+  "staged": true,
   "stock_status": "IN_STOCK",
   "strap_bags": "abc123",
   "style_bags": "abc123",
   "style_bottom": "abc123",
   "style_general": "xyz789",
-  "swatch_image": "xyz789",
+  "swatch_image": "abc123",
   "thumbnail": ProductImage,
-  "tier_price": 987.65,
+  "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "xyz789",
+  "type_id": "abc123",
   "uid": 4,
-  "updated_at": "xyz789",
+  "updated_at": "abc123",
   "upsell_products": [ProductInterface],
   "url_key": "xyz789",
   "url_path": "abc123",
@@ -53478,10 +52532,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "added_at": "abc123",
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
-  "id": 4,
+  "id": "4",
   "product": ProductInterface,
   "quantity": 123.45
 }
@@ -53531,64 +52585,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "reason": "abc123",
-  "token": "xyz789"
-}
-
    
-                
    
-              
    
-            
    
-
    -
    -
    - Types -
    -

    GuestOrderInformationInput

    -
    -
    -
    -
    Description
    -

    Input to retrieve an order based on details.

    -
    -
    -
    Fields
    - - - - - - - - - - - - - - - - - - - - - -
    Input FieldDescription
    - email - String! - Order billing address email.
    - lastname - String! - Order billing address lastname.
    - number - String! - Order number.
    -
    -
    -
    -
    -
    Example
    - 
    {
-  "email": "xyz789",
-  "lastname": "xyz789",
-  "number": "xyz789"
+  "reason": "xyz789",
+  "token": "abc123"
 }
    @@ -53681,18 +52679,18 @@
    Fields
    Example
    {
-  "cc_vault_code": "abc123",
-  "code": "abc123",
+  "cc_vault_code": "xyz789",
+  "code": "xyz789",
   "is_vault_enabled": true,
   "is_visible": true,
-  "payment_intent": "abc123",
+  "payment_intent": "xyz789",
   "payment_source": "abc123",
-  "requires_card_details": true,
+  "requires_card_details": false,
   "sdk_params": [SDKParams],
   "sort_order": "xyz789",
-  "three_ds": true,
+  "three_ds": false,
   "three_ds_mode": "OFF",
-  "title": "abc123"
+  "title": "xyz789"
 }
    @@ -53782,15 +52780,15 @@
    Fields
    Example
    {
-  "cardBin": "abc123",
-  "cardExpiryMonth": "xyz789",
-  "cardExpiryYear": "xyz789",
+  "cardBin": "xyz789",
+  "cardExpiryMonth": "abc123",
+  "cardExpiryYear": "abc123",
   "cardLast4": "xyz789",
-  "holderName": "abc123",
-  "is_active_payment_token_enabler": false,
-  "payment_source": "abc123",
+  "holderName": "xyz789",
+  "is_active_payment_token_enabler": true,
+  "payment_source": "xyz789",
   "payments_order_id": "xyz789",
-  "paypal_order_id": "abc123"
+  "paypal_order_id": "xyz789"
 }
    @@ -53838,7 +52836,7 @@
    Fields
    Example
    {
-  "cancel_url": "xyz789",
+  "cancel_url": "abc123",
   "return_url": "xyz789"
 }
    @@ -53964,7 +52962,7 @@
    Fields
    Example
    {
-  "name": "xyz789",
+  "name": "abc123",
   "value": "xyz789"
 }
    @@ -53987,7 +52985,7 @@
    Description
    Example
    - 
    "4"
+                  
    4
    @@ -54028,7 +53026,7 @@
    Fields
    Example
    {
-  "thumbnail": "abc123",
+  "thumbnail": "xyz789",
   "value": "abc123"
 }
    @@ -54141,8 +53139,8 @@
    Fields
    Example
    {
   "code": "PRODUCT_NOT_FOUND",
-  "message": "abc123",
-  "quantity": 987.65
+  "message": "xyz789",
+  "quantity": 123.45
 }
    @@ -54266,7 +53264,7 @@
    Example
    "comments": [SalesCommentItem], "id": 4, "items": [InvoiceItemInterface], - "number": "abc123", + "number": "xyz789", "total": InvoiceTotal }     @@ -54335,12 +53333,12 @@
    Fields
    Example
    {
   "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
+  "quantity_invoiced": 123.45
 }
    @@ -54417,12 +53415,12 @@
    Possible Types
    -

    DownloadableInvoiceItem

    +

    BundleInvoiceItem

    -

    BundleInvoiceItem

    +

    DownloadableInvoiceItem

    @@ -54444,7 +53442,7 @@
    Possible Types
    Example
    {
   "discounts": [Discount],
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
@@ -54572,7 +53570,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"is_email_available": true}
+                  
    {"is_email_available": false}
 
    
                 
    
               
    
@@ -54611,7 +53609,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"is_email_available": true}
+                  
    {"is_email_available": false}
 
    
                 
    
               
    
@@ -54650,7 +53648,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"is_role_name_available": true}
+                  
    {"is_role_name_available": false}
 
    
                 
    
               
    
@@ -54689,7 +53687,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"is_email_available": true}
+                  
    {"is_email_available": false}
 
    
                 
    
               
    
@@ -54728,7 +53726,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"is_email_available": true}
+                  
    {"is_email_available": false}
 
    
                 
    
               
    
@@ -54793,12 +53791,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "creator_id": 123,
-  "creator_type": 987,
-  "negotiable_quote_item_uid": 4,
+  "creator_type": 123,
+  "negotiable_quote_item_uid": "4",
   "note": "abc123",
-  "note_uid": 4
+  "note_uid": "4"
 }
 
    
                 
    
@@ -54929,7 +53927,7 @@ 
    Example
    
   "price": Money,
   "product_name": "abc123",
   "product_sku": "abc123",
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": "4"
 }
    @@ -55091,7 +54089,7 @@
    Fields
    Example
    {
   "items_count": 123,
-  "label": "abc123",
+  "label": "xyz789",
   "value_string": "abc123"
 }
    @@ -55164,9 +54162,9 @@
    Possible Types
    Example
    {
-  "items_count": 123,
+  "items_count": 987,
   "label": "xyz789",
-  "value_string": "xyz789"
+  "value_string": "abc123"
 }
    @@ -55220,9 +54218,9 @@
    Fields
    Example
    {
-  "note": "abc123",
+  "note": "xyz789",
   "quote_item_uid": "4",
-  "quote_uid": 4
+  "quote_uid": "4"
 }
    @@ -55315,9 +54313,9 @@
    Example
    "id": 123, "label": "abc123", "media_type": "xyz789", - "position": 123, - "types": ["abc123"], - "uid": "4", + "position": 987, + "types": ["xyz789"], + "uid": 4, "video_content": ProductMediaGalleryEntriesVideoContent }     @@ -55361,11 +54359,6 @@
    Fields
    The media item's position after it has been sorted. - - types - [String] - - Array of image types. It can have the following values: image, small_image, thumbnail. - url - String @@ -55402,10 +54395,9 @@
    Possible Types
    Example
    {
   "disabled": true,
-  "label": "abc123",
+  "label": "xyz789",
   "position": 123,
-  "types": ["abc123"],
-  "url": "abc123"
+  "url": "xyz789"
 }
    @@ -55482,7 +54474,7 @@
    Fields
    Example
    {
-  "layout": "abc123",
+  "layout": "xyz789",
   "logo": MessageStyleLogo
 }
    @@ -55528,7 +54520,7 @@
    Fields
    Example
    - 
    {"currency": "AFN", "value": 987.65}
+                  
    {"currency": "AFN", "value": 123.45}
    @@ -55579,7 +54571,7 @@
    Fields
    Example
    {
   "gift_registry": GiftRegistry,
-  "status": true,
+  "status": false,
   "user_errors": [GiftRegistryItemsUserError]
 }
    @@ -55621,7 +54613,7 @@
    Fields
    Example
    - 
    {"requisitionListItemUids": [4]}
+                  
    {"requisitionListItemUids": ["4"]}
    @@ -55721,7 +54713,7 @@
    Fields
    Example
    {
-  "quote_item_uid": "4",
+  "quote_item_uid": 4,
   "quote_uid": "4",
   "requisition_list_uid": "4"
 }
@@ -55940,10 +54932,10 @@ 
    Example
    
   "billing_address": NegotiableQuoteBillingAddress,
   "buyer": NegotiableQuoteUser,
   "comments": [NegotiableQuoteComment],
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "email": "abc123",
   "history": [NegotiableQuoteHistoryEntry],
-  "is_virtual": false,
+  "is_virtual": true,
   "items": [CartItemInterface],
   "name": "abc123",
   "prices": CartPrices,
@@ -55951,8 +54943,8 @@ 
    Example
    
   "shipping_addresses": [NegotiableQuoteShippingAddress],
   "status": "SUBMITTED",
   "total_quantity": 123.45,
-  "uid": 4,
-  "updated_at": "xyz789"
+  "uid": "4",
+  "updated_at": "abc123"
 }
    @@ -55998,8 +54990,8 @@
    Fields
    Example
    {
-  "code": "abc123",
-  "label": "xyz789"
+  "code": "xyz789",
+  "label": "abc123"
 }
    @@ -56101,15 +55093,15 @@
    Fields
    Example
    {
-  "city": "abc123",
+  "city": "xyz789",
   "company": "abc123",
   "country_code": "abc123",
   "firstname": "xyz789",
   "lastname": "xyz789",
   "postcode": "xyz789",
   "region": "xyz789",
-  "region_id": 123,
-  "save_in_address_book": true,
+  "region_id": 987,
+  "save_in_address_book": false,
   "street": ["abc123"],
   "telephone": "xyz789"
 }
@@ -56210,12 +55202,12 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "city": "abc123",
-  "company": "abc123",
+  "city": "xyz789",
+  "company": "xyz789",
   "country": NegotiableQuoteAddressCountry,
-  "firstname": "xyz789",
+  "firstname": "abc123",
   "lastname": "abc123",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": NegotiableQuoteAddressRegion,
   "street": ["xyz789"],
   "telephone": "abc123"
@@ -56269,9 +55261,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "xyz789",
+  "code": "abc123",
   "label": "abc123",
-  "region_id": 123
+  "region_id": 987
 }
 
    
                 
    
@@ -56348,14 +55340,14 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "xyz789",
-  "company": "xyz789",
+  "city": "abc123",
+  "company": "abc123",
   "country": NegotiableQuoteAddressCountry,
   "firstname": "abc123",
   "lastname": "xyz789",
   "postcode": "abc123",
   "region": NegotiableQuoteAddressRegion,
-  "street": ["abc123"],
+  "street": ["xyz789"],
   "telephone": "abc123"
 }
 
    
@@ -56419,7 +55411,7 @@ 
    Example
    
   "address": NegotiableQuoteAddressInput,
   "customer_address_uid": 4,
   "same_as_shipping": true,
-  "use_for_shipping": true
+  "use_for_shipping": false
 }
 
    
                 
    
@@ -56483,7 +55475,7 @@ 
    Example
    
   "author": NegotiableQuoteUser,
   "created_at": "xyz789",
   "creator_type": "BUYER",
-  "text": "xyz789",
+  "text": "abc123",
   "uid": 4
 }
    @@ -56569,7 +55561,7 @@
    Fields
    Example
    - 
    {"comment": "abc123"}
+                  
    {"comment": "xyz789"}
    @@ -56621,7 +55613,7 @@
    Example
    {
   "new_value": "xyz789",
   "old_value": "xyz789",
-  "title": "xyz789"
+  "title": "abc123"
 }
    @@ -56844,7 +55836,7 @@
    Example
    "author": NegotiableQuoteUser, "change_type": "CREATED", "changes": NegotiableQuoteHistoryChanges, - "created_at": "abc123", + "created_at": "xyz789", "uid": "4" }     @@ -56950,7 +55942,7 @@
    Fields
    Example
    {
   "new_expiration": "xyz789",
-  "old_expiration": "xyz789"
+  "old_expiration": "abc123"
 }
    @@ -57167,7 +56159,7 @@
    Fields
    Example
    - 
    {"message": "abc123"}
+                  
    {"message": "xyz789"}
    @@ -57213,7 +56205,7 @@
    Fields
    Example
    - 
    {"quantity": 123.45, "quote_item_uid": 4}
+                  
    {"quantity": 987.65, "quote_item_uid": 4}
    @@ -57319,7 +56311,7 @@
    Example
    {
   "document_identifier": "xyz789",
   "document_name": "abc123",
-  "link_id": "4",
+  "link_id": 4,
   "reference_document_url": "abc123"
 }
    @@ -57408,12 +56400,12 @@
    Fields
    Example
    {
   "available_shipping_methods": [AvailableShippingMethod],
-  "city": "abc123",
+  "city": "xyz789",
   "company": "abc123",
   "country": NegotiableQuoteAddressCountry,
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "lastname": "abc123",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "region": NegotiableQuoteAddressRegion,
   "selected_shipping_method": SelectedShippingMethod,
   "street": ["abc123"],
@@ -57789,7 +56781,7 @@ 
    Example
    
   "is_virtual": false,
   "items": [CartItemInterface],
   "max_order_commitment": 123,
-  "min_order_commitment": 123,
+  "min_order_commitment": 987,
   "name": "xyz789",
   "notifications": [QuoteTemplateNotificationMessage],
   "prices": CartPrices,
@@ -57798,7 +56790,7 @@ 
    Example
    
   ],
   "shipping_addresses": [NegotiableQuoteShippingAddress],
   "status": "abc123",
-  "template_id": 4,
+  "template_id": "4",
   "total_quantity": 123.45
 }
    @@ -57962,14 +56954,14 @@
    Example
    "activated_at": "abc123", "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": 123.45, + "min_negotiated_grand_total": 987.65, "min_order_commitment": 123, "name": "xyz789", - "orders_placed": 987, - "sales_rep_name": "abc123", + "orders_placed": 123, + "sales_rep_name": "xyz789", "state": "xyz789", "status": "abc123", "submitted_by": "abc123", @@ -58032,7 +57024,12 @@
    Fields
    Example
    - 
    {"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": 987.65
+}
    @@ -58092,9 +57089,9 @@
    Fields
    Example
    {
   "document_identifier": "xyz789",
-  "document_name": "xyz789",
-  "link_id": 4,
-  "reference_document_url": "xyz789"
+  "document_name": "abc123",
+  "link_id": "4",
+  "reference_document_url": "abc123"
 }
    @@ -58150,7 +57147,7 @@
    Example
    {
   "address": NegotiableQuoteAddressInput,
   "customer_address_uid": 4,
-  "customer_notes": "xyz789"
+  "customer_notes": "abc123"
 }
    @@ -58297,7 +57294,7 @@
    Example
    "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 }     @@ -58350,7 +57347,7 @@
    Possible Types
    Example
    - 
    {"quote_uid": 4}
+                  
    {"quote_uid": "4"}
    @@ -58389,7 +57386,7 @@
    Fields
    Example
    - 
    {"quote_uid": 4}
+                  
    {"quote_uid": "4"}
    @@ -58435,7 +57432,7 @@
    Fields
    Example
    {
   "firstname": "xyz789",
-  "lastname": "abc123"
+  "lastname": "xyz789"
 }
    @@ -58494,7 +57491,7 @@
    Example
    "items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 }     @@ -58540,7 +57537,7 @@
    Fields
    Example
    {
-  "message": "abc123",
+  "message": "xyz789",
   "uid": "4"
 }
    @@ -58582,7 +57579,7 @@
    Fields
    Example
    - 
    {"template_id": 4}
+                  
    {"template_id": "4"}
    @@ -58630,7 +57627,7 @@
    Fields
    Example
    {
   "order_id": "abc123",
-  "order_number": "xyz789"
+  "order_number": "abc123"
 }
    @@ -58815,21 +57812,21 @@
    attributeCodes
    Example
    {
   "city": "abc123",
-  "company": "abc123",
+  "company": "xyz789",
   "country_code": "AF",
   "custom_attributesV2": [AttributeValueInterface],
-  "fax": "abc123",
-  "firstname": "abc123",
+  "fax": "xyz789",
+  "firstname": "xyz789",
   "lastname": "abc123",
-  "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"
 }
    @@ -58886,12 +57883,68 @@
    Fields
    Example
    {
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "lastname": "abc123",
-  "middlename": "abc123",
-  "prefix": "xyz789",
+  "middlename": "xyz789",
+  "prefix": "abc123",
   "suffix": "xyz789"
 }
+
    +
    + + +
    +
    +
    + Types +
    +

    OrderInformationInput

    +
    +
    +
    +
    Description
    +

    Input to retrieve an order based on details.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + email - String! + Order billing address email.
    + lastname - String! + Order billing address lastname.
    + number - String! + Order number.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "email": "xyz789",
+  "lastname": "abc123",
+  "number": "xyz789"
+}
    @@ -59033,7 +58086,7 @@
    Fields
    Example
    {
   "discounts": [Discount],
-  "eligible_for_return": true,
+  "eligible_for_return": false,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
@@ -59044,16 +58097,16 @@ 
    Example
    
   "product_sale_price": Money,
   "product_sku": "xyz789",
   "product_type": "abc123",
-  "product_url_key": "abc123",
+  "product_url_key": "xyz789",
   "quantity_canceled": 123.45,
   "quantity_invoiced": 123.45,
-  "quantity_ordered": 987.65,
+  "quantity_ordered": 123.45,
   "quantity_refunded": 123.45,
   "quantity_return_requested": 987.65,
-  "quantity_returned": 987.65,
-  "quantity_shipped": 123.45,
+  "quantity_returned": 123.45,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "abc123"
+  "status": "xyz789"
 }
    @@ -59210,12 +58263,12 @@
    Possible Types
    -

    DownloadableOrderItem

    +

    BundleOrderItem

    -

    BundleOrderItem

    +

    DownloadableOrderItem

    @@ -59237,7 +58290,7 @@
    Possible Types
    Example
    {
   "discounts": [Discount],
-  "eligible_for_return": true,
+  "eligible_for_return": false,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
@@ -59246,18 +58299,18 @@ 
    Example
    
   "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": 123.45,
   "quantity_invoiced": 987.65,
   "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": 123.45,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "xyz789"
+  "status": "abc123"
 }
    @@ -59303,8 +58356,8 @@
    Fields
    Example
    {
-  "label": "xyz789",
-  "value": "abc123"
+  "label": "abc123",
+  "value": "xyz789"
 }
    @@ -59454,7 +58507,7 @@
    Fields
    Example
    {
   "additional_data": [KeyValue],
-  "name": "xyz789",
+  "name": "abc123",
   "type": "abc123"
 }
    @@ -59519,7 +58572,7 @@
    Example
    "comments": [SalesCommentItem], "id": "4", "items": [ShipmentItemInterface], - "number": "xyz789", + "number": "abc123", "tracking": [ShipmentTracking] }     @@ -59561,7 +58614,7 @@
    Fields
    Example
    - 
    {"token": "xyz789"}
+                  
    {"token": "abc123"}
    @@ -59609,11 +58662,6 @@
    Fields
    The final total amount, including shipping, discounts, and taxes. - - grand_total_excl_tax - Money! - - The grand total of the order, excluding taxes. - shipping_handling - ShippingHandling @@ -59677,7 +58725,6 @@
    Example
    "discounts": [Discount], "gift_options": GiftOptionsPrices, "grand_total": Money, - "grand_total_excl_tax": Money, "shipping_handling": ShippingHandling, "subtotal": Money, "subtotal_excl_tax": Money, @@ -59735,8 +58782,8 @@
    Fields
    Example
    {
-  "payer_id": "xyz789",
-  "token": "xyz789"
+  "payer_id": "abc123",
+  "token": "abc123"
 }
    @@ -59791,8 +58838,8 @@
    Fields
    Example
    {
   "cancel_url": "xyz789",
-  "error_url": "abc123",
-  "return_url": "xyz789"
+  "error_url": "xyz789",
+  "return_url": "abc123"
 }
    @@ -59897,9 +58944,9 @@
    Fields
    Example
    {
   "mode": "TEST",
-  "paypal_url": "abc123",
-  "secure_token": "xyz789",
-  "secure_token_id": "xyz789"
+  "paypal_url": "xyz789",
+  "secure_token": "abc123",
+  "secure_token_id": "abc123"
 }
    @@ -59940,7 +58987,7 @@
    Fields
    Example
    - 
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}
    @@ -60036,7 +59083,7 @@
    Fields
    Example
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "paypal_payload": "abc123"
 }
    @@ -60120,7 +59167,7 @@
    Fields
    Example
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "urls": PayflowProUrlInput
 }
    @@ -60175,9 +59222,9 @@
    Fields
    Example
    {
-  "cancel_url": "xyz789",
+  "cancel_url": "abc123",
   "error_url": "xyz789",
-  "return_url": "abc123"
+  "return_url": "xyz789"
 }
    @@ -60267,11 +59314,6 @@
    Possible Types

    GooglePayConfig

    - - -

    FastlaneConfig

    - -
    @@ -60280,12 +59322,12 @@
    Possible Types
    Example
    {
-  "code": "abc123",
-  "is_visible": true,
+  "code": "xyz789",
+  "is_visible": false,
   "payment_intent": "xyz789",
   "sdk_params": [SDKParams],
-  "sort_order": "abc123",
-  "title": "abc123"
+  "sort_order": "xyz789",
+  "title": "xyz789"
 }
    @@ -60318,11 +59360,6 @@
    Fields
    ApplePay payment method configuration - - fastlane - FastlaneConfig - - Fastlane payment method configuration - google_pay - GooglePayConfig @@ -60347,7 +59384,6 @@
    Fields
    Example
    {
   "apple_pay": ApplePayConfig,
-  "fastlane": FastlaneConfig,
   "google_pay": GooglePayConfig,
   "hosted_fields": HostedFieldsConfig,
   "smart_buttons": SmartButtonsConfig
@@ -60406,13 +59442,6 @@ 
    Values
    
                         
                         
                       
-                      
-                        
-                          
    START_OF_CHECKOUT
    
-                        
-                        
-                        
-                      
                       
                         
                           
    ADMIN
    
@@ -60552,12 +59581,6 @@ 
    Fields
    
                         
                          Required input for Apple Pay button 
                       
-                      
-                        
-                          payment_services_paypal_fastlane - FastlaneMethodInput
-                        
-                         Required input for fastlane 
-                      
                       
                         
                           payment_services_paypal_google_pay - GooglePayMethodInput
@@ -60617,7 +59640,6 @@ 
    Example
    
   "payflowpro": PayflowProInput,
   "payflowpro_cc_vault": VaultTokenInput,
   "payment_services_paypal_apple_pay": ApplePayMethodInput,
-  "payment_services_paypal_fastlane": FastlaneMethodInput,
   "payment_services_paypal_google_pay": GooglePayMethodInput,
   "payment_services_paypal_hosted_fields": HostedFieldsInput,
   "payment_services_paypal_smart_buttons": SmartButtonMethodInput,
@@ -60680,9 +59702,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "id": "xyz789",
-  "mp_order_id": "abc123",
+  "mp_order_id": "xyz789",
   "payment_source_details": PaymentSourceDetails,
-  "status": "xyz789"
+  "status": "abc123"
 }
    @@ -60993,7 +60015,7 @@
    Fields
    Example
    {
   "payer_id": "abc123",
-  "token": "xyz789"
+  "token": "abc123"
 }
    @@ -61061,7 +60083,7 @@
    Example
    {
   "cart_id": "abc123",
   "code": "abc123",
-  "express_button": false,
+  "express_button": true,
   "urls": PaypalExpressUrlsInput,
   "use_paypal_credit": true
 }
@@ -61156,7 +60178,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "edit": "abc123",
+  "edit": "xyz789",
   "start": "abc123"
 }
 
    
@@ -61217,9 +60239,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cancel_url": "xyz789",
-  "pending_url": "xyz789",
-  "return_url": "abc123",
+  "cancel_url": "abc123",
+  "pending_url": "abc123",
+  "return_url": "xyz789",
   "success_url": "abc123"
 }
 
    
@@ -61297,7 +60319,7 @@ 
    Possible Types
    
               
    
                 
    
                   
    Example
    
-                  
    {"weight": 123.45}
+                  
    {"weight": 987.65}
 
    
                 
    
               
    
@@ -61424,19 +60446,19 @@ 
    Example
    
                   
    {
   "city": "xyz789",
   "contact_name": "abc123",
-  "country_id": "abc123",
+  "country_id": "xyz789",
   "description": "xyz789",
-  "email": "abc123",
+  "email": "xyz789",
   "fax": "xyz789",
   "latitude": 987.65,
-  "longitude": 123.45,
-  "name": "abc123",
-  "phone": "xyz789",
+  "longitude": 987.65,
+  "name": "xyz789",
+  "phone": "abc123",
   "pickup_location_code": "abc123",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": "abc123",
   "region_id": 123,
-  "street": "abc123"
+  "street": "xyz789"
 }
 
    
                 
    
@@ -61727,7 +60749,7 @@ 
    Example
    
                   
    {
   "items": [PickupLocation],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
    
                 
    
@@ -61768,7 +60790,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"quote_uid": "4"}
+                  
    {"quote_uid": 4}
 
    
                 
    
               
    
@@ -61853,7 +60875,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "CART_NOT_FOUND",
-  "message": "xyz789"
+  "message": "abc123"
 }
 
    
                 
@@ -62066,7 +61088,7 @@ 
    Fields
    
                     
                     
                       
-                        errors - [PlaceOrderError]
+                        errors - [PlaceOrderError]!
                         
                          An array of place order errors. 
                       
@@ -62433,7 +61455,7 @@ 
    Example
    
                   
    {
   "discount_percentage": 123.45,
   "main_final_price": 987.65,
-  "main_price": 987.65
+  "main_price": 123.45
 }
 
    
                 
@@ -63032,7 +62054,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"amount_off": 123.45, "percent_off": 987.65}
+                  
    {"amount_off": 123.45, "percent_off": 123.45}
 
    
                 
    
               
    
@@ -63383,11 +62405,6 @@ 
    Fields
    
                         
                          The media item's position after it has been sorted. 
                       
-                      
-                        types - [String]
-                        
-                         Array of image types. It can have the following values: image, small_image, thumbnail. 
-                      
                       
                         url - String
                         
@@ -63401,10 +62418,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "disabled": false,
-  "label": "xyz789",
+  "disabled": true,
+  "label": "abc123",
   "position": 987,
-  "types": ["abc123"],
   "url": "xyz789"
 }
 
    
@@ -63838,6 +62854,11 @@ 
    currentPage
                         
                       
+                      
+                        rules - [CatalogRule]
+                        
+                         Provides applied catalog rules in the current active cart 
+                      
                       
                         sale - Int
                         
@@ -64029,12 +63050,12 @@ 
    Possible Types
    
                       
                       
                         
-                          
    DownloadableProduct
    
+                          
    BundleProduct
    
                         
                       
                       
                         
-                          
    BundleProduct
    
+                          
    DownloadableProduct
    
                         
                       
                       
@@ -64056,83 +63077,84 @@ 
    Possible Types
    
                   
    Example
    
                   
    {
   "activity": "xyz789",
-  "attribute_set_id": 123,
-  "canonical_url": "abc123",
+  "attribute_set_id": 987,
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "abc123",
-  "collar": "xyz789",
+  "category_gear": "xyz789",
+  "climate": "xyz789",
+  "collar": "abc123",
   "color": 987,
-  "country_of_manufacture": "abc123",
+  "country_of_manufacture": "xyz789",
   "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 987,
-  "erin_recommends": 123,
-  "features_bags": "xyz789",
+  "eco_collection": 123,
+  "erin_recommends": 987,
+  "features_bags": "abc123",
   "format": 987,
   "gender": "abc123",
   "gift_message_available": true,
   "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
-  "id": 123,
+  "id": 987,
   "image": ProductImage,
-  "is_returnable": "abc123",
-  "manufacturer": 123,
+  "is_returnable": "xyz789",
+  "manufacturer": 987,
   "material": "xyz789",
-  "max_sale_qty": 987.65,
+  "max_sale_qty": 123.45,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "xyz789",
+  "meta_description": "abc123",
   "meta_keyword": "xyz789",
   "meta_title": "abc123",
   "min_sale_qty": 987.65,
-  "name": "abc123",
-  "new": 987,
-  "new_from_date": "abc123",
-  "new_to_date": "abc123",
-  "only_x_left_in_stock": 987.65,
-  "options_container": "xyz789",
-  "pattern": "xyz789",
-  "performance_fabric": 987,
+  "name": "xyz789",
+  "new": 123,
+  "new_from_date": "xyz789",
+  "new_to_date": "xyz789",
+  "only_x_left_in_stock": 123.45,
+  "options_container": "abc123",
+  "pattern": "abc123",
+  "performance_fabric": 123,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
   "purpose": 123,
   "quantity": 123.45,
-  "rating_summary": 987.65,
+  "rating_summary": 123.45,
   "related_products": [ProductInterface],
   "review_count": 123,
   "reviews": ProductReviews,
+  "rules": [CatalogRule],
   "sale": 987,
   "short_description": ComplexTextValue,
-  "size": 123,
+  "size": 987,
   "sku": "xyz789",
   "sleeve": "xyz789",
   "small_image": ProductImage,
-  "special_from_date": "xyz789",
+  "special_from_date": "abc123",
   "special_price": 123.45,
-  "special_to_date": "abc123",
+  "special_to_date": "xyz789",
   "staged": true,
   "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
-  "style_bags": "abc123",
-  "style_bottom": "xyz789",
+  "strap_bags": "xyz789",
+  "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_id": "abc123",
-  "uid": "4",
-  "updated_at": "xyz789",
+  "uid": 4,
+  "updated_at": "abc123",
   "upsell_products": [ProductInterface],
   "url_key": "abc123",
-  "url_path": "abc123",
+  "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "xyz789",
+  "url_suffix": "abc123",
   "websites": [Website]
 }
 
    
@@ -64195,8 +63217,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "link_type": "abc123",
-  "linked_product_sku": "abc123",
-  "linked_product_type": "abc123",
+  "linked_product_sku": "xyz789",
+  "linked_product_type": "xyz789",
   "position": 123,
   "sku": "abc123"
 }
@@ -64276,11 +63298,11 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "link_type": "xyz789",
+  "link_type": "abc123",
   "linked_product_sku": "xyz789",
-  "linked_product_type": "xyz789",
+  "linked_product_type": "abc123",
   "position": 123,
-  "sku": "xyz789"
+  "sku": "abc123"
 }
 
    
                 
    
@@ -64331,9 +63353,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "base64_encoded_data": "xyz789",
-  "name": "abc123",
-  "type": "xyz789"
+  "base64_encoded_data": "abc123",
+  "name": "xyz789",
+  "type": "abc123"
 }
 
    
                 
    
@@ -64399,11 +63421,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "media_type": "xyz789",
-  "video_description": "abc123",
-  "video_metadata": "abc123",
-  "video_provider": "abc123",
-  "video_title": "abc123",
+  "media_type": "abc123",
+  "video_description": "xyz789",
+  "video_metadata": "xyz789",
+  "video_provider": "xyz789",
+  "video_title": "xyz789",
   "video_url": "abc123"
 }
 
    
@@ -64590,13 +63612,13 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "average_rating": 123.45,
-  "created_at": "abc123",
+  "average_rating": 987.65,
+  "created_at": "xyz789",
   "nickname": "xyz789",
   "product": ProductInterface,
   "ratings_breakdown": [ProductReviewRating],
   "summary": "xyz789",
-  "text": "abc123"
+  "text": "xyz789"
 }
 
    
                 
    
@@ -64642,7 +63664,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "name": "xyz789",
+  "name": "abc123",
   "value": "abc123"
 }
 
    
@@ -64691,8 +63713,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": "abc123",
-  "value_id": "abc123"
+  "id": "xyz789",
+  "value_id": "xyz789"
 }
 
    
                 
    
@@ -64744,7 +63766,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "id": "xyz789",
-  "name": "abc123",
+  "name": "xyz789",
   "values": [ProductReviewRatingValueMetadata]
 }
 
    
@@ -64791,8 +63813,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "value": "xyz789",
-  "value_id": "xyz789"
+  "value": "abc123",
+  "value_id": "abc123"
 }
 
    
                 
    
@@ -64992,11 +64014,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "customer_group_id": "abc123",
-  "percentage_value": 987.65,
-  "qty": 123.45,
-  "value": 123.45,
-  "website_id": 123.45
+  "customer_group_id": "xyz789",
+  "percentage_value": 123.45,
+  "qty": 987.65,
+  "value": 987.65,
+  "website_id": 987.65
 }
 
    
                 
    
@@ -65039,11 +64061,6 @@ 
    Fields
    
                         
                          The media item's position after it has been sorted. 
                       
-                      
-                        types - [String]
-                        
-                         Array of image types. It can have the following values: image, small_image, thumbnail. 
-                      
                       
                         url - String
                         
@@ -65064,8 +64081,7 @@ 
    Example
    
                   
    {
   "disabled": true,
   "label": "abc123",
-  "position": 987,
-  "types": ["xyz789"],
+  "position": 123,
   "url": "abc123",
   "video_content": ProductMediaGalleryEntriesVideoContent
 }
@@ -65257,14 +64273,14 @@ 
    Example
    
   "approval_flow": [PurchaseOrderRuleApprovalFlow],
   "available_actions": ["REJECT"],
   "comments": [PurchaseOrderComment],
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "created_by": Customer,
   "history_log": [PurchaseOrderHistoryItem],
-  "number": "abc123",
+  "number": "xyz789",
   "order": CustomerOrder,
   "quote": Cart,
   "status": "PENDING",
-  "uid": "4",
+  "uid": 4,
   "updated_at": "abc123"
 }
 
    
@@ -65375,7 +64391,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"message": "abc123", "type": "NOT_FOUND"}
+                  
    {"message": "xyz789", "type": "NOT_FOUND"}
 
    
                 
    
               
    
@@ -65435,11 +64451,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "message": "abc123",
-  "name": "abc123",
+  "message": "xyz789",
+  "name": "xyz789",
   "role": "xyz789",
   "status": "PENDING",
-  "updated_at": "xyz789"
+  "updated_at": "abc123"
 }
 
    
                 
    
@@ -65580,8 +64596,8 @@ 
    Example
    
   "approver_roles": [CompanyRole],
   "condition": PurchaseOrderApprovalRuleConditionInterface,
   "created_at": "xyz789",
-  "created_by": "xyz789",
-  "description": "xyz789",
+  "created_by": "abc123",
+  "description": "abc123",
   "name": "abc123",
   "status": "ENABLED",
   "uid": "4",
@@ -65812,7 +64828,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123}
+                  
    {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}
 
    
                 
    
               
    
@@ -66269,10 +65285,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "activity": "xyz789",
-  "created_at": "abc123",
-  "message": "xyz789",
-  "uid": "4"
+  "activity": "abc123",
+  "created_at": "xyz789",
+  "message": "abc123",
+  "uid": 4
 }
 
    
                 
    
@@ -66465,7 +65481,7 @@ 
    Example
    
                   
    {
   "items": [PurchaseOrder],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
    
                 
    
@@ -66614,7 +65630,7 @@ 
    Example
    
                   
    {
   "company_purchase_orders": true,
   "created_date": FilterRangeTypeInput,
-  "require_my_approval": false,
+  "require_my_approval": true,
   "status": "PENDING"
 }
 
    
@@ -66884,14 +65900,14 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "badge_position": "xyz789",
+  "badge_position": "abc123",
   "language_code": "abc123",
   "minimum_score": 987.65,
   "re_captcha_type": "INVISIBLE",
   "technical_failure_message": "xyz789",
   "theme": "xyz789",
   "validation_failure_message": "xyz789",
-  "website_key": "xyz789"
+  "website_key": "abc123"
 }
 
    
                 
    
@@ -66967,14 +65983,14 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "badge_position": "xyz789",
+  "badge_position": "abc123",
   "failure_message": "xyz789",
   "forms": ["PLACE_ORDER"],
   "is_enabled": true,
   "language_code": "xyz789",
   "minimum_score": 987.65,
   "theme": "abc123",
-  "website_key": "xyz789"
+  "website_key": "abc123"
 }
 
    
                 
    
@@ -67179,9 +66195,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "abc123",
-  "id": 123,
-  "name": "abc123"
+  "code": "xyz789",
+  "id": 987,
+  "name": "xyz789"
 }
 
    
                 
    
@@ -67222,7 +66238,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
 
    
                 
    
               
    
@@ -67308,8 +66324,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "abc123",
-  "coupon_codes": ["xyz789"]
+  "cart_id": "xyz789",
+  "coupon_codes": ["abc123"]
 }
 
    
                 
    
@@ -67476,7 +66492,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"success": false}
+                  
    {"success": true}
 
    
                 
    
               
    
@@ -67568,7 +66584,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "cart_item_id": 123,
   "cart_item_uid": "4"
 }
@@ -67656,10 +66672,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {
-  "quote_item_uids": ["4"],
-  "quote_uid": "4"
-}
+                  
    {"quote_item_uids": ["4"], "quote_uid": 4}
 
    
                 
    
               
    
@@ -67744,10 +66757,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {
-  "item_uids": ["4"],
-  "template_id": "4"
-}
+                  
    {"item_uids": ["4"], "template_id": 4}
 
    
                 
    
               
    
@@ -67793,7 +66803,10 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"products": [4], "uid": 4}
+                  
    {
+  "products": ["4"],
+  "uid": "4"
+}
 
    
                 
    
               
    
@@ -68090,9 +67103,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "quote_comment": "abc123",
+  "quote_comment": "xyz789",
   "quote_name": "abc123",
-  "quote_uid": 4
+  "quote_uid": "4"
 }
 
    
                 
    
@@ -68238,10 +67251,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "comment_text": "xyz789",
-  "contact_email": "abc123",
+  "comment_text": "abc123",
+  "contact_email": "xyz789",
   "items": [RequestReturnItemInput],
-  "token": "xyz789"
+  "token": "abc123"
 }
 
    
                 
    
@@ -68301,10 +67314,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": 4,
+  "cart_id": "4",
   "comment": NegotiableQuoteCommentInput,
-  "is_draft": false,
-  "quote_name": "xyz789"
+  "is_draft": true,
+  "quote_name": "abc123"
 }
 
    
                 
    
@@ -68443,8 +67456,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "comment_text": "abc123",
-  "contact_email": "xyz789",
+  "comment_text": "xyz789",
+  "contact_email": "abc123",
   "items": [RequestReturnItemInput],
   "order_uid": 4
 }
@@ -68510,7 +67523,7 @@ 
    Example
    
     EnteredCustomAttributeInput
   ],
   "order_item_uid": 4,
-  "quantity_to_return": 123.45,
+  "quantity_to_return": 987.65,
   "selected_custom_attributes": [
     SelectedCustomAttributeInput
   ]
@@ -68666,10 +67679,10 @@ 
    Example
    
                   
    {
   "description": "xyz789",
   "items": RequistionListItems,
-  "items_count": 987,
+  "items_count": 123,
   "name": "xyz789",
-  "uid": 4,
-  "updated_at": "xyz789"
+  "uid": "4",
+  "updated_at": "abc123"
 }
 
    
                 
    
@@ -68886,9 +67899,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "entered_options": [EnteredOptionInput],
-  "parent_sku": "xyz789",
+  "parent_sku": "abc123",
   "quantity": 987.65,
-  "selected_options": ["abc123"],
+  "selected_options": ["xyz789"],
   "sku": "abc123"
 }
 
    
@@ -68942,7 +67955,7 @@ 
    Example
    
                   
    {
   "items": [RequisitionList],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
    
                 
    
@@ -68995,7 +68008,7 @@ 
    Example
    
                   
    {
   "items": [RequisitionListItemInterface],
   "page_info": SearchResultPageInfo,
-  "total_pages": 123
+  "total_pages": 987
 }
 
    
                 
    
@@ -69083,10 +68096,10 @@ 
    Example
    
                   
    {
   "available_shipping_carriers": [ReturnShippingCarrier],
   "comments": [ReturnComment],
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "customer": ReturnCustomer,
   "items": [ReturnItem],
-  "number": "abc123",
+  "number": "xyz789",
   "order": CustomerOrder,
   "shipping": ReturnShipping,
   "status": "PENDING",
@@ -69147,9 +68160,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "author_name": "abc123",
-  "created_at": "abc123",
-  "text": "xyz789",
-  "uid": "4"
+  "created_at": "xyz789",
+  "text": "abc123",
+  "uid": 4
 }
 
    
                 
    
@@ -69201,7 +68214,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "label": "abc123",
-  "uid": 4,
+  "uid": "4",
   "value": "abc123"
 }
 
    
@@ -69254,8 +68267,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "email": "abc123",
-  "firstname": "xyz789",
-  "lastname": "abc123"
+  "firstname": "abc123",
+  "lastname": "xyz789"
 }
 
    
                 
@@ -69330,7 +68343,7 @@ 
    Example
    
   "custom_attributes": [ReturnCustomAttribute],
   "custom_attributesV2": [AttributeValueInterface],
   "order_item": OrderItemInterface,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "request_quantity": 123.45,
   "status": "PENDING",
   "uid": 4
@@ -69435,17 +68448,17 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "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": false,
   "label": "abc123",
-  "multiline_count": 123,
+  "multiline_count": 987,
   "options": [CustomAttributeOptionInterface],
-  "sort_order": 123,
+  "sort_order": 987,
   "validate_rules": [ValidationRule]
 }
 
    
@@ -69649,13 +68662,13 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "xyz789",
+  "city": "abc123",
   "contact_name": "abc123",
   "country": Country,
   "postcode": "abc123",
   "region": Region,
-  "street": ["xyz789"],
-  "telephone": "abc123"
+  "street": ["abc123"],
+  "telephone": "xyz789"
 }
 
    
                 
    
@@ -69700,7 +68713,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"label": "xyz789", "uid": 4}
+                  
    {"label": "abc123", "uid": 4}
 
    
                 
    
               
    
@@ -69757,7 +68770,7 @@ 
    Example
    
                   
    {
   "carrier": ReturnShippingCarrier,
   "status": ReturnShippingTrackingStatus,
-  "tracking_number": "abc123",
+  "tracking_number": "xyz789",
   "uid": "4"
 }
 
    
@@ -70060,7 +69073,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"result": true}
+                  
    {"result": false}
 
    
                 
    
               
    
@@ -70216,8 +69229,8 @@ 
    Example
    
                   
    {
   "balance": RewardPointsAmount,
   "change_reason": "xyz789",
-  "date": "abc123",
-  "points_change": 987.65
+  "date": "xyz789",
+  "points_change": 123.45
 }
 
    
                 
@@ -70309,7 +69322,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"currency_amount": 987.65, "points": 987.65}
+                  
    {"currency_amount": 123.45, "points": 123.45}
 
    
                 
    
               
    
@@ -70476,12 +69489,12 @@ 
    Possible Types
    
                       
                       
                         
-                          
    RoutableUrl
    
+                          
    ConfigurableProduct
    
                         
                       
                       
                         
-                          
    ConfigurableProduct
    
+                          
    BundleProduct
    
                         
                       
                       
@@ -70491,17 +69504,17 @@ 
    Possible Types
    
                       
                       
                         
-                          
    BundleProduct
    
+                          
    GiftCardProduct
    
                         
                       
                       
                         
-                          
    GiftCardProduct
    
+                          
    GroupedProduct
    
                         
                       
                       
                         
-                          
    GroupedProduct
    
+                          
    RoutableUrl
    
                         
                       
                     
@@ -70512,7 +69525,7 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "redirect_code": 123,
+  "redirect_code": 987,
   "relative_url": "abc123",
   "type": "CMS_PAGE"
 }
@@ -70565,7 +69578,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "redirect_code": 123,
+  "redirect_code": 987,
   "relative_url": "xyz789",
   "type": "CMS_PAGE"
 }
@@ -70613,8 +69626,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "name": "abc123",
-  "value": "abc123"
+  "name": "xyz789",
+  "value": "xyz789"
 }
 
    
                 
    
@@ -70661,7 +69674,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "message": "xyz789",
-  "timestamp": "abc123"
+  "timestamp": "xyz789"
 }
 
    
                 
    
@@ -70766,7 +69779,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"current_page": 987, "page_size": 987, "total_pages": 987}
+                  
    {"current_page": 987, "page_size": 123, "total_pages": 123}
 
    
                 
    
               
    
@@ -70805,7 +69818,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"search": "xyz789"}
+                  
    {"search": "abc123"}
 
    
                 
    
               
    
@@ -70867,10 +69880,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": 123,
-  "label": "xyz789",
-  "type": "abc123",
-  "uid": 4,
+  "id": 987,
+  "label": "abc123",
+  "type": "xyz789",
+  "uid": "4",
   "values": [SelectedBundleOptionValue]
 }
 
    
@@ -70944,11 +69957,11 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "id": 123,
-  "label": "abc123",
+  "label": "xyz789",
   "original_price": Money,
   "price": 123.45,
   "priceV2": Money,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": 4
 }
 
    
@@ -71021,9 +70034,9 @@ 
    Example
    
                   
    {
   "configurable_product_option_uid": 4,
   "configurable_product_option_value_uid": "4",
-  "id": 123,
-  "option_label": "abc123",
-  "value_id": 987,
+  "id": 987,
+  "option_label": "xyz789",
+  "value_id": 123,
   "value_label": "abc123"
 }
 
    
@@ -71146,11 +70159,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "customizable_option_uid": 4,
+  "customizable_option_uid": "4",
   "id": 987,
-  "is_required": true,
+  "is_required": false,
   "label": "abc123",
-  "sort_order": 123,
+  "sort_order": 987,
   "type": "abc123",
   "values": [SelectedCustomizableOptionValue]
 }
@@ -71216,7 +70229,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "customizable_option_value_uid": 4,
-  "id": 987,
+  "id": 123,
   "label": "xyz789",
   "price": CartItemSelectedOptionValuePrice,
   "value": "abc123"
@@ -71271,8 +70284,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "xyz789",
-  "purchase_order_number": "abc123",
-  "title": "abc123"
+  "purchase_order_number": "xyz789",
+  "title": "xyz789"
 }
 
    
                 
    
@@ -71352,7 +70365,7 @@ 
    Example
    
                   
    {
   "amount": Money,
   "base_amount": Money,
-  "carrier_code": "abc123",
+  "carrier_code": "xyz789",
   "carrier_title": "xyz789",
   "method_code": "xyz789",
   "method_title": "abc123",
@@ -71411,7 +70424,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "product_id": 987,
+  "product_id": 123,
   "recipients": [SendEmailToFriendRecipientInput],
   "sender": SendEmailToFriendSenderInput
 }
@@ -71555,7 +70568,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "xyz789",
+  "email": "abc123",
   "name": "xyz789"
 }
 
    
@@ -71710,7 +70723,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"enabled_for_customers": false, "enabled_for_guests": false}
+                  
    {"enabled_for_customers": true, "enabled_for_guests": true}
 
    
                 
    
               
    
@@ -71846,7 +70859,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "billing_address": BillingAddressInput,
-  "cart_id": "xyz789"
+  "cart_id": "abc123"
 }
 
    
                 
    
@@ -71887,50 +70900,6 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {"cart": Cart}
-
    
-                
    
-              
    
-            
    
-
    -
    -
    - Types -
    -

    SetCartAsInactiveOutput

    -
    -
    -
    -
    Description
    -

    Sets the cart as inactive

    -
    -
    -
    Fields
    - - - - - - - - - - - - - - - - - -
    Field NameDescription
    error - String - The error message returned after failing to set the cart as inactive
    success - Boolean! - Indicates whether the cart was set as inactive
    -
    -
    -
    -
    -
    Example
    - 
    {"error": "xyz789", "success": true}
    @@ -71998,7 +70967,7 @@
    Example
    "cart_id": "abc123", "gift_message": GiftMessageInput, "gift_receipt_included": false, - "gift_wrapping_id": 4, + "gift_wrapping_id": "4", "printed_card_included": false }     @@ -72086,8 +71055,8 @@
    Fields
    Example
    {
-  "cart_id": "abc123",
-  "email": "abc123"
+  "cart_id": "xyz789",
+  "email": "xyz789"
 }
    @@ -72214,7 +71183,7 @@
    Fields
    Example
    {
   "billing_address": NegotiableQuoteBillingAddressInput,
-  "quote_uid": "4"
+  "quote_uid": 4
 }
    @@ -72302,7 +71271,7 @@
    Fields
    Example
    {
   "payment_method": NegotiableQuotePaymentMethodInput,
-  "quote_uid": "4"
+  "quote_uid": 4
 }
    @@ -72395,7 +71364,7 @@
    Fields
    Example
    {
-  "customer_address_id": 4,
+  "customer_address_id": "4",
   "quote_uid": "4",
   "shipping_addresses": [
     NegotiableQuoteShippingAddressInput
@@ -72672,7 +71641,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "payment_method": PaymentMethodInput
 }
 
    
@@ -72760,7 +71729,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "shipping_addresses": [ShippingAddressInput]
 }
 
    
@@ -72848,7 +71817,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "shipping_methods": [ShippingMethodInput]
 }
 
    
@@ -72937,7 +71906,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "email": "xyz789",
-  "name": "abc123"
+  "name": "xyz789"
 }
 
    
                 
    
@@ -72977,7 +71946,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"is_shared": true}
+                  
    {"is_shared": false}
 
    
                 
    
               
    
@@ -73139,8 +72108,8 @@ 
    Example
    
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_shipped": 987.65
+  "product_sku": "xyz789",
+  "quantity_shipped": 123.45
 }
    @@ -73290,8 +72259,8 @@
    Fields
    Example
    {
   "carrier": "abc123",
-  "number": "abc123",
-  "title": "abc123"
+  "number": "xyz789",
+  "title": "xyz789"
 }
    @@ -73331,12 +72300,6 @@
    Fields
    An ID from the customer's address book that uniquely identifies the address to be used for shipping. - - - customer_address_uid - ID - - The unique ID from the customer's address book that uniquely identifies the address to be used for shipping. - customer_notes - String @@ -73358,10 +72321,9 @@
    Fields
    Example
    {
   "address": CartAddressInput,
-  "customer_address_id": 987,
-  "customer_address_uid": "4",
-  "customer_notes": "abc123",
-  "pickup_location_code": "abc123"
+  "customer_address_id": 123,
+  "customer_notes": "xyz789",
+  "pickup_location_code": "xyz789"
 }
    @@ -73426,11 +72388,6 @@
    Fields
    The custom attribute values of the billing or shipping address. - - customer_address_uid - ID - - The unique ID from the customer's address book that uniquely identifies the address. - customer_notes - String @@ -73447,10 +72404,9 @@
    Fields
    The first name of the customer or guest. - id - Int - - Id of the customer address. Use customer_address_uid instead. + id - Int + Id of the customer address. items_weight - Float @@ -73516,9 +72472,9 @@
    Fields
    The telephone number for the billing or shipping address. - uid - ID! + uid - String! - The unique id of the customer cart address. + The unique id of the customer address. vat_id - String @@ -73540,24 +72496,23 @@
    Example
    "company": "abc123", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": "4", "customer_notes": "xyz789", "fax": "xyz789", "firstname": "xyz789", "id": 987, - "items_weight": 123.45, - "lastname": "abc123", - "middlename": "abc123", + "items_weight": 987.65, + "lastname": "xyz789", + "middlename": "xyz789", "pickup_location_code": "abc123", - "postcode": "xyz789", + "postcode": "abc123", "prefix": "xyz789", "region": CartAddressRegion, "same_as_billing": true, "selected_shipping_method": SelectedShippingMethod, - "street": ["xyz789"], - "suffix": "abc123", + "street": ["abc123"], + "suffix": "xyz789", "telephone": "abc123", - "uid": 4, + "uid": "xyz789", "vat_id": "abc123" }     @@ -73710,7 +72665,7 @@
    Fields
    Example
    {
-  "carrier_code": "abc123",
+  "carrier_code": "xyz789",
   "method_code": "xyz789"
 }
    @@ -73840,17 +72795,17 @@
    Example
    "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "xyz789", - "is_available": true, - "max_qty": 987.65, + "id": "abc123", + "is_available": false, + "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" + "quantity": 123.45, + "uid": 4 }
    @@ -74216,6 +73171,11 @@
    currentPage + + rules - [CatalogRule] + + Provides applied catalog rules in the current active cart + sale - Int @@ -74396,88 +73356,89 @@
    currentPage
    Example
    {
-  "activity": "abc123",
-  "attribute_set_id": 123,
-  "canonical_url": "abc123",
+  "activity": "xyz789",
+  "attribute_set_id": 987,
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "abc123",
-  "collar": "xyz789",
-  "color": 987,
+  "category_gear": "xyz789",
+  "climate": "xyz789",
+  "collar": "abc123",
+  "color": 123,
   "country_of_manufacture": "xyz789",
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "eco_collection": 123,
-  "erin_recommends": 987,
-  "features_bags": "xyz789",
-  "format": 123,
+  "erin_recommends": 123,
+  "features_bags": "abc123",
+  "format": 987,
   "gender": "abc123",
   "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",
+  "is_returnable": "abc123",
   "manufacturer": 987,
   "material": "xyz789",
-  "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,
+  "min_sale_qty": 987.65,
   "name": "xyz789",
   "new": 123,
   "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,
   "options": [CustomizableOptionInterface],
   "options_container": "xyz789",
-  "pattern": "xyz789",
+  "pattern": "abc123",
   "performance_fabric": 123,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
   "purpose": 987,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "rating_summary": 987.65,
   "redirect_code": 123,
   "related_products": [ProductInterface],
   "relative_url": "abc123",
   "review_count": 987,
   "reviews": ProductReviews,
-  "sale": 987,
+  "rules": [CatalogRule],
+  "sale": 123,
   "short_description": ComplexTextValue,
-  "size": 987,
-  "sku": "xyz789",
+  "size": 123,
+  "sku": "abc123",
   "sleeve": "abc123",
   "small_image": ProductImage,
-  "special_from_date": "abc123",
+  "special_from_date": "xyz789",
   "special_price": 123.45,
   "special_to_date": "abc123",
   "staged": false,
   "stock_status": "IN_STOCK",
   "strap_bags": "xyz789",
-  "style_bags": "xyz789",
+  "style_bags": "abc123",
   "style_bottom": "abc123",
-  "style_general": "abc123",
+  "style_general": "xyz789",
   "swatch_image": "xyz789",
   "thumbnail": ProductImage,
   "tier_price": 987.65,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "abc123",
+  "type_id": "xyz789",
   "uid": 4,
   "updated_at": "xyz789",
   "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
 }
@@ -74586,8 +73547,8 @@ 
    Example
    
                   
    {
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 987.65,
-  "uid": 4
+  "quantity": 123.45,
+  "uid": "4"
 }
 
    
                 
@@ -74653,12 +73614,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "added_at": "xyz789",
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
-  "id": "4",
+  "description": "abc123",
+  "id": 4,
   "product": ProductInterface,
-  "quantity": 987.65
+  "quantity": 123.45
 }
 
    
                 
    
@@ -74713,8 +73674,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "payment_source": "xyz789",
-  "payments_order_id": "abc123",
-  "paypal_order_id": "xyz789"
+  "payments_order_id": "xyz789",
+  "paypal_order_id": "abc123"
 }
 
    
                 
@@ -74738,11 +73699,6 @@ 
    Fields
    
                       
                     
                     
-                      
-                        app_switch_when_available - Boolean
-                        
-                         Indicated whether to use App Switch on enabled mobile devices 
-                      
                       
                         button_styles - ButtonStyles
                         
@@ -74801,12 +73757,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "app_switch_when_available": false,
   "button_styles": ButtonStyles,
-  "code": "xyz789",
+  "code": "abc123",
   "display_message": false,
   "display_venmo": true,
-  "is_visible": true,
+  "is_visible": false,
   "message_styles": MessageStyles,
   "payment_intent": "xyz789",
   "sdk_params": [SDKParams],
@@ -74905,7 +73860,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "label": "xyz789",
+  "label": "abc123",
   "value": "xyz789"
 }
 
    
@@ -74952,7 +73907,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "default": "xyz789",
+  "default": "abc123",
   "options": [SortField]
 }
 
    
@@ -75711,11 +74666,6 @@ 
    Fields
    
                         
                          Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). 
                       
-                      
-                        cart_merge_preference - String!
-                        
-                         Configuration data from checkout/cart/cart_merge_preference 
-                      
                       
                         cart_printed_card - String
                         
@@ -75938,7 +74888,12 @@ 
    Fields
    
                          The landing page that is associated with the base URL. 
                       
                       
-                        graphql_share_customer_group - Boolean
+                        graphql_share_all_customer_groups - Boolean!
+                        
+                         Configuration data from customer/account_information/graphql_share_all_customer_groups 
+                      
+                      
+                        graphql_share_customer_group - Boolean!
                         
                          Configuration data from customer/account_information/graphql_share_customer_group 
                       
@@ -76296,14 +75251,24 @@ 
    Fields
    
                          Email to a Friend configuration. 
                       
                       
-                        share_active_segments - Boolean
+                        share_all_catalog_rules - Boolean!
+                        
+                         Configuration data from catalog/rule/share_all_catalog_rules 
+                      
+                      
+                        share_all_sales_rule - Boolean!
+                        
+                         Configuration data from promo/graphql/share_all_sales_rule 
+                      
+                      
+                        share_applied_catalog_rules - Boolean!
                         
-                         Configuration data from customer/magento_customersegment/share_active_segments 
+                         Configuration data from catalog/rule/share_applied_catalog_rules 
                       
                       
-                        share_applied_cart_rule - Boolean
+                        share_applied_sales_rule - Boolean!
                         
-                         Configuration data from promo/graphql/share_applied_cart_rule 
+                         Configuration data from promo/graphql/share_applied_sales_rule 
                       
                       
                         shopping_cart_display_full_summary - Boolean
@@ -76464,41 +75429,41 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "absolute_footer": "abc123",
-  "allow_gift_receipt": "abc123",
+  "absolute_footer": "xyz789",
+  "allow_gift_receipt": "xyz789",
   "allow_gift_wrapping_on_order": "abc123",
-  "allow_gift_wrapping_on_order_items": "abc123",
-  "allow_guests_to_write_product_reviews": "xyz789",
-  "allow_items": "abc123",
+  "allow_gift_wrapping_on_order_items": "xyz789",
+  "allow_guests_to_write_product_reviews": "abc123",
+  "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": "xyz789",
   "base_link_url": "xyz789",
   "base_media_url": "abc123",
   "base_static_url": "xyz789",
-  "base_url": "xyz789",
-  "braintree_3dsecure_allowspecific": true,
+  "base_url": "abc123",
+  "braintree_3dsecure_allowspecific": false,
   "braintree_3dsecure_always_request_3ds": false,
   "braintree_3dsecure_specificcountry": "abc123",
   "braintree_3dsecure_threshold_amount": "abc123",
-  "braintree_3dsecure_verify_3dsecure": false,
+  "braintree_3dsecure_verify_3dsecure": true,
   "braintree_ach_direct_debit_vault_active": true,
-  "braintree_applepay_merchant_name": "abc123",
+  "braintree_applepay_merchant_name": "xyz789",
   "braintree_applepay_vault_active": false,
   "braintree_cc_vault_active": "abc123",
   "braintree_cc_vault_cvv": true,
   "braintree_environment": "xyz789",
-  "braintree_googlepay_btn_color": "abc123",
+  "braintree_googlepay_btn_color": "xyz789",
   "braintree_googlepay_cctypes": "xyz789",
   "braintree_googlepay_merchant_id": "xyz789",
-  "braintree_googlepay_vault_active": true,
+  "braintree_googlepay_vault_active": false,
   "braintree_local_payment_allowed_methods": "xyz789",
   "braintree_local_payment_fallback_button_text": "abc123",
-  "braintree_local_payment_redirect_on_fail": "abc123",
-  "braintree_merchant_account_id": "abc123",
+  "braintree_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_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",
@@ -76507,150 +75472,150 @@ 
    Example
    
   "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_label": "xyz789",
   "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
   "braintree_paypal_button_location_cart_type_paylater_show": true,
-  "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
-  "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
+  "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
+  "braintree_paypal_button_location_cart_type_paypal_label": "abc123",
   "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
-  "braintree_paypal_button_location_cart_type_paypal_show": false,
-  "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
-  "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
-  "braintree_paypal_button_location_checkout_type_credit_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": "xyz789",
   "braintree_paypal_button_location_checkout_type_credit_show": false,
-  "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
-  "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
+  "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
+  "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
   "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
-  "braintree_paypal_button_location_checkout_type_messaging_show": true,
+  "braintree_paypal_button_location_checkout_type_messaging_show": false,
   "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
   "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
-  "braintree_paypal_button_location_checkout_type_paylater_label": "abc123",
+  "braintree_paypal_button_location_checkout_type_paylater_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": "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_shape": "xyz789",
   "braintree_paypal_button_location_checkout_type_paypal_show": true,
-  "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
+  "braintree_paypal_button_location_productpage_type_credit_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_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": "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_label": "xyz789",
   "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
-  "braintree_paypal_button_location_productpage_type_paylater_show": true,
+  "braintree_paypal_button_location_productpage_type_paylater_show": false,
   "braintree_paypal_button_location_productpage_type_paypal_color": "abc123",
   "braintree_paypal_button_location_productpage_type_paypal_label": "abc123",
-  "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_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_display_on_shopping_cart": false,
+  "braintree_paypal_merchant_country": "xyz789",
   "braintree_paypal_merchant_name_override": "xyz789",
-  "braintree_paypal_require_billing_address": true,
+  "braintree_paypal_require_billing_address": false,
   "braintree_paypal_send_cart_line_items": true,
   "braintree_paypal_vault_active": false,
-  "cart_expires_in_days": 123,
-  "cart_gift_wrapping": "abc123",
-  "cart_merge_preference": "abc123",
-  "cart_printed_card": "abc123",
-  "cart_summary_display_quantity": 987,
-  "catalog_default_sort_by": "xyz789",
+  "cart_expires_in_days": 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": 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_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": 987,
-  "check_money_order_title": "abc123",
-  "cms_home_page": "abc123",
-  "cms_no_cookies": "abc123",
-  "cms_no_route": "abc123",
+  "check_money_order_title": "xyz789",
+  "cms_home_page": "xyz789",
+  "cms_no_cookies": "xyz789",
+  "cms_no_route": "xyz789",
   "code": "xyz789",
   "configurable_product_image": "ITSELF",
   "configurable_thumbnail_source": "abc123",
-  "contact_enabled": false,
+  "contact_enabled": true,
   "copyright": "xyz789",
-  "countries_with_required_region": "abc123",
+  "countries_with_required_region": "xyz789",
   "create_account_confirmation": true,
   "customer_access_token_lifetime": 987.65,
-  "default_country": "abc123",
-  "default_description": "xyz789",
+  "default_country": "xyz789",
+  "default_description": "abc123",
   "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": 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_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": 987,
   "fixed_product_taxes_enable": true,
   "fixed_product_taxes_include_fpt_in_subtotal": true,
-  "front": "xyz789",
-  "graphql_share_customer_group": true,
-  "grid_per_page": 123,
-  "grid_per_page_values": "abc123",
+  "front": "abc123",
+  "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": "abc123",
+  "head_shortcut_icon": "xyz789",
   "header_logo_src": "xyz789",
-  "id": 123,
-  "is_checkout_agreements_enabled": false,
-  "is_default_store": true,
-  "is_default_store_group": false,
+  "id": 987,
+  "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_requisition_list_active": "abc123",
+  "is_one_page_checkout_enabled": true,
+  "is_requisition_list_active": "xyz789",
   "list_mode": "xyz789",
-  "list_per_page": 987,
-  "list_per_page_values": "abc123",
-  "locale": "abc123",
+  "list_per_page": 123,
+  "list_per_page_values": "xyz789",
+  "locale": "xyz789",
   "logo_alt": "xyz789",
   "logo_height": 123,
-  "logo_width": 123,
-  "magento_reward_general_is_enabled": "abc123",
-  "magento_reward_general_is_enabled_on_front": "xyz789",
+  "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_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": "xyz789",
-  "magento_reward_points_invitation_order_limit": "xyz789",
+  "magento_reward_points_invitation_order_limit": "abc123",
   "magento_reward_points_newsletter": "abc123",
-  "magento_reward_points_order": "abc123",
+  "magento_reward_points_order": "xyz789",
   "magento_reward_points_register": "xyz789",
   "magento_reward_points_review": "abc123",
   "magento_reward_points_review_limit": "xyz789",
-  "magento_wishlist_general_is_enabled": "abc123",
-  "max_items_in_order_summary": 987,
-  "maximum_number_of_wishlists": "xyz789",
+  "magento_wishlist_general_is_enabled": "xyz789",
+  "max_items_in_order_summary": 123,
+  "maximum_number_of_wishlists": "abc123",
   "minicart_display": false,
   "minicart_max_items": 123,
-  "minimum_password_length": "xyz789",
+  "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": 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": 987,
   "orders_invoices_credit_memos_display_subtotal": 987,
   "orders_invoices_credit_memos_display_zero_tax": true,
@@ -76658,47 +75623,49 @@ 
    Example
    
   "printed_card_price": "abc123",
   "printed_card_priceV2": Money,
   "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-  "product_reviews_enabled": "xyz789",
-  "product_url_suffix": "abc123",
-  "quickorder_active": true,
+  "product_reviews_enabled": "abc123",
+  "product_url_suffix": "xyz789",
+  "quickorder_active": false,
   "required_character_classes_number": "xyz789",
-  "returns_enabled": "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": "xyz789",
   "sales_printed_card": "xyz789",
   "secure_base_link_url": "abc123",
-  "secure_base_media_url": "abc123",
-  "secure_base_static_url": "xyz789",
+  "secure_base_media_url": "xyz789",
+  "secure_base_static_url": "abc123",
   "secure_base_url": "abc123",
   "send_friend": SendFriendConfiguration,
-  "share_active_segments": true,
-  "share_applied_cart_rule": true,
-  "shopping_cart_display_full_summary": false,
-  "shopping_cart_display_grand_total": false,
+  "share_all_catalog_rules": 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_grand_total": true,
   "shopping_cart_display_price": 987,
-  "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,
   "show_cms_breadcrumbs": 987,
-  "store_code": "4",
+  "store_code": 4,
   "store_group_code": "4",
-  "store_group_name": "abc123",
-  "store_name": "xyz789",
-  "store_sort_order": 987,
+  "store_group_name": "xyz789",
+  "store_name": "abc123",
+  "store_sort_order": 123,
   "timezone": "abc123",
   "title_prefix": "xyz789",
   "title_separator": "xyz789",
   "title_suffix": "xyz789",
   "use_store_in_url": true,
-  "website_code": "4",
-  "website_id": 123,
+  "website_code": 4,
+  "website_id": 987,
   "website_name": "xyz789",
-  "weight_unit": "abc123",
+  "weight_unit": "xyz789",
   "welcome": "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",
@@ -76765,9 +75732,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "position": 987,
+  "position": 123,
   "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": true
 }
@@ -76862,10 +75829,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "comment": "abc123",
+  "comment": "xyz789",
   "max_order_commitment": 123,
   "min_order_commitment": 987,
-  "name": "abc123",
+  "name": "xyz789",
   "reference_document_links": [
     NegotiableQuoteTemplateReferenceDocumentLinkInput
   ],
@@ -77016,8 +75983,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "type": "abc123",
-  "value": "abc123"
+  "type": "xyz789",
+  "value": "xyz789"
 }
 
    
                 
    
@@ -77080,7 +76047,7 @@ 
    Possible Types
    
               
    
                 
    
                   
    Example
    
-                  
    {"value": "xyz789"}
+                  
    {"value": "abc123"}
 
    
                 
    
               
    
@@ -77397,7 +76364,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cartId": "abc123",
+  "cartId": "xyz789",
   "id": "abc123"
 }
 
    
@@ -77450,8 +76417,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "amount": Money,
-  "rate": 123.45,
-  "title": "xyz789"
+  "rate": 987.65,
+  "title": "abc123"
 }
 
    
                 
    
@@ -77645,7 +76612,7 @@ 
    Example
    
                   
    {
   "discount": ProductDiscount,
   "final_price": Money,
-  "quantity": 123.45
+  "quantity": 987.65
 }
 
    
                 
    
@@ -77693,7 +76660,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "cart_items": [CartItemUpdateInput]
 }
 
    
@@ -78012,7 +76979,7 @@ 
    Example
    
     GiftRegistryDynamicAttributeInput
   ],
   "event_name": "abc123",
-  "message": "xyz789",
+  "message": "abc123",
   "privacy_settings": "PRIVATE",
   "shipping_address": GiftRegistryShippingAddressInput,
   "status": "ACTIVE"
@@ -78069,9 +77036,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "gift_registry_item_uid": "4",
+  "gift_registry_item_uid": 4,
   "note": "xyz789",
-  "quantity": 123.45
+  "quantity": 987.65
 }
 
    
                 
    
@@ -78219,9 +77186,9 @@ 
    Example
    
     GiftRegistryDynamicAttributeInput
   ],
   "email": "abc123",
-  "firstname": "xyz789",
+  "firstname": "abc123",
   "gift_registry_registrant_uid": "4",
-  "lastname": "abc123"
+  "lastname": "xyz789"
 }
 
    
                 
    
@@ -78436,7 +77403,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "items": [NegotiableQuoteTemplateItemQuantityInput],
-  "template_id": "4"
+  "template_id": 4
 }
 
    
                 
    
@@ -78561,11 +77528,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "applies_to": ["4"],
+  "applies_to": [4],
   "approvers": [4],
   "condition": CreatePurchaseOrderApprovalRuleConditionInput,
   "description": "xyz789",
-  "name": "abc123",
+  "name": "xyz789",
   "status": "ENABLED",
   "uid": 4
 }
@@ -78615,7 +77582,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "description": "abc123",
+  "description": "xyz789",
   "name": "abc123"
 }
 
    
@@ -78678,7 +77645,7 @@ 
    Example
    
                   
    {
   "entered_options": [EnteredOptionInput],
   "item_id": "4",
-  "quantity": 987.65,
+  "quantity": 123.45,
   "selected_options": ["xyz789"]
 }
 
    
@@ -78808,7 +77775,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "name": "xyz789",
+  "name": "abc123",
   "uid": 4,
   "visibility": "PUBLIC"
 }
@@ -78857,7 +77824,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "parameters": [HttpQueryParameter],
-  "url": "xyz789"
+  "url": "abc123"
 }
 
    
                 
    
@@ -79021,7 +77988,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "currentPage": 123,
+  "currentPage": 987,
   "pageSize": 123,
   "sort": [CompaniesSortInput]
 }
@@ -79558,10 +78525,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "payment_source": "abc123",
-  "payments_order_id": "abc123",
-  "paypal_order_id": "abc123",
-  "public_hash": "xyz789"
+  "payment_source": "xyz789",
+  "payments_order_id": "xyz789",
+  "paypal_order_id": "xyz789",
+  "public_hash": "abc123"
 }
 
    
                 
    
@@ -79642,7 +78609,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"public_hash": "abc123"}
+                  
    {"public_hash": "xyz789"}
 
    
                 
    
               
    
@@ -79753,10 +78720,10 @@ 
    Example
    
   "discount": [Discount],
   "errors": [CartItemError],
   "id": "xyz789",
-  "is_available": true,
-  "max_qty": 987.65,
-  "min_qty": 987.65,
-  "not_available_message": "xyz789",
+  "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,
@@ -80128,6 +79095,11 @@ 
    currentPage
                         
                       
+                      
+                        rules - [CatalogRule]
+                        
+                         Provides applied catalog rules in the current active cart 
+                      
                       
                         sale - Int
                         
@@ -80304,46 +79276,46 @@ 
    currentPageExample
    
                   
    {
   "activity": "abc123",
-  "attribute_set_id": 987,
+  "attribute_set_id": 123,
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "xyz789",
+  "category_gear": "abc123",
   "climate": "abc123",
   "collar": "xyz789",
-  "color": 987,
-  "country_of_manufacture": "abc123",
+  "color": 123,
+  "country_of_manufacture": "xyz789",
   "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 123,
+  "eco_collection": 987,
   "erin_recommends": 987,
   "features_bags": "xyz789",
   "format": 987,
   "gender": "abc123",
-  "gift_message_available": false,
+  "gift_message_available": true,
   "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
   "id": 123,
   "image": ProductImage,
   "is_returnable": "abc123",
   "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": "xyz789",
+  "meta_description": "abc123",
   "meta_keyword": "abc123",
   "meta_title": "xyz789",
   "min_sale_qty": 987.65,
   "name": "xyz789",
   "new": 987,
   "new_from_date": "abc123",
-  "new_to_date": "abc123",
+  "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,
@@ -80355,20 +79327,21 @@ 
    Example
    
   "redirect_code": 987,
   "related_products": [ProductInterface],
   "relative_url": "abc123",
-  "review_count": 123,
+  "review_count": 987,
   "reviews": ProductReviews,
+  "rules": [CatalogRule],
   "sale": 987,
   "short_description": ComplexTextValue,
   "size": 123,
-  "sku": "xyz789",
+  "sku": "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": "xyz789",
   "style_bottom": "xyz789",
   "style_general": "abc123",
@@ -80378,8 +79351,8 @@ 
    Example
    
   "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": "xyz789",
@@ -80493,7 +79466,7 @@ 
    Example
    
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
   "quantity": 123.45,
-  "uid": 4
+  "uid": "4"
 }
 
    
                 
    
@@ -80561,7 +79534,7 @@ 
    Example
    
                   
    {
   "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
+  "description": "xyz789",
   "id": "4",
   "product": ProductInterface,
   "quantity": 987.65
@@ -80641,7 +79614,7 @@ 
    Example
    
   "id": 123,
   "is_default": true,
   "name": "xyz789",
-  "sort_order": 123
+  "sort_order": 987
 }
 
    
                 
    
@@ -80835,9 +79808,9 @@ 
    Example
    
   "items": [WishlistItem],
   "items_count": 987,
   "items_v2": WishlistItems,
-  "name": "xyz789",
-  "sharing_code": "abc123",
-  "updated_at": "xyz789",
+  "name": "abc123",
+  "sharing_code": "xyz789",
+  "updated_at": "abc123",
   "visibility": "PUBLIC"
 }
 
    
@@ -80895,8 +79868,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "PRODUCT_NOT_FOUND",
-  "message": "xyz789",
-  "wishlistId": 4,
+  "message": "abc123",
+  "wishlistId": "4",
   "wishlistItemId": 4
 }
 
    
@@ -80932,13 +79905,6 @@ 
    Values
    
                         
                         
                       
-                      
-                        
-                          
    REQUIRED_PARAMETER_MISSING
    
-                        
-                        
-                        
-                      
                       
                         
                           
    NOT_SALABLE
    
@@ -81029,9 +79995,9 @@ 
    Example
    
                   
    {
   "added_at": "xyz789",
   "description": "xyz789",
-  "id": 123,
+  "id": 987,
   "product": ProductInterface,
-  "qty": 987.65
+  "qty": 123.45
 }
 
    
                 
    
@@ -81147,10 +80113,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "entered_options": [EnteredOptionInput],
-  "parent_sku": "abc123",
-  "quantity": 123.45,
-  "selected_options": [4],
-  "sku": "abc123"
+  "parent_sku": "xyz789",
+  "quantity": 987.65,
+  "selected_options": ["4"],
+  "sku": "xyz789"
 }
 
    
                 
    
@@ -81237,12 +80203,12 @@ 
    Possible Types
    
                       
                       
                         
-                          
    DownloadableWishlistItem
    
+                          
    BundleWishlistItem
    
                         
                       
                       
                         
-                          
    BundleWishlistItem
    
+                          
    DownloadableWishlistItem
    
                         
                       
                       
@@ -81263,12 +80229,12 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "added_at": "xyz789",
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
-  "id": 4,
+  "description": "xyz789",
+  "id": "4",
   "product": ProductInterface,
-  "quantity": 987.65
+  "quantity": 123.45
 }
 
    
                 
    
@@ -81315,7 +80281,10 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"quantity": 123.45, "wishlist_item_id": 4}
+                  
    {
+  "quantity": 987.65,
+  "wishlist_item_id": "4"
+}
 
    
                 
    
               
    
@@ -81380,10 +80349,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "description": "abc123",
+  "description": "xyz789",
   "entered_options": [EnteredOptionInput],
   "quantity": 987.65,
-  "selected_options": ["4"],
+  "selected_options": [4],
   "wishlist_item_id": "4"
 }
 
    
@@ -81498,10 +80467,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "items": [WishlistItem],
-  "items_count": 987,
+  "items_count": 123,
   "name": "xyz789",
   "sharing_code": "abc123",
-  "updated_at": "xyz789"
+  "updated_at": "abc123"
 }
 
    
                 
    
@@ -81590,7 +80559,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}
 
    
                 
    
               
    
diff --git a/static/graphql-api/2.4.9-beta-1/javascripts/spectaql.min.js b/static/graphql-api/2.4.8/javascripts/spectaql.min.js
similarity index 100%
rename from static/graphql-api/2.4.9-beta-1/javascripts/spectaql.min.js
rename to static/graphql-api/2.4.8/javascripts/spectaql.min.js
diff --git a/static/graphql-api/2.4.9-beta-1/stylesheets/spectaql.min.css b/static/graphql-api/2.4.8/stylesheets/spectaql.min.css
similarity index 100%
rename from static/graphql-api/2.4.9-beta-1/stylesheets/spectaql.min.css
rename to static/graphql-api/2.4.8/stylesheets/spectaql.min.css
diff --git a/static/graphql-api/index.html b/static/graphql-api/index.html
index a284d836c..2fcbe2579 100644
--- a/static/graphql-api/index.html
+++ b/static/graphql-api/index.html
@@ -57,8 +57,10 @@ 
    
                   
  • customer
    • 
                   
  • customerCart
    • 
                   
  • customerDownloadableProducts
    • 
+                  
  • customerGroup
    • 
                   
  • customerOrders
    • 
                   
  • customerPaymentTokens
    • 
+                  
  • customerSegments
    • 
                   
  • dynamicBlocks
    • 
                   
  • getHostedProUrl
    • 
                   
  • getPayflowLinkToken
    • 
@@ -107,6 +109,7 @@ 
    
                   
  • addGiftRegistryRegistrants
    • 
                   
  • addProductsToCart
    • 
                   
  • addProductsToCompareList
    • 
+                  
  • addProductsToNewCart
    • 
                   
  • addProductsToRequisitionList
    • 
                   
  • addProductsToWishlist
    • 
                   
  • addPurchaseOrderComment
    • 
@@ -131,7 +134,9 @@ 
    
                   
  • changeCustomerPassword
    • 
                   
  • clearCart
    • 
                   
  • clearCustomerCart
    • 
+                  
  • clearWishlist
    • 
                   
  • closeNegotiableQuotes
    • 
+                  
  • completeOrder
    • 
                   
  • confirmCancelOrder
    • 
                   
  • confirmEmail
    • 
                   
  • confirmReturn
    • 
@@ -168,6 +173,7 @@ 
    
                   
  • deleteCompareList
    • 
                   
  • deleteCustomer
    • 
                   
  • deleteCustomerAddress
    • 
+                  
  • deleteCustomerAddressV2
    • 
                   
  • deleteNegotiableQuoteTemplate
    • 
                   
  • deleteNegotiableQuotes
    • 
                   
  • deletePaymentToken
    • 
@@ -178,6 +184,7 @@ 
    
                   
  • duplicateNegotiableQuote
    • 
                   
  • estimateShippingMethods
    • 
                   
  • estimateTotals
    • 
+                  
  • exchangeExternalCustomerToken
    • 
                   
  • generateCustomerToken
    • 
                   
  • generateCustomerTokenAsAdmin
    • 
                   
  • generateNegotiableQuoteFromTemplate
    • 
@@ -222,6 +229,7 @@ 
    
                   
  • sendEmailToFriend
    • 
                   
  • sendNegotiableQuoteForReview
    • 
                   
  • setBillingAddressOnCart
    • 
+                  
  • setCartAsInactive
    • 
                   
  • setGiftOptionsOnCart
    • 
                   
  • setGuestEmailOnCart
    • 
                   
  • setLineItemNote
    • 
@@ -239,7 +247,6 @@ 
    
                   
  • submitNegotiableQuoteTemplateForReview
    • 
                   
  • subscribeEmailToNewsletter
    • 
                   
  • syncPaymentOrder
    • 
-                  
  • trackViewedProduct
    • 
                   
  • updateCartItems
    • 
                   
  • updateCompany
    • 
                   
  • updateCompanyRole
    • 
@@ -248,6 +255,7 @@ 
    
                   
  • updateCompanyUser
    • 
                   
  • updateCustomer
    • 
                   
  • updateCustomerAddress
    • 
+                  
  • updateCustomerAddressV2
    • 
                   
  • updateCustomerEmail
    • 
                   
  • updateCustomerV2
    • 
                   
  • updateGiftRegistry
    • 
@@ -280,6 +288,7 @@ 
    Types
    
               
  • AddGiftRegistryRegistrantsOutput
    • 
               
  • AddProductsToCartOutput
    • 
               
  • AddProductsToCompareListInput
    • 
+              
  • AddProductsToNewCartOutput
    • 
               
  • AddProductsToRequisitionListOutput
    • 
               
  • AddProductsToWishlistOutput
    • 
               
  • AddPurchaseOrderCommentInput
    • 
@@ -390,13 +399,12 @@ 
    Types
    
               
  • CartItemUpdateInput
    • 
               
  • CartItems
    • 
               
  • CartPrices
    • 
-              
  • CartRule
    • 
+              
  • CartRuleStorefront
    • 
               
  • CartTaxItem
    • 
               
  • CartUserInputError
    • 
               
  • CartUserInputErrorType
    • 
               
  • CatalogAttributeApplyToEnum
    • 
               
  • CatalogAttributeMetadata
    • 
-              
  • CatalogRule
    • 
               
  • CategoryFilterInput
    • 
               
  • CategoryInterface
    • 
               
  • CategoryProducts
    • 
@@ -445,6 +453,7 @@ 
    Types
    
               
  • CompanyRoleUpdateInput
    • 
               
  • CompanyRoles
    • 
               
  • CompanySalesRepresentative
    • 
+              
  • CompanyStatusEnum
    • 
               
  • CompanyStructure
    • 
               
  • CompanyStructureEntity
    • 
               
  • CompanyStructureItem
    • 
@@ -461,6 +470,7 @@ 
    Types
    
               
  • ComparableAttribute
    • 
               
  • ComparableItem
    • 
               
  • CompareList
    • 
+              
  • CompleteOrderInput
    • 
               
  • ComplexTextValue
    • 
               
  • ConfigurableAttributeOption
    • 
               
  • ConfigurableCartItem
    • 
@@ -533,7 +543,7 @@ 
    Types
    
               
  • CustomerCreateInput
    • 
               
  • CustomerDownloadableProduct
    • 
               
  • CustomerDownloadableProducts
    • 
-              
  • CustomerGroup
    • 
+              
  • CustomerGroupStorefront
    • 
               
  • CustomerInput
    • 
               
  • CustomerOrder
    • 
               
  • CustomerOrderSortInput
    • 
@@ -542,8 +552,7 @@ 
    Types
    
               
  • CustomerOrdersFilterInput
    • 
               
  • CustomerOutput
    • 
               
  • CustomerPaymentTokens
    • 
-              
  • CustomerSegment
    • 
-              
  • CustomerSegmentApplyTo
    • 
+              
  • CustomerSegmentStorefront
    • 
               
  • CustomerStoreCredit
    • 
               
  • CustomerStoreCreditHistory
    • 
               
  • CustomerStoreCreditHistoryItem
    • 
@@ -616,7 +625,11 @@ 
    Types
    
               
  • EstimateAddressInput
    • 
               
  • EstimateTotalsInput
    • 
               
  • EstimateTotalsOutput
    • 
+              
  • ExchangeExternalCustomerTokenInput
    • 
+              
  • ExchangeExternalCustomerTokenOutput
    • 
               
  • ExchangeRate
    • 
+              
  • FastlaneConfig
    • 
+              
  • FastlaneMethodInput
    • 
               
  • FilterEqualTypeInput
    • 
               
  • FilterMatchTypeEnum
    • 
               
  • FilterMatchTypeInput
    • 
@@ -645,6 +658,7 @@ 
    Types
    
               
  • GiftCardShipmentItem
    • 
               
  • GiftCardTypeEnum
    • 
               
  • GiftCardWishlistItem
    • 
+              
  • GiftCartAttributeValue
    • 
               
  • GiftMessage
    • 
               
  • GiftMessageInput
    • 
               
  • GiftOptionsPrices
    • 
@@ -677,6 +691,7 @@ 
    Types
    
               
  • GroupedProductItem
    • 
               
  • GroupedProductWishlistItem
    • 
               
  • GuestOrderCancelInput
    • 
+              
  • GuestOrderInformationInput
    • 
               
  • HostedFieldsConfig
    • 
               
  • HostedFieldsInput
    • 
               
  • HostedProInput
    • 
@@ -766,7 +781,6 @@ 
    Types
    
               
  • OrderActionType
    • 
               
  • OrderAddress
    • 
               
  • OrderCustomerInfo
    • 
-              
  • OrderInformationInput
    • 
               
  • OrderItem
    • 
               
  • OrderItemInterface
    • 
               
  • OrderItemOption
    • 
@@ -917,6 +931,7 @@ 
    Types
    
               
  • RequisitionList
    • 
               
  • RequisitionListFilterInput
    • 
               
  • RequisitionListItemInterface
    • 
+              
  • RequisitionListItems
    • 
               
  • RequisitionListItemsInput
    • 
               
  • RequisitionLists
    • 
               
  • RequistionListItems
    • 
@@ -969,6 +984,7 @@ 
    Types
    
               
  • SendNegotiableQuoteForReviewOutput
    • 
               
  • SetBillingAddressOnCartInput
    • 
               
  • SetBillingAddressOnCartOutput
    • 
+              
  • SetCartAsInactiveOutput
    • 
               
  • SetGiftOptionsOnCartInput
    • 
               
  • SetGiftOptionsOnCartOutput
    • 
               
  • SetGuestEmailOnCartInput
    • 
@@ -1437,6 +1453,7 @@ 
    Query
    
     braintree_paypal_vault_active
     cart_expires_in_days
     cart_gift_wrapping
+    cart_merge_preference
     cart_printed_card
     cart_summary_display_quantity
     catalog_default_sort_by
@@ -1481,7 +1498,6 @@ 
    Query
    
     fixed_product_taxes_enable
     fixed_product_taxes_include_fpt_in_subtotal
     front
-    graphql_share_all_customer_groups
     graphql_share_customer_group
     grid_per_page
     grid_per_page_values
@@ -1559,10 +1575,8 @@ 
    Query
    
     send_friend {
       ...SendFriendConfigurationFragment
     }
-    share_all_catalog_rules
-    share_all_sales_rule
-    share_applied_catalog_rules
-    share_applied_sales_rule
+    share_active_segments
+    share_applied_cart_rule
     shopping_cart_display_full_summary
     shopping_cart_display_grand_total
     shopping_cart_display_price
@@ -1599,7 +1613,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"useCurrentGroup": false}
+                  
    {"useCurrentGroup": true}
 
    
                 
    
                 
    
@@ -1609,188 +1623,188 @@ 
    Response
    
     "availableStores": [
       {
         "absolute_footer": "abc123",
-        "allow_gift_receipt": "xyz789",
-        "allow_gift_wrapping_on_order": "xyz789",
-        "allow_gift_wrapping_on_order_items": "xyz789",
-        "allow_guests_to_write_product_reviews": "xyz789",
+        "allow_gift_receipt": "abc123",
+        "allow_gift_wrapping_on_order": "abc123",
+        "allow_gift_wrapping_on_order_items": "abc123",
+        "allow_guests_to_write_product_reviews": "abc123",
         "allow_items": "abc123",
-        "allow_order": "xyz789",
-        "allow_printed_card": "abc123",
-        "autocomplete_on_storefront": true,
-        "base_currency_code": "abc123",
+        "allow_order": "abc123",
+        "allow_printed_card": "xyz789",
+        "autocomplete_on_storefront": false,
+        "base_currency_code": "xyz789",
         "base_link_url": "abc123",
         "base_media_url": "xyz789",
-        "base_static_url": "xyz789",
-        "base_url": "xyz789",
+        "base_static_url": "abc123",
+        "base_url": "abc123",
         "braintree_3dsecure_allowspecific": true,
-        "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": false,
-        "braintree_ach_direct_debit_vault_active": false,
-        "braintree_applepay_merchant_name": "xyz789",
-        "braintree_applepay_vault_active": false,
+        "braintree_3dsecure_threshold_amount": "abc123",
+        "braintree_3dsecure_verify_3dsecure": true,
+        "braintree_ach_direct_debit_vault_active": true,
+        "braintree_applepay_merchant_name": "abc123",
+        "braintree_applepay_vault_active": true,
         "braintree_cc_vault_active": "xyz789",
         "braintree_cc_vault_cvv": false,
-        "braintree_environment": "xyz789",
+        "braintree_environment": "abc123",
         "braintree_googlepay_btn_color": "xyz789",
         "braintree_googlepay_cctypes": "xyz789",
         "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": "xyz789",
-        "braintree_merchant_account_id": "abc123",
+        "braintree_local_payment_redirect_on_fail": "abc123",
+        "braintree_merchant_account_id": "xyz789",
         "braintree_paypal_button_location_cart_type_credit_color": "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_layout": "xyz789",
         "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789",
         "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
-        "braintree_paypal_button_location_cart_type_messaging_show": true,
-        "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
-        "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
-        "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
+        "braintree_paypal_button_location_cart_type_messaging_show": false,
+        "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789",
+        "braintree_paypal_button_location_cart_type_paylater_color": "xyz789",
+        "braintree_paypal_button_location_cart_type_paylater_label": "abc123",
         "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789",
         "braintree_paypal_button_location_cart_type_paylater_show": 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_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_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": 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_show": true,
-        "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
+        "braintree_paypal_button_location_checkout_type_messaging_show": false,
+        "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789",
         "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
-        "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
-        "braintree_paypal_button_location_checkout_type_paylater_shape": "abc123",
-        "braintree_paypal_button_location_checkout_type_paylater_show": 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": "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": true,
-        "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": "abc123",
-        "braintree_paypal_button_location_productpage_type_credit_show": true,
+        "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": "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_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": "abc123",
+        "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
+        "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
+        "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789",
         "braintree_paypal_button_location_productpage_type_paylater_show": false,
         "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789",
         "braintree_paypal_button_location_productpage_type_paypal_label": "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": true,
-        "braintree_paypal_send_cart_line_items": false,
+        "braintree_paypal_send_cart_line_items": true,
         "braintree_paypal_vault_active": true,
-        "cart_expires_in_days": 123,
-        "cart_gift_wrapping": "abc123",
+        "cart_expires_in_days": 987,
+        "cart_gift_wrapping": "xyz789",
+        "cart_merge_preference": "xyz789",
         "cart_printed_card": "xyz789",
-        "cart_summary_display_quantity": 987,
+        "cart_summary_display_quantity": 123,
         "catalog_default_sort_by": "abc123",
         "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-        "category_url_suffix": "xyz789",
-        "check_money_order_enable_for_specific_countries": true,
-        "check_money_order_enabled": false,
+        "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": "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": "abc123",
         "check_money_order_send_check_to": "abc123",
         "check_money_order_sort_order": 987,
         "check_money_order_title": "abc123",
-        "cms_home_page": "xyz789",
-        "cms_no_cookies": "xyz789",
-        "cms_no_route": "abc123",
-        "code": "abc123",
+        "cms_home_page": "abc123",
+        "cms_no_cookies": "abc123",
+        "cms_no_route": "xyz789",
+        "code": "xyz789",
         "configurable_product_image": "ITSELF",
-        "configurable_thumbnail_source": "abc123",
+        "configurable_thumbnail_source": "xyz789",
         "contact_enabled": false,
         "copyright": "abc123",
         "countries_with_required_region": "abc123",
-        "create_account_confirmation": false,
+        "create_account_confirmation": true,
         "customer_access_token_lifetime": 123.45,
-        "default_country": "xyz789",
+        "default_country": "abc123",
         "default_description": "abc123",
-        "default_display_currency_code": "xyz789",
-        "default_keywords": "xyz789",
-        "default_title": "xyz789",
+        "default_display_currency_code": "abc123",
+        "default_keywords": "abc123",
+        "default_title": "abc123",
         "demonotice": 123,
-        "display_product_prices_in_catalog": 123,
-        "display_shipping_prices": 123,
-        "display_state_if_optional": false,
-        "enable_multiple_wishlists": "xyz789",
+        "display_product_prices_in_catalog": 987,
+        "display_shipping_prices": 987,
+        "display_state_if_optional": true,
+        "enable_multiple_wishlists": "abc123",
         "fixed_product_taxes_apply_tax_to_fpt": 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_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": false,
+        "front": "abc123",
         "graphql_share_customer_group": false,
-        "grid_per_page": 123,
+        "grid_per_page": 987,
         "grid_per_page_values": "xyz789",
         "grouped_product_image": "ITSELF",
-        "head_includes": "xyz789",
-        "head_shortcut_icon": "abc123",
-        "header_logo_src": "abc123",
+        "head_includes": "abc123",
+        "head_shortcut_icon": "xyz789",
+        "header_logo_src": "xyz789",
         "id": 987,
         "is_checkout_agreements_enabled": false,
-        "is_default_store": true,
-        "is_default_store_group": true,
-        "is_guest_checkout_enabled": true,
+        "is_default_store": false,
+        "is_default_store_group": false,
+        "is_guest_checkout_enabled": false,
         "is_negotiable_quote_active": true,
         "is_one_page_checkout_enabled": true,
-        "is_requisition_list_active": "xyz789",
+        "is_requisition_list_active": "abc123",
         "list_mode": "xyz789",
-        "list_per_page": 987,
+        "list_per_page": 123,
         "list_per_page_values": "xyz789",
         "locale": "abc123",
         "logo_alt": "xyz789",
         "logo_height": 987,
-        "logo_width": 123,
+        "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_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_customer": "xyz789",
+        "magento_reward_points_invitation_customer_limit": "abc123",
         "magento_reward_points_invitation_order": "xyz789",
         "magento_reward_points_invitation_order_limit": "xyz789",
-        "magento_reward_points_newsletter": "xyz789",
-        "magento_reward_points_order": "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": "abc123",
+        "magento_reward_points_review_limit": "xyz789",
         "magento_wishlist_general_is_enabled": "xyz789",
         "max_items_in_order_summary": 123,
         "maximum_number_of_wishlists": "xyz789",
         "minicart_display": false,
         "minicart_max_items": 987,
-        "minimum_password_length": "xyz789",
+        "minimum_password_length": "abc123",
         "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
         ],
@@ -1798,60 +1812,58 @@ 
    Response
    
         "orders_invoices_credit_memos_display_grandtotal": false,
         "orders_invoices_credit_memos_display_price": 123,
         "orders_invoices_credit_memos_display_shipping_amount": 987,
-        "orders_invoices_credit_memos_display_subtotal": 123,
+        "orders_invoices_credit_memos_display_subtotal": 987,
         "orders_invoices_credit_memos_display_zero_tax": true,
-        "payment_payflowpro_cc_vault_active": "xyz789",
-        "printed_card_price": "abc123",
+        "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_uid": "4",
         "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-        "sales_gift_wrapping": "abc123",
-        "sales_printed_card": "xyz789",
+        "sales_gift_wrapping": "xyz789",
+        "sales_printed_card": "abc123",
         "secure_base_link_url": "abc123",
         "secure_base_media_url": "abc123",
         "secure_base_static_url": "xyz789",
-        "secure_base_url": "xyz789",
+        "secure_base_url": "abc123",
         "send_friend": SendFriendConfiguration,
-        "share_all_catalog_rules": false,
-        "share_all_sales_rule": false,
-        "share_applied_catalog_rules": true,
-        "share_applied_sales_rule": true,
-        "shopping_cart_display_full_summary": false,
+        "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_shipping": 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,
+        "shopping_cart_display_zero_tax": false,
         "show_cms_breadcrumbs": 987,
-        "store_code": "4",
-        "store_group_code": "4",
-        "store_group_name": "xyz789",
-        "store_name": "abc123",
-        "store_sort_order": 987,
+        "store_code": 4,
+        "store_group_code": 4,
+        "store_group_name": "abc123",
+        "store_name": "xyz789",
+        "store_sort_order": 123,
         "timezone": "abc123",
-        "title_prefix": "xyz789",
-        "title_separator": "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": 987,
-        "website_name": "abc123",
+        "website_id": 123,
+        "website_name": "xyz789",
         "weight_unit": "xyz789",
         "welcome": "xyz789",
         "zero_subtotal_enable_for_specific_countries": true,
-        "zero_subtotal_enabled": true,
+        "zero_subtotal_enabled": false,
         "zero_subtotal_new_order_status": "abc123",
         "zero_subtotal_payment_action": "xyz789",
         "zero_subtotal_payment_from_specific_countries": "abc123",
-        "zero_subtotal_sort_order": 123,
+        "zero_subtotal_sort_order": 987,
         "zero_subtotal_title": "abc123"
       }
     ]
@@ -1956,7 +1968,7 @@ 
    Query
    
     }
     printed_card_included
     rules {
-      ...CartRuleFragment
+      ...CartRuleStorefrontFragment
     }
     selected_payment_method {
       ...SelectedPaymentMethodFragment
@@ -1971,7 +1983,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
 
    
                 
    
                 
    
@@ -1989,20 +2001,20 @@ 
    Response
    
         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,
+      "id": 4,
+      "is_virtual": false,
       "items": [CartItemInterface],
       "itemsV2": CartItems,
       "prices": CartPrices,
       "printed_card_included": false,
-      "rules": [CartRule],
+      "rules": [CartRuleStorefront],
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
-      "total_quantity": 123.45
+      "total_quantity": 987.65
     }
   }
 }
@@ -2223,7 +2235,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"id": 123}
+                  
    {"id": 987}
 
    
                 
    
                 
    
@@ -2234,39 +2246,39 @@ 
    Response
    
       "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": "abc123",
-      "description": "xyz789",
+      "description": "abc123",
       "display_mode": "xyz789",
-      "filter_price_range": 987.65,
+      "filter_price_range": 123.45,
       "id": 987,
       "image": "abc123",
-      "include_in_menu": 123,
+      "include_in_menu": 987,
       "is_anchor": 987,
-      "landing_page": 987,
-      "level": 987,
-      "meta_description": "abc123",
+      "landing_page": 123,
+      "level": 123,
+      "meta_description": "xyz789",
       "meta_keywords": "xyz789",
       "meta_title": "xyz789",
-      "name": "xyz789",
+      "name": "abc123",
       "path": "xyz789",
-      "path_in_store": "xyz789",
+      "path_in_store": "abc123",
       "position": 987,
       "product_count": 987,
       "products": CategoryProducts,
-      "redirect_code": 123,
+      "redirect_code": 987,
       "relative_url": "abc123",
-      "staged": true,
+      "staged": false,
       "type": "CMS_PAGE",
-      "uid": "4",
-      "updated_at": "xyz789",
+      "uid": 4,
+      "updated_at": "abc123",
       "url_key": "abc123",
-      "url_path": "xyz789",
+      "url_path": "abc123",
       "url_suffix": "xyz789"
     }
   }
@@ -2416,41 +2428,41 @@ 
    Response
    
   "data": {
     "categoryList": [
       {
-        "automatic_sorting": "xyz789",
+        "automatic_sorting": "abc123",
         "available_sort_by": ["xyz789"],
         "breadcrumbs": [Breadcrumb],
         "canonical_url": "abc123",
         "children": [CategoryTree],
-        "children_count": "xyz789",
+        "children_count": "abc123",
         "cms_block": CmsBlock,
         "created_at": "xyz789",
-        "custom_layout_update_file": "abc123",
-        "default_sort_by": "xyz789",
-        "description": "xyz789",
+        "custom_layout_update_file": "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,
         "is_anchor": 123,
         "landing_page": 987,
         "level": 987,
-        "meta_description": "abc123",
+        "meta_description": "xyz789",
         "meta_keywords": "xyz789",
         "meta_title": "abc123",
-        "name": "abc123",
-        "path": "xyz789",
+        "name": "xyz789",
+        "path": "abc123",
         "path_in_store": "xyz789",
-        "position": 987,
+        "position": 123,
         "product_count": 123,
         "products": CategoryProducts,
         "redirect_code": 987,
-        "relative_url": "xyz789",
-        "staged": true,
+        "relative_url": "abc123",
+        "staged": false,
         "type": "CMS_PAGE",
-        "uid": "4",
+        "uid": 4,
         "updated_at": "xyz789",
-        "url_key": "abc123",
+        "url_key": "xyz789",
         "url_path": "xyz789",
         "url_suffix": "xyz789"
       }
@@ -2511,11 +2523,11 @@ 
    Response
    
       {
         "agreement_id": 987,
         "checkbox_text": "abc123",
-        "content": "xyz789",
-        "content_height": "abc123",
-        "is_html": false,
+        "content": "abc123",
+        "content_height": "xyz789",
+        "is_html": true,
         "mode": "AUTO",
-        "name": "xyz789"
+        "name": "abc123"
       }
     ]
   }
@@ -2583,7 +2595,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"identifiers": ["abc123"]}
+                  
    {"identifiers": ["xyz789"]}
 
    
                 
    
                 
    
@@ -2673,7 +2685,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"id": 987, "identifier": "abc123"}
+                  
    {"id": 987, "identifier": "xyz789"}
 
    
                 
    
                 
    
@@ -2682,14 +2694,14 @@ 
    Response
    
   "data": {
     "cmsPage": {
       "content": "xyz789",
-      "content_heading": "abc123",
-      "identifier": "abc123",
+      "content_heading": "xyz789",
+      "identifier": "xyz789",
       "meta_description": "xyz789",
       "meta_keywords": "xyz789",
-      "meta_title": "abc123",
+      "meta_title": "xyz789",
       "page_layout": "xyz789",
-      "redirect_code": 123,
-      "relative_url": "abc123",
+      "redirect_code": 987,
+      "relative_url": "xyz789",
       "title": "xyz789",
       "type": "CMS_PAGE",
       "url_key": "abc123"
@@ -2788,10 +2800,10 @@ 
    Response
    
       "credit": CompanyCredit,
       "credit_history": CompanyCreditHistory,
       "email": "abc123",
-      "id": 4,
+      "id": "4",
       "legal_address": CompanyLegalAddress,
-      "legal_name": "xyz789",
-      "name": "xyz789",
+      "legal_name": "abc123",
+      "name": "abc123",
       "payment_methods": ["abc123"],
       "reseller_id": "xyz789",
       "role": CompanyRole,
@@ -2801,7 +2813,7 @@ 
    Response
    
       "team": CompanyTeam,
       "user": Customer,
       "users": CompanyUsers,
-      "vat_tax_id": "xyz789"
+      "vat_tax_id": "abc123"
     }
   }
 }
@@ -2882,9 +2894,9 @@ 
    Response
    
   "data": {
     "compareList": {
       "attributes": [ComparableAttribute],
-      "item_count": 123,
+      "item_count": 987,
       "items": [ComparableItem],
-      "uid": 4
+      "uid": "4"
     }
   }
 }
@@ -2942,11 +2954,11 @@ 
    Response
    
     "countries": [
       {
         "available_regions": [Region],
-        "full_name_english": "xyz789",
-        "full_name_locale": "abc123",
-        "id": "xyz789",
-        "three_letter_abbreviation": "abc123",
-        "two_letter_abbreviation": "xyz789"
+        "full_name_english": "abc123",
+        "full_name_locale": "xyz789",
+        "id": "abc123",
+        "three_letter_abbreviation": "xyz789",
+        "two_letter_abbreviation": "abc123"
       }
     ]
   }
@@ -3020,7 +3032,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"id": "xyz789"}
+                  
    {"id": "abc123"}
 
    
                 
    
                 
    
@@ -3031,9 +3043,9 @@ 
    Response
    
       "available_regions": [Region],
       "full_name_english": "abc123",
       "full_name_locale": "abc123",
-      "id": "xyz789",
-      "three_letter_abbreviation": "abc123",
-      "two_letter_abbreviation": "xyz789"
+      "id": "abc123",
+      "three_letter_abbreviation": "xyz789",
+      "two_letter_abbreviation": "abc123"
     }
   }
 }
@@ -3095,10 +3107,10 @@ 
    Response
    
         "abc123"
       ],
       "base_currency_code": "abc123",
-      "base_currency_symbol": "abc123",
-      "default_display_currecy_code": "xyz789",
+      "base_currency_symbol": "xyz789",
+      "default_display_currecy_code": "abc123",
       "default_display_currecy_symbol": "abc123",
-      "default_display_currency_code": "abc123",
+      "default_display_currency_code": "xyz789",
       "default_display_currency_symbol": "abc123",
       "exchange_rates": [ExchangeRate]
     }
@@ -3331,7 +3343,7 @@ 
    Query
    
       ...GiftRegistryFragment
     }
     group {
-      ...CustomerGroupFragment
+      ...CustomerGroupStorefrontFragment
     }
     group_id
     id
@@ -3378,7 +3390,7 @@ 
    Query
    
       ...CompanyRoleFragment
     }
     segments {
-      ...CustomerSegmentFragment
+      ...CustomerSegmentStorefrontFragment
     }
     status
     store_credit {
@@ -3417,21 +3429,21 @@ 
    Response
    
       "confirmation_status": "ACCOUNT_CONFIRMED",
       "created_at": "abc123",
       "custom_attributes": [AttributeValueInterface],
-      "date_of_birth": "xyz789",
-      "default_billing": "xyz789",
-      "default_shipping": "abc123",
+      "date_of_birth": "abc123",
+      "default_billing": "abc123",
+      "default_shipping": "xyz789",
       "dob": "xyz789",
-      "email": "abc123",
+      "email": "xyz789",
       "firstname": "xyz789",
-      "gender": 123,
+      "gender": 987,
       "gift_registries": [GiftRegistry],
       "gift_registry": GiftRegistry,
-      "group": CustomerGroup,
-      "group_id": 987,
-      "id": 987,
+      "group": CustomerGroupStorefront,
+      "group_id": 123,
+      "id": 4,
       "is_subscribed": false,
-      "job_title": "xyz789",
-      "lastname": "xyz789",
+      "job_title": "abc123",
+      "lastname": "abc123",
       "middlename": "abc123",
       "orders": CustomerOrders,
       "prefix": "abc123",
@@ -3440,19 +3452,19 @@ 
    Response
    
       "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,
       "reviews": ProductReviews,
       "reward_points": RewardPoints,
       "role": CompanyRole,
-      "segments": [CustomerSegment],
+      "segments": [CustomerSegmentStorefront],
       "status": "ACTIVE",
       "store_credit": CustomerStoreCredit,
       "structure_id": "4",
       "suffix": "abc123",
-      "taxvat": "abc123",
+      "taxvat": "xyz789",
       "team": CompanyTeam,
       "telephone": "abc123",
       "wishlist": Wishlist,
@@ -3541,7 +3553,7 @@ 
    Query
    
     }    
     printed_card_included
     rules {
-      ...CartRuleFragment
+      ...CartRuleStorefrontFragment
     }
     selected_payment_method {
       ...SelectedPaymentMethodFragment
@@ -3571,18 +3583,18 @@ 
    Response
    
       "billing_address": BillingCartAddress,
       "email": "abc123",
       "gift_message": GiftMessage,
-      "gift_receipt_included": true,
+      "gift_receipt_included": false,
       "gift_wrapping": GiftWrapping,
-      "id": "4",
+      "id": 4,
       "is_virtual": false,
       "items": [CartItemInterface],
       "itemsV2": CartItems,
       "prices": CartPrices,
       "printed_card_included": true,
-      "rules": [CartRule],
+      "rules": [CartRuleStorefront],
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
-      "total_quantity": 123.45
+      "total_quantity": 987.65
     }
   }
 }
@@ -3637,6 +3649,49 @@ 
    Response
    
     }
   }
 }
+
    
+                
    
+              
+              back to top
+            
+
    +
    +
    + Queries +
    +

    + customerGroup +

    +
    +
    +
    +
    Description
    +

    Provides Customer Group assigned to the Customer or Guest.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a CustomerGroupStorefront! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    query customerGroup {
+  customerGroup {
+    uid
+  }
+}
+
    +
    +
    +
    Response
    + 
    {"data": {"customerGroup": {"uid": "4"}}}
    @@ -3688,10 +3743,10 @@
    Response
    {
   "data": {
     "customerOrders": {
-      "date_of_first_order": "abc123",
+      "date_of_first_order": "xyz789",
       "items": [CustomerOrder],
       "page_info": SearchResultPageInfo,
-      "total_count": 987
+      "total_count": 123
     }
   }
 }
@@ -3744,6 +3799,73 @@ 
    Response
    
     "customerPaymentTokens": {"items": [PaymentToken]}
   }
 }
+
    +
    + + back to top + +
    +
    +
    + Queries +
    +

    + customerSegments +

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns [CustomerSegmentStorefront] +

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

    Example

    +
    +
    Query
    + 
    query customerSegments($cartId: String!) {
+  customerSegments(cartId: $cartId) {
+    uid
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"cartId": "xyz789"}
+
    +
    +
    +
    Response
    + 
    {"data": {"customerSegments": [{"uid": 4}]}}
    @@ -3845,7 +3967,7 @@
    Response
    "dynamicBlocks": { "items": [DynamicBlock], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -3995,9 +4117,9 @@
    Response
    "data": { "getPayflowLinkToken": { "mode": "TEST", - "paypal_url": "xyz789", - "secure_token": "abc123", - "secure_token_id": "abc123" + "paypal_url": "abc123", + "secure_token": "xyz789", + "secure_token_id": "xyz789" } } } @@ -4058,6 +4180,9 @@
    Query
    apple_pay { ...ApplePayConfigFragment } + fastlane { + ...FastlaneConfigFragment + } google_pay { ...GooglePayConfigFragment } @@ -4082,6 +4207,7 @@
    Response
    "data": { "getPaymentConfig": { "apple_pay": ApplePayConfig, + "fastlane": FastlaneConfig, "google_pay": GooglePayConfig, "hosted_fields": HostedFieldsConfig, "smart_buttons": SmartButtonsConfig @@ -4168,7 +4294,7 @@
    Query
    Variables
    {
   "cartId": "abc123",
-  "id": "abc123"
+  "id": "xyz789"
 }
    @@ -4180,7 +4306,7 @@
    Response
    "id": "abc123", "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, - "status": "abc123" + "status": "xyz789" } } } @@ -4382,8 +4508,8 @@
    Response
    "data": { "giftCardAccount": { "balance": Money, - "code": "abc123", - "expiration_date": "abc123" + "code": "xyz789", + "expiration_date": "xyz789" } } } @@ -4560,7 +4686,7 @@
    Query
    Variables
    - 
    {"email": "abc123"}
+                  
    {"email": "xyz789"}
    @@ -4570,11 +4696,11 @@
    Response
    "giftRegistryEmailSearch": [ { "event_date": "xyz789", - "event_title": "xyz789", - "gift_registry_uid": "4", - "location": "abc123", - "name": "xyz789", - "type": "xyz789" + "event_title": "abc123", + "gift_registry_uid": 4, + "location": "xyz789", + "name": "abc123", + "type": "abc123" } ] } @@ -4645,7 +4771,7 @@
    Query
    Variables
    - 
    {"giftRegistryUid": "4"}
+                  
    {"giftRegistryUid": 4}
    @@ -4656,9 +4782,9 @@
    Response
    { "event_date": "abc123", "event_title": "abc123", - "gift_registry_uid": 4, - "location": "abc123", - "name": "xyz789", + "gift_registry_uid": "4", + "location": "xyz789", + "name": "abc123", "type": "xyz789" } ] @@ -4752,8 +4878,8 @@
    Query
    Variables
    {
   "firstName": "abc123",
-  "lastName": "xyz789",
-  "giftRegistryTypeUid": "4"
+  "lastName": "abc123",
+  "giftRegistryTypeUid": 4
 }
    @@ -4763,12 +4889,12 @@
    Response
    "data": { "giftRegistryTypeSearch": [ { - "event_date": "abc123", + "event_date": "xyz789", "event_title": "xyz789", "gift_registry_uid": 4, "location": "abc123", "name": "abc123", - "type": "xyz789" + "type": "abc123" } ] } @@ -4827,7 +4953,7 @@
    Response
    GiftRegistryDynamicAttributeMetadataInterface ], "label": "xyz789", - "uid": "4" + "uid": 4 } ] } @@ -4872,7 +4998,7 @@
    Arguments
    - input - OrderInformationInput! + input - GuestOrderInformationInput! @@ -4885,7 +5011,7 @@
    Arguments

    Example

    Query
    - 
    query guestOrder($input: OrderInformationInput!) {
+                  
    query guestOrder($input: GuestOrderInformationInput!) {
   guestOrder(input: $input) {
     applied_coupons {
       ...AppliedCouponFragment
@@ -4958,7 +5084,7 @@ 
    Query
    Variables
    - 
    {"input": OrderInformationInput}
+                  
    {"input": GuestOrderInformationInput}
    @@ -4972,7 +5098,7 @@
    Response
    "billing_address": OrderAddress, "carrier": "abc123", "comments": [SalesCommentItem], - "created_at": "xyz789", + "created_at": "abc123", "credit_memos": [CreditMemo], "customer_info": OrderCustomerInfo, "email": "xyz789", @@ -4983,21 +5109,21 @@
    Response
    "id": 4, "increment_id": "xyz789", "invoices": [Invoice], - "is_virtual": false, + "is_virtual": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "xyz789", + "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, + "printed_card_included": false, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "abc123", - "status": "xyz789", - "token": "abc123", + "status": "abc123", + "token": "xyz789", "total": OrderTotal } } @@ -5147,7 +5273,7 @@
    Response
    "customer_info": OrderCustomerInfo, "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "grand_total": 123.45, "id": "4", @@ -5166,7 +5292,7 @@
    Response
    "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "abc123", - "status": "abc123", + "status": "xyz789", "token": "abc123", "total": OrderTotal } @@ -5239,7 +5365,7 @@
    Variables
    Response
    - 
    {"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}}
+                  
    {"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}}
    @@ -5375,7 +5501,7 @@
    Variables
    Response
    - 
    {"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}}
+                  
    {"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}}
    @@ -5505,7 +5631,7 @@
    Query
    Variables
    - 
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
    @@ -5607,7 +5733,7 @@
    Query
    Variables
    - 
    {"uid": 4}
+                  
    {"uid": "4"}
    @@ -5622,9 +5748,9 @@
    Response
    "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "abc123", - "email": "abc123", + "email": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "name": "xyz789", "prices": CartPrices, @@ -5633,9 +5759,9 @@
    Response
    NegotiableQuoteShippingAddress ], "status": "SUBMITTED", - "total_quantity": 987.65, + "total_quantity": 123.45, "uid": "4", - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -5733,7 +5859,7 @@
    Query
    Variables
    - 
    {"templateId": 4}
+                  
    {"templateId": "4"}
    @@ -5745,12 +5871,12 @@
    Response
    "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": 987, "min_order_commitment": 123, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -5759,9 +5885,9 @@
    Response
    "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": 4, - "total_quantity": 123.45 + "status": "xyz789", + "template_id": "4", + "total_quantity": 987.65 } } } @@ -5879,7 +6005,7 @@
    Response
    "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } } } @@ -6389,7 +6515,7 @@
    Response
    "data": { "recaptchaFormConfig": { "configurations": ReCaptchaConfiguration, - "is_enabled": false + "is_enabled": true } } } @@ -6445,10 +6571,10 @@
    Response
    {
   "data": {
     "recaptchaV3Config": {
-      "badge_position": "xyz789",
-      "failure_message": "xyz789",
+      "badge_position": "abc123",
+      "failure_message": "abc123",
       "forms": ["PLACE_ORDER"],
-      "is_enabled": true,
+      "is_enabled": false,
       "language_code": "abc123",
       "minimum_score": 123.45,
       "theme": "xyz789",
@@ -6528,7 +6654,7 @@ 
    Response
    
   "data": {
     "route": {
       "redirect_code": 987,
-      "relative_url": "abc123",
+      "relative_url": "xyz789",
       "type": "CMS_PAGE"
     }
   }
@@ -6661,6 +6787,7 @@ 
    Query
    
     braintree_paypal_vault_active
     cart_expires_in_days
     cart_gift_wrapping
+    cart_merge_preference
     cart_printed_card
     cart_summary_display_quantity
     catalog_default_sort_by
@@ -6705,7 +6832,6 @@ 
    Query
    
     fixed_product_taxes_enable
     fixed_product_taxes_include_fpt_in_subtotal
     front
-    graphql_share_all_customer_groups
     graphql_share_customer_group
     grid_per_page
     grid_per_page_values
@@ -6783,10 +6909,8 @@ 
    Query
    
     send_friend {
       ...SendFriendConfigurationFragment
     }
-    share_all_catalog_rules
-    share_all_sales_rule
-    share_applied_catalog_rules
-    share_applied_sales_rule
+    share_active_segments
+    share_applied_cart_rule
     shopping_cart_display_full_summary
     shopping_cart_display_grand_total
     shopping_cart_display_price
@@ -6828,125 +6952,126 @@ 
    Response
    
     "storeConfig": {
       "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_items": "abc123",
-      "allow_order": "abc123",
+      "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": "abc123",
-      "base_media_url": "xyz789",
-      "base_static_url": "abc123",
+      "base_currency_code": "xyz789",
+      "base_link_url": "xyz789",
+      "base_media_url": "abc123",
+      "base_static_url": "xyz789",
       "base_url": "abc123",
       "braintree_3dsecure_allowspecific": true,
       "braintree_3dsecure_always_request_3ds": false,
       "braintree_3dsecure_specificcountry": "xyz789",
-      "braintree_3dsecure_threshold_amount": "abc123",
+      "braintree_3dsecure_threshold_amount": "xyz789",
       "braintree_3dsecure_verify_3dsecure": false,
-      "braintree_ach_direct_debit_vault_active": true,
-      "braintree_applepay_merchant_name": "xyz789",
+      "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_environment": "abc123",
-      "braintree_googlepay_btn_color": "abc123",
-      "braintree_googlepay_cctypes": "xyz789",
+      "braintree_environment": "xyz789",
+      "braintree_googlepay_btn_color": "xyz789",
+      "braintree_googlepay_cctypes": "abc123",
       "braintree_googlepay_merchant_id": "abc123",
-      "braintree_googlepay_vault_active": true,
+      "braintree_googlepay_vault_active": false,
       "braintree_local_payment_allowed_methods": "abc123",
       "braintree_local_payment_fallback_button_text": "abc123",
-      "braintree_local_payment_redirect_on_fail": "xyz789",
-      "braintree_merchant_account_id": "xyz789",
-      "braintree_paypal_button_location_cart_type_credit_color": "abc123",
+      "braintree_local_payment_redirect_on_fail": "abc123",
+      "braintree_merchant_account_id": "abc123",
+      "braintree_paypal_button_location_cart_type_credit_color": "xyz789",
       "braintree_paypal_button_location_cart_type_credit_label": "abc123",
-      "braintree_paypal_button_location_cart_type_credit_shape": "xyz789",
-      "braintree_paypal_button_location_cart_type_credit_show": true,
-      "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
+      "braintree_paypal_button_location_cart_type_credit_shape": "abc123",
+      "braintree_paypal_button_location_cart_type_credit_show": false,
+      "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789",
       "braintree_paypal_button_location_cart_type_messaging_logo": "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_show": false,
       "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
       "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
-      "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
-      "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
+      "braintree_paypal_button_location_cart_type_paylater_label": "abc123",
+      "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789",
       "braintree_paypal_button_location_cart_type_paylater_show": false,
       "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
       "braintree_paypal_button_location_cart_type_paypal_label": "abc123",
       "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
-      "braintree_paypal_button_location_cart_type_paypal_show": false,
-      "braintree_paypal_button_location_checkout_type_credit_color": "xyz789",
-      "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
-      "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
-      "braintree_paypal_button_location_checkout_type_credit_show": true,
-      "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
+      "braintree_paypal_button_location_cart_type_paypal_show": true,
+      "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
+      "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
+      "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
+      "braintree_paypal_button_location_checkout_type_credit_show": 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",
       "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": "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": "abc123",
       "braintree_paypal_button_location_checkout_type_paypal_label": "abc123",
-      "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
-      "braintree_paypal_button_location_checkout_type_paypal_show": false,
+      "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789",
+      "braintree_paypal_button_location_checkout_type_paypal_show": true,
       "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
       "braintree_paypal_button_location_productpage_type_credit_label": "abc123",
       "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789",
       "braintree_paypal_button_location_productpage_type_credit_show": true,
       "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
-      "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789",
+      "braintree_paypal_button_location_productpage_type_messaging_logo": "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_text_color": "abc123",
+      "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789",
       "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
       "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789",
       "braintree_paypal_button_location_productpage_type_paylater_show": 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": "xyz789",
       "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789",
-      "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_merchant_name_override": "xyz789",
+      "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,
-      "cart_gift_wrapping": "abc123",
+      "braintree_paypal_vault_active": false,
+      "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",
-      "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_enable_for_specific_countries": true,
+      "check_money_order_enabled": false,
+      "check_money_order_make_check_payable_to": "abc123",
+      "check_money_order_max_order_total": "xyz789",
       "check_money_order_min_order_total": "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_payment_from_specific_countries": "abc123",
+      "check_money_order_send_check_to": "xyz789",
       "check_money_order_sort_order": 987,
-      "check_money_order_title": "xyz789",
-      "cms_home_page": "abc123",
+      "check_money_order_title": "abc123",
+      "cms_home_page": "xyz789",
       "cms_no_cookies": "abc123",
-      "cms_no_route": "xyz789",
+      "cms_no_route": "abc123",
       "code": "xyz789",
       "configurable_product_image": "ITSELF",
-      "configurable_thumbnail_source": "abc123",
+      "configurable_thumbnail_source": "xyz789",
       "contact_enabled": true,
       "copyright": "abc123",
       "countries_with_required_region": "xyz789",
-      "create_account_confirmation": false,
-      "customer_access_token_lifetime": 123.45,
+      "create_account_confirmation": true,
+      "customer_access_token_lifetime": 987.65,
       "default_country": "abc123",
-      "default_description": "abc123",
+      "default_description": "xyz789",
       "default_display_currency_code": "xyz789",
       "default_keywords": "abc123",
       "default_title": "abc123",
@@ -6956,118 +7081,115 @@ 
    Response
    
       "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_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": false,
-      "front": "xyz789",
-      "graphql_share_all_customer_groups": true,
-      "graphql_share_customer_group": false,
-      "grid_per_page": 987,
+      "fixed_product_taxes_display_prices_in_sales_modules": 987,
+      "fixed_product_taxes_display_prices_on_product_view_page": 123,
+      "fixed_product_taxes_enable": false,
+      "fixed_product_taxes_include_fpt_in_subtotal": true,
+      "front": "abc123",
+      "graphql_share_customer_group": true,
+      "grid_per_page": 123,
       "grid_per_page_values": "abc123",
       "grouped_product_image": "ITSELF",
       "head_includes": "xyz789",
-      "head_shortcut_icon": "abc123",
+      "head_shortcut_icon": "xyz789",
       "header_logo_src": "abc123",
-      "id": 123,
+      "id": 987,
       "is_checkout_agreements_enabled": true,
-      "is_default_store": true,
-      "is_default_store_group": true,
+      "is_default_store": false,
+      "is_default_store_group": false,
       "is_guest_checkout_enabled": true,
       "is_negotiable_quote_active": true,
-      "is_one_page_checkout_enabled": true,
-      "is_requisition_list_active": "xyz789",
-      "list_mode": "xyz789",
-      "list_per_page": 987,
+      "is_one_page_checkout_enabled": false,
+      "is_requisition_list_active": "abc123",
+      "list_mode": "abc123",
+      "list_per_page": 123,
       "list_per_page_values": "xyz789",
       "locale": "xyz789",
-      "logo_alt": "abc123",
-      "logo_height": 987,
-      "logo_width": 987,
+      "logo_alt": "xyz789",
+      "logo_height": 123,
+      "logo_width": 123,
       "magento_reward_general_is_enabled": "xyz789",
-      "magento_reward_general_is_enabled_on_front": "abc123",
+      "magento_reward_general_is_enabled_on_front": "xyz789",
       "magento_reward_general_min_points_balance": "xyz789",
-      "magento_reward_general_publish_history": "abc123",
-      "magento_reward_points_invitation_customer": "abc123",
-      "magento_reward_points_invitation_customer_limit": "abc123",
-      "magento_reward_points_invitation_order": "xyz789",
-      "magento_reward_points_invitation_order_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": "abc123",
+      "magento_reward_points_invitation_order_limit": "xyz789",
       "magento_reward_points_newsletter": "abc123",
       "magento_reward_points_order": "xyz789",
-      "magento_reward_points_register": "abc123",
+      "magento_reward_points_register": "xyz789",
       "magento_reward_points_review": "xyz789",
-      "magento_reward_points_review_limit": "abc123",
+      "magento_reward_points_review_limit": "xyz789",
       "magento_wishlist_general_is_enabled": "abc123",
       "max_items_in_order_summary": 123,
-      "maximum_number_of_wishlists": "abc123",
-      "minicart_display": true,
-      "minicart_max_items": 987,
-      "minimum_password_length": "xyz789",
+      "maximum_number_of_wishlists": "xyz789",
+      "minicart_display": false,
+      "minicart_max_items": 123,
+      "minimum_password_length": "abc123",
       "newsletter_enabled": false,
       "no_route": "abc123",
-      "optional_zip_countries": "xyz789",
+      "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": 987,
+      "orders_invoices_credit_memos_display_grandtotal": true,
+      "orders_invoices_credit_memos_display_price": 123,
       "orders_invoices_credit_memos_display_shipping_amount": 123,
-      "orders_invoices_credit_memos_display_subtotal": 123,
+      "orders_invoices_credit_memos_display_subtotal": 987,
       "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_reviews_enabled": "xyz789",
       "product_url_suffix": "abc123",
-      "quickorder_active": true,
-      "required_character_classes_number": "abc123",
-      "returns_enabled": "abc123",
-      "root_category_id": 987,
-      "root_category_uid": 4,
+      "quickorder_active": false,
+      "required_character_classes_number": "xyz789",
+      "returns_enabled": "xyz789",
+      "root_category_id": 123,
+      "root_category_uid": "4",
       "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-      "sales_gift_wrapping": "xyz789",
-      "sales_printed_card": "xyz789",
-      "secure_base_link_url": "abc123",
-      "secure_base_media_url": "abc123",
-      "secure_base_static_url": "abc123",
-      "secure_base_url": "abc123",
+      "sales_gift_wrapping": "abc123",
+      "sales_printed_card": "abc123",
+      "secure_base_link_url": "xyz789",
+      "secure_base_media_url": "xyz789",
+      "secure_base_static_url": "xyz789",
+      "secure_base_url": "xyz789",
       "send_friend": SendFriendConfiguration,
-      "share_all_catalog_rules": false,
-      "share_all_sales_rule": false,
-      "share_applied_catalog_rules": true,
-      "share_applied_sales_rule": false,
+      "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": 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": 987,
-      "store_code": "4",
+      "store_code": 4,
       "store_group_code": 4,
-      "store_group_name": "abc123",
+      "store_group_name": "xyz789",
       "store_name": "xyz789",
       "store_sort_order": 987,
       "timezone": "xyz789",
       "title_prefix": "abc123",
-      "title_separator": "abc123",
-      "title_suffix": "abc123",
-      "use_store_in_url": true,
+      "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": "abc123",
       "welcome": "abc123",
-      "zero_subtotal_enable_for_specific_countries": false,
-      "zero_subtotal_enabled": true,
-      "zero_subtotal_new_order_status": "xyz789",
-      "zero_subtotal_payment_action": "abc123",
+      "zero_subtotal_enable_for_specific_countries": true,
+      "zero_subtotal_enabled": false,
+      "zero_subtotal_new_order_status": "abc123",
+      "zero_subtotal_payment_action": "xyz789",
       "zero_subtotal_payment_from_specific_countries": "abc123",
-      "zero_subtotal_sort_order": 123,
+      "zero_subtotal_sort_order": 987,
       "zero_subtotal_title": "abc123"
     }
   }
@@ -7145,7 +7267,7 @@ 
    Query
    Variables
    - 
    {"url": "xyz789"}
+                  
    {"url": "abc123"}
    @@ -7153,10 +7275,10 @@
    Response
    {
   "data": {
     "urlResolver": {
-      "canonical_url": "xyz789",
-      "entity_uid": "4",
-      "id": 123,
-      "redirectCode": 987,
+      "canonical_url": "abc123",
+      "entity_uid": 4,
+      "id": 987,
+      "redirectCode": 123,
       "relative_url": "xyz789",
       "type": "CMS_PAGE"
     }
@@ -7221,9 +7343,9 @@ 
    Response
    
   "data": {
     "wishlist": {
       "items": [WishlistItem],
-      "items_count": 987,
-      "name": "abc123",
-      "sharing_code": "xyz789",
+      "items_count": 123,
+      "name": "xyz789",
+      "sharing_code": "abc123",
       "updated_at": "abc123"
     }
   }
@@ -7402,9 +7524,9 @@ 
    Response
    
       "is_min_max_qty_used": true,
       "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,
       "reference_document_links": [
@@ -7413,9 +7535,9 @@ 
    Response
    
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "abc123",
+      "status": "xyz789",
       "template_id": 4,
-      "total_quantity": 123.45
+      "total_quantity": 987.65
     }
   }
 }
@@ -7710,7 +7832,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "giftRegistryUid": 4,
+  "giftRegistryUid": "4",
   "registrants": [AddGiftRegistryRegistrantInput]
 }
 
    
@@ -7803,7 +7925,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "cartId": "abc123",
+  "cartId": "xyz789",
   "cartItems": [CartItemInput]
 }
 
    
@@ -7895,9 +8017,88 @@ 
    Response
    
   "data": {
     "addProductsToCompareList": {
       "attributes": [ComparableAttribute],
-      "item_count": 987,
+      "item_count": 123,
       "items": [ComparableItem],
-      "uid": 4
+      "uid": "4"
+    }
+  }
+}
+
    +
    + + back to top + +
    +
    +
    + Mutations +
    +

    + addProductsToNewCart +

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns an AddProductsToNewCartOutput +

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

    Example

    +
    +
    Query
    + 
    mutation addProductsToNewCart($cartItems: [CartItemInput!]!) {
+  addProductsToNewCart(cartItems: $cartItems) {
+    cart {
+      ...CartFragment
+    }
+    user_errors {
+      ...CartUserInputErrorFragment
+    }
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"cartItems": [CartItemInput]}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "addProductsToNewCart": {
+      "cart": Cart,
+      "user_errors": [CartUserInputError]
     }
   }
 }
@@ -7977,7 +8178,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "requisitionListUid": 4,
+  "requisitionListUid": "4",
   "requisitionListItems": [RequisitionListItemsInput]
 }
 
    
@@ -8069,7 +8270,10 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"wishlistId": 4, "wishlistItems": [WishlistItemInput]}
+                  
    {
+  "wishlistId": "4",
+  "wishlistItems": [WishlistItemInput]
+}
 
    
                 
    
                 
    
@@ -8329,7 +8533,7 @@ 
    Response
    
         AddRequisitionListItemToCartUserError
       ],
       "cart": Cart,
-      "status": true
+      "status": false
     }
   }
 }
@@ -8698,7 +8902,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"wishlistId": "4", "wishlistItemIds": [4]}
+                  
    {"wishlistId": 4, "wishlistItemIds": [4]}
 
    
                 
    
                 
    
@@ -9213,7 +9417,7 @@ 
    Response
    
   "data": {
     "assignCompareListToCustomer": {
       "compare_list": CompareList,
-      "result": true
+      "result": false
     }
   }
 }
@@ -9317,7 +9521,7 @@ 
    Query
    
     }
     printed_card_included
     rules {
-      ...CartRuleFragment
+      ...CartRuleStorefrontFragment
     }
     selected_payment_method {
       ...SelectedPaymentMethodFragment
@@ -9332,7 +9536,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}
 
    
                 
    
                 
    
@@ -9350,20 +9554,20 @@ 
    Response
    
         AvailablePaymentMethod
       ],
       "billing_address": BillingCartAddress,
-      "email": "abc123",
+      "email": "xyz789",
       "gift_message": GiftMessage,
       "gift_receipt_included": false,
       "gift_wrapping": GiftWrapping,
       "id": "4",
-      "is_virtual": false,
+      "is_virtual": true,
       "items": [CartItemInterface],
       "itemsV2": CartItems,
       "prices": CartPrices,
-      "printed_card_included": false,
-      "rules": [CartRule],
+      "printed_card_included": true,
+      "rules": [CartRuleStorefront],
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
-      "total_quantity": 987.65
+      "total_quantity": 123.45
     }
   }
 }
@@ -9470,13 +9674,13 @@ 
    Response
    
     "cancelNegotiableQuoteTemplate": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "xyz789",
+      "expiration_date": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
-      "is_min_max_qty_used": false,
+      "is_min_max_qty_used": true,
       "is_virtual": 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,
@@ -9568,7 +9772,7 @@ 
    Response
    
                   
    {
   "data": {
     "cancelOrder": {
-      "error": "xyz789",
+      "error": "abc123",
       "errorV2": CancelOrderError,
       "order": CustomerOrder
     }
@@ -9752,7 +9956,7 @@ 
    Query
    
       ...GiftRegistryFragment
     }
     group {
-      ...CustomerGroupFragment
+      ...CustomerGroupStorefrontFragment
     }
     group_id
     id
@@ -9799,7 +10003,7 @@ 
    Query
    
       ...CompanyRoleFragment
     }
     segments {
-      ...CustomerSegmentFragment
+      ...CustomerSegmentStorefrontFragment
     }
     status
     store_credit {
@@ -9829,7 +10033,7 @@ 
    Query
    
                   
    Variables
    
                   
    {
   "currentPassword": "abc123",
-  "newPassword": "xyz789"
+  "newPassword": "abc123"
 }
 
    
                 
    
@@ -9840,28 +10044,28 @@ 
    Response
    
     "changeCustomerPassword": {
       "addresses": [CustomerAddress],
       "addressesV2": CustomerAddresses,
-      "allow_remote_shopping_assistance": false,
+      "allow_remote_shopping_assistance": true,
       "companies": UserCompaniesOutput,
       "compare_list": CompareList,
       "confirmation_status": "ACCOUNT_CONFIRMED",
       "created_at": "xyz789",
       "custom_attributes": [AttributeValueInterface],
       "date_of_birth": "abc123",
-      "default_billing": "abc123",
-      "default_shipping": "abc123",
-      "dob": "xyz789",
-      "email": "abc123",
-      "firstname": "abc123",
+      "default_billing": "xyz789",
+      "default_shipping": "xyz789",
+      "dob": "abc123",
+      "email": "xyz789",
+      "firstname": "xyz789",
       "gender": 123,
       "gift_registries": [GiftRegistry],
       "gift_registry": GiftRegistry,
-      "group": CustomerGroup,
-      "group_id": 123,
-      "id": 987,
+      "group": CustomerGroupStorefront,
+      "group_id": 987,
+      "id": "4",
       "is_subscribed": true,
-      "job_title": "xyz789",
-      "lastname": "xyz789",
-      "middlename": "abc123",
+      "job_title": "abc123",
+      "lastname": "abc123",
+      "middlename": "xyz789",
       "orders": CustomerOrders,
       "prefix": "abc123",
       "purchase_order": PurchaseOrder,
@@ -9876,10 +10080,10 @@ 
    Response
    
       "reviews": ProductReviews,
       "reward_points": RewardPoints,
       "role": CompanyRole,
-      "segments": [CustomerSegment],
+      "segments": [CustomerSegmentStorefront],
       "status": "ACTIVE",
       "store_credit": CustomerStoreCredit,
-      "structure_id": "4",
+      "structure_id": 4,
       "suffix": "xyz789",
       "taxvat": "abc123",
       "team": CompanyTeam,
@@ -10033,14 +10237,93 @@ 
    Query
    Variables
    - 
    {"cartUid": "xyz789"}
+                  
    {"cartUid": "abc123"}
    Response
    {
   "data": {
-    "clearCustomerCart": {"cart": Cart, "status": false}
+    "clearCustomerCart": {"cart": Cart, "status": true}
+  }
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Mutations +
    +

    + clearWishlist +

    +
    +
    +
    +
    Description
    +

    Remove all the products from the specified wish list.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a RemoveProductsFromWishlistOutput +

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

    Example

    +
    +
    Query
    + 
    mutation clearWishlist($wishlistId: ID!) {
+  clearWishlist(wishlistId: $wishlistId) {
+    user_errors {
+      ...WishListUserInputErrorFragment
+    }
+    wishlist {
+      ...WishlistFragment
+    }
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"wishlistId": "4"}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "clearWishlist": {
+      "user_errors": [WishListUserInputError],
+      "wishlist": Wishlist
+    }
   }
 }
    @@ -10135,6 +10418,89 @@
    Response
    } } } +     +
    +
    + back to top +
    +
    +
    +
    + Mutations +
    +

    + completeOrder +

    +
    +
    +
    +
    Description
    +

    Synchronizes order details and place the order

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a PlaceOrderOutput +

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

    Example

    +
    +
    Query
    + 
    mutation completeOrder($input: CompleteOrderInput) {
+  completeOrder(input: $input) {
+    errors {
+      ...PlaceOrderErrorFragment
+    }
+    order {
+      ...OrderFragment
+    }
+    orderV2 {
+      ...CustomerOrderFragment
+    }
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"input": CompleteOrderInput}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "completeOrder": {
+      "errors": [PlaceOrderError],
+      "order": Order,
+      "orderV2": CustomerOrder
+    }
+  }
+}
    @@ -10211,7 +10577,7 @@
    Response
    {
   "data": {
     "confirmCancelOrder": {
-      "error": "xyz789",
+      "error": "abc123",
       "errorV2": CancelOrderError,
       "order": CustomerOrder
     }
@@ -10517,7 +10883,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "sourceRequisitionListUid": 4,
+  "sourceRequisitionListUid": "4",
   "destinationRequisitionListUid": "4",
   "requisitionListItem": CopyItemsBetweenRequisitionListsInput
 }
@@ -10622,8 +10988,8 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "sourceWishlistUid": 4,
-  "destinationWishlistUid": "4",
+  "sourceWishlistUid": "4",
+  "destinationWishlistUid": 4,
   "wishlistItems": [WishlistItemCopyInput]
 }
 
    
@@ -10681,7 +11047,7 @@ 
    Query
    
                   
    Response
    
                   
    {
   "data": {
-    "createBraintreeClientToken": "xyz789"
+    "createBraintreeClientToken": "abc123"
   }
 }
 
    
@@ -11157,7 +11523,7 @@ 
    Response
    
   "data": {
     "createCompareList": {
       "attributes": [ComparableAttribute],
-      "item_count": 987,
+      "item_count": 123,
       "items": [ComparableItem],
       "uid": 4
     }
@@ -11316,6 +11682,7 @@ 
    Query
    
     street
     suffix
     telephone
+    uid
     vat_id
   }
 }
@@ -11332,27 +11699,28 @@ 
    Response
    
   "data": {
     "createCustomerAddress": {
       "city": "xyz789",
-      "company": "abc123",
+      "company": "xyz789",
       "country_code": "AF",
       "country_id": "abc123",
       "custom_attributes": [CustomerAddressAttribute],
       "custom_attributesV2": [AttributeValueInterface],
       "customer_id": 987,
-      "default_billing": false,
-      "default_shipping": false,
+      "default_billing": true,
+      "default_shipping": true,
       "extension_attributes": [CustomerAddressAttribute],
       "fax": "xyz789",
-      "firstname": "xyz789",
-      "id": 123,
-      "lastname": "xyz789",
+      "firstname": "abc123",
+      "id": 987,
+      "lastname": "abc123",
       "middlename": "xyz789",
-      "postcode": "abc123",
+      "postcode": "xyz789",
       "prefix": "abc123",
       "region": CustomerAddressRegion,
-      "region_id": 123,
+      "region_id": 987,
       "street": ["xyz789"],
       "suffix": "xyz789",
-      "telephone": "abc123",
+      "telephone": "xyz789",
+      "uid": 4,
       "vat_id": "xyz789"
     }
   }
@@ -11714,11 +12082,11 @@ 
    Response
    
                   
    {
   "data": {
     "createPayflowProToken": {
-      "response_message": "xyz789",
+      "response_message": "abc123",
       "result": 987,
-      "result_code": 123,
-      "secure_token": "xyz789",
-      "secure_token_id": "abc123"
+      "result_code": 987,
+      "secure_token": "abc123",
+      "secure_token_id": "xyz789"
     }
   }
 }
@@ -11795,11 +12163,11 @@ 
    Response
    
                   
    {
   "data": {
     "createPaymentOrder": {
-      "amount": 987.65,
+      "amount": 123.45,
       "currency_code": "xyz789",
-      "id": "abc123",
-      "mp_order_id": "abc123",
-      "status": "xyz789"
+      "id": "xyz789",
+      "mp_order_id": "xyz789",
+      "status": "abc123"
     }
   }
 }
@@ -12041,10 +12409,10 @@ 
    Response
    
       "applies_to_roles": [CompanyRole],
       "approver_roles": [CompanyRole],
       "condition": PurchaseOrderApprovalRuleConditionInterface,
-      "created_at": "xyz789",
+      "created_at": "abc123",
       "created_by": "xyz789",
-      "description": "xyz789",
-      "name": "xyz789",
+      "description": "abc123",
+      "name": "abc123",
       "status": "ENABLED",
       "uid": "4",
       "updated_at": "xyz789"
@@ -12200,7 +12568,7 @@ 
    Response
    
   "data": {
     "createVaultCardPaymentToken": {
       "payment_source": PaymentSourceOutput,
-      "vault_token_id": "xyz789"
+      "vault_token_id": "abc123"
     }
   }
 }
@@ -12273,7 +12641,7 @@ 
    Response
    
                   
    {
   "data": {
     "createVaultCardSetupToken": {
-      "setup_token": "abc123"
+      "setup_token": "xyz789"
     }
   }
 }
@@ -12408,7 +12776,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"id": "4"}
+                  
    {"id": 4}
 
    
                 
    
                 
    
@@ -12467,8 +12835,151 @@ 
    Arguments
    
                 
    Example
    
                 
    
                   
    Query
    
-                  
    mutation deleteCompanyTeam($id: ID!) {
-  deleteCompanyTeam(id: $id) {
+                  
    mutation deleteCompanyTeam($id: ID!) {
+  deleteCompanyTeam(id: $id) {
+    success
+  }
+}
+
    
+                
    
+                
    
+                  
    Variables
    
+                  
    {"id": 4}
+
    
+                
    
+                
    
+                  
    Response
    
+                  
    {"data": {"deleteCompanyTeam": {"success": false}}}
+
    
+                
    
+              
    
+              back to top
+            
    
+
    +
    +
    + Mutations +
    +

    + deleteCompanyUser +

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

    Delete the specified company user.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a DeleteCompanyUserOutput +

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

    Example

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

    + deleteCompanyUserV2 +

    +
    +
    +
    +
    Description
    +

    Delete the specified company user.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a DeleteCompanyUserOutput +

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

    Example

    +
    +
    Query
    + 
    mutation deleteCompanyUserV2($id: ID!) {
+  deleteCompanyUserV2(id: $id) {
     success
   }
 }
@@ -12481,32 +12992,25 @@ 
    Variables
    Response
    - 
    {"data": {"deleteCompanyTeam": {"success": true}}}
+                  
    {"data": {"deleteCompanyUserV2": {"success": true}}}
    back to top
    -
    +
    Mutations
    -

    - deleteCompanyUser +

    + deleteCompareList

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

    Delete the specified company user.

    +

    Delete the specified compare list.

    @@ -12514,7 +13018,7 @@
    Description
    Response
    -

    Returns a DeleteCompanyUserOutput +

    Returns a DeleteCompareListOutput

    @@ -12529,10 +13033,9 @@
    Arguments
    - id - ID! - - + uid - ID! + The unique ID of the compare list to be deleted. @@ -12542,39 +13045,39 @@
    Arguments

    Example

    Query
    - 
    mutation deleteCompanyUser($id: ID!) {
-  deleteCompanyUser(id: $id) {
-    success
+                  
    mutation deleteCompareList($uid: ID!) {
+  deleteCompareList(uid: $uid) {
+    result
   }
 }
    Variables
    - 
    {"id": "4"}
+                  
    {"uid": "4"}
    Response
    - 
    {"data": {"deleteCompanyUser": {"success": false}}}
+                  
    {"data": {"deleteCompareList": {"result": true}}}
    back to top
    -
    +
    Mutations

    - deleteCompanyUserV2 + deleteCustomer

    Description
    -

    Delete the specified company user.

    +

    Delete customer account

    @@ -12582,67 +13085,47 @@
    Description
    Response
    -

    Returns a DeleteCompanyUserOutput +

    Returns a Boolean

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

    Example

    Query
    - 
    mutation deleteCompanyUserV2($id: ID!) {
-  deleteCompanyUserV2(id: $id) {
-    success
-  }
+                  
    mutation deleteCustomer {
+  deleteCustomer
 }
-
    
-
    -
    -
    Variables
    - 
    {"id": 4}
    Response
    - 
    {"data": {"deleteCompanyUserV2": {"success": true}}}
+                  
    {"data": {"deleteCustomer": true}}
    back to top
    -
    +
    Mutations
    -

    - deleteCompareList +

    + deleteCustomerAddress

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

    Delete the specified compare list.

    +

    Delete the billing or shipping address of a customer.

    @@ -12650,7 +13133,7 @@
    Description
    Response
    -

    Returns a DeleteCompareListOutput +

    Returns a Boolean

    @@ -12665,9 +13148,9 @@
    Arguments
    - uid - ID! + id - Int! - The unique ID of the compare list to be deleted. + The ID of the customer address to be deleted. @@ -12677,74 +13160,31 @@
    Arguments

    Example

    Query
    - 
    mutation deleteCompareList($uid: ID!) {
-  deleteCompareList(uid: $uid) {
-    result
-  }
+                  
    mutation deleteCustomerAddress($id: Int!) {
+  deleteCustomerAddress(id: $id)
 }
    Variables
    - 
    {"uid": 4}
-
    -
    -
    -
    Response
    - 
    {"data": {"deleteCompareList": {"result": false}}}
-
    -
    -
    - back to top -
    -
    -
    -
    - Mutations -
    -

    - deleteCustomer -

    -
    -
    -
    -
    Description
    -

    Delete customer account

    -
    -
    -
    -
    -
    -
    -
    Response
    -

    Returns a Boolean -

    -
    -
    -
    -

    Example

    -
    -
    Query
    - 
    mutation deleteCustomer {
-  deleteCustomer
-}
+                  
    {"id": 123}
    Response
    - 
    {"data": {"deleteCustomer": true}}
+                  
    {"data": {"deleteCustomerAddress": true}}
    back to top
    -
    +
    Mutations

    - deleteCustomerAddress + deleteCustomerAddressV2

    @@ -12773,9 +13213,9 @@
    Arguments
    - id - Int! + uid - ID! - The ID of the customer address to be deleted. + The unique ID of the customer address to be deleted. @@ -12785,19 +13225,19 @@
    Arguments

    Example

    Query
    - 
    mutation deleteCustomerAddress($id: Int!) {
-  deleteCustomerAddress(id: $id)
+                  
    mutation deleteCustomerAddressV2($uid: ID!) {
+  deleteCustomerAddressV2(uid: $uid)
 }
    Variables
    - 
    {"id": 123}
+                  
    {"uid": "4"}
    Response
    - 
    {"data": {"deleteCustomerAddress": false}}
+                  
    {"data": {"deleteCustomerAddressV2": true}}
    @@ -13177,7 +13617,7 @@
    Response
    "data": { "deleteRequisitionList": { "requisition_lists": RequisitionLists, - "status": true + "status": false } } } @@ -13257,7 +13697,7 @@
    Query
    Variables
    {
-  "requisitionListUid": 4,
+  "requisitionListUid": "4",
   "requisitionListItemUids": ["4"]
 }
    @@ -13512,7 +13952,7 @@
    Response
    "available": false, "base_amount": Money, "carrier_code": "xyz789", - "carrier_title": "abc123", + "carrier_title": "xyz789", "error_message": "xyz789", "method_code": "abc123", "method_title": "xyz789", @@ -13591,6 +14031,83 @@
    Variables
    Response
    {"data": {"estimateTotals": {"cart": Cart}}}
+
    +
    +
    + back to top +
    +
    +
    +
    + Mutations +
    +

    + exchangeExternalCustomerToken +

    +
    +
    +
    +
    Description
    +

    Generate a token for specified customer.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns an ExchangeExternalCustomerTokenOutput +

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

    Example

    +
    +
    Query
    + 
    mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInput) {
+  exchangeExternalCustomerToken(input: $input) {
+    customer {
+      ...CustomerFragment
+    }
+    token
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"input": ExchangeExternalCustomerTokenInput}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "exchangeExternalCustomerToken": {
+      "customer": Customer,
+      "token": "xyz789"
+    }
+  }
+}
    @@ -13665,8 +14182,8 @@
    Query
    Variables
    {
-  "email": "xyz789",
-  "password": "abc123"
+  "email": "abc123",
+  "password": "xyz789"
 }
    @@ -13675,7 +14192,7 @@
    Response
    {
   "data": {
     "generateCustomerToken": {
-      "token": "abc123"
+      "token": "xyz789"
     }
   }
 }
@@ -13818,7 +14335,13 @@ 
    Variables
    Response
    - 
    {"data": {"generateNegotiableQuoteFromTemplate": {"negotiable_quote_uid": 4}}}
+                  
    {
+  "data": {
+    "generateNegotiableQuoteFromTemplate": {
+      "negotiable_quote_uid": "4"
+    }
+  }
+}
    @@ -13999,7 +14522,7 @@
    Query
    } printed_card_included rules { - ...CartRuleFragment + ...CartRuleStorefrontFragment } selected_payment_method { ...SelectedPaymentMethodFragment @@ -14015,7 +14538,7 @@
    Query
    Variables
    {
-  "source_cart_id": "abc123",
+  "source_cart_id": "xyz789",
   "destination_cart_id": "abc123"
 }
    @@ -14035,17 +14558,17 @@
    Response
    AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": "4", - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, - "rules": [CartRule], + "printed_card_included": true, + "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], "total_quantity": 123.45 @@ -14131,7 +14654,7 @@
    Query
    Variables
    - 
    {"cartUid": "4", "giftRegistryUid": 4}
+                  
    {"cartUid": 4, "giftRegistryUid": 4}
    @@ -14140,7 +14663,7 @@
    Response
    "data": { "moveCartItemsToGiftRegistry": { "gift_registry": GiftRegistry, - "status": true, + "status": false, "user_errors": [GiftRegistryItemsUserError] } } @@ -14233,7 +14756,7 @@
    Query
    Variables
    {
   "sourceRequisitionListUid": 4,
-  "destinationRequisitionListUid": "4",
+  "destinationRequisitionListUid": 4,
   "requisitionListItem": MoveItemsBetweenRequisitionListsInput
 }
    @@ -14533,14 +15056,14 @@
    Response
    "openNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 987, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -14549,7 +15072,7 @@
    Response
    "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": 4, "total_quantity": 123.45 } @@ -14931,8 +15454,8 @@
    Response
    "data": { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, - "code": "xyz789", - "expiration_date": "abc123" + "code": "abc123", + "expiration_date": "xyz789" } } } @@ -15289,7 +15812,7 @@
    Variables
    Response
    - 
    {"data": {"removeGiftRegistry": {"success": true}}}
+                  
    {"data": {"removeGiftRegistry": {"success": false}}}
    @@ -15365,7 +15888,7 @@
    Query
    Variables
    - 
    {"giftRegistryUid": 4, "itemsUid": ["4"]}
+                  
    {"giftRegistryUid": 4, "itemsUid": [4]}
    @@ -15452,7 +15975,10 @@
    Query
    Variables
    - 
    {"giftRegistryUid": 4, "registrantsUid": [4]}
+                  
    {
+  "giftRegistryUid": "4",
+  "registrantsUid": ["4"]
+}
    @@ -15716,8 +16242,8 @@
    Response
    "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 987, + "max_order_commitment": 123, + "min_order_commitment": 123, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -15729,7 +16255,7 @@
    Response
    ], "status": "xyz789", "template_id": 4, - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -15810,9 +16336,9 @@
    Response
    "data": { "removeProductsFromCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -16255,7 +16781,7 @@
    Query
    Variables
    - 
    {"orderNumber": "xyz789"}
+                  
    {"orderNumber": "abc123"}
    @@ -16344,7 +16870,7 @@
    Response
    {
   "data": {
     "requestGuestOrderCancel": {
-      "error": "xyz789",
+      "error": "abc123",
       "errorV2": CancelOrderError,
       "order": CustomerOrder
     }
@@ -16615,7 +17141,7 @@ 
    Response
    
       ],
       "status": "xyz789",
       "template_id": 4,
-      "total_quantity": 123.45
+      "total_quantity": 987.65
     }
   }
 }
@@ -16678,7 +17204,7 @@ 
    Query
    Variables
    - 
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
    @@ -16908,15 +17434,15 @@
    Query
    Variables
    {
-  "email": "abc123",
+  "email": "xyz789",
   "resetPasswordToken": "xyz789",
-  "newPassword": "xyz789"
+  "newPassword": "abc123"
 }
    Response
    - 
    {"data": {"resetPassword": false}}
+                  
    {"data": {"resetPassword": true}}
    @@ -16959,7 +17485,7 @@
    Query
    Response
    - 
    {"data": {"revokeCustomerToken": {"result": true}}}
+                  
    {"data": {"revokeCustomerToken": {"result": false}}}
    @@ -17183,6 +17709,81 @@
    Variables
    Response
    {"data": {"setBillingAddressOnCart": {"cart": Cart}}}
+
    +
    + + back to top + +
    +
    +
    + Mutations +
    +

    + setCartAsInactive +

    +
    +
    +
    +
    Description
    +

    Sets the cart as inactive

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a SetCartAsInactiveOutput +

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

    Example

    +
    +
    Query
    + 
    mutation setCartAsInactive($cartId: String!) {
+  setCartAsInactive(cartId: $cartId) {
+    error
+    success
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"cartId": "xyz789"}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "setCartAsInactive": {
+      "error": "xyz789",
+      "success": false
+    }
+  }
+}
    @@ -17799,8 +18400,8 @@
    Response
    "is_virtual": false, "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": [ @@ -17809,9 +18410,9 @@
    Response
    "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": "4", - "total_quantity": 123.45 + "status": "xyz789", + "template_id": 4, + "total_quantity": 987.65 } } } @@ -18078,10 +18679,10 @@
    Response
    "setQuoteTemplateLineItemNote": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "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, @@ -18094,7 +18695,7 @@
    Response
    "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": 4, "total_quantity": 987.65 } @@ -18328,7 +18929,7 @@
    Variables
    Response
    - 
    {"data": {"shareGiftRegistry": {"is_shared": false}}}
+                  
    {"data": {"shareGiftRegistry": {"is_shared": true}}}
    @@ -18432,13 +19033,13 @@
    Response
    "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": 987, + "max_order_commitment": 123, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -18515,7 +19116,7 @@
    Query
    Variables
    - 
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
    @@ -18585,72 +19186,7 @@
    Variables
    Response
    - 
    {"data": {"syncPaymentOrder": false}}
-
    -
    - - back to top - -
    -
    -
    - Mutations -
    -

    - trackViewedProduct -

    -
    -
    -
    -
    Description
    -

    Track that a product was viewed in adobe commerce

    -
    -
    -
    -
    -
    -
    -
    Response
    -

    Returns a Boolean -

    -
    -
    -
    Arguments
    - - - - - - - - - - - - - -
    NameDescription
    - sku - String! - The sku for a ProductInterface object.
    -
    -
    -
    -

    Example

    -
    -
    Query
    - 
    mutation trackViewedProduct($sku: String!) {
-  trackViewedProduct(sku: $sku)
-}
-
    -
    -
    -
    Variables
    - 
    {"sku": "xyz789"}
-
    -
    -
    -
    Response
    - 
    {"data": {"trackViewedProduct": true}}
+                  
    {"data": {"syncPaymentOrder": true}}
    @@ -19158,9 +19694,16 @@
    Response
    Mutations
    -

    +

    updateCustomerAddress

    +
    +
    +
    +
    Use updateCustomerAddressV2 instead.
    +
    +
    +
    @@ -19244,6 +19787,7 @@
    Query
    street suffix telephone + uid vat_id } } @@ -19266,22 +19810,162 @@
    Response
    "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", + "fax": "abc123", "firstname": "xyz789", "id": 987, + "lastname": "xyz789", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "xyz789", + "region": CustomerAddressRegion, + "region_id": 123, + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "xyz789", + "uid": 4, + "vat_id": "xyz789" + } + } +} +     +
    +
    + back to top +
    +
    +
    +
    + Mutations +
    +

    + updateCustomerAddressV2 +

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a CustomerAddress +

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

    Example

    +
    +
    Query
    + 
    mutation updateCustomerAddressV2(
+  $uid: ID!,
+  $input: CustomerAddressInput
+) {
+  updateCustomerAddressV2(
+    uid: $uid,
+    input: $input
+  ) {
+    city
+    company
+    country_code
+    country_id
+    custom_attributes {
+      ...CustomerAddressAttributeFragment
+    }
+    custom_attributesV2 {
+      ...AttributeValueInterfaceFragment
+    }
+    customer_id
+    default_billing
+    default_shipping
+    extension_attributes {
+      ...CustomerAddressAttributeFragment
+    }
+    fax
+    firstname
+    id
+    lastname
+    middlename
+    postcode
+    prefix
+    region {
+      ...CustomerAddressRegionFragment
+    }
+    region_id
+    street
+    suffix
+    telephone
+    uid
+    vat_id
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"uid": 4, "input": CustomerAddressInput}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "updateCustomerAddressV2": {
+      "city": "xyz789",
+      "company": "abc123",
+      "country_code": "AF",
+      "country_id": "abc123",
+      "custom_attributes": [CustomerAddressAttribute],
+      "custom_attributesV2": [AttributeValueInterface],
+      "customer_id": 987,
+      "default_billing": false,
+      "default_shipping": false,
+      "extension_attributes": [CustomerAddressAttribute],
+      "fax": "abc123",
+      "firstname": "abc123",
+      "id": 123,
       "lastname": "abc123",
       "middlename": "xyz789",
       "postcode": "xyz789",
-      "prefix": "abc123",
+      "prefix": "xyz789",
       "region": CustomerAddressRegion,
       "region_id": 123,
-      "street": ["xyz789"],
-      "suffix": "xyz789",
-      "telephone": "abc123",
-      "vat_id": "xyz789"
+      "street": ["abc123"],
+      "suffix": "abc123",
+      "telephone": "xyz789",
+      "uid": "4",
+      "vat_id": "abc123"
     }
   }
 }
@@ -19361,7 +20045,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "email": "xyz789",
+  "email": "abc123",
   "password": "abc123"
 }
 
    
@@ -19514,7 +20198,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "giftRegistryUid": "4",
+  "giftRegistryUid": 4,
   "giftRegistry": UpdateGiftRegistryInput
 }
 
    
@@ -19602,7 +20286,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "giftRegistryUid": 4,
+  "giftRegistryUid": "4",
   "items": [UpdateGiftRegistryItemInput]
 }
 
    
@@ -20038,9 +20722,9 @@ 
    Response
    
       "applies_to_roles": [CompanyRole],
       "approver_roles": [CompanyRole],
       "condition": PurchaseOrderApprovalRuleConditionInterface,
-      "created_at": "abc123",
-      "created_by": "xyz789",
-      "description": "abc123",
+      "created_at": "xyz789",
+      "created_by": "abc123",
+      "description": "xyz789",
       "name": "abc123",
       "status": "ENABLED",
       "uid": "4",
@@ -20125,7 +20809,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "requisitionListUid": "4",
+  "requisitionListUid": 4,
   "input": UpdateRequisitionListInput
 }
 
    
@@ -20315,8 +20999,8 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "wishlistId": "4",
-  "name": "xyz789",
+  "wishlistId": 4,
+  "name": "abc123",
   "visibility": "PUBLIC"
 }
 
    
@@ -20450,7 +21134,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"template_id": "4"}
+                  
    {"template_id": 4}
 
    
                 
    
               
    
@@ -20779,8 +21463,8 @@ 
    Example
    
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
-  "email": "xyz789",
-  "firstname": "xyz789",
+  "email": "abc123",
+  "firstname": "abc123",
   "lastname": "xyz789"
 }
    @@ -20917,7 +21601,55 @@
    Fields
    Example
    - 
    {"products": [4], "uid": "4"}
+                  
    {"products": ["4"], "uid": 4}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    AddProductsToNewCartOutput

    +
    +
    +
    +
    Description
    +

    Contains details about the cart after adding products to it.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    cart - Cart + The cart after products have been added.
    user_errors - [CartUserInputError] + Contains errors encountered while adding an item to the cart.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "cart": Cart,
+  "user_errors": [CartUserInputError]
+}
    @@ -21053,7 +21785,7 @@
    Fields
    Example
    {
-  "comment": "abc123",
+  "comment": "xyz789",
   "purchase_order_uid": "4"
 }
    @@ -21149,9 +21881,9 @@
    Fields
    Example
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "purchase_order_uid": 4,
-  "replace_existing_cart_items": false
+  "replace_existing_cart_items": true
 }
    @@ -21362,10 +22094,7 @@
    Fields
    Example
    - 
    {
-  "comment_text": "abc123",
-  "return_uid": "4"
-}
+                  
    {"comment_text": "xyz789", "return_uid": 4}
    @@ -21460,8 +22189,8 @@
    Fields
    Example
    {
   "carrier_uid": "4",
-  "return_uid": "4",
-  "tracking_number": "xyz789"
+  "return_uid": 4,
+  "tracking_number": "abc123"
 }
    @@ -21558,7 +22287,7 @@
    Fields
    Example
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "cart_items": [SimpleProductCartItemInput]
 }
    @@ -21648,7 +22377,7 @@
    Fields
    Example
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "cart_items": [VirtualProductCartItemInput]
 }
    @@ -21809,9 +22538,9 @@
    Example
    {
   "attribute_code": "xyz789",
   "count": 123,
-  "label": "xyz789",
+  "label": "abc123",
   "options": [AggregationOption],
-  "position": 123
+  "position": 987
 }
    @@ -21864,8 +22593,8 @@
    Fields
    Example
    {
   "count": 987,
-  "label": "abc123",
-  "value": "abc123"
+  "label": "xyz789",
+  "value": "xyz789"
 }
    @@ -21935,7 +22664,7 @@
    Possible Types
    Example
    {
   "count": 987,
-  "label": "xyz789",
+  "label": "abc123",
   "value": "abc123"
 }
    @@ -22092,7 +22821,7 @@
    Fields
    Example
    {
   "button_styles": ButtonStyles,
-  "code": "abc123",
+  "code": "xyz789",
   "is_visible": true,
   "payment_intent": "abc123",
   "payment_source": "xyz789",
@@ -22154,7 +22883,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "payment_source": "xyz789",
-  "payments_order_id": "abc123",
+  "payments_order_id": "xyz789",
   "paypal_order_id": "abc123"
 }
 
    
@@ -22196,7 +22925,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"code": "xyz789"}
+                  
    {"code": "abc123"}
 
    
                 
    
               
    
@@ -22253,9 +22982,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "applied_balance": Money,
-  "code": "xyz789",
+  "code": "abc123",
   "current_balance": Money,
-  "expiration_date": "xyz789"
+  "expiration_date": "abc123"
 }
    @@ -22358,8 +23087,8 @@
    Fields
    Example
    {
-  "cart_id": "xyz789",
-  "coupon_code": "xyz789"
+  "cart_id": "abc123",
+  "coupon_code": "abc123"
 }
    @@ -22503,8 +23232,8 @@
    Fields
    Example
    {
-  "cart_id": "xyz789",
-  "coupon_codes": ["xyz789"],
+  "cart_id": "abc123",
+  "coupon_codes": ["abc123"],
   "type": "APPEND"
 }
    @@ -22725,7 +23454,7 @@
    Fields
    Example
    - 
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
    @@ -22812,7 +23541,7 @@
    Fields
    Example
    - 
    {"radius": 987, "search_term": "xyz789"}
+                  
    {"radius": 987, "search_term": "abc123"}
    @@ -22923,11 +23652,11 @@
    Fields
    Example
    {
-  "attribute_code": "xyz789",
+  "attribute_code": "abc123",
   "attribute_options": [AttributeOption],
   "attribute_type": "abc123",
   "entity_type": "xyz789",
-  "input_type": "abc123",
+  "input_type": "xyz789",
   "storefront_properties": StorefrontProperties
 }
    @@ -23109,16 +23838,16 @@
    Example
    {
   "is_comparable": false,
   "is_filterable": true,
-  "is_filterable_in_search": false,
-  "is_html_allowed_on_front": false,
+  "is_filterable_in_search": true,
+  "is_html_allowed_on_front": true,
   "is_searchable": true,
   "is_used_for_customer_segment": false,
-  "is_used_for_price_rules": true,
-  "is_used_for_promo_rules": true,
-  "is_visible_in_advanced_search": false,
-  "is_visible_on_front": true,
-  "is_wysiwyg_enabled": true,
-  "used_in_product_listing": true
+  "is_used_for_price_rules": false,
+  "is_used_for_promo_rules": false,
+  "is_visible_in_advanced_search": true,
+  "is_visible_on_front": false,
+  "is_wysiwyg_enabled": false,
+  "used_in_product_listing": false
 }
    @@ -23315,7 +24044,7 @@
    Fields
    Example
    {
   "attribute_code": "xyz789",
-  "entity_type": "xyz789"
+  "entity_type": "abc123"
 }
    @@ -23441,11 +24170,11 @@
    Example
    "code": 4, "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "is_required": false, - "is_unique": false, - "label": "xyz789", + "is_unique": true, + "label": "abc123", "options": [CustomAttributeOptionInterface] }     @@ -23601,7 +24330,7 @@
    Fields
    Example
    {
   "label": "abc123",
-  "value": "xyz789"
+  "value": "abc123"
 }
    @@ -23655,7 +24384,7 @@
    Example
    {
   "is_default": true,
   "label": "abc123",
-  "value": "abc123"
+  "value": "xyz789"
 }
    @@ -23759,8 +24488,8 @@
    Possible Types
    Example
    {
-  "label": "xyz789",
-  "value": "abc123"
+  "label": "abc123",
+  "value": "xyz789"
 }
    @@ -23847,7 +24576,10 @@
    Fields
    Example
    - 
    {"code": 4, "value": "abc123"}
+                  
    {
+  "code": "4",
+  "value": "xyz789"
+}
    @@ -23901,7 +24633,7 @@
    Fields
    Example
    {
-  "attribute_code": "abc123",
+  "attribute_code": "xyz789",
   "selected_options": [AttributeInputSelectedOption],
   "value": "abc123"
 }
@@ -23955,6 +24687,11 @@ 
    Possible Types
    
                           
    AttributeSelectedOptions
    
                         
                       
+                      
+                        
+                          
    GiftCartAttributeValue
    
+                        
+
    @@ -23962,7 +24699,7 @@
    Possible Types
    Example
    - 
    {"code": 4}
+                  
    {"code": "4"}
    @@ -24103,7 +24840,7 @@
    Fields
    Example
    - 
    {"code": "AFN", "symbol": "xyz789"}
+                  
    {"code": "AFN", "symbol": "abc123"}
    @@ -24154,9 +24891,9 @@
    Fields
    Example
    {
-  "code": "xyz789",
-  "is_deferred": true,
-  "title": "abc123"
+  "code": "abc123",
+  "is_deferred": false,
+  "title": "xyz789"
 }
    @@ -24250,9 +24987,9 @@
    Example
    "base_amount": Money, "carrier_code": "xyz789", "carrier_title": "abc123", - "error_message": "xyz789", + "error_message": "abc123", "method_code": "xyz789", - "method_title": "xyz789", + "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money } @@ -24347,6 +25084,12 @@
    Fields
    An ID from the customer's address book that uniquely identifies the address to be used for billing. + + + customer_address_uid - ID + + The unique ID from the customer's address book that uniquely identifies the address to be used for billing. + same_as_shipping - Boolean @@ -24368,9 +25111,10 @@
    Fields
    Example
    {
   "address": CartAddressInput,
-  "customer_address_id": 123,
-  "same_as_shipping": true,
-  "use_for_shipping": true
+  "customer_address_id": 987,
+  "customer_address_uid": 4,
+  "same_as_shipping": false,
+  "use_for_shipping": false
 }
    @@ -24443,8 +25187,8 @@
    Fields
    Example
    {
-  "address_line_1": "xyz789",
-  "address_line_2": "xyz789",
+  "address_line_1": "abc123",
+  "address_line_2": "abc123",
   "city": "abc123",
   "country_code": "xyz789",
   "postal_code": "xyz789",
@@ -24497,6 +25241,11 @@ 
    Fields
    
                         
                          The custom attribute values of the billing or shipping address. 
                       
+                      
+                        customer_address_uid - ID
+                        
+                         The unique ID from the customer's address book that uniquely identifies the address. 
+                      
                       
                         customer_notes - String
                         
@@ -24515,9 +25264,10 @@ 
    Fields
    
                          The first name of the customer or guest. 
                       
                       
-                        id - Int
+                        id - Int
+                        
+                         Id of the customer address. Use customer_address_uid instead.
                         
-                         Id of the customer address. 
                       
                       
                         lastname - String!
@@ -24560,9 +25310,9 @@ 
    Fields
    
                          The telephone number for the billing or shipping address. 
                       
                       
-                        uid - String!
+                        uid - ID!
                         
-                         The unique id of the customer address. 
+                         The unique id of the customer cart address. 
                       
                       
                         vat_id - String
@@ -24577,23 +25327,24 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "xyz789",
+  "city": "abc123",
   "company": "xyz789",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
+  "customer_address_uid": "4",
   "customer_notes": "abc123",
-  "fax": "abc123",
+  "fax": "xyz789",
   "firstname": "xyz789",
-  "id": 123,
+  "id": 987,
   "lastname": "abc123",
-  "middlename": "abc123",
+  "middlename": "xyz789",
   "postcode": "xyz789",
-  "prefix": "abc123",
+  "prefix": "xyz789",
   "region": CartAddressRegion,
   "street": ["xyz789"],
-  "suffix": "abc123",
-  "telephone": "abc123",
-  "uid": "xyz789",
+  "suffix": "xyz789",
+  "telephone": "xyz789",
+  "uid": 4,
   "vat_id": "xyz789"
 }
 
    
@@ -24717,7 +25468,7 @@ 
    Example
    
                   
    {
   "device_data": "xyz789",
   "is_active_payment_token_enabler": true,
-  "payment_method_nonce": "abc123"
+  "payment_method_nonce": "xyz789"
 }
 
    
                 
    
@@ -24765,7 +25516,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "device_data": "abc123",
-  "public_hash": "xyz789"
+  "public_hash": "abc123"
 }
    @@ -24834,10 +25585,10 @@
    Fields
    Example
    {
   "category_id": 987,
-  "category_level": 123,
+  "category_level": 987,
   "category_name": "xyz789",
-  "category_uid": 4,
-  "category_url_key": "abc123",
+  "category_uid": "4",
+  "category_url_key": "xyz789",
   "category_url_path": "abc123"
 }
    @@ -24974,11 +25725,11 @@
    Example
    "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "xyz789", + "id": "abc123", "is_available": true, "max_qty": 987.65, "min_qty": 987.65, - "not_available_message": "xyz789", + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -25067,7 +25818,7 @@
    Example
    "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_refunded": 123.45 }     @@ -25149,10 +25900,10 @@
    Example
    "discounts": [Discount], "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_invoiced": 987.65 + "quantity_invoiced": 123.45 }     @@ -25239,10 +25990,10 @@
    Example
    "options": [BundleItemOption], "position": 123, "price_range": PriceRange, - "required": false, - "sku": "abc123", + "required": true, + "sku": "xyz789", "title": "abc123", - "type": "abc123", + "type": "xyz789", "uid": 4 }     @@ -25338,14 +26089,14 @@
    Fields
    Example
    {
   "can_change_quantity": false,
-  "id": 123,
-  "is_default": true,
+  "id": 987,
+  "is_default": false,
   "label": "abc123",
   "position": 123,
   "price": 123.45,
   "price_type": "FIXED",
   "product": ProductInterface,
-  "qty": 123.45,
+  "qty": 987.65,
   "quantity": 123.45,
   "uid": "4"
 }
@@ -25563,7 +26314,7 @@ 
    Example
    
                   
    {
   "bundle_options": [ItemSelectedBundleOption],
   "discounts": [Discount],
-  "eligible_for_return": true,
+  "eligible_for_return": false,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
@@ -25573,16 +26324,16 @@ 
    Example
    
   "product": ProductInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "product_type": "xyz789",
-  "product_url_key": "xyz789",
+  "product_sku": "xyz789",
+  "product_type": "abc123",
+  "product_url_key": "abc123",
   "quantity_canceled": 987.65,
   "quantity_invoiced": 123.45,
-  "quantity_ordered": 123.45,
-  "quantity_refunded": 987.65,
-  "quantity_return_requested": 123.45,
+  "quantity_ordered": 987.65,
+  "quantity_refunded": 123.45,
+  "quantity_return_requested": 987.65,
   "quantity_returned": 123.45,
-  "quantity_shipped": 123.45,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
   "status": "xyz789"
 }
@@ -25613,13 +26364,6 @@ 
    Fields
    
                       
                     
                     
-                      
-                        activity - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         attribute_set_id - Int
                         
@@ -25636,27 +26380,6 @@ 
    Fields
    
                         
                          The categories assigned to a product. 
                       
-                      
-                        category_gear - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        climate - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        collar - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         color - Int
                         
@@ -25718,41 +26441,6 @@ 
    filters
                         
                          Indicates whether the bundle product has a dynamically calculated weight. 
                       
-                      
-                        eco_collection - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        erin_recommends - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        features_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        format - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        gender - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         gift_message_available - Boolean!
                         
@@ -25795,13 +26483,6 @@ 
    filters
                          A number representing the product's manufacturer. Use the custom_attributes field instead.
                         
                       
-                      
-                        material - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         max_sale_qty - Float
                         
@@ -25843,13 +26524,6 @@ 
    filters
                         
                          The product name. Customers use this name to identify the product. 
                       
-                      
-                        new - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         new_from_date - String
                         
@@ -25875,20 +26549,6 @@ 
    filters
                         
                          If the product has multiple options, determines where they appear on the product page. 
                       
-                      
-                        pattern - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        performance_fabric - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         price - ProductPrices
                         
@@ -25920,13 +26580,6 @@ 
    filters
                         
                          An array of ProductLinks objects. 
                       
-                      
-                        purpose - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         quantity - Float
                         
@@ -25981,18 +26634,6 @@ 
    currentPage
                         
                       
-                      
-                        rules - [CatalogRule]
-                        
-                         Provides applied catalog rules in the current active cart 
-                      
-                      
-                        sale - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         ship_bundle_items - ShipBundleItemsEnum
                         
@@ -26003,25 +26644,11 @@ 
    currentPage
                          A short description of the product. Its use depends on the theme. 
                       
-                      
-                        size - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         sku - String
                         
                          A number or code assigned to a product to identify the product, options, price, and manufacturer. 
                       
-                      
-                        sleeve - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         small_image - ProductImage
                         
@@ -26053,34 +26680,6 @@ 
    currentPage
                          Stock status of the product 
                       
-                      
-                        strap_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_bottom - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_general - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         swatch_image - String
                         
@@ -26171,59 +26770,45 @@ 
    currentPage
                   
    Example
    
                   
    {
-  "activity": "abc123",
   "attribute_set_id": 123,
-  "canonical_url": "xyz789",
+  "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "abc123",
-  "collar": "abc123",
-  "color": 987,
-  "country_of_manufacture": "xyz789",
-  "created_at": "xyz789",
+  "color": 123,
+  "country_of_manufacture": "abc123",
+  "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "dynamic_price": false,
-  "dynamic_sku": true,
-  "dynamic_weight": false,
-  "eco_collection": 987,
-  "erin_recommends": 123,
-  "features_bags": "abc123",
-  "format": 123,
-  "gender": "abc123",
+  "dynamic_sku": false,
+  "dynamic_weight": true,
   "gift_message_available": false,
-  "gift_wrapping_available": true,
+  "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
   "id": 123,
   "image": ProductImage,
-  "is_returnable": "xyz789",
+  "is_returnable": "abc123",
   "items": [BundleItem],
   "manufacturer": 123,
-  "material": "abc123",
-  "max_sale_qty": 987.65,
+  "max_sale_qty": 123.45,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
-  "meta_keyword": "abc123",
+  "meta_description": "xyz789",
+  "meta_keyword": "xyz789",
   "meta_title": "xyz789",
-  "min_sale_qty": 123.45,
+  "min_sale_qty": 987.65,
   "name": "xyz789",
-  "new": 987,
   "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,
   "options": [CustomizableOptionInterface],
   "options_container": "xyz789",
-  "pattern": "abc123",
-  "performance_fabric": 987,
   "price": ProductPrices,
   "price_details": PriceDetails,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "price_view": "PRICE_RANGE",
   "product_links": [ProductLinksInterface],
-  "purpose": 987,
   "quantity": 123.45,
   "rating_summary": 987.65,
   "redirect_code": 123,
@@ -26231,38 +26816,30 @@ 
    Example
    
   "relative_url": "abc123",
   "review_count": 987,
   "reviews": ProductReviews,
-  "rules": [CatalogRule],
-  "sale": 987,
   "ship_bundle_items": "TOGETHER",
   "short_description": ComplexTextValue,
-  "size": 987,
   "sku": "xyz789",
-  "sleeve": "xyz789",
   "small_image": ProductImage,
-  "special_from_date": "xyz789",
+  "special_from_date": "abc123",
   "special_price": 987.65,
-  "special_to_date": "xyz789",
-  "staged": false,
+  "special_to_date": "abc123",
+  "staged": true,
   "stock_status": "IN_STOCK",
-  "strap_bags": "xyz789",
-  "style_bags": "abc123",
-  "style_bottom": "xyz789",
-  "style_general": "xyz789",
   "swatch_image": "abc123",
   "thumbnail": ProductImage,
-  "tier_price": 123.45,
+  "tier_price": 987.65,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
   "type_id": "xyz789",
   "uid": "4",
   "updated_at": "abc123",
   "upsell_products": [ProductInterface],
-  "url_key": "abc123",
+  "url_key": "xyz789",
   "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "xyz789",
+  "url_suffix": "abc123",
   "websites": [Website],
-  "weight": 987.65
+  "weight": 123.45
 }
 
    
                 
@@ -26384,8 +26961,8 @@ 
    Example
    
   "bundle_options": [SelectedBundleOption],
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": 4
+  "quantity": 987.65,
+  "uid": "4"
 }
 
    
                 
@@ -26458,12 +27035,12 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "bundle_options": [ItemSelectedBundleOption],
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "xyz789",
-  "quantity_shipped": 987.65
+  "quantity_shipped": 123.45
 }
 
    
                 
@@ -26535,13 +27112,13 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "added_at": "abc123",
+  "added_at": "xyz789",
   "bundle_options": [SelectedBundleOption],
   "customizable_options": [SelectedCustomizableOption],
   "description": "abc123",
   "id": "4",
   "product": ProductInterface,
-  "quantity": 123.45
+  "quantity": 987.65
 }
 
    
                 
    
@@ -26609,10 +27186,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "color": "xyz789",
+  "color": "abc123",
   "height": 987,
   "label": "abc123",
-  "layout": "abc123",
+  "layout": "xyz789",
   "shape": "xyz789",
   "tagline": true,
   "use_default_height": true
@@ -26664,7 +27241,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cancellation_comment": "abc123",
+  "cancellation_comment": "xyz789",
   "template_id": "4"
 }
 
    
@@ -26885,7 +27462,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "error": "abc123",
+  "error": "xyz789",
   "errorV2": CancelOrderError,
   "order": CustomerOrder
 }
@@ -26983,10 +27560,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "bin_details": CardBin,
-  "card_expiry_month": "abc123",
+  "card_expiry_month": "xyz789",
   "card_expiry_year": "abc123",
   "last_digits": "xyz789",
-  "name": "xyz789"
+  "name": "abc123"
 }
 
    
                 
    
@@ -27023,7 +27600,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"bin": "abc123"}
+                  
    {"bin": "xyz789"}
 
    
                 
    
               
    
@@ -27072,7 +27649,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "billing_address": BillingAddressPaymentSourceInput,
-  "name": "abc123"
+  "name": "xyz789"
 }
 
    
                 
    
@@ -27124,7 +27701,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "brand": "xyz789",
+  "brand": "abc123",
   "expiry": "xyz789",
   "last_digits": "xyz789"
 }
@@ -27271,7 +27848,7 @@ 
    sort Indicates whether the shopper requested a printed card for the cart. 
                       
                       
-                        rules - [CartRule]
+                        rules - [CartRuleStorefront]
                         
                          Provides applied cart rules in the current active cart 
                       
@@ -27310,13 +27887,13 @@ 
    Example
    
   "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,
-  "rules": [CartRule],
+  "rules": [CartRuleStorefront],
   "selected_payment_method": SelectedPaymentMethod,
   "shipping_addresses": [ShippingCartAddress],
   "total_quantity": 987.65
@@ -27488,7 +28065,7 @@ 
    Fields
    
                       
                       
                         
-                          telephone - String
+                          telephone - String!
                         
                          The telephone number for the billing or shipping address. 
                       
@@ -27508,21 +28085,21 @@ 
    Example
    
                   
    {
   "city": "abc123",
   "company": "xyz789",
-  "country_code": "xyz789",
+  "country_code": "abc123",
   "custom_attributes": [AttributeValueInput],
   "fax": "xyz789",
-  "firstname": "xyz789",
+  "firstname": "abc123",
   "lastname": "abc123",
   "middlename": "xyz789",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "prefix": "xyz789",
   "region": "xyz789",
-  "region_id": 123,
-  "save_in_address_book": true,
+  "region_id": 987,
+  "save_in_address_book": false,
   "street": ["abc123"],
-  "suffix": "abc123",
-  "telephone": "xyz789",
-  "vat_id": "xyz789"
+  "suffix": "xyz789",
+  "telephone": "abc123",
+  "vat_id": "abc123"
 }
 
    
                 
    
@@ -27567,6 +28144,11 @@ 
    Fields
    
                         
                          The custom attribute values of the billing or shipping address. 
                       
+                      
+                        customer_address_uid - ID
+                        
+                         The unique ID from the customer's address book that uniquely identifies the address. 
+                      
                       
                         fax - String
                         
@@ -27578,9 +28160,10 @@ 
    Fields
    
                          The first name of the customer or guest. 
                       
                       
-                        id - Int
+                        id - Int
+                        
+                         Id of the customer address. Use customer_address_uid instead.
                         
-                         Id of the customer address. 
                       
                       
                         lastname - String!
@@ -27623,9 +28206,9 @@ 
    Fields
    
                          The telephone number for the billing or shipping address. 
                       
                       
-                        uid - String!
+                        uid - ID!
                         
-                         The unique id of the customer address. 
+                         The unique id of the customer cart address. 
                       
                       
                         vat_id - String
@@ -27666,18 +28249,19 @@ 
    Example
    
   "company": "abc123",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
+  "customer_address_uid": "4",
   "fax": "xyz789",
   "firstname": "xyz789",
   "id": 987,
-  "lastname": "abc123",
-  "middlename": "abc123",
-  "postcode": "xyz789",
+  "lastname": "xyz789",
+  "middlename": "xyz789",
+  "postcode": "abc123",
   "prefix": "abc123",
   "region": CartAddressRegion,
   "street": ["abc123"],
   "suffix": "abc123",
   "telephone": "abc123",
-  "uid": "xyz789",
+  "uid": "4",
   "vat_id": "abc123"
 }
 
    
@@ -27730,9 +28314,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "xyz789",
-  "label": "xyz789",
-  "region_id": 123
+  "code": "abc123",
+  "label": "abc123",
+  "region_id": 987
 }
 
    
                 
    
@@ -27867,7 +28451,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"code": "UNDEFINED", "message": "xyz789"}
+                  
    {"code": "UNDEFINED", "message": "abc123"}
 
    
                 
    
               
    
@@ -27987,9 +28571,9 @@ 
    Example
    
                   
    {
   "entered_options": [EnteredOptionInput],
   "parent_sku": "abc123",
-  "quantity": 123.45,
+  "quantity": 987.65,
   "selected_options": [4],
-  "sku": "abc123"
+  "sku": "xyz789"
 }
 
    
                 
    
@@ -28114,12 +28698,12 @@ 
    Possible Types
    
                       
                       
                         
-                          
    BundleCartItem
    
+                          
    DownloadableCartItem
    
                         
                       
                       
                         
-                          
    DownloadableCartItem
    
+                          
    BundleCartItem
    
                         
                       
                       
@@ -28138,16 +28722,16 @@ 
    Example
    
   "discount": [Discount],
   "errors": [CartItemError],
   "id": "abc123",
-  "is_available": true,
-  "max_qty": 123.45,
+  "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,
   "product": ProductInterface,
   "quantity": 123.45,
-  "uid": 4
+  "uid": "4"
 }
    @@ -28299,7 +28883,7 @@
    Fields
    Example
    - 
    {"cart_item_id": 123, "quantity": 123.45}
+                  
    {"cart_item_id": 123, "quantity": 987.65}
    @@ -28351,8 +28935,8 @@
    Fields
    Example
    {
   "type": "FIXED",
-  "units": "abc123",
-  "value": 123.45
+  "units": "xyz789",
+  "value": 987.65
 }
    @@ -28480,7 +29064,7 @@
    Example
    {
   "items": [CartItemInterface],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
    @@ -28580,11 +29164,11 @@
    Example
    back to top
    -
    +
    Types
    -

    CartRule

    +

    CartRuleStorefront

    @@ -28598,9 +29182,9 @@
    Fields
    - name - String! + uid - ID! - Name of the cart price rule + The unique ID for a CartRule object. @@ -28609,7 +29193,7 @@
    Fields
    Example
    - 
    {"name": "abc123"}
+                  
    {"uid": "4"}
    @@ -29026,65 +29610,29 @@
    Example
    {
   "apply_to": ["SIMPLE"],
   "code": 4,
-  "default_value": "xyz789",
+  "default_value": "abc123",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "abc123",
+  "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
-  "is_comparable": false,
+  "is_comparable": true,
   "is_filterable": false,
   "is_filterable_in_search": false,
-  "is_html_allowed_on_front": true,
+  "is_html_allowed_on_front": false,
   "is_required": false,
   "is_searchable": false,
   "is_unique": false,
   "is_used_for_price_rules": true,
-  "is_used_for_promo_rules": true,
+  "is_used_for_promo_rules": false,
   "is_visible_in_advanced_search": false,
-  "is_visible_on_front": false,
+  "is_visible_on_front": true,
   "is_wysiwyg_enabled": false,
-  "label": "xyz789",
+  "label": "abc123",
   "options": [CustomAttributeOptionInterface],
   "swatch_input_type": "BOOLEAN",
   "update_product_preview_image": false,
   "use_product_image_for_swatch": false,
   "used_in_product_listing": false
 }
-
    -
    -
    - back to top -
    -
    -
    -
    - Types -
    -

    CatalogRule

    -
    -
    -
    -
    Fields
    - - - - - - - - - - - - - -
    Field NameDescription
    name - String! - Name of the catalog rule
    -
    -
    -
    -
    -
    Example
    - 
    {"name": "xyz789"}
    @@ -29434,23 +29982,23 @@
    Example
    "children_count": "abc123", "cms_block": CmsBlock, "created_at": "abc123", - "custom_layout_update_file": "abc123", - "default_sort_by": "abc123", - "description": "xyz789", + "custom_layout_update_file": "xyz789", + "default_sort_by": "xyz789", + "description": "abc123", "display_mode": "abc123", "filter_price_range": 987.65, - "id": 987, - "image": "abc123", - "include_in_menu": 987, + "id": 123, + "image": "xyz789", + "include_in_menu": 123, "is_anchor": 123, "landing_page": 123, - "level": 987, - "meta_description": "xyz789", - "meta_keywords": "abc123", + "level": 123, + "meta_description": "abc123", + "meta_keywords": "xyz789", "meta_title": "abc123", "name": "abc123", "path": "abc123", - "path_in_store": "xyz789", + "path_in_store": "abc123", "position": 987, "product_count": 987, "products": CategoryProducts, @@ -29458,7 +30006,7 @@
    Example
    "uid": "4", "updated_at": "abc123", "url_key": "abc123", - "url_path": "xyz789", + "url_path": "abc123", "url_suffix": "xyz789" }     @@ -29567,7 +30115,7 @@
    Example
    {
   "items": [CategoryTree],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
    @@ -29830,42 +30378,42 @@
    sortExample
    {
   "automatic_sorting": "abc123",
-  "available_sort_by": ["abc123"],
+  "available_sort_by": ["xyz789"],
   "breadcrumbs": [Breadcrumb],
-  "canonical_url": "xyz789",
+  "canonical_url": "abc123",
   "children": [CategoryTree],
   "children_count": "abc123",
   "cms_block": CmsBlock,
   "created_at": "abc123",
-  "custom_layout_update_file": "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": 123,
-  "image": "abc123",
-  "include_in_menu": 987,
+  "image": "xyz789",
+  "include_in_menu": 123,
   "is_anchor": 123,
   "landing_page": 123,
   "level": 987,
   "meta_description": "xyz789",
   "meta_keywords": "xyz789",
-  "meta_title": "xyz789",
+  "meta_title": "abc123",
   "name": "xyz789",
   "path": "abc123",
   "path_in_store": "abc123",
-  "position": 987,
+  "position": 123,
   "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",
+  "updated_at": "xyz789",
   "url_key": "abc123",
   "url_path": "abc123",
-  "url_suffix": "abc123"
+  "url_suffix": "xyz789"
 }
    @@ -29939,11 +30487,11 @@
    Example
    {
   "agreement_id": 987,
   "checkbox_text": "abc123",
-  "content": "xyz789",
-  "content_height": "abc123",
-  "is_html": false,
+  "content": "abc123",
+  "content_height": "xyz789",
+  "is_html": true,
   "mode": "AUTO",
-  "name": "xyz789"
+  "name": "abc123"
 }
    @@ -30044,7 +30592,7 @@
    Example
    {
   "code": "REORDER_NOT_AVAILABLE",
   "message": "abc123",
-  "path": ["xyz789"]
+  "path": ["abc123"]
 }
    @@ -30156,7 +30704,7 @@
    Fields
    Example
    - 
    {"message": "abc123", "type": "NOT_FOUND"}
+                  
    {"message": "xyz789", "type": "NOT_FOUND"}
    @@ -30667,8 +31215,8 @@
    Fields
    Example
    {
   "content": "xyz789",
-  "identifier": "abc123",
-  "title": "xyz789"
+  "identifier": "xyz789",
+  "title": "abc123"
 }
    @@ -30805,18 +31353,18 @@
    Fields
    Example
    {
-  "content": "xyz789",
+  "content": "abc123",
   "content_heading": "abc123",
   "identifier": "abc123",
   "meta_description": "xyz789",
   "meta_keywords": "abc123",
   "meta_title": "abc123",
   "page_layout": "abc123",
-  "redirect_code": 987,
-  "relative_url": "xyz789",
+  "redirect_code": 123,
+  "relative_url": "abc123",
   "title": "abc123",
   "type": "CMS_PAGE",
-  "url_key": "xyz789"
+  "url_key": "abc123"
 }
    @@ -31198,12 +31746,12 @@
    Example
    "company_admin": Customer, "credit": CompanyCredit, "credit_history": CompanyCreditHistory, - "email": "xyz789", - "id": 4, + "email": "abc123", + "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, @@ -31212,7 +31760,7 @@
    Example
    "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" }     @@ -31271,7 +31819,7 @@
    Example
    {
   "children": [CompanyAclResource],
   "id": "4",
-  "sort_order": 123,
+  "sort_order": 987,
   "text": "abc123"
 }
    @@ -31353,11 +31901,11 @@
    Example
    {
   "custom_attributes": [AttributeValueInput],
   "email": "xyz789",
-  "firstname": "abc123",
-  "gender": 987,
-  "job_title": "xyz789",
-  "lastname": "abc123",
-  "telephone": "xyz789"
+  "firstname": "xyz789",
+  "gender": 123,
+  "job_title": "abc123",
+  "lastname": "xyz789",
+  "telephone": "abc123"
 }
    @@ -31401,6 +31949,11 @@
    Fields
    The name of the company. + + status - CompanyStatusEnum + + The current status of the company. + @@ -31409,9 +31962,10 @@
    Fields
    Example
    {
-  "id": "4",
-  "legal_name": "abc123",
-  "name": "xyz789"
+  "id": 4,
+  "legal_name": "xyz789",
+  "name": "xyz789",
+  "status": "PENDING"
 }
    @@ -31492,10 +32046,10 @@
    Example
    {
   "company_admin": CompanyAdminInput,
   "company_email": "abc123",
-  "company_name": "xyz789",
+  "company_name": "abc123",
   "legal_address": CompanyLegalAddressCreateInput,
-  "legal_name": "abc123",
-  "reseller_id": "abc123",
+  "legal_name": "xyz789",
+  "reseller_id": "xyz789",
   "vat_tax_id": "xyz789"
 }
    @@ -31730,7 +32284,7 @@
    Example
    {
   "amount": Money,
   "balance": CompanyCredit,
-  "custom_reference_number": "abc123",
+  "custom_reference_number": "xyz789",
   "date": "abc123",
   "type": "ALLOCATION",
   "updated_by": CompanyCreditOperationUser
@@ -31852,7 +32406,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"name": "abc123", "type": "CUSTOMER"}
+                  
    {"name": "xyz789", "type": "CUSTOMER"}
 
    
                 
    
               
    
@@ -31952,7 +32506,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "abc123",
-  "role_id": 4,
+  "role_id": "4",
   "user": CompanyInvitationUserInput
 }
 
    
@@ -31994,7 +32548,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"success": true}
+                  
    {"success": false}
 
    
                 
    
               
    
@@ -32131,7 +32685,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "xyz789",
+  "city": "abc123",
   "country_code": "AF",
   "postcode": "xyz789",
   "region": CustomerAddressRegion,
@@ -32213,7 +32767,7 @@ 
    Example
    
   "country_id": "AF",
   "postcode": "xyz789",
   "region": CustomerAddressRegionInput,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "telephone": "abc123"
 }
 
    
@@ -32289,9 +32843,9 @@ 
    Example
    
                   
    {
   "city": "xyz789",
   "country_id": "AF",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": CustomerAddressRegionInput,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "telephone": "abc123"
 }
 
    
@@ -32349,7 +32903,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": "4",
+  "id": 4,
   "name": "abc123",
   "permissions": [CompanyAclResource],
   "users_count": 987
@@ -32402,7 +32956,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "name": "xyz789",
-  "permissions": ["abc123"]
+  "permissions": ["xyz789"]
 }
 
    
                 
    
@@ -32459,7 +33013,7 @@ 
    Example
    
                   
    {
   "id": "4",
   "name": "abc123",
-  "permissions": ["abc123"]
+  "permissions": ["xyz789"]
 }
 
    
                 
    
@@ -32513,7 +33067,7 @@ 
    Example
    
                   
    {
   "items": [CompanyRole],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
    
                 
@@ -32565,10 +33119,69 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "xyz789",
+  "email": "abc123",
   "firstname": "abc123",
-  "lastname": "xyz789"
+  "lastname": "abc123"
 }
+
    
+                
    
+              
+              back to top
+            
+
    +
    +
    + Types +
    +

    CompanyStatusEnum

    +
    +
    +
    +
    Description
    +

    Defines the list of company status values.

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

    PENDING

    +     		Company is pending approval.
    +

    APPROVED

    +     		Company is approved.
    +

    REJECTED

    +     		Company is rejected.
    +

    BLOCKED

    +     		Company is blocked.
    +
    +
    +
    +
    +
    Example
    + 
    "PENDING"
    @@ -32698,7 +33311,11 @@
    Fields
    Example
    - 
    {"entity": CompanyTeam, "id": 4, "parent_id": 4}
+                  
    {
+  "entity": CompanyTeam,
+  "id": "4",
+  "parent_id": 4
+}
    @@ -32745,7 +33362,7 @@
    Fields
    Example
    - 
    {"parent_tree_id": 4, "tree_id": "4"}
+                  
    {"parent_tree_id": 4, "tree_id": 4}
    @@ -32779,7 +33396,7 @@
    Fields
    An optional description of the team. - id - ID! + id - ID The unique ID for a CompanyTeam object. @@ -32860,8 +33477,8 @@
    Fields
    Example
    {
   "description": "xyz789",
-  "name": "abc123",
-  "target_id": 4
+  "name": "xyz789",
+  "target_id": "4"
 }
    @@ -32916,9 +33533,9 @@
    Fields
    Example
    {
-  "description": "xyz789",
-  "id": "4",
-  "name": "xyz789"
+  "description": "abc123",
+  "id": 4,
+  "name": "abc123"
 }
    @@ -32991,11 +33608,11 @@
    Fields
    Example
    {
-  "company_email": "abc123",
-  "company_name": "xyz789",
+  "company_email": "xyz789",
+  "company_name": "abc123",
   "legal_address": CompanyLegalAddressUpdateInput,
-  "legal_name": "xyz789",
-  "reseller_id": "abc123",
+  "legal_name": "abc123",
+  "reseller_id": "xyz789",
   "vat_tax_id": "abc123"
 }
    @@ -33082,13 +33699,13 @@
    Fields
    Example
    {
   "email": "xyz789",
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "job_title": "xyz789",
-  "lastname": "abc123",
+  "lastname": "xyz789",
   "role_id": 4,
   "status": "ACTIVE",
-  "target_id": 4,
-  "telephone": "xyz789"
+  "target_id": "4",
+  "telephone": "abc123"
 }
    @@ -33220,11 +33837,11 @@
    Fields
    Example
    {
-  "email": "xyz789",
-  "firstname": "xyz789",
-  "id": "4",
+  "email": "abc123",
+  "firstname": "abc123",
+  "id": 4,
   "job_title": "abc123",
-  "lastname": "xyz789",
+  "lastname": "abc123",
   "role_id": 4,
   "status": "ACTIVE",
   "telephone": "xyz789"
@@ -33281,7 +33898,7 @@ 
    Example
    
                   
    {
   "items": [Customer],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
    @@ -33369,7 +33986,7 @@
    Fields
    Example
    {
-  "code": "abc123",
+  "code": "xyz789",
   "label": "abc123"
 }
    @@ -33424,7 +34041,7 @@
    Example
    {
   "attributes": [ProductAttribute],
   "product": ProductInterface,
-  "uid": 4
+  "uid": "4"
 }
    @@ -33482,9 +34099,59 @@
    Fields
    Example
    {
   "attributes": [ComparableAttribute],
-  "item_count": 123,
+  "item_count": 987,
   "items": [ComparableItem],
-  "uid": "4"
+  "uid": 4
+}
+
    + + + back to top + +
    +
    +
    + Types +
    +

    CompleteOrderInput

    +
    +
    +
    +
    Description
    +

    Update the quote and complete the order

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + cartId - String! + The customer cart ID
    + id - String! + PayPal order ID
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "cartId": "abc123",
+  "id": "xyz789"
 }
    @@ -33521,7 +34188,7 @@
    Fields
    Example
    - 
    {"html": "xyz789"}
+                  
    {"html": "abc123"}
    @@ -33577,10 +34244,10 @@
    Fields
    Example
    {
-  "code": "abc123",
+  "code": "xyz789",
   "label": "xyz789",
   "uid": "4",
-  "value_index": 987
+  "value_index": 123
 }
    @@ -33723,16 +34390,16 @@
    Example
    "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "abc123", - "is_available": false, - "max_qty": 987.65, + "is_available": true, + "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 + "uid": "4" }
    @@ -33779,8 +34446,8 @@
    Fields
    Example
    {
-  "attribute_code": "abc123",
-  "option_value_uids": ["4"]
+  "attribute_code": "xyz789",
+  "option_value_uids": [4]
 }
    @@ -33934,21 +34601,21 @@
    Example
    "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "4", - "parent_sku": "xyz789", + "parent_sku": "abc123", "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": 987.65, - "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, - "quantity_refunded": 123.45, - "quantity_return_requested": 123.45, - "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "product_url_key": "xyz789", + "quantity_canceled": 123.45, + "quantity_invoiced": 987.65, + "quantity_ordered": 987.65, + "quantity_refunded": 987.65, + "quantity_return_requested": 987.65, + "quantity_returned": 123.45, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "xyz789" } @@ -33979,13 +34646,6 @@
    Fields
    - - activity - String - - - Use the custom_attributes field instead. - - attribute_set_id - Int @@ -34002,27 +34662,6 @@
    Fields
    The categories assigned to a product. - - category_gear - String - - - Use the custom_attributes field instead. - - - - climate - String - - - Use the custom_attributes field instead. - - - - collar - String - - - Use the custom_attributes field instead. - - color - Int @@ -34092,41 +34731,6 @@
    filters Detailed information about the product. The value can include simple HTML tags. - - eco_collection - Int - - - Use the custom_attributes field instead. - - - - erin_recommends - Int - - - Use the custom_attributes field instead. - - - - features_bags - String - - - Use the custom_attributes field instead. - - - - format - Int - - - Use the custom_attributes field instead. - - - - gender - String - - - Use the custom_attributes field instead. - - gift_message_available - Boolean! @@ -34164,13 +34768,6 @@
    filters A number representing the product's manufacturer. Use the custom_attributes field instead. - - material - String - - - Use the custom_attributes field instead. - - max_sale_qty - Float @@ -34212,13 +34809,6 @@
    filters The product name. Customers use this name to identify the product. - - new - Int - - - Use the custom_attributes field instead. - - new_from_date - String @@ -34244,20 +34834,6 @@
    filters If the product has multiple options, determines where they appear on the product page. - - pattern - String - - - Use the custom_attributes field instead. - - - - performance_fabric - Int - - - Use the custom_attributes field instead. - - price - ProductPrices @@ -34279,13 +34855,6 @@
    filters An array of ProductLinks objects. - - purpose - Int - - - Use the custom_attributes field instead. - - quantity - Float @@ -34340,42 +34909,16 @@
    currentPage - - rules - [CatalogRule] - - Provides applied catalog rules in the current active cart - - - sale - Int - - - Use the custom_attributes field instead. - - short_description - ComplexTextValue A short description of the product. Its use depends on the theme. - - size - Int - - - Use the custom_attributes field instead. - - sku - String A number or code assigned to a product to identify the product, options, price, and manufacturer. - - sleeve - String - - - Use the custom_attributes field instead. - - small_image - ProductImage @@ -34407,34 +34950,6 @@
    currentPage Stock status of the product - - strap_bags - String - - - Use the custom_attributes field instead. - - - - style_bags - String - - - Use the custom_attributes field instead. - - - - style_bottom - String - - - Use the custom_attributes field instead. - - - - style_general - String - - - Use the custom_attributes field instead. - - swatch_image - String @@ -34530,14 +35045,10 @@
    currentPage
    Example
    {
-  "activity": "xyz789",
-  "attribute_set_id": 123,
+  "attribute_set_id": 987,
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "xyz789",
-  "climate": "xyz789",
-  "collar": "abc123",
-  "color": 123,
+  "color": 987,
   "configurable_options": [ConfigurableProductOptions],
   "configurable_product_options_selection": ConfigurableProductOptionsSelection,
   "country_of_manufacture": "xyz789",
@@ -34545,19 +35056,13 @@ 
    Example
    
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 123,
-  "erin_recommends": 987,
-  "features_bags": "xyz789",
-  "format": 987,
-  "gender": "abc123",
   "gift_message_available": false,
   "gift_wrapping_available": true,
   "gift_wrapping_price": Money,
-  "id": 987,
+  "id": 123,
   "image": ProductImage,
-  "is_returnable": "xyz789",
+  "is_returnable": "abc123",
   "manufacturer": 987,
-  "material": "abc123",
   "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
@@ -34565,54 +35070,42 @@ 
    Example
    
   "meta_keyword": "abc123",
   "meta_title": "xyz789",
   "min_sale_qty": 987.65,
-  "name": "abc123",
-  "new": 123,
+  "name": "xyz789",
   "new_from_date": "abc123",
   "new_to_date": "xyz789",
   "only_x_left_in_stock": 123.45,
   "options": [CustomizableOptionInterface],
-  "options_container": "abc123",
-  "pattern": "abc123",
-  "performance_fabric": 987,
+  "options_container": "xyz789",
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 123,
-  "quantity": 123.45,
-  "rating_summary": 123.45,
+  "quantity": 987.65,
+  "rating_summary": 987.65,
   "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": 123,
-  "sku": "xyz789",
-  "sleeve": "abc123",
+  "sku": "abc123",
   "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": "xyz789",
-  "style_general": "abc123",
-  "swatch_image": "xyz789",
+  "swatch_image": "abc123",
   "thumbnail": ProductImage,
-  "tier_price": 987.65,
+  "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "abc123",
+  "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": "xyz789",
   "variants": [ConfigurableVariant],
@@ -34678,7 +35171,7 @@ 
    Example
    
   "customizable_options": [CustomizableOptionInput],
   "data": CartItemInput,
   "parent_sku": "xyz789",
-  "variant_sku": "abc123"
+  "variant_sku": "xyz789"
 }
    @@ -34801,8 +35294,8 @@
    Fields
    Example
    {
   "is_available": false,
-  "is_use_default": false,
-  "label": "abc123",
+  "is_use_default": true,
+  "label": "xyz789",
   "swatch": SwatchDataInterface,
   "uid": 4
 }
@@ -34901,15 +35394,15 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "attribute_code": "xyz789",
-  "attribute_id": "abc123",
-  "attribute_id_v2": 987,
+  "attribute_id": "xyz789",
+  "attribute_id_v2": 123,
   "attribute_uid": "4",
   "id": 987,
   "label": "xyz789",
-  "position": 987,
+  "position": 123,
   "product_id": 123,
   "uid": 4,
-  "use_default": true,
+  "use_default": false,
   "values": [ConfigurableProductOptionsValues]
 }
 
    
@@ -35050,7 +35543,7 @@ 
    Example
    
   "store_label": "xyz789",
   "swatch_data": SwatchDataInterface,
   "uid": "4",
-  "use_default_value": true,
+  "use_default_value": false,
   "value_index": 987
 }
    @@ -35116,7 +35609,7 @@
    Example
    "configurable_options": [SelectedConfigurableOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "uid": "4" }     @@ -35253,10 +35746,10 @@
    Example
    "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], - "description": "abc123", + "description": "xyz789", "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 }     @@ -35351,8 +35844,8 @@
    Fields
    Example
    {
-  "confirmation_key": "xyz789",
-  "email": "abc123"
+  "confirmation_key": "abc123",
+  "email": "xyz789"
 }
    @@ -35398,7 +35891,7 @@
    Fields
    Example
    {
   "confirmation_key": "xyz789",
-  "order_id": "4"
+  "order_id": 4
 }
    @@ -35502,10 +35995,10 @@
    Fields
    Example
    {
-  "comment": "xyz789",
+  "comment": "abc123",
   "email": "xyz789",
   "name": "abc123",
-  "telephone": "xyz789"
+  "telephone": "abc123"
 }
    @@ -35546,7 +36039,7 @@
    Fields
    Example
    - 
    {"status": true}
+                  
    {"status": false}
    @@ -35744,11 +36237,11 @@
    Fields
    Example
    {
   "available_regions": [Region],
-  "full_name_english": "abc123",
-  "full_name_locale": "abc123",
+  "full_name_english": "xyz789",
+  "full_name_locale": "xyz789",
   "id": "xyz789",
-  "three_letter_abbreviation": "xyz789",
-  "two_letter_abbreviation": "xyz789"
+  "three_letter_abbreviation": "abc123",
+  "two_letter_abbreviation": "abc123"
 }
    @@ -37543,8 +38036,8 @@
    Example
    GiftRegistryDynamicAttributeInput ], "event_name": "xyz789", - "gift_registry_type_uid": "4", - "message": "abc123", + "gift_registry_type_uid": 4, + "message": "xyz789", "privacy_settings": "PRIVATE", "registrants": [AddGiftRegistryRegistrantInput], "shipping_address": GiftRegistryShippingAddressInput, @@ -37723,10 +38216,10 @@
    Fields
    Example
    {
-  "response_message": "xyz789",
+  "response_message": "abc123",
   "result": 987,
   "result_code": 123,
-  "secure_token": "xyz789",
+  "secure_token": "abc123",
   "secure_token_id": "abc123"
 }
    @@ -37794,11 +38287,11 @@
    Fields
    Example
    {
-  "cartId": "abc123",
+  "cartId": "xyz789",
   "location": "PRODUCT_DETAIL",
-  "methodCode": "abc123",
+  "methodCode": "xyz789",
   "paymentSource": "abc123",
-  "vaultIntent": true
+  "vaultIntent": false
 }
    @@ -37861,10 +38354,10 @@
    Fields
    Example
    {
   "amount": 123.45,
-  "currency_code": "abc123",
+  "currency_code": "xyz789",
   "id": "xyz789",
   "mp_order_id": "abc123",
-  "status": "xyz789"
+  "status": "abc123"
 }
    @@ -37933,8 +38426,8 @@
    Example
    {
   "nickname": "abc123",
   "ratings": [ProductReviewRatingInput],
-  "sku": "xyz789",
-  "summary": "xyz789",
+  "sku": "abc123",
+  "summary": "abc123",
   "text": "xyz789"
 }
    @@ -38023,7 +38516,7 @@
    Fields
    Example
    - 
    {"currency": "AFN", "value": 987.65}
+                  
    {"currency": "AFN", "value": 123.45}
    @@ -38225,8 +38718,8 @@
    Fields
    Example
    {
-  "card_description": "abc123",
-  "setup_token_id": "abc123"
+  "card_description": "xyz789",
+  "setup_token_id": "xyz789"
 }
    @@ -38412,7 +38905,7 @@
    Fields
    Example
    - 
    {"name": "abc123", "visibility": "PUBLIC"}
+                  
    {"name": "xyz789", "visibility": "PUBLIC"}
    @@ -38514,7 +39007,7 @@
    Example
    {
   "cc_exp_month": 123,
   "cc_exp_year": 123,
-  "cc_last_4": 987,
+  "cc_last_4": 123,
   "cc_type": "xyz789"
 }
    @@ -38654,7 +39147,7 @@
    Example
    "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_refunded": 987.65 }     @@ -38733,12 +39226,12 @@
    Possible Types
    -

    BundleCreditMemoItem

    +

    DownloadableCreditMemoItem

    -

    DownloadableCreditMemoItem

    +

    BundleCreditMemoItem

    @@ -38765,7 +39258,7 @@
    Example
    "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_refunded": 987.65 + "quantity_refunded": 123.45 }     @@ -38932,12 +39425,12 @@
    Fields
    Example
    {
-  "available_currency_codes": ["abc123"],
+  "available_currency_codes": ["xyz789"],
   "base_currency_code": "abc123",
-  "base_currency_symbol": "xyz789",
-  "default_display_currecy_code": "xyz789",
-  "default_display_currecy_symbol": "xyz789",
-  "default_display_currency_code": "xyz789",
+  "base_currency_symbol": "abc123",
+  "default_display_currecy_code": "abc123",
+  "default_display_currecy_symbol": "abc123",
+  "default_display_currency_code": "abc123",
   "default_display_currency_symbol": "abc123",
   "exchange_rates": [ExchangeRate]
 }
@@ -40318,14 +40811,14 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "code": "4",
+  "code": 4,
   "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
   "is_required": false,
-  "is_unique": true,
-  "label": "abc123",
+  "is_unique": false,
+  "label": "xyz789",
   "options": [CustomAttributeOptionInterface]
 }
 
    
@@ -40392,8 +40885,8 @@ 
    Possible Types
    
                   
    Example
    
                   
    {
   "is_default": false,
-  "label": "xyz789",
-  "value": "xyz789"
+  "label": "abc123",
+  "value": "abc123"
 }
 
    
                 
    
@@ -40567,9 +41060,9 @@ 
    giftRegistryUi
                         
                       
                       
-                        group - CustomerGroup
+                        group - CustomerGroupStorefront
                         
-                         Name of the customer group assigned to the customer 
+                         Customer group assigned to the customer 
                       
                       
                         group_id - Int
@@ -40579,10 +41072,9 @@ 
    giftRegistryUi
                         
                       
                       
-                        id - Int
-                        
-                         The ID assigned to the customer. id is not needed as part of Customer, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side.
+                        id - ID!
                         
+                         The unique ID assigned to the customer. 
                       
                       
                         is_subscribed - Boolean
@@ -40849,7 +41341,7 @@ 
    currentPage The role name and permissions assigned to the company user. 
                       
                       
-                        segments - [CustomerSegment]
+                        segments - [CustomerSegmentStorefront]
                         
                          Customer segments associated with the current customer 
                       
@@ -40946,30 +41438,30 @@ 
    Example
    
                   
    {
   "addresses": [CustomerAddress],
   "addressesV2": CustomerAddresses,
-  "allow_remote_shopping_assistance": false,
+  "allow_remote_shopping_assistance": true,
   "companies": UserCompaniesOutput,
   "compare_list": CompareList,
   "confirmation_status": "ACCOUNT_CONFIRMED",
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "custom_attributes": [AttributeValueInterface],
   "date_of_birth": "xyz789",
-  "default_billing": "xyz789",
+  "default_billing": "abc123",
   "default_shipping": "xyz789",
-  "dob": "abc123",
-  "email": "abc123",
+  "dob": "xyz789",
+  "email": "xyz789",
   "firstname": "abc123",
-  "gender": 123,
+  "gender": 987,
   "gift_registries": [GiftRegistry],
   "gift_registry": GiftRegistry,
-  "group": CustomerGroup,
-  "group_id": 987,
-  "id": 987,
+  "group": CustomerGroupStorefront,
+  "group_id": 123,
+  "id": 4,
   "is_subscribed": false,
   "job_title": "xyz789",
-  "lastname": "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,
@@ -40982,14 +41474,14 @@ 
    Example
    
   "reviews": ProductReviews,
   "reward_points": RewardPoints,
   "role": CompanyRole,
-  "segments": [CustomerSegment],
+  "segments": [CustomerSegmentStorefront],
   "status": "ACTIVE",
   "store_credit": CustomerStoreCredit,
   "structure_id": "4",
   "suffix": "abc123",
-  "taxvat": "xyz789",
+  "taxvat": "abc123",
   "team": CompanyTeam,
-  "telephone": "abc123",
+  "telephone": "xyz789",
   "wishlist": Wishlist,
   "wishlist_v2": Wishlist,
   "wishlists": [Wishlist]
@@ -41099,9 +41591,10 @@ 
    attributeCodes
                          The first name of the person associated with the shipping/billing address. 
                       
                       
-                        id - Int
+                        id - Int
+                        
+                         The ID of a CustomerAddress object. Use uid instead.
                         
-                         The ID of a CustomerAddress object. 
                       
                       
                         lastname - String
@@ -41148,6 +41641,11 @@ 
    attributeCodes
                         
                          The customer's telephone number. 
                       
+                      
+                        uid - ID
+                        
+                         The unique ID for a CustomerAddress object. 
+                      
                       
                         vat_id - String
                         
@@ -41161,29 +41659,30 @@ 
    attributeCodes
                 
    
                   
    Example
    
                   
    {
-  "city": "abc123",
-  "company": "abc123",
+  "city": "xyz789",
+  "company": "xyz789",
   "country_code": "AF",
   "country_id": "abc123",
   "custom_attributes": [CustomerAddressAttribute],
   "custom_attributesV2": [AttributeValueInterface],
-  "customer_id": 123,
+  "customer_id": 987,
   "default_billing": false,
   "default_shipping": true,
   "extension_attributes": [CustomerAddressAttribute],
   "fax": "xyz789",
   "firstname": "abc123",
-  "id": 123,
-  "lastname": "abc123",
-  "middlename": "abc123",
-  "postcode": "abc123",
-  "prefix": "abc123",
+  "id": 987,
+  "lastname": "xyz789",
+  "middlename": "xyz789",
+  "postcode": "xyz789",
+  "prefix": "xyz789",
   "region": CustomerAddressRegion,
   "region_id": 123,
-  "street": ["abc123"],
+  "street": ["xyz789"],
   "suffix": "abc123",
   "telephone": "abc123",
-  "vat_id": "abc123"
+  "uid": 4,
+  "vat_id": "xyz789"
 }
 
    
                 
    
@@ -41230,8 +41729,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "attribute_code": "xyz789",
-  "value": "abc123"
+  "attribute_code": "abc123",
+  "value": "xyz789"
 }
 
    
                 
    
@@ -41434,18 +41933,18 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "xyz789",
+  "city": "abc123",
   "company": "xyz789",
   "country_code": "AF",
   "country_id": "AF",
   "custom_attributes": [CustomerAddressAttributeInput],
   "custom_attributesV2": [AttributeValueInput],
-  "default_billing": false,
-  "default_shipping": false,
+  "default_billing": true,
+  "default_shipping": true,
   "fax": "xyz789",
-  "firstname": "xyz789",
-  "lastname": "abc123",
-  "middlename": "xyz789",
+  "firstname": "abc123",
+  "lastname": "xyz789",
+  "middlename": "abc123",
   "postcode": "xyz789",
   "prefix": "xyz789",
   "region": CustomerAddressRegionInput,
@@ -41505,7 +42004,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "region": "xyz789",
-  "region_code": "xyz789",
+  "region_code": "abc123",
   "region_id": 123
 }
 
    
@@ -41563,7 +42062,7 @@ 
    Example
    
                   
    {
   "region": "abc123",
   "region_code": "xyz789",
-  "region_id": 123
+  "region_id": 987
 }
 
    
                 
    
@@ -41613,7 +42112,7 @@ 
    Example
    
                   
    {
   "items": [CustomerAddress],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
    @@ -41715,16 +42214,16 @@
    Fields
    Example
    {
-  "code": "4",
-  "default_value": "abc123",
+  "code": 4,
+  "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "abc123",
+  "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
   "input_filter": "NONE",
-  "is_required": true,
-  "is_unique": true,
-  "label": "abc123",
-  "multiline_count": 987,
+  "is_required": false,
+  "is_unique": false,
+  "label": "xyz789",
+  "multiline_count": 123,
   "options": [CustomAttributeOptionInterface],
   "sort_order": 987,
   "validate_rules": [ValidationRule]
@@ -41849,20 +42348,20 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "allow_remote_shopping_assistance": true,
+  "allow_remote_shopping_assistance": false,
   "custom_attributes": [AttributeValueInput],
   "date_of_birth": "abc123",
-  "dob": "xyz789",
+  "dob": "abc123",
   "email": "abc123",
-  "firstname": "xyz789",
-  "gender": 987,
-  "is_subscribed": true,
+  "firstname": "abc123",
+  "gender": 123,
+  "is_subscribed": false,
   "lastname": "abc123",
   "middlename": "xyz789",
-  "password": "abc123",
+  "password": "xyz789",
   "prefix": "xyz789",
-  "suffix": "abc123",
-  "taxvat": "abc123"
+  "suffix": "xyz789",
+  "taxvat": "xyz789"
 }
 
    
                 
    
@@ -41924,9 +42423,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "date": "xyz789",
+  "date": "abc123",
   "download_url": "abc123",
-  "order_increment_id": "abc123",
+  "order_increment_id": "xyz789",
   "remaining_downloads": "abc123",
   "status": "xyz789"
 }
@@ -41976,11 +42475,11 @@ 
    Example
    
               back to top
    -
    +
    Types
    -

    CustomerGroup

    +

    CustomerGroupStorefront

    @@ -41998,9 +42497,9 @@
    Fields
    - name - String + uid - ID! - The name of customer group. + The unique ID for a CustomerGroup object. @@ -42009,7 +42508,7 @@
    Fields
    Example
    - 
    {"name": "abc123"}
+                  
    {"uid": 4}
    @@ -42119,16 +42618,16 @@
    Fields
    Example
    {
   "date_of_birth": "xyz789",
-  "dob": "abc123",
-  "email": "abc123",
-  "firstname": "abc123",
-  "gender": 123,
-  "is_subscribed": false,
-  "lastname": "abc123",
-  "middlename": "xyz789",
-  "password": "abc123",
+  "dob": "xyz789",
+  "email": "xyz789",
+  "firstname": "xyz789",
+  "gender": 987,
+  "is_subscribed": true,
+  "lastname": "xyz789",
+  "middlename": "abc123",
+  "password": "xyz789",
   "prefix": "abc123",
-  "suffix": "abc123",
+  "suffix": "xyz789",
   "taxvat": "xyz789"
 }
    @@ -42366,15 +42865,15 @@
    Example
    "billing_address": OrderAddress, "carrier": "abc123", "comments": [SalesCommentItem], - "created_at": "abc123", + "created_at": "xyz789", "credit_memos": [CreditMemo], "customer_info": OrderCustomerInfo, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, "grand_total": 987.65, - "id": "4", + "id": 4, "increment_id": "xyz789", "invoices": [Invoice], "is_virtual": false, @@ -42382,14 +42881,14 @@
    Example
    "items_eligible_for_return": [OrderItemInterface], "number": "xyz789", "order_date": "xyz789", - "order_number": "abc123", + "order_number": "xyz789", "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], - "printed_card_included": false, + "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "xyz789", + "shipping_method": "abc123", "status": "abc123", "token": "abc123", "total": OrderTotal @@ -42546,7 +43045,7 @@
    Example
    "date_of_first_order": "xyz789", "items": [CustomerOrder], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 }
    @@ -42698,16 +43197,16 @@
    Example
    back to top
    -
    +
    Types
    -

    CustomerSegment

    +

    CustomerSegmentStorefront

    Description
    -

    Customer segment.

    +

    Customer segment details

    Fields
    @@ -42720,76 +43219,9 @@
    Fields
    - apply_to - CustomerSegmentApplyTo! - - Customer segment is applicable to visitor, registered customer or both. - - - description - String - - Customer segment description. - - - name - String! - - Customer segment name. - - - -
    -
    -
    -
    -
    Example
    - 
    {
-  "apply_to": "BOTH",
-  "description": "abc123",
-  "name": "xyz789"
-}
-
    -
    -
    - back to top -
    -
    -
    -
    - Types -
    -

    CustomerSegmentApplyTo

    -
    -
    -
    -
    Description
    -

    Customer segment is applicable to visitor, registered customers or both.

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

    BOTH

    -     		Customer segment is applicable to visitor and registered customers.
    -

    REGISTERED

    -     		Customer segment is applicable to registered customers.
    -

    VISITOR

    +     		uid - ID! Customer segment is applicable to visitors/guests. The unique ID for a CustomerSegment object.
    @@ -42798,7 +43230,7 @@
    Values
    Example
    - 
    "BOTH"
+                  
    {"uid": "4"}
    @@ -42870,7 +43302,7 @@
    Example
    {
   "balance_history": CustomerStoreCreditHistory,
   "current_balance": Money,
-  "enabled": false
+  "enabled": true
 }
    @@ -42924,7 +43356,7 @@
    Example
    {
   "items": [CustomerStoreCreditHistoryItem],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
    @@ -43025,7 +43457,7 @@
    Fields
    Example
    - 
    {"token": "abc123"}
+                  
    {"token": "xyz789"}
    @@ -43138,13 +43570,13 @@
    Example
    "custom_attributes": [AttributeValueInput], "date_of_birth": "xyz789", "dob": "xyz789", - "firstname": "xyz789", + "firstname": "abc123", "gender": 123, "is_subscribed": true, "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "prefix": "xyz789", - "suffix": "abc123", + "suffix": "xyz789", "taxvat": "xyz789" }     @@ -43221,8 +43653,8 @@
    Example
    "option_id": 987, "product_sku": "xyz789", "required": false, - "sort_order": 987, - "title": "xyz789", + "sort_order": 123, + "title": "abc123", "uid": "4", "value": CustomizableAreaValue } @@ -43289,7 +43721,7 @@
    Example
    "max_characters": 123, "price": 123.45, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "uid": 4 }     @@ -43359,10 +43791,10 @@
    Fields
    Example
    {
   "option_id": 123,
-  "required": true,
+  "required": false,
   "sort_order": 987,
-  "title": "abc123",
-  "uid": "4",
+  "title": "xyz789",
+  "uid": 4,
   "value": [CustomizableCheckboxValue]
 }
    @@ -43436,12 +43868,12 @@
    Fields
    Example
    {
   "option_type_id": 123,
-  "price": 123.45,
+  "price": 987.65,
   "price_type": "FIXED",
   "sku": "xyz789",
   "sort_order": 987,
   "title": "xyz789",
-  "uid": 4
+  "uid": "4"
 }
    @@ -43514,12 +43946,12 @@
    Fields
    Example
    {
-  "option_id": 123,
-  "product_sku": "xyz789",
-  "required": true,
-  "sort_order": 123,
+  "option_id": 987,
+  "product_sku": "abc123",
+  "required": false,
+  "sort_order": 987,
   "title": "abc123",
-  "uid": "4",
+  "uid": 4,
   "value": CustomizableDateValue
 }
    @@ -43640,9 +44072,9 @@
    Example
    {
   "price": 987.65,
   "price_type": "FIXED",
-  "sku": "abc123",
+  "sku": "xyz789",
   "type": "DATE",
-  "uid": 4
+  "uid": "4"
 }
    @@ -43710,10 +44142,10 @@
    Fields
    Example
    {
-  "option_id": 987,
+  "option_id": 123,
   "required": true,
   "sort_order": 987,
-  "title": "abc123",
+  "title": "xyz789",
   "uid": "4",
   "value": [CustomizableDropDownValue]
 }
@@ -43787,11 +44219,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "option_type_id": 987,
+  "option_type_id": 123,
   "price": 987.65,
   "price_type": "FIXED",
   "sku": "xyz789",
-  "sort_order": 987,
+  "sort_order": 123,
   "title": "xyz789",
   "uid": 4
 }
@@ -43871,7 +44303,7 @@ 
    Example
    
   "required": false,
   "sort_order": 987,
   "title": "xyz789",
-  "uid": 4,
+  "uid": "4",
   "value": CustomizableFieldValue
 }
 
    
@@ -43934,11 +44366,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "max_characters": 987,
-  "price": 123.45,
+  "max_characters": 123,
+  "price": 987.65,
   "price_type": "FIXED",
   "sku": "abc123",
-  "uid": 4
+  "uid": "4"
 }
 
    
                 
    
@@ -44011,12 +44443,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "option_id": 123,
-  "product_sku": "xyz789",
+  "option_id": 987,
+  "product_sku": "abc123",
   "required": false,
-  "sort_order": 987,
+  "sort_order": 123,
   "title": "xyz789",
-  "uid": "4",
+  "uid": 4,
   "value": CustomizableFileValue
 }
 
    
@@ -44089,13 +44521,13 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "file_extension": "abc123",
-  "image_size_x": 123,
+  "file_extension": "xyz789",
+  "image_size_x": 987,
   "image_size_y": 987,
-  "price": 123.45,
+  "price": 987.65,
   "price_type": "FIXED",
-  "sku": "abc123",
-  "uid": "4"
+  "sku": "xyz789",
+  "uid": 4
 }
 
    
                 
    
@@ -44167,7 +44599,7 @@ 
    Example
    
   "required": false,
   "sort_order": 987,
   "title": "abc123",
-  "uid": 4,
+  "uid": "4",
   "value": [CustomizableMultipleValue]
 }
    @@ -44240,13 +44672,13 @@
    Fields
    Example
    {
-  "option_type_id": 123,
-  "price": 987.65,
+  "option_type_id": 987,
+  "price": 123.45,
   "price_type": "FIXED",
-  "sku": "abc123",
+  "sku": "xyz789",
   "sort_order": 987,
-  "title": "xyz789",
-  "uid": 4
+  "title": "abc123",
+  "uid": "4"
 }
    @@ -44418,11 +44850,11 @@
    Possible Types
    Example
    {
-  "option_id": 987,
+  "option_id": 123,
   "required": true,
   "sort_order": 123,
   "title": "abc123",
-  "uid": 4
+  "uid": "4"
 }
    @@ -44485,12 +44917,12 @@
    Possible Types
    -

    BundleProduct

    +

    DownloadableProduct

    -

    DownloadableProduct

    +

    BundleProduct

    @@ -44575,7 +45007,7 @@
    Example
    "option_id": 123, "required": true, "sort_order": 123, - "title": "xyz789", + "title": "abc123", "uid": 4, "value": [CustomizableRadioValue] } @@ -44650,12 +45082,12 @@
    Fields
    Example
    {
   "option_type_id": 123,
-  "price": 123.45,
+  "price": 987.65,
   "price_type": "FIXED",
   "sku": "abc123",
-  "sort_order": 123,
-  "title": "abc123",
-  "uid": "4"
+  "sort_order": 987,
+  "title": "xyz789",
+  "uid": 4
 }
    @@ -44696,7 +45128,7 @@
    Fields
    Example
    - 
    {"success": false}
+                  
    {"success": true}
    @@ -44816,7 +45248,7 @@
    Fields
    Example
    - 
    {"result": false}
+                  
    {"result": true}
    @@ -44991,7 +45423,7 @@
    Fields
    Example
    - 
    {"template_id": "4"}
+                  
    {"template_id": 4}
    @@ -45028,7 +45460,7 @@
    Fields
    Example
    - 
    {"quote_uids": [4]}
+                  
    {"quote_uids": ["4"]}
    @@ -45160,7 +45592,7 @@
    Fields
    Example
    {
   "customerPaymentTokens": CustomerPaymentTokens,
-  "result": false
+  "result": true
 }
    @@ -45292,7 +45724,7 @@
    Fields
    Example
    - 
    {"approval_rule_uids": ["4"]}
+                  
    {"approval_rule_uids": [4]}
    @@ -45462,7 +45894,7 @@
    Fields
    Example
    - 
    {"status": false, "wishlists": [Wishlist]}
+                  
    {"status": true, "wishlists": [Wishlist]}
    @@ -45536,7 +45968,7 @@
    Example
    "amount": Money, "applied_to": "ITEM", "coupon": AppliedCoupon, - "is_discounting_locked": true, + "is_discounting_locked": false, "label": "xyz789", "type": "xyz789", "value": 987.65 @@ -45664,9 +46096,9 @@
    Example
    "id": "xyz789", "is_available": false, "links": [DownloadableProductLinks], - "max_qty": 987.65, + "max_qty": 123.45, "min_qty": 987.65, - "not_available_message": "abc123", + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -45883,11 +46315,11 @@
    Example
    {
   "discounts": [Discount],
   "downloadable_links": [DownloadableItemsLinks],
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "abc123",
+  "product_sku": "xyz789",
   "quantity_invoiced": 123.45
 }
    @@ -45942,7 +46374,7 @@
    Example
    {
   "sort_order": 987,
   "title": "abc123",
-  "uid": "4"
+  "uid": 4
 }
    @@ -46096,25 +46528,25 @@
    Example
    {
   "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": "xyz789",
   "product_sale_price": Money,
   "product_sku": "xyz789",
-  "product_type": "abc123",
-  "product_url_key": "abc123",
-  "quantity_canceled": 123.45,
+  "product_type": "xyz789",
+  "product_url_key": "xyz789",
+  "quantity_canceled": 987.65,
   "quantity_invoiced": 987.65,
   "quantity_ordered": 123.45,
   "quantity_refunded": 987.65,
-  "quantity_return_requested": 123.45,
-  "quantity_returned": 123.45,
-  "quantity_shipped": 123.45,
+  "quantity_return_requested": 987.65,
+  "quantity_returned": 987.65,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
   "status": "xyz789"
 }
@@ -46145,13 +46577,6 @@ 
    Fields
    
                       
                     
                     
-                      
-                        activity - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         attribute_set_id - Int
                         
@@ -46168,27 +46593,6 @@ 
    Fields
    
                         
                          The categories assigned to a product. 
                       
-                      
-                        category_gear - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        climate - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        collar - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         color - Int
                         
@@ -46245,41 +46649,6 @@ 
    filters
                         
                          An array containing information about samples of this downloadable product. 
                       
-                      
-                        eco_collection - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        erin_recommends - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        features_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        format - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        gender - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         gift_message_available - Boolean!
                         
@@ -46327,13 +46696,6 @@ 
    filters
                          A number representing the product's manufacturer. Use the custom_attributes field instead.
                         
                       
-                      
-                        material - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         max_sale_qty - Float
                         
@@ -46375,13 +46737,6 @@ 
    filters
                         
                          The product name. Customers use this name to identify the product. 
                       
-                      
-                        new - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         new_from_date - String
                         
@@ -46407,20 +46762,6 @@ 
    filters
                         
                          If the product has multiple options, determines where they appear on the product page. 
                       
-                      
-                        pattern - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        performance_fabric - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         price - ProductPrices
                         
@@ -46442,13 +46783,6 @@ 
    filters
                         
                          An array of ProductLinks objects. 
                       
-                      
-                        purpose - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         quantity - Float
                         
@@ -46503,42 +46837,16 @@ 
    currentPage
                         
                       
-                      
-                        rules - [CatalogRule]
-                        
-                         Provides applied catalog rules in the current active cart 
-                      
-                      
-                        sale - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         short_description - ComplexTextValue
                         
                          A short description of the product. Its use depends on the theme. 
                       
-                      
-                        size - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         sku - String
                         
                          A number or code assigned to a product to identify the product, options, price, and manufacturer. 
                       
-                      
-                        sleeve - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         small_image - ProductImage
                         
@@ -46570,34 +46878,6 @@ 
    currentPage
                          Stock status of the product 
                       
-                      
-                        strap_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_bottom - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_general - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         swatch_image - String
                         
@@ -46683,15 +46963,11 @@ 
    currentPage
                   
    Example
    
                   
    {
-  "activity": "abc123",
-  "attribute_set_id": 987,
-  "canonical_url": "xyz789",
+  "attribute_set_id": 123,
+  "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "abc123",
-  "collar": "xyz789",
-  "color": 123,
-  "country_of_manufacture": "xyz789",
+  "color": 987,
+  "country_of_manufacture": "abc123",
   "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
@@ -46702,78 +46978,60 @@ 
    Example
    
   "downloadable_product_samples": [
     DownloadableProductSamples
   ],
-  "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": 123,
   "image": ProductImage,
-  "is_returnable": "abc123",
+  "is_returnable": "xyz789",
   "links_purchased_separately": 123,
   "links_title": "abc123",
-  "manufacturer": 987,
-  "material": "xyz789",
-  "max_sale_qty": 123.45,
+  "manufacturer": 123,
+  "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
   "meta_description": "abc123",
-  "meta_keyword": "xyz789",
-  "meta_title": "abc123",
-  "min_sale_qty": 987.65,
+  "meta_keyword": "abc123",
+  "meta_title": "xyz789",
+  "min_sale_qty": 123.45,
   "name": "abc123",
-  "new": 987,
   "new_from_date": "abc123",
-  "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",
-  "pattern": "xyz789",
-  "performance_fabric": 123,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 987,
-  "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",
+  "relative_url": "xyz789",
   "review_count": 123,
   "reviews": ProductReviews,
-  "rules": [CatalogRule],
-  "sale": 123,
   "short_description": ComplexTextValue,
-  "size": 123,
-  "sku": "abc123",
-  "sleeve": "abc123",
+  "sku": "xyz789",
   "small_image": ProductImage,
   "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": "xyz789",
-  "style_bottom": "abc123",
-  "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",
+  "uid": "4",
+  "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
   "url_key": "abc123",
-  "url_path": "abc123",
+  "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "xyz789",
+  "url_suffix": "abc123",
   "websites": [Website]
 }
 
    
@@ -46937,17 +47195,17 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": 987,
-  "is_shareable": true,
+  "id": 123,
+  "is_shareable": false,
   "link_type": "FILE",
-  "number_of_downloads": 123,
+  "number_of_downloads": 987,
   "price": 987.65,
-  "sample_file": "abc123",
+  "sample_file": "xyz789",
   "sample_type": "FILE",
   "sample_url": "abc123",
   "sort_order": 987,
   "title": "xyz789",
-  "uid": 4
+  "uid": "4"
 }
 
    
                 
    
@@ -47061,12 +47319,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": 123,
+  "id": 987,
   "sample_file": "abc123",
   "sample_type": "FILE",
-  "sample_url": "abc123",
+  "sample_url": "xyz789",
   "sort_order": 987,
-  "title": "abc123"
+  "title": "xyz789"
 }
 
    
                 
    
@@ -47138,7 +47396,7 @@ 
    Example
    
   "product": ProductInterface,
   "quantity": 987.65,
   "samples": [DownloadableProductSamples],
-  "uid": "4"
+  "uid": 4
 }
    @@ -47215,10 +47473,10 @@
    Fields
    Example
    {
-  "added_at": "xyz789",
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
-  "id": 4,
+  "description": "abc123",
+  "id": "4",
   "links_v2": [DownloadableProductLinks],
   "product": ProductInterface,
   "quantity": 123.45,
@@ -47271,8 +47529,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "duplicated_quote_uid": 4,
-  "quote_uid": "4"
+  "duplicated_quote_uid": "4",
+  "quote_uid": 4
 }
 
    
                 
    
@@ -47647,7 +47905,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "attribute_code": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
    @@ -47764,9 +48022,9 @@
    Fields
    Example
    {
-  "canonical_url": "abc123",
+  "canonical_url": "xyz789",
   "entity_uid": 4,
-  "id": 987,
+  "id": 123,
   "redirectCode": 987,
   "relative_url": "abc123",
   "type": "CMS_PAGE"
@@ -47839,7 +48097,7 @@ 
    Possible Types
    
                   
    Example
    
                   
    {
   "code": "PRODUCT_NOT_FOUND",
-  "message": "xyz789"
+  "message": "abc123"
 }
    @@ -47958,7 +48216,7 @@
    Fields
    Example
    {
   "country_code": "AF",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": CustomerAddressRegionInput
 }
    @@ -48054,6 +48312,95 @@
    Fields
    Example
    {"cart": Cart}
+
    +
    + + back to top + +
    +
    +
    + Types +
    +

    ExchangeExternalCustomerTokenInput

    +
    +
    +
    +
    Description
    +

    Contains details about external customer.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + customer - CustomerCreateInput! + An input object that defines the customer characteristics to update.
    +
    +
    +
    +
    +
    Example
    + 
    {"customer": CustomerCreateInput}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    ExchangeExternalCustomerTokenOutput

    +
    +
    +
    +
    Description
    +

    Contains customer token for external customer.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    customer - Customer! + Return detailed information about a customer account.
    token - String! + The customer authorization token.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "customer": Customer,
+  "token": "abc123"
+}
    @@ -48098,7 +48445,137 @@
    Fields
    Example
    - 
    {"currency_to": "xyz789", "rate": 123.45}
+                  
    {"currency_to": "xyz789", "rate": 987.65}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    FastlaneConfig

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

    FastlaneMethodInput

    +
    +
    +
    +
    Description
    +

    Fastlane Payment inputs

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + payment_source - String + The payment source for the payment method
    + paypal_fastlane_token - String + The single use token from Fastlane
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "payment_source": "xyz789",
+  "paypal_fastlane_token": "xyz789"
+}
    @@ -48146,8 +48623,8 @@
    Fields
    Example
    {
-  "eq": "abc123",
-  "in": ["xyz789"]
+  "eq": "xyz789",
+  "in": ["abc123"]
 }
    @@ -48289,7 +48766,7 @@
    Fields
    Example
    {
   "from": "abc123",
-  "to": "abc123"
+  "to": "xyz789"
 }
    @@ -48345,7 +48822,7 @@
    Fields
    Example
    {
   "eq": "xyz789",
-  "in": ["xyz789"],
+  "in": ["abc123"],
   "match": "abc123"
 }
    @@ -48475,15 +48952,15 @@
    Fields
    Example
    {
   "eq": "abc123",
-  "finset": ["abc123"],
+  "finset": ["xyz789"],
   "from": "xyz789",
   "gt": "abc123",
   "gteq": "abc123",
-  "in": ["xyz789"],
+  "in": ["abc123"],
   "like": "xyz789",
-  "lt": "xyz789",
-  "lteq": "xyz789",
-  "moreq": "abc123",
+  "lt": "abc123",
+  "lteq": "abc123",
+  "moreq": "xyz789",
   "neq": "abc123",
   "nin": ["abc123"],
   "notnull": "xyz789",
@@ -48624,7 +49101,7 @@ 
    Description
    
               
    
                 
    
                   
    Example
    
-                  
    123.45
+                  
    987.65
 
    
                 
    
               
    
@@ -48705,7 +49182,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"customer_token": "xyz789"}
+                  
    {"customer_token": "abc123"}
 
    
                 
    
               
    
@@ -48746,7 +49223,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"template_id": 4}
+                  
    {"template_id": "4"}
 
    
                 
    
               
    
@@ -48879,7 +49356,7 @@ 
    Example
    
                   
    {
   "balance": Money,
   "code": "xyz789",
-  "expiration_date": "abc123"
+  "expiration_date": "xyz789"
 }
 
    
                 
@@ -48921,7 +49398,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"gift_card_code": "xyz789"}
+                  
    {"gift_card_code": "abc123"}
 
    
                 
    
               
    
@@ -48990,10 +49467,10 @@ 
    Example
    
                   
    {
   "attribute_id": 123,
   "uid": "4",
-  "value": 123.45,
-  "value_id": 987,
-  "website_id": 123,
-  "website_value": 123.45
+  "value": 987.65,
+  "value_id": 123,
+  "website_id": 987,
+  "website_value": 987.65
 }
 
    
                 
@@ -49155,20 +49632,20 @@ 
    Example
    
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
   "id": "abc123",
-  "is_available": false,
-  "max_qty": 987.65,
-  "message": "xyz789",
+  "is_available": true,
+  "max_qty": 123.45,
+  "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,
+  "quantity": 987.65,
   "recipient_email": "abc123",
-  "recipient_name": "xyz789",
-  "sender_email": "abc123",
-  "sender_name": "xyz789",
+  "recipient_name": "abc123",
+  "sender_email": "xyz789",
+  "sender_name": "abc123",
   "uid": 4
 }
    @@ -49248,8 +49725,8 @@
    Example
    "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 123.45 + "product_sku": "xyz789", + "quantity_refunded": 987.65 }     @@ -49324,12 +49801,12 @@
    Example
    {
   "discounts": [Discount],
   "gift_card": GiftCardItem,
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "quantity_invoiced": 987.65
+  "product_sku": "abc123",
+  "quantity_invoiced": 123.45
 }
    @@ -49393,9 +49870,9 @@
    Example
    {
   "message": "abc123",
   "recipient_email": "abc123",
-  "recipient_name": "abc123",
-  "sender_email": "xyz789",
-  "sender_name": "abc123"
+  "recipient_name": "xyz789",
+  "sender_email": "abc123",
+  "sender_name": "xyz789"
 }
    @@ -49469,11 +49946,11 @@
    Example
    {
   "amount": Money,
   "custom_giftcard_amount": Money,
-  "message": "abc123",
-  "recipient_email": "abc123",
-  "recipient_name": "abc123",
-  "sender_email": "abc123",
-  "sender_name": "xyz789"
+  "message": "xyz789",
+  "recipient_email": "xyz789",
+  "recipient_name": "xyz789",
+  "sender_email": "xyz789",
+  "sender_name": "abc123"
 }
    @@ -49622,7 +50099,7 @@
    Fields
    Example
    {
   "discounts": [Discount],
-  "eligible_for_return": false,
+  "eligible_for_return": true,
   "entered_options": [OrderItemOption],
   "gift_card": GiftCardItem,
   "gift_message": GiftMessage,
@@ -49633,15 +50110,15 @@ 
    Example
    
   "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "xyz789",
-  "product_type": "xyz789",
-  "product_url_key": "xyz789",
+  "product_type": "abc123",
+  "product_url_key": "abc123",
   "quantity_canceled": 987.65,
-  "quantity_invoiced": 987.65,
+  "quantity_invoiced": 123.45,
   "quantity_ordered": 123.45,
-  "quantity_refunded": 987.65,
+  "quantity_refunded": 123.45,
   "quantity_return_requested": 123.45,
   "quantity_returned": 123.45,
-  "quantity_shipped": 123.45,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
   "status": "abc123"
 }
@@ -49672,13 +50149,6 @@ 
    Fields
    
                       
                     
                     
-                      
-                        activity - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         allow_message - Boolean
                         
@@ -49705,27 +50175,6 @@ 
    Fields
    
                         
                          The categories assigned to a product. 
                       
-                      
-                        category_gear - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        climate - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        collar - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         color - Int
                         
@@ -49772,41 +50221,6 @@ 
    filters
                         
                          Detailed information about the product. The value can include simple HTML tags. 
                       
-                      
-                        eco_collection - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        erin_recommends - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        features_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        format - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        gender - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         gift_card_options - [CustomizableOptionInterface]!
                         
@@ -49869,13 +50283,6 @@ 
    filters
                          A number representing the product's manufacturer. Use the custom_attributes field instead.
                         
                       
-                      
-                        material - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         max_sale_qty - Float
                         
@@ -49922,13 +50329,6 @@ 
    filters
                         
                          The product name. Customers use this name to identify the product. 
                       
-                      
-                        new - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         new_from_date - String
                         
@@ -49964,20 +50364,6 @@ 
    filters
                         
                          If the product has multiple options, determines where they appear on the product page. 
                       
-                      
-                        pattern - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        performance_fabric - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         price - ProductPrices
                         
@@ -49999,13 +50385,6 @@ 
    filters
                         
                          An array of ProductLinks objects. 
                       
-                      
-                        purpose - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         quantity - Float
                         
@@ -50060,42 +50439,16 @@ 
    currentPage
                         
                       
-                      
-                        rules - [CatalogRule]
-                        
-                         Provides applied catalog rules in the current active cart 
-                      
-                      
-                        sale - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         short_description - ComplexTextValue
                         
                          A short description of the product. Its use depends on the theme. 
                       
-                      
-                        size - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         sku - String
                         
                          A number or code assigned to a product to identify the product, options, price, and manufacturer. 
                       
-                      
-                        sleeve - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         small_image - ProductImage
                         
@@ -50127,34 +50480,6 @@ 
    currentPage
                          Stock status of the product 
                       
-                      
-                        strap_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_bottom - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_general - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         swatch_image - String
                         
@@ -50245,28 +50570,19 @@ 
    currentPage
                   
    Example
    
                   
    {
-  "activity": "abc123",
-  "allow_message": true,
-  "allow_open_amount": true,
-  "attribute_set_id": 123,
+  "allow_message": false,
+  "allow_open_amount": false,
+  "attribute_set_id": 987,
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "xyz789",
-  "collar": "abc123",
-  "color": 123,
+  "color": 987,
   "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": "abc123",
-  "format": 123,
-  "gender": "abc123",
   "gift_card_options": [CustomizableOptionInterface],
-  "gift_message_available": false,
+  "gift_message_available": true,
   "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
   "giftcard_amounts": [GiftCardAmounts],
@@ -50274,70 +50590,57 @@ 
    Example
    
   "id": 123,
   "image": ProductImage,
   "is_redeemable": false,
-  "is_returnable": "abc123",
-  "lifetime": 987,
-  "manufacturer": 987,
-  "material": "xyz789",
+  "is_returnable": "xyz789",
+  "lifetime": 123,
+  "manufacturer": 123,
   "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "message_max_length": 123,
-  "meta_description": "xyz789",
+  "message_max_length": 987,
+  "meta_description": "abc123",
   "meta_keyword": "xyz789",
-  "meta_title": "xyz789",
-  "min_sale_qty": 987.65,
+  "meta_title": "abc123",
+  "min_sale_qty": 123.45,
   "name": "xyz789",
-  "new": 123,
-  "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,
   "open_amount_max": 987.65,
-  "open_amount_min": 123.45,
+  "open_amount_min": 987.65,
   "options": [CustomizableOptionInterface],
   "options_container": "abc123",
-  "pattern": "xyz789",
-  "performance_fabric": 987,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 987,
   "quantity": 987.65,
-  "rating_summary": 123.45,
-  "redirect_code": 123,
+  "rating_summary": 987.65,
+  "redirect_code": 987,
   "related_products": [ProductInterface],
   "relative_url": "abc123",
   "review_count": 987,
   "reviews": ProductReviews,
-  "rules": [CatalogRule],
-  "sale": 123,
   "short_description": ComplexTextValue,
-  "size": 123,
   "sku": "xyz789",
-  "sleeve": "xyz789",
   "small_image": ProductImage,
   "special_from_date": "abc123",
-  "special_price": 987.65,
-  "special_to_date": "xyz789",
+  "special_price": 123.45,
+  "special_to_date": "abc123",
   "staged": true,
   "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
-  "style_bags": "xyz789",
-  "style_bottom": "abc123",
-  "style_general": "abc123",
-  "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",
+  "type_id": "xyz789",
   "uid": "4",
-  "updated_at": "abc123",
+  "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
 }
@@ -50476,7 +50779,7 @@ 
    Example
    
   "gift_card": GiftCardItem,
   "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "xyz789",
   "quantity_shipped": 987.65
@@ -50613,7 +50916,55 @@ 
    Example
    
   "gift_card_options": GiftCardOptions,
   "id": "4",
   "product": ProductInterface,
-  "quantity": 123.45
+  "quantity": 987.65
+}
+
    
+                
+              
+              back to top
+            
+
    +
    +
    + Types +
    +

    GiftCartAttributeValue

    +
    +
    +
    +
    Description
    +

    Gift card custom attribute value containing array data.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    code - ID! + The attribute code.
    options - [String]! + Array of gift card attribute option values.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "code": "4",
+  "options": ["xyz789"]
 }
    @@ -50666,8 +51017,8 @@
    Fields
    Example
    {
   "from": "xyz789",
-  "message": "xyz789",
-  "to": "xyz789"
+  "message": "abc123",
+  "to": "abc123"
 }
    @@ -50722,9 +51073,9 @@
    Fields
    Example
    {
-  "from": "abc123",
-  "message": "xyz789",
-  "to": "abc123"
+  "from": "xyz789",
+  "message": "abc123",
+  "to": "xyz789"
 }
    @@ -50893,7 +51244,7 @@
    Fields
    Example
    {
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "dynamic_attributes": [GiftRegistryDynamicAttribute],
   "event_name": "abc123",
   "items": [GiftRegistryItemInterface],
@@ -50904,7 +51255,7 @@ 
    Example
    
   "shipping_address": CustomerAddress,
   "status": "ACTIVE",
   "type": GiftRegistryType,
-  "uid": "4"
+  "uid": 4
 }
    @@ -50959,8 +51310,8 @@
    Example
    {
   "code": "4",
   "group": "EVENT_INFORMATION",
-  "label": "abc123",
-  "value": "xyz789"
+  "label": "xyz789",
+  "value": "abc123"
 }
    @@ -51085,7 +51436,10 @@
    Fields
    Example
    - 
    {"code": 4, "value": "abc123"}
+                  
    {
+  "code": "4",
+  "value": "abc123"
+}
    @@ -51219,11 +51573,11 @@
    Fields
    Example
    {
-  "attribute_group": "xyz789",
+  "attribute_group": "abc123",
   "code": 4,
-  "input_type": "abc123",
+  "input_type": "xyz789",
   "is_required": false,
-  "label": "abc123",
+  "label": "xyz789",
   "sort_order": 987
 }
    @@ -51304,10 +51658,10 @@
    Possible Types
    Example
    {
-  "attribute_group": "abc123",
+  "attribute_group": "xyz789",
   "code": 4,
-  "input_type": "xyz789",
-  "is_required": false,
+  "input_type": "abc123",
+  "is_required": true,
   "label": "abc123",
   "sort_order": 987
 }
@@ -51377,7 +51731,7 @@ 
    Example
    
   "product": ProductInterface,
   "quantity": 987.65,
   "quantity_fulfilled": 987.65,
-  "uid": "4"
+  "uid": 4
 }
    @@ -51460,7 +51814,7 @@
    Example
    "created_at": "abc123", "note": "xyz789", "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "quantity_fulfilled": 123.45, "uid": 4 } @@ -51526,7 +51880,7 @@
    Possible Types
    Example
    {
-  "status": false,
+  "status": true,
   "user_errors": [GiftRegistryItemsUserError]
 }
    @@ -51591,9 +51945,9 @@
    Example
    {
   "code": "OUT_OF_STOCK",
   "gift_registry_item_uid": "4",
-  "gift_registry_uid": "4",
-  "message": "abc123",
-  "product_uid": 4
+  "gift_registry_uid": 4,
+  "message": "xyz789",
+  "product_uid": "4"
 }
    @@ -51817,10 +52171,10 @@
    Example
    "dynamic_attributes": [ GiftRegistryRegistrantDynamicAttribute ], - "email": "abc123", + "email": "xyz789", "firstname": "xyz789", "lastname": "abc123", - "uid": 4 + "uid": "4" }
    @@ -51868,9 +52222,9 @@
    Fields
    Example
    {
-  "code": "4",
+  "code": 4,
   "label": "abc123",
-  "value": "abc123"
+  "value": "xyz789"
 }
    @@ -51938,8 +52292,8 @@
    Fields
    Example
    {
   "event_date": "xyz789",
-  "event_title": "abc123",
-  "gift_registry_uid": "4",
+  "event_title": "xyz789",
+  "gift_registry_uid": 4,
   "location": "abc123",
   "name": "xyz789",
   "type": "xyz789"
@@ -51983,6 +52337,12 @@ 
    Fields
    
                         
                          The ID assigned to this customer address. 
                       
+                      
+                        
+                          customer_address_uid - ID
+                        
+                         The unique ID assigned to this customer address. 
+                      
                     
                   
                 
@@ -51990,7 +52350,11 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"address_data": CustomerAddressInput, "address_id": 4}
+                  
    {
+  "address_data": CustomerAddressInput,
+  "address_id": "4",
+  "customer_address_uid": "4"
+}
 
    
                 
    
               
    
@@ -52093,7 +52457,7 @@ 
    Example
    
   "dynamic_attributes_metadata": [
     GiftRegistryDynamicAttributeMetadataInterface
   ],
-  "label": "xyz789",
+  "label": "abc123",
   "uid": "4"
 }
    @@ -52157,11 +52521,11 @@
    Fields
    Example
    {
-  "design": "xyz789",
+  "design": "abc123",
   "id": 4,
   "image": GiftWrappingImage,
   "price": Money,
-  "uid": "4"
+  "uid": 4
 }
    @@ -52208,8 +52572,8 @@
    Fields
    Example
    {
-  "label": "xyz789",
-  "url": "xyz789"
+  "label": "abc123",
+  "url": "abc123"
 }
    @@ -52258,7 +52622,7 @@
    Fields
    Example
    {
   "color": "xyz789",
-  "height": 123,
+  "height": 987,
   "type": "xyz789"
 }
    @@ -52341,11 +52705,11 @@
    Example
    "code": "abc123", "is_visible": true, "payment_intent": "xyz789", - "payment_source": "abc123", + "payment_source": "xyz789", "sdk_params": [SDKParams], - "sort_order": "xyz789", + "sort_order": "abc123", "three_ds_mode": "OFF", - "title": "xyz789" + "title": "abc123" }     @@ -52400,7 +52764,7 @@
    Fields
    Example
    {
-  "payment_source": "xyz789",
+  "payment_source": "abc123",
   "payments_order_id": "abc123",
   "paypal_order_id": "abc123"
 }
@@ -52431,13 +52795,6 @@ 
    Fields
    
                       
                     
                     
-                      
-                        activity - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         attribute_set_id - Int
                         
@@ -52454,27 +52811,6 @@ 
    Fields
    
                         
                          The categories assigned to a product. 
                       
-                      
-                        category_gear - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        climate - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        collar - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         color - Int
                         
@@ -52521,41 +52857,6 @@ 
    filters
                         
                          Detailed information about the product. The value can include simple HTML tags. 
                       
-                      
-                        eco_collection - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        erin_recommends - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        features_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        format - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        gender - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         gift_message_available - Boolean!
                         
@@ -52598,13 +52899,6 @@ 
    filters
                          A number representing the product's manufacturer. Use the custom_attributes field instead.
                         
                       
-                      
-                        material - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         max_sale_qty - Float
                         
@@ -52646,13 +52940,6 @@ 
    filters
                         
                          The product name. Customers use this name to identify the product. 
                       
-                      
-                        new - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         new_from_date - String
                         
@@ -52673,20 +52960,6 @@ 
    filters
                         
                          If the product has multiple options, determines where they appear on the product page. 
                       
-                      
-                        pattern - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        performance_fabric - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         price - ProductPrices
                         
@@ -52708,13 +52981,6 @@ 
    filters
                         
                          An array of ProductLinks objects. 
                       
-                      
-                        purpose - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         quantity - Float
                         
@@ -52769,42 +53035,16 @@ 
    currentPage
                         
                       
-                      
-                        rules - [CatalogRule]
-                        
-                         Provides applied catalog rules in the current active cart 
-                      
-                      
-                        sale - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         short_description - ComplexTextValue
                         
                          A short description of the product. Its use depends on the theme. 
                       
-                      
-                        size - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         sku - String
                         
                          A number or code assigned to a product to identify the product, options, price, and manufacturer. 
                       
-                      
-                        sleeve - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         small_image - ProductImage
                         
@@ -52836,34 +53076,6 @@ 
    currentPage
                          Stock status of the product 
                       
-                      
-                        strap_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_bottom - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_general - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         swatch_image - String
                         
@@ -52954,91 +53166,69 @@ 
    currentPage
                   
    Example
    
                   
    {
-  "activity": "xyz789",
   "attribute_set_id": 987,
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "abc123",
-  "collar": "abc123",
   "color": 987,
-  "country_of_manufacture": "xyz789",
+  "country_of_manufacture": "abc123",
   "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 987,
-  "erin_recommends": 123,
-  "features_bags": "xyz789",
-  "format": 987,
-  "gender": "xyz789",
-  "gift_message_available": false,
+  "gift_message_available": true,
   "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
-  "id": 987,
+  "id": 123,
   "image": ProductImage,
   "is_returnable": "abc123",
   "items": [GroupedProductItem],
   "manufacturer": 987,
-  "material": "xyz789",
   "max_sale_qty": 123.45,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "xyz789",
-  "meta_keyword": "xyz789",
-  "meta_title": "xyz789",
+  "meta_description": "abc123",
+  "meta_keyword": "abc123",
+  "meta_title": "abc123",
   "min_sale_qty": 987.65,
   "name": "xyz789",
-  "new": 123,
   "new_from_date": "xyz789",
-  "new_to_date": "abc123",
+  "new_to_date": "xyz789",
   "only_x_left_in_stock": 987.65,
-  "options_container": "xyz789",
-  "pattern": "xyz789",
-  "performance_fabric": 987,
+  "options_container": "abc123",
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 987,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "rating_summary": 123.45,
   "redirect_code": 123,
   "related_products": [ProductInterface],
-  "relative_url": "xyz789",
-  "review_count": 123,
+  "relative_url": "abc123",
+  "review_count": 987,
   "reviews": ProductReviews,
-  "rules": [CatalogRule],
-  "sale": 123,
   "short_description": ComplexTextValue,
-  "size": 987,
   "sku": "abc123",
-  "sleeve": "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,
   "stock_status": "IN_STOCK",
-  "strap_bags": "xyz789",
-  "style_bags": "abc123",
-  "style_bottom": "xyz789",
-  "style_general": "abc123",
-  "swatch_image": "xyz789",
+  "swatch_image": "abc123",
   "thumbnail": ProductImage,
-  "tier_price": 987.65,
+  "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": "xyz789",
+  "url_key": "abc123",
   "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "abc123",
+  "url_suffix": "xyz789",
   "websites": [Website],
-  "weight": 123.45
+  "weight": 987.65
 }
    @@ -53092,7 +53282,7 @@
    Example
    {
   "position": 987,
   "product": ProductInterface,
-  "qty": 987.65
+  "qty": 123.45
 }
    @@ -53162,9 +53352,9 @@
    Example
    "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "xyz789", - "id": "4", + "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 }     @@ -53213,8 +53403,65 @@
    Fields
    Example
    {
-  "reason": "xyz789",
-  "token": "xyz789"
+  "reason": "abc123",
+  "token": "abc123"
+}
+
    +
    + + back to top + +
    +
    +
    + Types +
    +

    GuestOrderInformationInput

    +
    +
    +
    +
    Description
    +

    Input to retrieve an order based on details.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + email - String! + Order billing address email.
    + lastname - String! + Order billing address lastname.
    + number - String! + Order number.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "email": "abc123",
+  "lastname": "xyz789",
+  "number": "xyz789"
 }
    @@ -53308,18 +53555,18 @@
    Fields
    Example
    {
-  "cc_vault_code": "xyz789",
-  "code": "abc123",
-  "is_vault_enabled": false,
-  "is_visible": true,
+  "cc_vault_code": "abc123",
+  "code": "xyz789",
+  "is_vault_enabled": true,
+  "is_visible": false,
   "payment_intent": "abc123",
-  "payment_source": "abc123",
-  "requires_card_details": false,
+  "payment_source": "xyz789",
+  "requires_card_details": true,
   "sdk_params": [SDKParams],
-  "sort_order": "abc123",
-  "three_ds": false,
+  "sort_order": "xyz789",
+  "three_ds": true,
   "three_ds_mode": "OFF",
-  "title": "abc123"
+  "title": "xyz789"
 }
    @@ -53410,10 +53657,10 @@
    Fields
    Example
    {
-  "cardBin": "abc123",
+  "cardBin": "xyz789",
   "cardExpiryMonth": "abc123",
-  "cardExpiryYear": "abc123",
-  "cardLast4": "abc123",
+  "cardExpiryYear": "xyz789",
+  "cardLast4": "xyz789",
   "holderName": "abc123",
   "is_active_payment_token_enabler": false,
   "payment_source": "xyz789",
@@ -53467,7 +53714,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cancel_url": "xyz789",
+  "cancel_url": "abc123",
   "return_url": "xyz789"
 }
 
    
@@ -53509,7 +53756,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"secure_form_url": "xyz789"}
+                  
    {"secure_form_url": "abc123"}
 
    
                 
    
               
    
@@ -53550,7 +53797,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
 
    
                 
    
               
    
@@ -53620,7 +53867,7 @@ 
    Description
    
               
    
                 
    
                   
    Example
    
-                  
    "4"
+                  
    4
 
    
                 
    
               
    
@@ -53662,7 +53909,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "thumbnail": "abc123",
+  "thumbnail": "xyz789",
   "value": "abc123"
 }
 
    
@@ -53778,7 +54025,7 @@ 
    Example
    
                   
    {
   "code": "PRODUCT_NOT_FOUND",
   "message": "abc123",
-  "quantity": 987.65
+  "quantity": 123.45
 }
 
    
                 
    
@@ -53841,7 +54088,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"message": "xyz789"}
+                  
    {"message": "abc123"}
 
    
                 
    
               
    
@@ -53975,9 +54222,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "discounts": [Discount],
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "abc123",
   "quantity_invoiced": 123.45
@@ -54058,12 +54305,12 @@ 
    Possible Types
    
                     
                       
                         
-                          
    BundleInvoiceItem
    
+                          
    DownloadableInvoiceItem
    
                         
                       
                       
                         
-                          
    DownloadableInvoiceItem
    
+                          
    BundleInvoiceItem
    
                         
                       
                       
@@ -54085,11 +54332,11 @@ 
    Possible Types
    
                   
    Example
    
                   
    {
   "discounts": [Discount],
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
+  "product_sku": "abc123",
   "quantity_invoiced": 987.65
 }
 
    
@@ -54215,7 +54462,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"is_email_available": true}
+                  
    {"is_email_available": false}
 
    
                 
    
               
    
@@ -54375,7 +54622,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"is_email_available": true}
+                  
    {"is_email_available": false}
 
    
                 
    
               
    
@@ -54444,9 +54691,9 @@ 
    Example
    
   "created_at": "abc123",
   "creator_id": 987,
   "creator_type": 987,
-  "negotiable_quote_item_uid": "4",
-  "note": "abc123",
-  "note_uid": "4"
+  "negotiable_quote_item_uid": 4,
+  "note": "xyz789",
+  "note_uid": 4
 }
 
    
                 
    
@@ -54505,8 +54752,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "id": 4,
-  "label": "xyz789",
-  "uid": 4,
+  "label": "abc123",
+  "uid": "4",
   "values": [ItemSelectedBundleOptionValue]
 }
 
    
@@ -54575,7 +54822,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": "4",
+  "id": 4,
   "price": Money,
   "product_name": "abc123",
   "product_sku": "abc123",
@@ -54627,7 +54874,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "name": "abc123",
+  "name": "xyz789",
   "value": "xyz789"
 }
 
    
@@ -54690,9 +54937,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "filter_items": [LayerFilterItemInterface],
-  "filter_items_count": 123,
-  "name": "abc123",
-  "request_var": "xyz789"
+  "filter_items_count": 987,
+  "name": "xyz789",
+  "request_var": "abc123"
 }
 
    
                 
    
@@ -54743,8 +54990,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "items_count": 123,
-  "label": "abc123",
+  "items_count": 987,
+  "label": "xyz789",
   "value_string": "xyz789"
 }
 
    
@@ -54875,9 +55122,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "note": "xyz789",
-  "quote_item_uid": 4,
-  "quote_uid": "4"
+  "note": "abc123",
+  "quote_item_uid": "4",
+  "quote_uid": 4
 }
 
    
                 
    
@@ -54966,11 +55213,11 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "content": ProductMediaGalleryEntriesContent,
-  "disabled": false,
+  "disabled": true,
   "file": "xyz789",
-  "id": 987,
+  "id": 123,
   "label": "xyz789",
-  "media_type": "abc123",
+  "media_type": "xyz789",
   "position": 123,
   "types": ["abc123"],
   "uid": 4,
@@ -55018,6 +55265,11 @@ 
    Fields
    
                         
                          The media item's position after it has been sorted. 
                       
+                      
+                        types - [String]
+                        
+                         Array of image types. It can have the following values: image, small_image, thumbnail. 
+                      
                       
                         url - String
                         
@@ -55053,9 +55305,10 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "disabled": true,
+  "disabled": false,
   "label": "abc123",
-  "position": 123,
+  "position": 987,
+  "types": ["abc123"],
   "url": "abc123"
 }
 
    
@@ -55093,7 +55346,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"type": "abc123"}
+                  
    {"type": "xyz789"}
 
    
                 
    
               
    
@@ -55234,7 +55487,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "gift_registry": GiftRegistry,
-  "status": true,
+  "status": false,
   "user_errors": [GiftRegistryItemsUserError]
 }
 
    
@@ -55277,7 +55530,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"requisitionListItemUids": ["4"]}
+                  
    {"requisitionListItemUids": [4]}
 
    
                 
    
               
    
@@ -55378,7 +55631,11 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"quote_item_uid": 4, "quote_uid": 4, "requisition_list_uid": 4}
+                  
    {
+  "quote_item_uid": 4,
+  "quote_uid": 4,
+  "requisition_list_uid": "4"
+}
 
    
                 
    
               
    
@@ -55597,19 +55854,19 @@ 
    Example
    
   "billing_address": NegotiableQuoteBillingAddress,
   "buyer": NegotiableQuoteUser,
   "comments": [NegotiableQuoteComment],
-  "created_at": "xyz789",
-  "email": "xyz789",
+  "created_at": "abc123",
+  "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": 987.65,
+  "total_quantity": 123.45,
   "uid": "4",
-  "updated_at": "abc123"
+  "updated_at": "xyz789"
 }
 
    
                 
    
@@ -55657,7 +55914,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "xyz789",
-  "label": "xyz789"
+  "label": "abc123"
 }
 
    
                 
    
@@ -55760,14 +56017,14 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "abc123",
+  "city": "xyz789",
   "company": "xyz789",
-  "country_code": "abc123",
+  "country_code": "xyz789",
   "firstname": "abc123",
   "lastname": "abc123",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "region": "abc123",
-  "region_id": 123,
+  "region_id": 987,
   "save_in_address_book": true,
   "street": ["abc123"],
   "telephone": "xyz789"
@@ -55873,12 +56130,12 @@ 
    Example
    
   "city": "abc123",
   "company": "xyz789",
   "country": NegotiableQuoteAddressCountry,
-  "firstname": "xyz789",
+  "firstname": "abc123",
   "lastname": "abc123",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": NegotiableQuoteAddressRegion,
   "street": ["xyz789"],
-  "telephone": "xyz789"
+  "telephone": "abc123"
 }
 
    
                 
    
@@ -55930,8 +56187,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "abc123",
-  "label": "abc123",
+  "code": "xyz789",
+  "label": "xyz789",
   "region_id": 123
 }
 
    
@@ -56011,10 +56268,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "city": "abc123",
-  "company": "xyz789",
+  "company": "abc123",
   "country": NegotiableQuoteAddressCountry,
   "firstname": "xyz789",
-  "lastname": "xyz789",
+  "lastname": "abc123",
   "postcode": "xyz789",
   "region": NegotiableQuoteAddressRegion,
   "street": ["xyz789"],
@@ -56082,7 +56339,7 @@ 
    Example
    
   "address": NegotiableQuoteAddressInput,
   "customer_address_uid": 4,
   "same_as_shipping": true,
-  "use_for_shipping": false
+  "use_for_shipping": true
 }
 
    
                 
    
@@ -56148,7 +56405,7 @@ 
    Example
    
   "created_at": "xyz789",
   "creator_type": "BUYER",
   "text": "abc123",
-  "uid": 4
+  "uid": "4"
 }
    @@ -56286,7 +56543,7 @@
    Fields
    Example
    {
-  "new_value": "xyz789",
+  "new_value": "abc123",
   "old_value": "xyz789",
   "title": "abc123"
 }
@@ -56892,7 +57149,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"quantity": 987.65, "quote_item_uid": 4}
+                  
    {"quantity": 987.65, "quote_item_uid": "4"}
 
    
                 
    
               
    
@@ -56941,7 +57198,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "xyz789",
-  "purchase_order_number": "abc123"
+  "purchase_order_number": "xyz789"
 }
    @@ -57001,7 +57258,7 @@
    Example
    "document_identifier": "xyz789", "document_name": "abc123", "link_id": 4, - "reference_document_url": "xyz789" + "reference_document_url": "abc123" }
    @@ -57090,15 +57347,15 @@
    Fields
    Example
    {
   "available_shipping_methods": [AvailableShippingMethod],
-  "city": "abc123",
-  "company": "abc123",
+  "city": "xyz789",
+  "company": "xyz789",
   "country": NegotiableQuoteAddressCountry,
   "firstname": "abc123",
   "lastname": "xyz789",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": NegotiableQuoteAddressRegion,
   "selected_shipping_method": SelectedShippingMethod,
-  "street": ["abc123"],
+  "street": ["xyz789"],
   "telephone": "xyz789"
 }
    @@ -57155,8 +57412,8 @@
    Fields
    Example
    {
   "address": NegotiableQuoteAddressInput,
-  "customer_address_uid": 4,
-  "customer_notes": "xyz789"
+  "customer_address_uid": "4",
+  "customer_notes": "abc123"
 }
    @@ -57470,13 +57727,13 @@
    Example
    {
   "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,
+  "max_order_commitment": 123,
+  "min_order_commitment": 987,
   "name": "xyz789",
   "notifications": [QuoteTemplateNotificationMessage],
   "prices": CartPrices,
@@ -57485,7 +57742,7 @@ 
    Example
    
   ],
   "shipping_addresses": [NegotiableQuoteShippingAddress],
   "status": "xyz789",
-  "template_id": "4",
+  "template_id": 4,
   "total_quantity": 987.65
 }
    @@ -57648,20 +57905,20 @@
    Fields
    Example
    {
-  "activated_at": "abc123",
+  "activated_at": "xyz789",
   "company_name": "abc123",
   "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": 123.45,
+  "max_order_commitment": 987,
+  "min_negotiated_grand_total": 987.65,
   "min_order_commitment": 123,
-  "name": "xyz789",
+  "name": "abc123",
   "orders_placed": 987,
   "sales_rep_name": "xyz789",
   "state": "xyz789",
-  "status": "abc123",
-  "submitted_by": "xyz789",
+  "status": "xyz789",
+  "submitted_by": "abc123",
   "template_id": 4
 }
    @@ -57726,7 +57983,7 @@
    Example
    "item_id": "4", "max_qty": 987.65, "min_qty": 987.65, - "quantity": 987.65 + "quantity": 123.45 }
    @@ -57787,8 +58044,8 @@
    Fields
    Example
    {
-  "document_identifier": "abc123",
-  "document_name": "abc123",
+  "document_identifier": "xyz789",
+  "document_name": "xyz789",
   "link_id": "4",
   "reference_document_url": "xyz789"
 }
@@ -57997,7 +58254,7 @@ 
    Example
    
   "items": [NegotiableQuoteTemplateGridItem],
   "page_info": SearchResultPageInfo,
   "sort_fields": SortFields,
-  "total_count": 987
+  "total_count": 123
 }
    @@ -58051,7 +58308,7 @@
    Possible Types
    Example
    - 
    {"quote_uid": 4}
+                  
    {"quote_uid": "4"}
    @@ -58137,8 +58394,8 @@
    Fields
    Example
    {
-  "firstname": "xyz789",
-  "lastname": "abc123"
+  "firstname": "abc123",
+  "lastname": "xyz789"
 }
    @@ -58288,7 +58545,7 @@
    Fields
    Example
    - 
    {"template_id": "4"}
+                  
    {"template_id": 4}
    @@ -58336,8 +58593,8 @@
    Fields
    Example
    {
-  "order_id": "abc123",
-  "order_number": "xyz789"
+  "order_id": "xyz789",
+  "order_number": "abc123"
 }
    @@ -58534,11 +58791,11 @@
    Example
    "postcode": "abc123", "prefix": "xyz789", "region": "abc123", - "region_id": "4", - "street": ["abc123"], + "region_id": 4, + "street": ["xyz789"], "suffix": "abc123", - "telephone": "xyz789", - "vat_id": "xyz789" + "telephone": "abc123", + "vat_id": "abc123" }     @@ -58596,69 +58853,12 @@
    Fields
    Example
    {
-  "firstname": "xyz789",
-  "lastname": "abc123",
+  "firstname": "abc123",
+  "lastname": "xyz789",
   "middlename": "xyz789",
   "prefix": "xyz789",
   "suffix": "xyz789"
 }
-
    -
    - - back to top - -
    -
    -
    - Types -
    -

    OrderInformationInput

    -
    -
    -
    -
    Description
    -

    Input to retrieve an order based on details.

    -
    -
    -
    Fields
    - - - - - - - - - - - - - - - - - - - - - -
    Input FieldDescription
    - email - String! - Order billing address email.
    - lastname - String! - Order billing address lastname.
    - number - String! - Order number.
    -
    -
    -
    -
    -
    Example
    - 
    {
-  "email": "abc123",
-  "lastname": "abc123",
-  "number": "abc123"
-}
    @@ -58808,18 +59008,18 @@
    Example
    "id": "4", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "product_type": "xyz789", - "product_url_key": "abc123", + "product_sku": "abc123", + "product_type": "abc123", + "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": 987.65, - "quantity_returned": 123.45, - "quantity_shipped": 123.45, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], "status": "xyz789" } @@ -58979,12 +59179,12 @@
    Possible Types
    -

    BundleOrderItem

    +

    DownloadableOrderItem

    -

    DownloadableOrderItem

    +

    BundleOrderItem

    @@ -59010,23 +59210,23 @@
    Example
    "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": "abc123", - "product_type": "abc123", - "product_url_key": "abc123", - "quantity_canceled": 987.65, + "product_sku": "xyz789", + "product_type": "xyz789", + "product_url_key": "xyz789", + "quantity_canceled": 123.45, "quantity_invoiced": 987.65, "quantity_ordered": 987.65, "quantity_refunded": 987.65, - "quantity_return_requested": 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" }
    @@ -59073,7 +59273,7 @@
    Fields
    Example
    {
-  "label": "abc123",
+  "label": "xyz789",
   "value": "xyz789"
 }
    @@ -59227,7 +59427,7 @@
    Example
    {
   "additional_data": [KeyValue],
   "name": "xyz789",
-  "type": "xyz789"
+  "type": "abc123"
 }
    @@ -59290,9 +59490,9 @@
    Fields
    Example
    {
   "comments": [SalesCommentItem],
-  "id": "4",
+  "id": 4,
   "items": [ShipmentItemInterface],
-  "number": "abc123",
+  "number": "xyz789",
   "tracking": [ShipmentTracking]
 }
    @@ -59335,7 +59535,7 @@
    Fields
    Example
    - 
    {"token": "xyz789"}
+                  
    {"token": "abc123"}
    @@ -59384,6 +59584,11 @@
    Fields
    The final total amount, including shipping, discounts, and taxes. + + grand_total_excl_tax - Money! + + The grand total of the order, excluding taxes. + shipping_handling - ShippingHandling @@ -59447,6 +59652,7 @@
    Example
    "discounts": [Discount], "gift_options": GiftOptionsPrices, "grand_total": Money, + "grand_total_excl_tax": Money, "shipping_handling": ShippingHandling, "subtotal": Money, "subtotal_excl_tax": Money, @@ -59505,7 +59711,7 @@
    Fields
    Example
    {
-  "payer_id": "abc123",
+  "payer_id": "xyz789",
   "token": "abc123"
 }
    @@ -59563,7 +59769,7 @@
    Example
    {
   "cancel_url": "abc123",
   "error_url": "xyz789",
-  "return_url": "abc123"
+  "return_url": "xyz789"
 }
    @@ -59670,8 +59876,8 @@
    Fields
    Example
    {
   "mode": "TEST",
-  "paypal_url": "xyz789",
-  "secure_token": "xyz789",
+  "paypal_url": "abc123",
+  "secure_token": "abc123",
   "secure_token_id": "abc123"
 }
    @@ -59763,7 +59969,7 @@
    Fields
    Example
    {
   "cc_details": CreditCardDetailsInput,
-  "is_active_payment_token_enabler": true
+  "is_active_payment_token_enabler": false
 }
    @@ -59812,7 +60018,7 @@
    Fields
    Example
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "paypal_payload": "xyz789"
 }
    @@ -59898,7 +60104,7 @@
    Fields
    Example
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "urls": PayflowProUrlInput
 }
    @@ -59954,9 +60160,9 @@
    Fields
    Example
    {
-  "cancel_url": "abc123",
+  "cancel_url": "xyz789",
   "error_url": "abc123",
-  "return_url": "abc123"
+  "return_url": "xyz789"
 }
    @@ -60047,6 +60253,11 @@
    Possible Types

    GooglePayConfig

    + + +

    FastlaneConfig

    + +
    @@ -60055,12 +60266,12 @@
    Possible Types
    Example
    {
-  "code": "xyz789",
+  "code": "abc123",
   "is_visible": false,
-  "payment_intent": "xyz789",
+  "payment_intent": "abc123",
   "sdk_params": [SDKParams],
   "sort_order": "abc123",
-  "title": "abc123"
+  "title": "xyz789"
 }
    @@ -60094,6 +60305,11 @@
    Fields
    ApplePay payment method configuration + + fastlane - FastlaneConfig + + Fastlane payment method configuration + google_pay - GooglePayConfig @@ -60118,6 +60334,7 @@
    Fields
    Example
    {
   "apple_pay": ApplePayConfig,
+  "fastlane": FastlaneConfig,
   "google_pay": GooglePayConfig,
   "hosted_fields": HostedFieldsConfig,
   "smart_buttons": SmartButtonsConfig
@@ -60177,6 +60394,13 @@ 
    Values
    
                         
                         
                       
+                      
+                        
+                          
    START_OF_CHECKOUT
    
+                        
+                        
+                        
+                      
                       
                         
                           
    ADMIN
    
@@ -60317,6 +60541,12 @@ 
    Fields
    
                         
                          Required input for Apple Pay button 
                       
+                      
+                        
+                          payment_services_paypal_fastlane - FastlaneMethodInput
+                        
+                         Required input for fastlane 
+                      
                       
                         
                           payment_services_paypal_google_pay - GooglePayMethodInput
@@ -60369,19 +60599,20 @@ 
    Example
    
   "braintree_googlepay_vault": BraintreeVaultInput,
   "braintree_paypal": BraintreeInput,
   "braintree_paypal_vault": BraintreeVaultInput,
-  "code": "abc123",
+  "code": "xyz789",
   "hosted_pro": HostedProInput,
   "payflow_express": PayflowExpressInput,
   "payflow_link": PayflowLinkInput,
   "payflowpro": PayflowProInput,
   "payflowpro_cc_vault": VaultTokenInput,
   "payment_services_paypal_apple_pay": ApplePayMethodInput,
+  "payment_services_paypal_fastlane": FastlaneMethodInput,
   "payment_services_paypal_google_pay": GooglePayMethodInput,
   "payment_services_paypal_hosted_fields": HostedFieldsInput,
   "payment_services_paypal_smart_buttons": SmartButtonMethodInput,
   "payment_services_paypal_vault": VaultMethodInput,
   "paypal_express": PaypalExpressInput,
-  "purchase_order_number": "xyz789"
+  "purchase_order_number": "abc123"
 }
    @@ -60439,7 +60670,7 @@
    Fields
    Example
    {
   "id": "xyz789",
-  "mp_order_id": "abc123",
+  "mp_order_id": "xyz789",
   "payment_source_details": PaymentSourceDetails,
   "status": "abc123"
 }
@@ -60484,7 +60715,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "abc123",
+  "code": "xyz789",
   "params": [SDKParams]
 }
 
    
@@ -60660,7 +60891,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "details": "xyz789",
-  "payment_method_code": "xyz789",
+  "payment_method_code": "abc123",
   "public_hash": "xyz789",
   "type": "card"
 }
@@ -60758,7 +60989,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "payer_id": "abc123",
+  "payer_id": "xyz789",
   "token": "xyz789"
 }
 
    
@@ -60827,10 +61058,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "cart_id": "xyz789",
-  "code": "abc123",
-  "express_button": true,
+  "code": "xyz789",
+  "express_button": false,
   "urls": PaypalExpressUrlsInput,
-  "use_paypal_credit": true
+  "use_paypal_credit": false
 }
 
    
                 
    
@@ -60926,7 +61157,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "edit": "abc123",
-  "start": "abc123"
+  "start": "xyz789"
 }
 
    
                 
    
@@ -60988,9 +61219,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "cancel_url": "xyz789",
-  "pending_url": "abc123",
-  "return_url": "xyz789",
-  "success_url": "abc123"
+  "pending_url": "xyz789",
+  "return_url": "abc123",
+  "success_url": "xyz789"
 }
 
    
                 
@@ -61196,18 +61427,18 @@ 
    Example
    
                   
    {
   "city": "xyz789",
   "contact_name": "abc123",
-  "country_id": "xyz789",
-  "description": "abc123",
-  "email": "abc123",
-  "fax": "abc123",
+  "country_id": "abc123",
+  "description": "xyz789",
+  "email": "xyz789",
+  "fax": "xyz789",
   "latitude": 123.45,
-  "longitude": 123.45,
+  "longitude": 987.65,
   "name": "abc123",
-  "phone": "xyz789",
+  "phone": "abc123",
   "pickup_location_code": "abc123",
-  "postcode": "abc123",
-  "region": "abc123",
-  "region_id": 987,
+  "postcode": "xyz789",
+  "region": "xyz789",
+  "region_id": 123,
   "street": "xyz789"
 }
 
    
@@ -61544,7 +61775,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"quote_uid": "4"}
+                  
    {"quote_uid": 4}
 
    
                 
    
               
    
@@ -61631,7 +61862,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "CART_NOT_FOUND",
-  "message": "xyz789"
+  "message": "abc123"
 }
 
    
                 
@@ -61820,7 +62051,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}
 
    
                 
    
               
    
@@ -61849,7 +62080,7 @@ 
    Fields
    
                     
                     
                       
-                        errors - [PlaceOrderError]!
+                        errors - [PlaceOrderError]
                         
                          An array of place order errors. 
                       
@@ -61916,7 +62147,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}
 
    
                 
    
               
    
@@ -62221,9 +62452,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "discount_percentage": 987.65,
+  "discount_percentage": 123.45,
   "main_final_price": 987.65,
-  "main_price": 987.65
+  "main_price": 123.45
 }
 
    
                 
    
@@ -62453,18 +62684,6 @@ 
    Fields
    
                       
                     
                     
-                      
-                        
-                          activity - FilterEqualTypeInput
-                        
-                         Attribute label: Activity 
-                      
-                      
-                        
-                          category_gear - FilterEqualTypeInput
-                        
-                         Attribute label: Category Gear 
-                      
                       
                         
                           category_id - FilterEqualTypeInput
@@ -62483,156 +62702,36 @@ 
    Fields
    
                         
                          Filter product by category URL path. 
                       
-                      
-                        
-                          climate - FilterEqualTypeInput
-                        
-                         Attribute label: Climate 
-                      
-                      
-                        
-                          collar - FilterEqualTypeInput
-                        
-                         Attribute label: Collar 
-                      
-                      
-                        
-                          color - FilterEqualTypeInput
-                        
-                         Attribute label: Color 
-                      
                       
                         
                           description - FilterMatchTypeInput
                         
                          Attribute label: Description 
                       
-                      
-                        
-                          eco_collection - FilterEqualTypeInput
-                        
-                         Attribute label: Eco Collection 
-                      
-                      
-                        
-                          erin_recommends - FilterEqualTypeInput
-                        
-                         Attribute label: Erin Recommends 
-                      
-                      
-                        
-                          features_bags - FilterEqualTypeInput
-                        
-                         Attribute label: Features 
-                      
-                      
-                        
-                          format - FilterEqualTypeInput
-                        
-                         Attribute label: Format 
-                      
-                      
-                        
-                          gender - FilterEqualTypeInput
-                        
-                         Attribute label: Gender 
-                      
-                      
-                        
-                          material - FilterEqualTypeInput
-                        
-                         Attribute label: Material 
-                      
                       
                         
                           name - FilterMatchTypeInput
                         
                          Attribute label: Product Name 
                       
-                      
-                        
-                          new - FilterEqualTypeInput
-                        
-                         Attribute label: New 
-                      
-                      
-                        
-                          pattern - FilterEqualTypeInput
-                        
-                         Attribute label: Pattern 
-                      
-                      
-                        
-                          performance_fabric - FilterEqualTypeInput
-                        
-                         Attribute label: Performance Fabric 
-                      
                       
                         
                           price - FilterRangeTypeInput
                         
                          Attribute label: Price 
                       
-                      
-                        
-                          purpose - FilterEqualTypeInput
-                        
-                         Attribute label: Purpose 
-                      
-                      
-                        
-                          sale - FilterEqualTypeInput
-                        
-                         Attribute label: Sale 
-                      
                       
                         
                           short_description - FilterMatchTypeInput
                         
                          Attribute label: Short Description 
                       
-                      
-                        
-                          size - FilterEqualTypeInput
-                        
-                         Attribute label: Size 
-                      
                       
                         
                           sku - FilterEqualTypeInput
                         
                          Attribute label: SKU 
                       
-                      
-                        
-                          sleeve - FilterEqualTypeInput
-                        
-                         Attribute label: Sleeve 
-                      
-                      
-                        
-                          strap_bags - FilterEqualTypeInput
-                        
-                         Attribute label: Strap/Handle 
-                      
-                      
-                        
-                          style_bags - FilterEqualTypeInput
-                        
-                         Attribute label: Style Bags 
-                      
-                      
-                        
-                          style_bottom - FilterEqualTypeInput
-                        
-                         Attribute label: Style Bottom 
-                      
-                      
-                        
-                          style_general - FilterEqualTypeInput
-                        
-                         Attribute label: Style General 
-                      
                       
                         
                           url_key - FilterEqualTypeInput
@@ -62647,36 +62746,14 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "activity": FilterEqualTypeInput,
-  "category_gear": FilterEqualTypeInput,
   "category_id": FilterEqualTypeInput,
   "category_uid": FilterEqualTypeInput,
   "category_url_path": FilterEqualTypeInput,
-  "climate": FilterEqualTypeInput,
-  "collar": FilterEqualTypeInput,
-  "color": FilterEqualTypeInput,
   "description": FilterMatchTypeInput,
-  "eco_collection": FilterEqualTypeInput,
-  "erin_recommends": FilterEqualTypeInput,
-  "features_bags": FilterEqualTypeInput,
-  "format": FilterEqualTypeInput,
-  "gender": FilterEqualTypeInput,
-  "material": FilterEqualTypeInput,
   "name": FilterMatchTypeInput,
-  "new": FilterEqualTypeInput,
-  "pattern": FilterEqualTypeInput,
-  "performance_fabric": FilterEqualTypeInput,
   "price": FilterRangeTypeInput,
-  "purpose": FilterEqualTypeInput,
-  "sale": FilterEqualTypeInput,
   "short_description": FilterMatchTypeInput,
-  "size": FilterEqualTypeInput,
   "sku": FilterEqualTypeInput,
-  "sleeve": FilterEqualTypeInput,
-  "strap_bags": FilterEqualTypeInput,
-  "style_bags": FilterEqualTypeInput,
-  "style_bottom": FilterEqualTypeInput,
-  "style_general": FilterEqualTypeInput,
   "url_key": FilterEqualTypeInput
 }
 
    
@@ -62830,7 +62907,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"amount_off": 123.45, "percent_off": 987.65}
+                  
    {"amount_off": 987.65, "percent_off": 123.45}
 
    
                 
    
               
    
@@ -63183,6 +63260,11 @@ 
    Fields
    
                         
                          The media item's position after it has been sorted. 
                       
+                      
+                        types - [String]
+                        
+                         Array of image types. It can have the following values: image, small_image, thumbnail. 
+                      
                       
                         url - String
                         
@@ -63196,10 +63278,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "disabled": false,
-  "label": "xyz789",
+  "disabled": true,
+  "label": "abc123",
   "position": 987,
-  "url": "xyz789"
+  "types": ["xyz789"],
+  "url": "abc123"
 }
 
    
                 
    
@@ -63284,7 +63367,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"sku": "xyz789"}
+                  
    {"sku": "abc123"}
 
    
                 
    
               
    
@@ -63312,13 +63395,6 @@ 
    Fields
    
                       
                     
                     
-                      
-                        activity - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         attribute_set_id - Int
                         
@@ -63335,27 +63411,6 @@ 
    Fields
    
                         
                          The categories assigned to a product. 
                       
-                      
-                        category_gear - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        climate - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        collar - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         color - Int
                         
@@ -63402,41 +63457,6 @@ 
    filters
                         
                          Detailed information about the product. The value can include simple HTML tags. 
                       
-                      
-                        eco_collection - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        erin_recommends - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        features_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        format - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        gender - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         gift_message_available - Boolean!
                         
@@ -63474,13 +63494,6 @@ 
    filters
                          A number representing the product's manufacturer. Use the custom_attributes field instead.
                         
                       
-                      
-                        material - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         max_sale_qty - Float
                         
@@ -63522,13 +63535,6 @@ 
    filters
                         
                          The product name. Customers use this name to identify the product. 
                       
-                      
-                        new - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         new_from_date - String
                         
@@ -63549,20 +63555,6 @@ 
    filters
                         
                          If the product has multiple options, determines where they appear on the product page. 
                       
-                      
-                        pattern - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        performance_fabric - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         price - ProductPrices
                         
@@ -63584,13 +63576,6 @@ 
    filters
                         
                          An array of ProductLinks objects. 
                       
-                      
-                        purpose - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         quantity - Float
                         
@@ -63635,42 +63620,16 @@ 
    currentPage
                         
                       
-                      
-                        rules - [CatalogRule]
-                        
-                         Provides applied catalog rules in the current active cart 
-                      
-                      
-                        sale - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         short_description - ComplexTextValue
                         
                          A short description of the product. Its use depends on the theme. 
                       
-                      
-                        size - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         sku - String
                         
                          A number or code assigned to a product to identify the product, options, price, and manufacturer. 
                       
-                      
-                        sleeve - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         small_image - ProductImage
                         
@@ -63702,34 +63661,6 @@ 
    currentPage
                          Stock status of the product 
                       
-                      
-                        strap_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_bottom - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_general - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         swatch_image - String
                         
@@ -63831,12 +63762,12 @@ 
    Possible Types
    
                       
                       
                         
-                          
    BundleProduct
    
+                          
    DownloadableProduct
    
                         
                       
                       
                         
-                          
    DownloadableProduct
    
+                          
    BundleProduct
    
                         
                       
                       
@@ -63857,85 +63788,63 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "activity": "xyz789",
   "attribute_set_id": 987,
-  "canonical_url": "abc123",
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "category_gear": "xyz789",
-  "climate": "xyz789",
-  "collar": "abc123",
   "color": 123,
-  "country_of_manufacture": "xyz789",
-  "created_at": "xyz789",
+  "country_of_manufacture": "abc123",
+  "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 123,
-  "erin_recommends": 123,
-  "features_bags": "abc123",
-  "format": 123,
-  "gender": "xyz789",
   "gift_message_available": false,
   "gift_wrapping_available": true,
   "gift_wrapping_price": Money,
   "id": 987,
   "image": ProductImage,
-  "is_returnable": "abc123",
+  "is_returnable": "xyz789",
   "manufacturer": 987,
-  "material": "abc123",
   "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "xyz789",
+  "meta_description": "abc123",
   "meta_keyword": "xyz789",
-  "meta_title": "abc123",
+  "meta_title": "xyz789",
   "min_sale_qty": 123.45,
-  "name": "abc123",
-  "new": 987,
-  "new_from_date": "abc123",
-  "new_to_date": "xyz789",
-  "only_x_left_in_stock": 987.65,
+  "name": "xyz789",
+  "new_from_date": "xyz789",
+  "new_to_date": "abc123",
+  "only_x_left_in_stock": 123.45,
   "options_container": "abc123",
-  "pattern": "xyz789",
-  "performance_fabric": 987,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 123,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "rating_summary": 987.65,
   "related_products": [ProductInterface],
   "review_count": 987,
   "reviews": ProductReviews,
-  "rules": [CatalogRule],
-  "sale": 987,
   "short_description": ComplexTextValue,
-  "size": 123,
-  "sku": "xyz789",
-  "sleeve": "xyz789",
+  "sku": "abc123",
   "small_image": ProductImage,
-  "special_from_date": "abc123",
+  "special_from_date": "xyz789",
   "special_price": 987.65,
-  "special_to_date": "abc123",
-  "staged": false,
+  "special_to_date": "xyz789",
+  "staged": true,
   "stock_status": "IN_STOCK",
-  "strap_bags": "xyz789",
-  "style_bags": "abc123",
-  "style_bottom": "xyz789",
-  "style_general": "abc123",
-  "swatch_image": "abc123",
+  "swatch_image": "xyz789",
   "thumbnail": ProductImage,
-  "tier_price": 987.65,
+  "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
-  "type_id": "abc123",
+  "type_id": "xyz789",
   "uid": "4",
-  "updated_at": "abc123",
+  "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
-  "url_key": "abc123",
-  "url_path": "xyz789",
+  "url_key": "xyz789",
+  "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "abc123",
+  "url_suffix": "xyz789",
   "websites": [Website]
 }
 
    
@@ -63998,8 +63907,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "link_type": "abc123",
-  "linked_product_sku": "xyz789",
+  "link_type": "xyz789",
+  "linked_product_sku": "abc123",
   "linked_product_type": "xyz789",
   "position": 987,
   "sku": "xyz789"
@@ -64082,10 +63991,10 @@ 
    Possible Types
    
                   
    Example
    
                   
    {
   "link_type": "abc123",
-  "linked_product_sku": "xyz789",
+  "linked_product_sku": "abc123",
   "linked_product_type": "abc123",
-  "position": 987,
-  "sku": "xyz789"
+  "position": 123,
+  "sku": "abc123"
 }
 
    
                 
    
@@ -64137,7 +64046,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "base64_encoded_data": "abc123",
+  "base64_encoded_data": "xyz789",
   "name": "abc123",
   "type": "abc123"
 }
@@ -64400,12 +64309,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "average_rating": 987.65,
-  "created_at": "xyz789",
+  "average_rating": 123.45,
+  "created_at": "abc123",
   "nickname": "abc123",
   "product": ProductInterface,
   "ratings_breakdown": [ProductReviewRating],
-  "summary": "abc123",
+  "summary": "xyz789",
   "text": "abc123"
 }
 
    
@@ -64504,7 +64413,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "id": "abc123",
-  "value_id": "abc123"
+  "value_id": "xyz789"
 }
 
    
                 
    
@@ -64810,11 +64719,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "customer_group_id": "abc123",
-  "percentage_value": 987.65,
-  "qty": 123.45,
-  "value": 123.45,
-  "website_id": 123.45
+  "customer_group_id": "xyz789",
+  "percentage_value": 123.45,
+  "qty": 987.65,
+  "value": 987.65,
+  "website_id": 987.65
 }
 
    
                 
    
@@ -64858,6 +64767,11 @@ 
    Fields
    
                         
                          The media item's position after it has been sorted. 
                       
+                      
+                        types - [String]
+                        
+                         Array of image types. It can have the following values: image, small_image, thumbnail. 
+                      
                       
                         url - String
                         
@@ -64876,10 +64790,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "disabled": false,
+  "disabled": true,
   "label": "xyz789",
   "position": 123,
-  "url": "abc123",
+  "types": ["xyz789"],
+  "url": "xyz789",
   "video_content": ProductMediaGalleryEntriesVideoContent
 }
 
    
@@ -65072,7 +64987,7 @@ 
    Example
    
   "approval_flow": [PurchaseOrderRuleApprovalFlow],
   "available_actions": ["REJECT"],
   "comments": [PurchaseOrderComment],
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "created_by": Customer,
   "history_log": [PurchaseOrderHistoryItem],
   "number": "xyz789",
@@ -65080,7 +64995,7 @@ 
    Example
    
   "quote": Cart,
   "status": "PENDING",
   "uid": 4,
-  "updated_at": "abc123"
+  "updated_at": "xyz789"
 }
 
    
                 
    
@@ -65192,7 +65107,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"message": "abc123", "type": "NOT_FOUND"}
+                  
    {"message": "xyz789", "type": "NOT_FOUND"}
 
    
                 
    
               
    
@@ -65400,11 +65315,11 @@ 
    Example
    
   "approver_roles": [CompanyRole],
   "condition": PurchaseOrderApprovalRuleConditionInterface,
   "created_at": "abc123",
-  "created_by": "abc123",
-  "description": "xyz789",
-  "name": "abc123",
+  "created_by": "xyz789",
+  "description": "abc123",
+  "name": "xyz789",
   "status": "ENABLED",
-  "uid": 4,
+  "uid": "4",
   "updated_at": "xyz789"
 }
    @@ -65709,9 +65624,9 @@
    Fields
    Example
    {
   "applies_to": ["4"],
-  "approvers": ["4"],
+  "approvers": [4],
   "condition": CreatePurchaseOrderApprovalRuleConditionInput,
-  "description": "xyz789",
+  "description": "abc123",
   "name": "abc123",
   "status": "ENABLED"
 }
@@ -65976,8 +65891,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "author": Customer,
-  "created_at": "xyz789",
-  "text": "xyz789",
+  "created_at": "abc123",
+  "text": "abc123",
   "uid": 4
 }
 
    
@@ -66101,10 +66016,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "activity": "xyz789",
+  "activity": "abc123",
   "created_at": "xyz789",
-  "message": "abc123",
-  "uid": 4
+  "message": "xyz789",
+  "uid": "4"
 }
 
    
                 
    
@@ -66300,7 +66215,7 @@ 
    Example
    
                   
    {
   "items": [PurchaseOrder],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
    
                 
@@ -66557,7 +66472,7 @@ 
    Example
    
                   
    {
   "item_id": 4,
   "note": "abc123",
-  "templateId": "4"
+  "templateId": 4
 }
 
    
                 
@@ -66605,7 +66520,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "message": "abc123",
-  "type": "xyz789"
+  "type": "abc123"
 }
 
    
                 
@@ -66727,11 +66642,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "badge_position": "xyz789",
-  "language_code": "xyz789",
-  "minimum_score": 123.45,
+  "badge_position": "abc123",
+  "language_code": "abc123",
+  "minimum_score": 987.65,
   "re_captcha_type": "INVISIBLE",
-  "technical_failure_message": "abc123",
+  "technical_failure_message": "xyz789",
   "theme": "abc123",
   "validation_failure_message": "abc123",
   "website_key": "abc123"
@@ -66815,9 +66730,9 @@ 
    Example
    
   "failure_message": "xyz789",
   "forms": ["PLACE_ORDER"],
   "is_enabled": true,
-  "language_code": "abc123",
+  "language_code": "xyz789",
   "minimum_score": 987.65,
-  "theme": "abc123",
+  "theme": "xyz789",
   "website_key": "abc123"
 }
 
    
@@ -67026,9 +66941,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "abc123",
+  "code": "xyz789",
   "id": 987,
-  "name": "xyz789"
+  "name": "abc123"
 }
 
    
                 
    
@@ -67158,8 +67073,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "xyz789",
-  "coupon_codes": ["abc123"]
+  "cart_id": "abc123",
+  "coupon_codes": ["xyz789"]
 }
 
    
                 
    
@@ -67208,8 +67123,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "xyz789",
-  "gift_card_code": "xyz789"
+  "cart_id": "abc123",
+  "gift_card_code": "abc123"
 }
 
    
                 
    
@@ -67330,7 +67245,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"success": false}
+                  
    {"success": true}
 
    
                 
    
               
    
@@ -67424,9 +67339,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "cart_item_id": 987,
-  "cart_item_uid": 4
+  "cart_item_uid": "4"
 }
 
    
                 
    
@@ -67514,10 +67429,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {
-  "quote_item_uids": ["4"],
-  "quote_uid": "4"
-}
+                  
    {"quote_item_uids": ["4"], "quote_uid": 4}
 
    
                 
    
               
    
@@ -67604,10 +67516,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {
-  "item_uids": ["4"],
-  "template_id": "4"
-}
+                  
    {"item_uids": [4], "template_id": 4}
 
    
                 
    
               
    
@@ -67963,7 +67872,7 @@ 
    Example
    
                   
    {
   "quote_comment": "abc123",
   "quote_name": "abc123",
-  "quote_uid": "4"
+  "quote_uid": 4
 }
 
    
                 
    
@@ -68112,10 +68021,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "comment_text": "abc123",
-  "contact_email": "abc123",
+  "comment_text": "xyz789",
+  "contact_email": "xyz789",
   "items": [RequestReturnItemInput],
-  "token": "xyz789"
+  "token": "abc123"
 }
 
    
                 
    
@@ -68324,7 +68233,7 @@ 
    Example
    
   "comment_text": "abc123",
   "contact_email": "abc123",
   "items": [RequestReturnItemInput],
-  "order_uid": 4
+  "order_uid": "4"
 }
    @@ -68388,7 +68297,7 @@
    Example
    "entered_custom_attributes": [ EnteredCustomAttributeInput ], - "order_item_uid": "4", + "order_item_uid": 4, "quantity_to_return": 123.45, "selected_custom_attributes": [ SelectedCustomAttributeInput @@ -68494,9 +68403,10 @@
    Fields
    Optional text that describes the requisition list. - items - RequistionListItems + items - RequistionListItems + + An array of products added to the requisition list. Deprecated. Use requisition_list_items instead. Will be removed in a future release. - An array of products added to the requisition list. @@ -68527,6 +68437,30 @@
    pageSize The requisition list name. + + requisition_list_items - RequisitionListItems + + An array of products added to the requisition list. + + + +
    +
    Arguments
    +
    +
    +
    currentPage - Int +
    +

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

    +
    +
    +
    pageSize - Int +
    +

    The maximum number of results to return. The default value is 1.

    +
    +
    +
    + + uid - ID! @@ -68547,8 +68481,9 @@
    Example
    {
   "description": "xyz789",
   "items": RequistionListItems,
-  "items_count": 987,
+  "items_count": 123,
   "name": "abc123",
+  "requisition_list_items": RequisitionListItems,
   "uid": "4",
   "updated_at": "xyz789"
 }
@@ -68704,6 +68639,60 @@ 
    Example
    
   "quantity": 123.45,
   "uid": "4"
 }
+
    + + + back to top + +
    +
    +
    + Types +
    +

    RequisitionListItems

    +
    +
    +
    +
    Description
    +

    Contains an array of items added to a requisition list.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    items - [RequisitionListItemInterface]! + An array of items in the requisition list.
    page_info - SearchResultPageInfo + Pagination metadata.
    total_pages - Int! + The number of pages returned.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "items": [RequisitionListItemInterface],
+  "page_info": SearchResultPageInfo,
+  "total_pages": 987
+}
    @@ -68771,9 +68760,9 @@
    Example
    {
   "entered_options": [EnteredOptionInput],
   "parent_sku": "xyz789",
-  "quantity": 987.65,
+  "quantity": 123.45,
   "selected_options": ["xyz789"],
-  "sku": "abc123"
+  "sku": "xyz789"
 }
    @@ -68844,7 +68833,7 @@

    RequistionListItems

    Description
    -

    Contains an array of items added to a requisition list.

    +

    Deprecated. Use RequisitionListItems via requisition_list_items. Will be removed in a future release.

    Fields
    @@ -68881,7 +68870,7 @@
    Example
    {
   "items": [RequisitionListItemInterface],
   "page_info": SearchResultPageInfo,
-  "total_pages": 123
+  "total_pages": 987
 }
    @@ -68970,14 +68959,14 @@
    Example
    {
   "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"
 }
    @@ -69035,9 +69024,9 @@
    Fields
    Example
    {
   "author_name": "xyz789",
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "text": "abc123",
-  "uid": 4
+  "uid": "4"
 }
    @@ -69090,8 +69079,8 @@
    Fields
    Example
    {
   "label": "xyz789",
-  "uid": 4,
-  "value": "xyz789"
+  "uid": "4",
+  "value": "abc123"
 }
    @@ -69144,7 +69133,7 @@
    Fields
    Example
    {
   "email": "abc123",
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "lastname": "abc123"
 }
    @@ -69326,15 +69315,15 @@
    Fields
    Example
    {
-  "code": 4,
-  "default_value": "abc123",
+  "code": "4",
+  "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
   "input_filter": "NONE",
-  "is_required": false,
-  "is_unique": true,
-  "label": "xyz789",
+  "is_required": true,
+  "is_unique": false,
+  "label": "abc123",
   "multiline_count": 987,
   "options": [CustomAttributeOptionInterface],
   "sort_order": 987,
@@ -69544,7 +69533,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "xyz789",
+  "city": "abc123",
   "contact_name": "xyz789",
   "country": Country,
   "postcode": "xyz789",
@@ -69596,7 +69585,10 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"label": "xyz789", "uid": 4}
+                  
    {
+  "label": "abc123",
+  "uid": "4"
+}
 
    
                 
    
               
    
@@ -69655,7 +69647,7 @@ 
    Example
    
   "carrier": ReturnShippingCarrier,
   "status": ReturnShippingTrackingStatus,
   "tracking_number": "abc123",
-  "uid": 4
+  "uid": "4"
 }
 
    
                 
    
@@ -69962,7 +69954,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"result": true}
+                  
    {"result": false}
 
    
                 
    
               
    
@@ -70063,7 +70055,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"money": Money, "points": 987.65}
+                  
    {"money": Money, "points": 123.45}
 
    
                 
    
               
    
@@ -70121,8 +70113,8 @@ 
    Example
    
                   
    {
   "balance": RewardPointsAmount,
   "change_reason": "xyz789",
-  "date": "abc123",
-  "points_change": 987.65
+  "date": "xyz789",
+  "points_change": 123.45
 }
    @@ -70386,12 +70378,12 @@
    Possible Types
    -

    ConfigurableProduct

    +

    RoutableUrl

    -

    BundleProduct

    +

    ConfigurableProduct

    @@ -70401,17 +70393,17 @@
    Possible Types
    -

    GiftCardProduct

    +

    BundleProduct

    -

    GroupedProduct

    +

    GiftCardProduct

    -

    RoutableUrl

    +

    GroupedProduct

    @@ -70422,8 +70414,8 @@
    Possible Types
    Example
    {
-  "redirect_code": 987,
-  "relative_url": "abc123",
+  "redirect_code": 123,
+  "relative_url": "xyz789",
   "type": "CMS_PAGE"
 }
    @@ -70476,8 +70468,8 @@
    Fields
    Example
    {
-  "redirect_code": 987,
-  "relative_url": "abc123",
+  "redirect_code": 123,
+  "relative_url": "xyz789",
   "type": "CMS_PAGE"
 }
    @@ -70525,8 +70517,8 @@
    Fields
    Example
    {
-  "name": "xyz789",
-  "value": "abc123"
+  "name": "abc123",
+  "value": "xyz789"
 }
    @@ -70574,7 +70566,7 @@
    Fields
    Example
    {
   "message": "abc123",
-  "timestamp": "xyz789"
+  "timestamp": "abc123"
 }
    @@ -70784,8 +70776,8 @@
    Fields
    Example
    {
-  "id": 987,
-  "label": "xyz789",
+  "id": 123,
+  "label": "abc123",
   "type": "abc123",
   "uid": 4,
   "values": [SelectedBundleOptionValue]
@@ -70862,12 +70854,12 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "id": 123,
-  "label": "abc123",
+  "label": "xyz789",
   "original_price": Money,
   "price": 987.65,
   "priceV2": Money,
   "quantity": 987.65,
-  "uid": 4
+  "uid": "4"
 }
    @@ -70939,10 +70931,10 @@
    Fields
    Example
    {
   "configurable_product_option_uid": "4",
-  "configurable_product_option_value_uid": 4,
-  "id": 123,
-  "option_label": "xyz789",
-  "value_id": 123,
+  "configurable_product_option_value_uid": "4",
+  "id": 987,
+  "option_label": "abc123",
+  "value_id": 987,
   "value_label": "xyz789"
 }
    @@ -70992,7 +70984,7 @@
    Fields
    Example
    {
-  "attribute_code": "abc123",
+  "attribute_code": "xyz789",
   "value": "xyz789"
 }
    @@ -71069,10 +71061,10 @@
    Example
    {
   "customizable_option_uid": 4,
   "id": 123,
-  "is_required": false,
+  "is_required": true,
   "label": "abc123",
-  "sort_order": 123,
-  "type": "xyz789",
+  "sort_order": 987,
+  "type": "abc123",
   "values": [SelectedCustomizableOptionValue]
 }
    @@ -71138,10 +71130,10 @@
    Fields
    Example
    {
   "customizable_option_value_uid": "4",
-  "id": 987,
+  "id": 123,
   "label": "xyz789",
   "price": CartItemSelectedOptionValuePrice,
-  "value": "xyz789"
+  "value": "abc123"
 }
    @@ -71194,8 +71186,8 @@
    Fields
    Example
    {
   "code": "abc123",
-  "purchase_order_number": "xyz789",
-  "title": "xyz789"
+  "purchase_order_number": "abc123",
+  "title": "abc123"
 }
    @@ -71276,10 +71268,10 @@
    Example
    {
   "amount": Money,
   "base_amount": Money,
-  "carrier_code": "xyz789",
+  "carrier_code": "abc123",
   "carrier_title": "abc123",
   "method_code": "xyz789",
-  "method_title": "abc123",
+  "method_title": "xyz789",
   "price_excl_tax": Money,
   "price_incl_tax": Money
 }
@@ -71433,8 +71425,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "xyz789",
-  "name": "abc123"
+  "email": "abc123",
+  "name": "xyz789"
 }
 
    
                 
    
@@ -71483,8 +71475,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "xyz789",
-  "name": "abc123"
+  "email": "abc123",
+  "name": "xyz789"
 }
 
    
                 
    
@@ -71536,9 +71528,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "abc123",
+  "email": "xyz789",
   "message": "xyz789",
-  "name": "xyz789"
+  "name": "abc123"
 }
 
    
                 
    
@@ -71593,9 +71585,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "abc123",
-  "message": "xyz789",
-  "name": "xyz789"
+  "email": "xyz789",
+  "message": "abc123",
+  "name": "abc123"
 }
 
    
                 
    
@@ -71780,7 +71772,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "billing_address": BillingAddressInput,
-  "cart_id": "xyz789"
+  "cart_id": "abc123"
 }
 
    
                 
@@ -71822,6 +71814,51 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {"cart": Cart}
+
    
+                
    
+              
+              back to top
+            
+
    +
    +
    + Types +
    +

    SetCartAsInactiveOutput

    +
    +
    +
    +
    Description
    +

    Sets the cart as inactive

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    error - String + The error message returned after failing to set the cart as inactive
    success - Boolean! + Indicates whether the cart was set as inactive
    +
    +
    +
    +
    +
    Example
    + 
    {"error": "abc123", "success": false}
    @@ -71980,8 +72017,8 @@
    Fields
    Example
    {
-  "cart_id": "abc123",
-  "email": "abc123"
+  "cart_id": "xyz789",
+  "email": "xyz789"
 }
    @@ -72201,7 +72238,7 @@
    Fields
    Example
    {
   "payment_method": NegotiableQuotePaymentMethodInput,
-  "quote_uid": 4
+  "quote_uid": "4"
 }
    @@ -72297,7 +72334,7 @@
    Fields
    Example
    {
   "customer_address_id": "4",
-  "quote_uid": 4,
+  "quote_uid": "4",
   "shipping_addresses": [
     NegotiableQuoteShippingAddressInput
   ]
@@ -72389,7 +72426,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "quote_uid": 4,
+  "quote_uid": "4",
   "shipping_methods": [ShippingMethodInput]
 }
 
    
@@ -72480,7 +72517,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "shipping_address": NegotiableQuoteTemplateShippingAddressInput,
-  "template_id": "4"
+  "template_id": 4
 }
 
    
                 
    
@@ -72669,7 +72706,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "shipping_addresses": [ShippingAddressInput]
 }
 
    
@@ -72759,7 +72796,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "shipping_methods": [ShippingMethodInput]
 }
 
    
@@ -72850,7 +72887,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "email": "abc123",
-  "name": "xyz789"
+  "name": "abc123"
 }
 
    
                 
    
@@ -72940,7 +72977,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "message": "xyz789",
-  "name": "xyz789"
+  "name": "abc123"
 }
 
    
                 
    
@@ -73052,7 +73089,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
@@ -73151,9 +73188,9 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "abc123",
   "quantity_shipped": 123.45
@@ -73208,8 +73245,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "carrier": "abc123",
-  "number": "xyz789",
+  "carrier": "xyz789",
+  "number": "abc123",
   "title": "abc123"
 }
 
    
@@ -73251,6 +73288,12 @@ 
    Fields
    
                         
                          An ID from the customer's address book that uniquely identifies the address to be used for shipping. 
                       
+                      
+                        
+                          customer_address_uid - ID
+                        
+                         The unique ID from the customer's address book that uniquely identifies the address to be used for shipping. 
+                      
                       
                         
                           customer_notes - String
@@ -73272,7 +73315,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "address": CartAddressInput,
-  "customer_address_id": 123,
+  "customer_address_id": 987,
+  "customer_address_uid": "4",
   "customer_notes": "xyz789",
   "pickup_location_code": "xyz789"
 }
@@ -73340,6 +73384,11 @@ 
    Fields
    
                         
                          The custom attribute values of the billing or shipping address. 
                       
+                      
+                        customer_address_uid - ID
+                        
+                         The unique ID from the customer's address book that uniquely identifies the address. 
+                      
                       
                         customer_notes - String
                         
@@ -73356,9 +73405,10 @@ 
    Fields
    
                          The first name of the customer or guest. 
                       
                       
-                        id - Int
+                        id - Int
+                        
+                         Id of the customer address. Use customer_address_uid instead.
                         
-                         Id of the customer address. 
                       
                       
                         items_weight - Float
@@ -73424,9 +73474,9 @@ 
    Fields
    
                          The telephone number for the billing or shipping address. 
                       
                       
-                        uid - String!
+                        uid - ID!
                         
-                         The unique id of the customer address. 
+                         The unique id of the customer cart address. 
                       
                       
                         vat_id - String
@@ -73445,27 +73495,28 @@ 
    Example
    
   "cart_items": [CartItemQuantity],
   "cart_items_v2": [CartItemInterface],
   "city": "abc123",
-  "company": "xyz789",
+  "company": "abc123",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "customer_notes": "xyz789",
+  "customer_address_uid": "4",
+  "customer_notes": "abc123",
   "fax": "xyz789",
-  "firstname": "xyz789",
+  "firstname": "abc123",
   "id": 987,
-  "items_weight": 987.65,
-  "lastname": "xyz789",
-  "middlename": "xyz789",
-  "pickup_location_code": "xyz789",
-  "postcode": "xyz789",
-  "prefix": "abc123",
+  "items_weight": 123.45,
+  "lastname": "abc123",
+  "middlename": "abc123",
+  "pickup_location_code": "abc123",
+  "postcode": "abc123",
+  "prefix": "xyz789",
   "region": CartAddressRegion,
-  "same_as_billing": false,
+  "same_as_billing": true,
   "selected_shipping_method": SelectedShippingMethod,
-  "street": ["xyz789"],
-  "suffix": "xyz789",
-  "telephone": "xyz789",
-  "uid": "xyz789",
-  "vat_id": "abc123"
+  "street": ["abc123"],
+  "suffix": "abc123",
+  "telephone": "abc123",
+  "uid": 4,
+  "vat_id": "xyz789"
 }
 
    
                 
    
@@ -73620,8 +73671,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "carrier_code": "abc123",
-  "method_code": "xyz789"
+  "carrier_code": "xyz789",
+  "method_code": "abc123"
 }
 
    
                 
    
@@ -73754,13 +73805,13 @@ 
    Example
    
   "id": "abc123",
   "is_available": false,
   "max_qty": 123.45,
-  "min_qty": 123.45,
+  "min_qty": 987.65,
   "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "uid": 4
 }
 
    
@@ -73790,13 +73841,6 @@ 
    Fields
    
                       
                     
                     
-                      
-                        activity - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         attribute_set_id - Int
                         
@@ -73813,27 +73857,6 @@ 
    Fields
    
                         
                          The categories assigned to a product. 
                       
-                      
-                        category_gear - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        climate - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        collar - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         color - Int
                         
@@ -73880,41 +73903,6 @@ 
    filters
                         
                          Detailed information about the product. The value can include simple HTML tags. 
                       
-                      
-                        eco_collection - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        erin_recommends - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        features_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        format - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        gender - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         gift_message_available - Boolean!
                         
@@ -73952,13 +73940,6 @@ 
    filters
                          A number representing the product's manufacturer. Use the custom_attributes field instead.
                         
                       
-                      
-                        material - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         max_sale_qty - Float
                         
@@ -74000,13 +73981,6 @@ 
    filters
                         
                          The product name. Customers use this name to identify the product. 
                       
-                      
-                        new - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         new_from_date - String
                         
@@ -74032,20 +74006,6 @@ 
    filters
                         
                          If the product has multiple options, determines where they appear on the product page. 
                       
-                      
-                        pattern - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        performance_fabric - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         price - ProductPrices
                         
@@ -74067,13 +74027,6 @@ 
    filters
                         
                          An array of ProductLinks objects. 
                       
-                      
-                        purpose - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         quantity - Float
                         
@@ -74128,42 +74081,16 @@ 
    currentPage
                         
                       
-                      
-                        rules - [CatalogRule]
-                        
-                         Provides applied catalog rules in the current active cart 
-                      
-                      
-                        sale - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         short_description - ComplexTextValue
                         
                          A short description of the product. Its use depends on the theme. 
                       
-                      
-                        size - Int
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         sku - String
                         
                          A number or code assigned to a product to identify the product, options, price, and manufacturer. 
                       
-                      
-                        sleeve - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         small_image - ProductImage
                         
@@ -74195,34 +74122,6 @@ 
    currentPage
                          Stock status of the product 
                       
-                      
-                        strap_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_bags - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_bottom - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
-                      
-                        style_general - String
-                        
-                        
-                          Use the custom_attributes field instead.
-                        
-                      
                       
                         swatch_image - String
                         
@@ -74313,91 +74212,69 @@ 
    currentPage
                   
    Example
    
                   
    {
-  "activity": "abc123",
   "attribute_set_id": 987,
   "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "category_gear": "xyz789",
-  "climate": "xyz789",
-  "collar": "abc123",
   "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": "xyz789",
-  "format": 123,
-  "gender": "xyz789",
-  "gift_message_available": true,
-  "gift_wrapping_available": true,
+  "gift_message_available": false,
+  "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
-  "id": 987,
+  "id": 123,
   "image": ProductImage,
-  "is_returnable": "xyz789",
+  "is_returnable": "abc123",
   "manufacturer": 987,
-  "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",
-  "min_sale_qty": 987.65,
-  "name": "xyz789",
-  "new": 123,
-  "new_from_date": "xyz789",
+  "meta_title": "abc123",
+  "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",
-  "pattern": "xyz789",
-  "performance_fabric": 123,
+  "options_container": "abc123",
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 987,
-  "quantity": 123.45,
-  "rating_summary": 987.65,
-  "redirect_code": 987,
+  "quantity": 987.65,
+  "rating_summary": 123.45,
+  "redirect_code": 123,
   "related_products": [ProductInterface],
-  "relative_url": "xyz789",
+  "relative_url": "abc123",
   "review_count": 123,
   "reviews": ProductReviews,
-  "rules": [CatalogRule],
-  "sale": 987,
   "short_description": ComplexTextValue,
-  "size": 123,
-  "sku": "abc123",
-  "sleeve": "abc123",
+  "sku": "xyz789",
   "small_image": ProductImage,
-  "special_from_date": "abc123",
+  "special_from_date": "xyz789",
   "special_price": 987.65,
   "special_to_date": "xyz789",
   "staged": false,
   "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
-  "style_bags": "abc123",
-  "style_bottom": "xyz789",
-  "style_general": "xyz789",
-  "swatch_image": "xyz789",
+  "swatch_image": "abc123",
   "thumbnail": ProductImage,
-  "tier_price": 987.65,
+  "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "xyz789",
-  "uid": "4",
-  "updated_at": "xyz789",
+  "type_id": "abc123",
+  "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],
-  "weight": 987.65
+  "weight": 123.45
 }
 
    
                 
    
@@ -74506,8 +74383,8 @@ 
    Example
    
                   
    {
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": 4
+  "quantity": 987.65,
+  "uid": "4"
 }
 
    
                 
    
@@ -74574,12 +74451,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "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
 }
 
    
                 
    
@@ -74634,8 +74511,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "payment_source": "abc123",
-  "payments_order_id": "xyz789",
+  "payment_source": "xyz789",
+  "payments_order_id": "abc123",
   "paypal_order_id": "abc123"
 }
 
    
@@ -74661,6 +74538,11 @@ 
    Fields
    
                       
                     
                     
+                      
+                        app_switch_when_available - Boolean
+                        
+                         Indicated whether to use App Switch on enabled mobile devices 
+                      
                       
                         button_styles - ButtonStyles
                         
@@ -74719,15 +74601,16 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
+  "app_switch_when_available": true,
   "button_styles": ButtonStyles,
   "code": "xyz789",
   "display_message": true,
-  "display_venmo": true,
+  "display_venmo": false,
   "is_visible": false,
   "message_styles": MessageStyles,
   "payment_intent": "abc123",
   "sdk_params": [SDKParams],
-  "sort_order": "abc123",
+  "sort_order": "xyz789",
   "title": "xyz789"
 }
 
    
@@ -74824,8 +74707,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "label": "xyz789",
-  "value": "xyz789"
+  "label": "abc123",
+  "value": "abc123"
 }
 
    
                 
    
@@ -75633,6 +75516,11 @@ 
    Fields
    
                         
                          Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). 
                       
+                      
+                        cart_merge_preference - String!
+                        
+                         Configuration data from checkout/cart/cart_merge_preference 
+                      
                       
                         cart_printed_card - String
                         
@@ -75855,12 +75743,7 @@ 
    Fields
    
                          The landing page that is associated with the base URL. 
                       
                       
-                        graphql_share_all_customer_groups - Boolean!
-                        
-                         Configuration data from customer/account_information/graphql_share_all_customer_groups 
-                      
-                      
-                        graphql_share_customer_group - Boolean!
+                        graphql_share_customer_group - Boolean
                         
                          Configuration data from customer/account_information/graphql_share_customer_group 
                       
@@ -76218,24 +76101,14 @@ 
    Fields
    
                          Email to a Friend configuration. 
                       
                       
-                        share_all_catalog_rules - Boolean!
-                        
-                         Configuration data from catalog/rule/share_all_catalog_rules 
-                      
-                      
-                        share_all_sales_rule - Boolean!
+                        share_active_segments - Boolean
                         
-                         Configuration data from promo/graphql/share_all_sales_rule 
+                         Configuration data from customer/magento_customersegment/share_active_segments 
                       
                       
-                        share_applied_catalog_rules - Boolean!
+                        share_applied_cart_rule - Boolean
                         
-                         Configuration data from catalog/rule/share_applied_catalog_rules 
-                      
-                      
-                        share_applied_sales_rule - Boolean!
-                        
-                         Configuration data from promo/graphql/share_applied_sales_rule 
+                         Configuration data from promo/graphql/share_applied_cart_rule 
                       
                       
                         shopping_cart_display_full_summary - Boolean
@@ -76396,248 +76269,246 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "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": "xyz789",
+  "allow_gift_wrapping_on_order": "abc123",
+  "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,
-  "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": true,
-  "braintree_3dsecure_specificcountry": "abc123",
+  "base_currency_code": "xyz789",
+  "base_link_url": "xyz789",
+  "base_media_url": "xyz789",
+  "base_static_url": "xyz789",
+  "base_url": "abc123",
+  "braintree_3dsecure_allowspecific": true,
+  "braintree_3dsecure_always_request_3ds": false,
+  "braintree_3dsecure_specificcountry": "xyz789",
   "braintree_3dsecure_threshold_amount": "xyz789",
-  "braintree_3dsecure_verify_3dsecure": false,
+  "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_cvv": false,
-  "braintree_environment": "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_local_payment_allowed_methods": "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": "xyz789",
   "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_color": "xyz789",
+  "braintree_paypal_button_location_cart_type_credit_label": "xyz789",
   "braintree_paypal_button_location_cart_type_credit_shape": "abc123",
   "braintree_paypal_button_location_cart_type_credit_show": true,
   "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789",
   "braintree_paypal_button_location_cart_type_messaging_logo": "abc123",
-  "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
+  "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789",
   "braintree_paypal_button_location_cart_type_messaging_show": false,
-  "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789",
-  "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
+  "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
+  "braintree_paypal_button_location_cart_type_paylater_color": "xyz789",
   "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
   "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
-  "braintree_paypal_button_location_cart_type_paylater_show": true,
-  "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
+  "braintree_paypal_button_location_cart_type_paylater_show": false,
+  "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
   "braintree_paypal_button_location_cart_type_paypal_label": "abc123",
   "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
-  "braintree_paypal_button_location_cart_type_paypal_show": 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": "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_credit_show": false,
+  "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
   "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
   "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
-  "braintree_paypal_button_location_checkout_type_messaging_show": false,
-  "braintree_paypal_button_location_checkout_type_messaging_text_color": "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": true,
+  "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": 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": 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_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_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": "abc123",
+  "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
+  "braintree_paypal_button_location_productpage_type_messaging_show": true,
+  "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789",
   "braintree_paypal_button_location_productpage_type_paylater_color": "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_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_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": "xyz789",
-  "braintree_paypal_display_on_shopping_cart": false,
+  "braintree_paypal_credit_uk_merchant_name": "abc123",
+  "braintree_paypal_display_on_shopping_cart": true,
   "braintree_paypal_merchant_country": "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": false,
-  "cart_expires_in_days": 987,
-  "cart_gift_wrapping": "xyz789",
+  "braintree_paypal_send_cart_line_items": true,
+  "braintree_paypal_vault_active": true,
+  "cart_expires_in_days": 123,
+  "cart_gift_wrapping": "abc123",
+  "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": 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_make_check_payable_to": "abc123",
+  "check_money_order_max_order_total": "abc123",
+  "check_money_order_min_order_total": "abc123",
   "check_money_order_new_order_status": "xyz789",
-  "check_money_order_payment_from_specific_countries": "abc123",
-  "check_money_order_send_check_to": "xyz789",
-  "check_money_order_sort_order": 123,
+  "check_money_order_payment_from_specific_countries": "xyz789",
+  "check_money_order_send_check_to": "abc123",
+  "check_money_order_sort_order": 987,
   "check_money_order_title": "abc123",
-  "cms_home_page": "abc123",
-  "cms_no_cookies": "abc123",
+  "cms_home_page": "xyz789",
+  "cms_no_cookies": "xyz789",
   "cms_no_route": "xyz789",
-  "code": "abc123",
+  "code": "xyz789",
   "configurable_product_image": "ITSELF",
   "configurable_thumbnail_source": "xyz789",
   "contact_enabled": false,
   "copyright": "abc123",
-  "countries_with_required_region": "xyz789",
+  "countries_with_required_region": "abc123",
   "create_account_confirmation": true,
   "customer_access_token_lifetime": 123.45,
-  "default_country": "abc123",
+  "default_country": "xyz789",
   "default_description": "xyz789",
   "default_display_currency_code": "abc123",
   "default_keywords": "xyz789",
   "default_title": "xyz789",
   "demonotice": 123,
-  "display_product_prices_in_catalog": 987,
+  "display_product_prices_in_catalog": 123,
   "display_shipping_prices": 123,
   "display_state_if_optional": false,
-  "enable_multiple_wishlists": "abc123",
-  "fixed_product_taxes_apply_tax_to_fpt": 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": 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": true,
-  "front": "abc123",
-  "graphql_share_all_customer_groups": false,
-  "graphql_share_customer_group": true,
+  "front": "xyz789",
+  "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_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": true,
   "is_negotiable_quote_active": false,
   "is_one_page_checkout_enabled": false,
-  "is_requisition_list_active": "abc123",
+  "is_requisition_list_active": "xyz789",
   "list_mode": "xyz789",
-  "list_per_page": 987,
+  "list_per_page": 123,
   "list_per_page_values": "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": "abc123",
   "magento_reward_general_is_enabled_on_front": "abc123",
-  "magento_reward_general_min_points_balance": "abc123",
-  "magento_reward_general_publish_history": "xyz789",
-  "magento_reward_points_invitation_customer": "xyz789",
+  "magento_reward_general_min_points_balance": "xyz789",
+  "magento_reward_general_publish_history": "abc123",
+  "magento_reward_points_invitation_customer": "abc123",
   "magento_reward_points_invitation_customer_limit": "xyz789",
   "magento_reward_points_invitation_order": "abc123",
-  "magento_reward_points_invitation_order_limit": "abc123",
-  "magento_reward_points_newsletter": "xyz789",
+  "magento_reward_points_invitation_order_limit": "xyz789",
+  "magento_reward_points_newsletter": "abc123",
   "magento_reward_points_order": "xyz789",
-  "magento_reward_points_register": "abc123",
-  "magento_reward_points_review": "xyz789",
-  "magento_reward_points_review_limit": "xyz789",
-  "magento_wishlist_general_is_enabled": "xyz789",
+  "magento_reward_points_register": "xyz789",
+  "magento_reward_points_review": "abc123",
+  "magento_reward_points_review_limit": "abc123",
+  "magento_wishlist_general_is_enabled": "abc123",
   "max_items_in_order_summary": 987,
-  "maximum_number_of_wishlists": "xyz789",
-  "minicart_display": true,
-  "minicart_max_items": 123,
+  "maximum_number_of_wishlists": "abc123",
+  "minicart_display": false,
+  "minicart_max_items": 987,
   "minimum_password_length": "xyz789",
   "newsletter_enabled": true,
-  "no_route": "xyz789",
-  "optional_zip_countries": "abc123",
+  "no_route": "abc123",
+  "optional_zip_countries": "xyz789",
   "order_cancellation_enabled": false,
   "order_cancellation_reasons": [CancellationReason],
-  "orders_invoices_credit_memos_display_full_summary": true,
-  "orders_invoices_credit_memos_display_grandtotal": false,
-  "orders_invoices_credit_memos_display_price": 987,
-  "orders_invoices_credit_memos_display_shipping_amount": 123,
-  "orders_invoices_credit_memos_display_subtotal": 123,
+  "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": 987,
   "orders_invoices_credit_memos_display_zero_tax": true,
-  "payment_payflowpro_cc_vault_active": "xyz789",
+  "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_reviews_enabled": "abc123",
   "product_url_suffix": "abc123",
-  "quickorder_active": true,
-  "required_character_classes_number": "abc123",
+  "quickorder_active": false,
+  "required_character_classes_number": "xyz789",
   "returns_enabled": "xyz789",
-  "root_category_id": 123,
+  "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": "abc123",
   "secure_base_media_url": "xyz789",
   "secure_base_static_url": "xyz789",
   "secure_base_url": "xyz789",
   "send_friend": SendFriendConfiguration,
-  "share_all_catalog_rules": true,
-  "share_all_sales_rule": false,
-  "share_applied_catalog_rules": true,
-  "share_applied_sales_rule": false,
-  "shopping_cart_display_full_summary": true,
-  "shopping_cart_display_grand_total": false,
-  "shopping_cart_display_price": 123,
-  "shopping_cart_display_shipping": 987,
+  "share_active_segments": true,
+  "share_applied_cart_rule": true,
+  "shopping_cart_display_full_summary": false,
+  "shopping_cart_display_grand_total": true,
+  "shopping_cart_display_price": 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,
+  "shopping_cart_display_zero_tax": false,
   "show_cms_breadcrumbs": 987,
-  "store_code": "4",
+  "store_code": 4,
   "store_group_code": 4,
   "store_group_name": "xyz789",
-  "store_name": "abc123",
-  "store_sort_order": 987,
+  "store_name": "xyz789",
+  "store_sort_order": 123,
   "timezone": "xyz789",
-  "title_prefix": "abc123",
+  "title_prefix": "xyz789",
   "title_separator": "xyz789",
   "title_suffix": "abc123",
-  "use_store_in_url": false,
+  "use_store_in_url": true,
   "website_code": "4",
   "website_id": 123,
   "website_name": "xyz789",
-  "weight_unit": "xyz789",
+  "weight_unit": "abc123",
   "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_sort_order": 123,
   "zero_subtotal_title": "xyz789"
 }
 
    
@@ -76703,7 +76574,7 @@ 
    Example
    
   "position": 987,
   "use_in_layered_navigation": "NO",
   "use_in_product_listing": false,
-  "use_in_search_results_layered_navigation": true,
+  "use_in_search_results_layered_navigation": false,
   "visible_on_catalog_pages": true
 }
    @@ -77021,7 +76892,7 @@
    Possible Types
    Example
    - 
    {"value": "abc123"}
+                  
    {"value": "xyz789"}
    @@ -77238,7 +77109,7 @@
    Fields
    Example
    {
   "items_count": 987,
-  "label": "abc123",
+  "label": "xyz789",
   "swatch_data": SwatchData,
   "value_string": "xyz789"
 }
@@ -77397,7 +77268,7 @@ 
    Example
    
                   
    {
   "amount": Money,
   "rate": 123.45,
-  "title": "xyz789"
+  "title": "abc123"
 }
 
    
                 
@@ -77969,7 +77840,7 @@ 
    Example
    
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
-  "event_name": "xyz789",
+  "event_name": "abc123",
   "message": "xyz789",
   "privacy_settings": "PRIVATE",
   "shipping_address": GiftRegistryShippingAddressInput,
@@ -78029,8 +77900,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "gift_registry_item_uid": 4,
-  "note": "abc123",
-  "quantity": 123.45
+  "note": "xyz789",
+  "quantity": 987.65
 }
 
    
                 
@@ -78181,8 +78052,8 @@ 
    Example
    
     GiftRegistryDynamicAttributeInput
   ],
   "email": "abc123",
-  "firstname": "xyz789",
-  "gift_registry_registrant_uid": "4",
+  "firstname": "abc123",
+  "gift_registry_registrant_uid": 4,
   "lastname": "xyz789"
 }
    @@ -78313,7 +78184,7 @@
    Fields
    Example
    {
   "items": [NegotiableQuoteItemQuantityInput],
-  "quote_uid": "4"
+  "quote_uid": 4
 }
    @@ -78403,7 +78274,7 @@
    Fields
    Example
    {
   "items": [NegotiableQuoteTemplateItemQuantityInput],
-  "template_id": "4"
+  "template_id": 4
 }
    @@ -78534,9 +78405,9 @@
    Example
    "approvers": [4], "condition": CreatePurchaseOrderApprovalRuleConditionInput, "description": "xyz789", - "name": "xyz789", + "name": "abc123", "status": "ENABLED", - "uid": 4 + "uid": "4" }     @@ -78649,8 +78520,8 @@
    Example
    {
   "entered_options": [EnteredOptionInput],
   "item_id": "4",
-  "quantity": 123.45,
-  "selected_options": ["xyz789"]
+  "quantity": 987.65,
+  "selected_options": ["abc123"]
 }
    @@ -78782,7 +78653,7 @@
    Fields
    Example
    {
-  "name": "xyz789",
+  "name": "abc123",
   "uid": 4,
   "visibility": "PUBLIC"
 }
@@ -78832,7 +78703,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "parameters": [HttpQueryParameter],
-  "url": "abc123"
+  "url": "xyz789"
 }
    @@ -78999,8 +78870,8 @@
    Fields
    Example
    {
-  "currentPage": 987,
-  "pageSize": 123,
+  "currentPage": 123,
+  "pageSize": 987,
   "sort": [CompaniesSortInput]
 }
    @@ -79483,7 +79354,7 @@
    Fields
    Example
    {
-  "is_vault_enabled": true,
+  "is_vault_enabled": false,
   "sdk_params": [SDKParams],
   "three_ds_mode": "OFF"
 }
@@ -79546,9 +79417,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "payment_source": "xyz789",
+  "payment_source": "abc123",
   "payments_order_id": "abc123",
-  "paypal_order_id": "abc123",
+  "paypal_order_id": "xyz789",
   "public_hash": "xyz789"
 }
 
    
@@ -79632,7 +79503,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"public_hash": "xyz789"}
+                  
    {"public_hash": "abc123"}
 
    
                 
    
               
    
@@ -79743,16 +79614,16 @@ 
    Example
    
   "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,
-  "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,
   "uid": 4
 }
    @@ -79782,13 +79653,6 @@
    Fields
    - - activity - String - - - Use the custom_attributes field instead. - - attribute_set_id - Int @@ -79805,27 +79669,6 @@
    Fields
    The categories assigned to a product. - - category_gear - String - - - Use the custom_attributes field instead. - - - - climate - String - - - Use the custom_attributes field instead. - - - - collar - String - - - Use the custom_attributes field instead. - - color - Int @@ -79872,41 +79715,6 @@
    filters Detailed information about the product. The value can include simple HTML tags. - - eco_collection - Int - - - Use the custom_attributes field instead. - - - - erin_recommends - Int - - - Use the custom_attributes field instead. - - - - features_bags - String - - - Use the custom_attributes field instead. - - - - format - Int - - - Use the custom_attributes field instead. - - - - gender - String - - - Use the custom_attributes field instead. - - gift_message_available - Boolean! @@ -79944,13 +79752,6 @@
    filters A number representing the product's manufacturer. Use the custom_attributes field instead. - - material - String - - - Use the custom_attributes field instead. - - max_sale_qty - Float @@ -79992,13 +79793,6 @@
    filters The product name. Customers use this name to identify the product. - - new - Int - - - Use the custom_attributes field instead. - - new_from_date - String @@ -80024,20 +79818,6 @@
    filters If the product has multiple options, determines where they appear on the product page. - - pattern - String - - - Use the custom_attributes field instead. - - - - performance_fabric - Int - - - Use the custom_attributes field instead. - - price - ProductPrices @@ -80059,13 +79839,6 @@
    filters An array of ProductLinks objects. - - purpose - Int - - - Use the custom_attributes field instead. - - quantity - Float @@ -80120,42 +79893,16 @@
    currentPage - - rules - [CatalogRule] - - Provides applied catalog rules in the current active cart - - - sale - Int - - - Use the custom_attributes field instead. - - short_description - ComplexTextValue A short description of the product. Its use depends on the theme. - - size - Int - - - Use the custom_attributes field instead. - - sku - String A number or code assigned to a product to identify the product, options, price, and manufacturer. - - sleeve - String - - - Use the custom_attributes field instead. - - small_image - ProductImage @@ -80187,34 +79934,6 @@
    currentPage Stock status of the product - - strap_bags - String - - - Use the custom_attributes field instead. - - - - style_bags - String - - - Use the custom_attributes field instead. - - - - style_bottom - String - - - Use the custom_attributes field instead. - - - - style_general - String - - - Use the custom_attributes field instead. - - swatch_image - String @@ -80300,87 +80019,65 @@
    currentPage
    Example
    {
-  "activity": "xyz789",
   "attribute_set_id": 987,
-  "canonical_url": "xyz789",
+  "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "xyz789",
-  "collar": "xyz789",
-  "color": 987,
+  "color": 123,
   "country_of_manufacture": "xyz789",
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 123,
-  "erin_recommends": 123,
-  "features_bags": "abc123",
-  "format": 987,
-  "gender": "abc123",
-  "gift_message_available": false,
-  "gift_wrapping_available": false,
+  "gift_message_available": true,
+  "gift_wrapping_available": true,
   "gift_wrapping_price": Money,
   "id": 987,
   "image": ProductImage,
   "is_returnable": "xyz789",
   "manufacturer": 987,
-  "material": "abc123",
-  "max_sale_qty": 123.45,
+  "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
   "meta_description": "abc123",
   "meta_keyword": "xyz789",
-  "meta_title": "xyz789",
+  "meta_title": "abc123",
   "min_sale_qty": 123.45,
   "name": "abc123",
-  "new": 123,
-  "new_from_date": "abc123",
-  "new_to_date": "abc123",
-  "only_x_left_in_stock": 123.45,
+  "new_from_date": "xyz789",
+  "new_to_date": "xyz789",
+  "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
-  "options_container": "abc123",
-  "pattern": "abc123",
-  "performance_fabric": 987,
+  "options_container": "xyz789",
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 987,
   "quantity": 987.65,
   "rating_summary": 123.45,
   "redirect_code": 987,
   "related_products": [ProductInterface],
-  "relative_url": "xyz789",
-  "review_count": 123,
+  "relative_url": "abc123",
+  "review_count": 987,
   "reviews": ProductReviews,
-  "rules": [CatalogRule],
-  "sale": 123,
   "short_description": ComplexTextValue,
-  "size": 987,
   "sku": "xyz789",
-  "sleeve": "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",
-  "strap_bags": "xyz789",
-  "style_bags": "abc123",
-  "style_bottom": "abc123",
-  "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",
-  "updated_at": "abc123",
+  "uid": 4,
+  "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
   "url_key": "abc123",
-  "url_path": "xyz789",
+  "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
   "url_suffix": "abc123",
   "websites": [Website]
@@ -80492,7 +80189,7 @@ 
    Example
    
                   
    {
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "uid": "4"
 }
 
    
@@ -80560,12 +80257,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "added_at": "abc123",
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
   "id": 4,
   "product": ProductInterface,
-  "quantity": 987.65
+  "quantity": 123.45
 }
 
    
                 
    
@@ -80639,10 +80336,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "xyz789",
-  "default_group_id": "abc123",
-  "id": 987,
-  "is_default": false,
-  "name": "xyz789",
+  "default_group_id": "xyz789",
+  "id": 123,
+  "is_default": true,
+  "name": "abc123",
   "sort_order": 987
 }
 
    
@@ -80691,7 +80388,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "PRODUCT_NOT_FOUND",
-  "message": "abc123"
+  "message": "xyz789"
 }
    @@ -80836,11 +80533,11 @@
    pageSize
    Example
    {
-  "id": "4",
+  "id": 4,
   "items": [WishlistItem],
   "items_count": 123,
   "items_v2": WishlistItems,
-  "name": "xyz789",
+  "name": "abc123",
   "sharing_code": "abc123",
   "updated_at": "abc123",
   "visibility": "PUBLIC"
@@ -80901,8 +80598,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "PRODUCT_NOT_FOUND",
-  "message": "abc123",
-  "wishlistId": "4",
+  "message": "xyz789",
+  "wishlistId": 4,
   "wishlistItemId": "4"
 }
 
    
@@ -80939,6 +80636,13 @@ 
    Values
    
                         
                         
                       
+                      
+                        
+                          
    REQUIRED_PARAMETER_MISSING
    
+                        
+                        
+                        
+                      
                       
                         
                           
    NOT_SALABLE
    
@@ -81032,7 +80736,7 @@ 
    Example
    
   "description": "abc123",
   "id": 987,
   "product": ProductInterface,
-  "qty": 123.45
+  "qty": 987.65
 }
    @@ -81080,10 +80784,7 @@
    Fields
    Example
    - 
    {
-  "quantity": 123.45,
-  "wishlist_item_id": "4"
-}
+                  
    {"quantity": 987.65, "wishlist_item_id": 4}
    @@ -81152,8 +80853,8 @@
    Example
    "entered_options": [EnteredOptionInput], "parent_sku": "abc123", "quantity": 123.45, - "selected_options": ["4"], - "sku": "xyz789" + "selected_options": [4], + "sku": "abc123" }     @@ -81241,12 +80942,12 @@
    Possible Types
    -

    BundleWishlistItem

    +

    DownloadableWishlistItem

    -

    DownloadableWishlistItem

    +

    BundleWishlistItem

    @@ -81320,10 +81021,7 @@
    Fields
    Example
    - 
    {
-  "quantity": 123.45,
-  "wishlist_item_id": "4"
-}
+                  
    {"quantity": 987.65, "wishlist_item_id": 4}
    @@ -81509,8 +81207,8 @@
    Fields
    Example
    {
   "items": [WishlistItem],
-  "items_count": 123,
-  "name": "abc123",
+  "items_count": 987,
+  "name": "xyz789",
   "sharing_code": "xyz789",
   "updated_at": "xyz789"
 }

From 863c2c938d5ce7a790e5b02ef5a479eb4693066f Mon Sep 17 00:00:00 2001
From: Dima Shevtsov 
Date: Mon, 11 May 2026 18:30:13 -0500
Subject: [PATCH 2/3] Revert openapi schemas

---
 src/openapi/admin-schema-2.4.9-beta-1.yaml    | 37205 ++++++++++++++++
 src/openapi/customer-schema-2.4.9-beta-1.yaml |  7870 ++++
 src/openapi/guest-schema-2.4.9-beta-1.yaml    |  6073 +++
 3 files changed, 51148 insertions(+)
 create mode 100644 src/openapi/admin-schema-2.4.9-beta-1.yaml
 create mode 100644 src/openapi/customer-schema-2.4.9-beta-1.yaml
 create mode 100644 src/openapi/guest-schema-2.4.9-beta-1.yaml

diff --git a/src/openapi/admin-schema-2.4.9-beta-1.yaml b/src/openapi/admin-schema-2.4.9-beta-1.yaml
new file mode 100644
index 000000000..31d73755e
--- /dev/null
+++ b/src/openapi/admin-schema-2.4.9-beta-1.yaml
@@ -0,0 +1,37205 @@
+---
+securityDefinitions:
+  api_key:
+    type: apiKey
+    name: api_key
+    in: header
+swagger: '2.0'
+info:
+  version: 2.4.9-beta-1
+  title: Commerce Admin REST endpoints - All inclusive
+  description:
+    "$ref": "../_includes/redocly-intro.md"
+host: example.com
+basePath: "/rest/default"
+schemes:
+- http
+tags:
+- name: addresses/{addressId}
+- name: adminuisdk/appmanagement/validate
+- name: adminuisdk/massaction/{request_id}
+- name: adminuisdk/orderviewbutton/{request_id}
+- name: adobe_io_events/check_configuration
+- name: adobestock/asset/{id}
+- name: adobestock/asset/list
+- name: adobestock/asset/search
+- name: adobestock/search
+- name: analytics/link
+- name: applepay/auth
+- name: attributeMetadata/customer
+- name: attributeMetadata/customer/attribute/{attributeCode}
+- name: attributeMetadata/customer/custom
+- name: attributeMetadata/customer/form/{formCode}
+- name: attributeMetadata/customerAddress
+- name: attributeMetadata/customerAddress/attribute/{attributeCode}
+- name: attributeMetadata/customerAddress/custom
+- name: attributeMetadata/customerAddress/form/{formCode}
+- name: braintree/mine/payment/vault
+- name: bulk
+- name: bulk/{bulkUuid}/detailed-status
+- name: bulk/{bulkUuid}/operation-status/{status}
+- name: bulk/{bulkUuid}/status
+- name: bundle-products/{productSku}/children
+- name: bundle-products/{sku}/links/{id}
+- name: bundle-products/{sku}/links/{optionId}
+- name: bundle-products/{sku}/options/{optionId}
+- name: bundle-products/{sku}/options/{optionId}/children/{childSku}
+- name: bundle-products/{sku}/options/all
+- name: bundle-products/options/{optionId}
+- name: bundle-products/options/add
+- name: bundle-products/options/types
+- name: carts/
+- name: carts/{cartId}
+- name: carts/{cartId}/billing-address
+- name: carts/{cartId}/coupons
+- name: carts/{cartId}/coupons/{couponCode}
+- name: carts/{cartId}/coupons/deleteByCodes
+- name: carts/{cartId}/estimate-shipping-methods
+- name: carts/{cartId}/estimate-shipping-methods-by-address-id
+- name: carts/{cartId}/gift-message
+- name: carts/{cartId}/gift-message/{itemId}
+- name: carts/{cartId}/giftCards
+- name: carts/{cartId}/giftCards/{giftCardCode}
+- name: carts/{cartId}/items
+- name: carts/{cartId}/items/{itemId}
+- name: carts/{cartId}/order
+- name: carts/{cartId}/payment-methods
+- name: carts/{cartId}/selected-payment-method
+- name: carts/{cartId}/shipping-information
+- name: carts/{cartId}/shipping-methods
+- name: carts/{cartId}/totals
+- name: carts/{cartId}/totals-information
+- name: carts/{quoteId}/giftCards
+- name: carts/{quoteId}/items
+- name: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
+- name: carts/guest-carts/{cartId}/giftCards
+- name: carts/guest-carts/{cartId}/giftCards/{giftCardCode}
+- name: carts/licence
+- name: carts/licence/list
+- name: carts/mine
+- name: carts/mine/balance/apply
+- name: carts/mine/billing-address
+- name: carts/mine/checkGiftCard/{giftCardCode}
+- name: carts/mine/collect-totals
+- name: carts/mine/coupons
+- name: carts/mine/coupons/{couponCode}
+- name: carts/mine/coupons/deleteByCodes
+- name: carts/mine/estimate-shipping-methods
+- name: carts/mine/estimate-shipping-methods-by-address-id
+- name: carts/mine/gift-message
+- name: carts/mine/gift-message/{itemId}
+- name: carts/mine/giftCards
+- name: carts/mine/giftCards/{giftCardCode}
+- name: carts/mine/items
+- name: carts/mine/items/{itemId}
+- name: carts/mine/order
+- name: carts/mine/payment-information
+- name: carts/mine/payment-methods
+- name: carts/mine/payment-order
+- name: carts/mine/payment-order/{id}
+- name: carts/mine/po-payment-information
+- name: carts/mine/selected-payment-method
+- name: carts/mine/set-payment-information
+- name: carts/mine/shipping-information
+- name: carts/mine/shipping-methods
+- name: carts/mine/totals
+- name: carts/mine/totals-information
+- name: carts/search
+- name: categories
+- name: categories/{categoryId}
+- name: categories/{categoryId}/move
+- name: categories/{categoryId}/products
+- name: categories/{categoryId}/products/{sku}
+- name: categories/{id}
+- name: categories/attributes
+- name: categories/attributes/{attributeCode}
+- name: categories/attributes/{attributeCode}/options
+- name: categories/list
+- name: cmsBlock
+- name: cmsBlock/{blockId}
+- name: cmsBlock/{id}
+- name: cmsBlock/search
+- name: cmsPage
+- name: cmsPage/{id}
+- name: cmsPage/{pageId}
+- name: cmsPage/search
+- name: company/
+- name: company/{companyId}
+- name: company/{parentId}/relations
+- name: company/{parentId}/relations/{companyId}
+- name: company/assignRoles
+- name: company/relations
+- name: company/role/
+- name: company/role/{id}
+- name: company/role/{roleId}
+- name: company/role/{roleId}/users
+- name: companyCredits/
+- name: companyCredits/{creditId}
+- name: companyCredits/{creditId}/decreaseBalance
+- name: companyCredits/{creditId}/increaseBalance
+- name: companyCredits/{id}
+- name: companyCredits/company/{companyId}
+- name: companyCredits/history
+- name: companyCredits/history/{historyId}
+- name: configurable-products/{sku}/child
+- name: configurable-products/{sku}/children
+- name: configurable-products/{sku}/children/{childSku}
+- name: configurable-products/{sku}/options
+- name: configurable-products/{sku}/options/{id}
+- name: configurable-products/{sku}/options/all
+- name: configurable-products/variation
+- name: coupons
+- name: coupons/{couponId}
+- name: coupons/deleteByCodes
+- name: coupons/deleteByIds
+- name: coupons/generate
+- name: coupons/search
+- name: creditmemo
+- name: creditmemo/{id}
+- name: creditmemo/{id}/comments
+- name: creditmemo/{id}/emails
+- name: creditmemo/refund
+- name: creditmemos
+- name: customerGroups
+- name: customerGroups/{id}
+- name: customerGroups/{id}/permissions
+- name: customerGroups/default
+- name: customerGroups/default/{id}
+- name: customerGroups/default/{storeId}
+- name: customerGroups/search
+- name: customers
+- name: customers/{customerId}
+- name: customers/{customerId}/billingAddress
+- name: customers/{customerId}/carts
+- name: customers/{customerId}/companies
+- name: customers/{customerId}/companies/{companyId}
+- name: customers/{customerId}/confirm
+- name: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
+- name: customers/{customerId}/permissions/readonly
+- name: customers/{customerId}/shippingAddress
+- name: customers/{customerId}/token
+- name: customers/{email}/activate
+- name: customers/activate
+- name: customers/addresses/{addressId}
+- name: customers/companies
+- name: customers/confirm
+- name: customers/isEmailAvailable
+- name: customers/me
+- name: customers/me/activate
+- name: customers/me/billingAddress
+- name: customers/me/password
+- name: customers/me/shippingAddress
+- name: customers/password
+- name: customers/resetPassword
+- name: customers/search
+- name: customers/validate
+- name: directory/countries
+- name: directory/countries/{countryId}
+- name: directory/currency
+- name: eav/attribute-sets
+- name: eav/attribute-sets/{attributeSetId}
+- name: eav/attribute-sets/list
+- name: eventing/eventProvider
+- name: eventing/eventProvider/{providerId}
+- name: eventing/eventSubscribe
+- name: eventing/eventSubscribe/{name}
+- name: eventing/eventUnsubscribe/{name}
+- name: eventing/getEventProviders
+- name: eventing/getEventSubscriptions
+- name: eventing/updateConfiguration
+- name: gift-wrappings
+- name: gift-wrappings/{id}
+- name: gift-wrappings/{wrappingId}
+- name: giftregistry/mine/estimate-shipping-methods
+- name: guest-carts
+- name: guest-carts/{cartId}
+- name: guest-carts/{cartId}/billing-address
+- name: guest-carts/{cartId}/collect-totals
+- name: guest-carts/{cartId}/coupons
+- name: guest-carts/{cartId}/coupons/{couponCode}
+- name: guest-carts/{cartId}/estimate-shipping-methods
+- name: guest-carts/{cartId}/gift-message
+- name: guest-carts/{cartId}/gift-message/{itemId}
+- name: guest-carts/{cartId}/items
+- name: guest-carts/{cartId}/items/{itemId}
+- name: guest-carts/{cartId}/order
+- name: guest-carts/{cartId}/payment-information
+- name: guest-carts/{cartId}/payment-methods
+- name: guest-carts/{cartId}/payment-order
+- name: guest-carts/{cartId}/payment-order/{id}
+- name: guest-carts/{cartId}/selected-payment-method
+- name: guest-carts/{cartId}/set-payment-information
+- name: guest-carts/{cartId}/shipping-information
+- name: guest-carts/{cartId}/shipping-methods
+- name: guest-carts/{cartId}/totals
+- name: guest-carts/{cartId}/totals-information
+- name: guest-giftregistry/{cartId}/estimate-shipping-methods
+- name: hierarchy/{id}
+- name: hierarchy/move/{id}
+- name: import/csv
+- name: import/json
+- name: integration/admin/token
+- name: integration/customer/revoke-customer-token
+- name: integration/customer/token
+- name: inventory/are-product-salable-for-requested-qty/
+- name: inventory/are-products-salable
+- name: inventory/bulk-partial-source-transfer
+- name: inventory/bulk-product-source-assign
+- name: inventory/bulk-product-source-transfer
+- name: inventory/bulk-product-source-unassign
+- name: inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode}
+- name: inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode}
+- name: inventory/get-distance
+- name: inventory/get-distance-provider-code
+- name: inventory/get-latlng-from-address
+- name: inventory/get-latslngs-from-address
+- name: inventory/get-product-salable-quantity/{sku}/{stockId}
+- name: inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId}
+- name: inventory/in-store-pickup/pickup-locations/
+- name: inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty}
+- name: inventory/is-product-salable/{sku}/{stockId}
+- name: inventory/low-quantity-notification
+- name: inventory/low-quantity-notification/{sourceCode}/{sku}
+- name: inventory/low-quantity-notifications-delete
+- name: inventory/source-items
+- name: inventory/source-items-delete
+- name: inventory/source-selection-algorithm-list
+- name: inventory/source-selection-algorithm-result
+- name: inventory/sources
+- name: inventory/sources/{sourceCode}
+- name: inventory/stock-resolver/{type}/{code}
+- name: inventory/stock-source-links
+- name: inventory/stock-source-links-delete
+- name: inventory/stocks
+- name: inventory/stocks/{stockId}
+- name: invoice/{invoiceId}/refund
+- name: invoices
+- name: invoices/
+- name: invoices/{id}
+- name: invoices/{id}/capture
+- name: invoices/{id}/comments
+- name: invoices/{id}/emails
+- name: invoices/{id}/void
+- name: invoices/comments
+- name: modules
+- name: negotiable-cart-item-note
+- name: negotiable-cart-item-note/{noteId}
+- name: negotiable-cart-item-note/search
+- name: negotiable-carts/{cartId}/billing-address
+- name: negotiable-carts/{cartId}/coupons
+- name: negotiable-carts/{cartId}/coupons/{couponCode}
+- name: negotiable-carts/{cartId}/estimate-shipping-methods
+- name: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
+- name: negotiable-carts/{cartId}/giftCards
+- name: negotiable-carts/{cartId}/giftCards/{giftCardCode}
+- name: negotiable-carts/{cartId}/payment-information
+- name: negotiable-carts/{cartId}/po-payment-information
+- name: negotiable-carts/{cartId}/set-payment-information
+- name: negotiable-carts/{cartId}/shipping-information
+- name: negotiable-carts/{cartId}/totals
+- name: negotiableQuote/{negotiableQuoteId}/duplicate
+- name: negotiableQuote/{quoteId}
+- name: negotiableQuote/{quoteId}/comments
+- name: negotiableQuote/{quoteId}/shippingMethod
+- name: negotiableQuote/attachmentContent
+- name: negotiableQuote/decline
+- name: negotiableQuote/draft
+- name: negotiableQuote/pricesUpdated
+- name: negotiableQuote/request
+- name: negotiableQuote/submitToCustomer
+- name: negotiableQuoteTemplate
+- name: negotiableQuoteTemplate/{templateId}
+- name: negotiableQuoteTemplate/accept
+- name: negotiableQuoteTemplate/cancel
+- name: negotiableQuoteTemplate/cancel/me
+- name: negotiableQuoteTemplate/decline
+- name: negotiableQuoteTemplate/draft
+- name: negotiableQuoteTemplate/generateQuote
+- name: negotiableQuoteTemplate/me
+- name: negotiableQuoteTemplate/me/{templateId}
+- name: negotiableQuoteTemplate/open
+- name: negotiableQuoteTemplate/open/me
+- name: negotiableQuoteTemplate/referenceDocumentLink
+- name: negotiableQuoteTemplate/referenceDocumentLink/{linkId}
+- name: negotiableQuoteTemplate/request
+- name: negotiableQuoteTemplate/request/me
+- name: negotiableQuoteTemplate/submitToCustomer
+- name: negotiableQuoteTemplate/submitToSeller
+- name: order/{orderId}/invoice
+- name: order/{orderId}/refund
+- name: order/{orderId}/ship
+- name: order/notify-orders-are-ready-for-pickup
+- name: orders
+- name: orders/{id}
+- name: orders/{id}/cancel
+- name: orders/{id}/comments
+- name: orders/{id}/emails
+- name: orders/{id}/hold
+- name: orders/{id}/statuses
+- name: orders/{id}/unhold
+- name: orders/{parent_id}
+- name: orders/create
+- name: orders/items
+- name: orders/items/{id}
+- name: payment-order/completeOrder
+- name: payments-config/{location}
+- name: payments-config/apple-pay/{location}
+- name: payments-config/google-pay/{location}
+- name: payments-config/hosted-fields/{location}
+- name: payments-config/smart-buttons/{location}
+- name: payments-sdk/{location}
+- name: payments-sdk/{location}/{methodCode}
+- name: paypal/lineItems
+- name: paypal/oneClick
+- name: paypal/validatePhoneNumber
+- name: products
+- name: products-render-info
+- name: products/{productSku}/stockItems/{itemId}
+- name: products/{sku}
+- name: products/{sku}/downloadable-links
+- name: products/{sku}/downloadable-links/{id}
+- name: products/{sku}/downloadable-links/samples
+- name: products/{sku}/downloadable-links/samples/{id}
+- name: products/{sku}/group-prices/{customerGroupId}/tiers
+- name: products/{sku}/group-prices/{customerGroupId}/tiers/{qty}
+- name: products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}
+- name: products/{sku}/links
+- name: products/{sku}/links/{type}
+- name: products/{sku}/links/{type}/{linkedProductSku}
+- name: products/{sku}/media
+- name: products/{sku}/media/{entryId}
+- name: products/{sku}/options
+- name: products/{sku}/options/{optionId}
+- name: products/{sku}/websites
+- name: products/{sku}/websites/{websiteId}
+- name: products/attribute-sets
+- name: products/attribute-sets/{attributeSetId}
+- name: products/attribute-sets/{attributeSetId}/attributes
+- name: products/attribute-sets/{attributeSetId}/attributes/{attributeCode}
+- name: products/attribute-sets/{attributeSetId}/groups
+- name: products/attribute-sets/attributes
+- name: products/attribute-sets/groups
+- name: products/attribute-sets/groups/{groupId}
+- name: products/attribute-sets/groups/list
+- name: products/attribute-sets/sets/list
+- name: products/attributes
+- name: products/attributes/{attributeCode}
+- name: products/attributes/{attributeCode}/is-filterable
+- name: products/attributes/{attributeCode}/is-filterable/{isFilterable}
+- name: products/attributes/{attributeCode}/options
+- name: products/attributes/{attributeCode}/options/{optionId}
+- name: products/attributes/types
+- name: products/base-prices
+- name: products/base-prices-information
+- name: products/cost
+- name: products/cost-delete
+- name: products/cost-information
+- name: products/downloadable-links/{id}
+- name: products/downloadable-links/samples/{id}
+- name: products/links/{type}/attributes
+- name: products/links/types
+- name: products/media/types/{attributeSetName}
+- name: products/options
+- name: products/options/{optionId}
+- name: products/options/types
+- name: products/special-price
+- name: products/special-price-delete
+- name: products/special-price-information
+- name: products/tier-prices
+- name: products/tier-prices-delete
+- name: products/tier-prices-information
+- name: products/types
+- name: purchase-order-carts/{cartId}/billing-address
+- name: purchase-order-carts/{cartId}/estimate-shipping-methods
+- name: purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id
+- name: purchase-order-carts/{cartId}/giftCards
+- name: purchase-order-carts/{cartId}/giftCards/{giftCardCode}
+- name: purchase-order-carts/{cartId}/payment-information
+- name: purchase-order-carts/{cartId}/set-payment-information
+- name: purchase-order-carts/{cartId}/totals
+- name: requisition_lists
+- name: returns
+- name: returns/{id}
+- name: returns/{id}/comments
+- name: returns/{id}/labels
+- name: returns/{id}/tracking-numbers
+- name: returns/{id}/tracking-numbers/{trackId}
+- name: returnsAttributeMetadata
+- name: returnsAttributeMetadata/{attributeCode}
+- name: returnsAttributeMetadata/custom
+- name: returnsAttributeMetadata/form/{formCode}
+- name: reward/mine/use-reward
+- name: salesRules
+- name: salesRules/{ruleId}
+- name: salesRules/search
+- name: search
+- name: sharedCatalog
+- name: sharedCatalog/
+- name: sharedCatalog/{id}
+- name: sharedCatalog/{id}/assignCategories
+- name: sharedCatalog/{id}/assignProducts
+- name: sharedCatalog/{id}/categories
+- name: sharedCatalog/{id}/products
+- name: sharedCatalog/{id}/unassignCategories
+- name: sharedCatalog/{id}/unassignProducts
+- name: sharedCatalog/{sharedCatalogId}
+- name: sharedCatalog/{sharedCatalogId}/assignCompanies
+- name: sharedCatalog/{sharedCatalogId}/assignTierPrices
+- name: sharedCatalog/{sharedCatalogId}/companies
+- name: sharedCatalog/{sharedCatalogId}/resetTierPrices
+- name: sharedCatalog/{sharedCatalogId}/unassignCompanies
+- name: shipment/
+- name: shipment/{id}
+- name: shipment/{id}/comments
+- name: shipment/{id}/emails
+- name: shipment/{id}/label
+- name: shipment/track
+- name: shipment/track/{id}
+- name: shipments
+- name: stockItems/{productSku}
+- name: stockItems/lowStock/
+- name: stockStatuses/{productSku}
+- name: store/storeConfigs
+- name: store/storeGroups
+- name: store/storeViews
+- name: store/websites
+- name: taxClasses
+- name: taxClasses/{classId}
+- name: taxClasses/{taxClassId}
+- name: taxClasses/search
+- name: taxRates
+- name: taxRates/{rateId}
+- name: taxRates/search
+- name: taxRules
+- name: taxRules/{ruleId}
+- name: taxRules/search
+- name: team/
+- name: team/{companyId}
+- name: team/{teamId}
+- name: tfa/default-provider-code/{userId}
+- name: tfa/forced-providers
+- name: tfa/installed-providers
+- name: tfa/provider/authy/activate
+- name: tfa/provider/authy/authenticate
+- name: tfa/provider/authy/authenticate-onetouch
+- name: tfa/provider/authy/configure
+- name: tfa/provider/authy/send-token/{via}
+- name: tfa/provider/duo_security/activate
+- name: tfa/provider/duo_security/authenticate
+- name: tfa/provider/duo_security/configure
+- name: tfa/provider/google/activate
+- name: tfa/provider/google/authenticate
+- name: tfa/provider/google/configure
+- name: tfa/provider/u2fkey/activate
+- name: tfa/provider/u2fkey/authentication-challenge
+- name: tfa/provider/u2fkey/configure
+- name: tfa/provider/u2fkey/verify
+- name: tfa/providers-to-activate/{userId}
+- name: tfa/tfat-providers-to-activate
+- name: tfa/tfat-user-providers
+- name: tfa/user-providers/{userId}
+- name: transactions
+- name: transactions/{id}
+- name: webhooks/list
+- name: webhooks/subscribe
+- name: webhooks/unsubscribe
+paths:
+  "/V1/addresses/{addressId}":
+    delete:
+      tags:
+      - addresses/{addressId}
+      description: Delete customer address by ID.
+      operationId: DeleteV1AddressesAddressId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: addressId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: addresses/{addressId}
+  "/V1/adminuisdk/appmanagement/validate":
+    post:
+      tags:
+      - adminuisdk/appmanagement/validate
+      description: Validate App Management User token
+      operationId: PostV1AdminuisdkAppmanagementValidate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1AdminuisdkAppmanagementValidateBody
+        in: body
+        schema:
+          required:
+          - orgId
+          properties:
+            orgId:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/commerce-backend-uix-data-app-management-validation-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: adminuisdk/appmanagement/validate
+  "/V1/adminuisdk/massaction/{request_id}":
+    get:
+      tags:
+      - adminuisdk/massaction/{request_id}
+      description: Load mass actions failed request by request id
+      operationId: GetV1AdminuisdkMassactionRequest_id
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: requestId
+        in: query
+        type: string
+        required: true
+      - name: request_id
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/commerce-backend-uix-data-mass-action-failed-request-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: adminuisdk/massaction/{request_id}
+  "/V1/adminuisdk/orderviewbutton/{request_id}":
+    get:
+      tags:
+      - adminuisdk/orderviewbutton/{request_id}
+      description: Load order view button failed request by request id
+      operationId: GetV1AdminuisdkOrderviewbuttonRequest_id
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: requestId
+        in: query
+        type: string
+        required: true
+      - name: request_id
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/commerce-backend-uix-data-order-view-button-failed-request-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: adminuisdk/orderviewbutton/{request_id}
+  "/V1/adobe_io_events/check_configuration":
+    get:
+      tags:
+      - adobe_io_events/check_configuration
+      description: Checks configuration and returns success/failure results for each
+        component
+      operationId: GetV1Adobe_io_eventsCheck_configuration
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/adobe-io-events-client-configuration-check-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: adobe_io_events/check_configuration
+  "/V1/adobestock/asset/list":
+    get:
+      tags:
+      - adobestock/asset/list
+      description: Search for images based on search criteria
+      operationId: GetV1AdobestockAssetList
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[requestName]
+        in: query
+        type: string
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/framework-search-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: adobestock/asset/list
+  "/V1/adobestock/asset/search":
+    get:
+      tags:
+      - adobestock/asset/search
+      description: Get a list of assets
+      operationId: GetV1AdobestockAssetSearch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/adobe-stock-asset-api-data-asset-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: adobestock/asset/search
+  "/V1/adobestock/asset/{id}":
+    delete:
+      tags:
+      - adobestock/asset/{id}
+      description: Delete asset
+      operationId: DeleteV1AdobestockAssetId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: adobestock/asset/{id}
+    get:
+      tags:
+      - adobestock/asset/{id}
+      description: Get asset by id
+      operationId: GetV1AdobestockAssetId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/adobe-stock-asset-api-data-asset-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: adobestock/asset/{id}
+  "/V1/adobestock/search":
+    get:
+      tags:
+      - adobestock/search
+      description: Search for images based on search criteria
+      operationId: GetV1AdobestockSearch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[requestName]
+        in: query
+        type: string
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/framework-search-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: adobestock/search
+  "/V1/analytics/link":
+    get:
+      tags:
+      - analytics/link
+      description: Retrieve link
+      operationId: GetV1AnalyticsLink
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/analytics-data-link-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: analytics/link
+  "/V1/applepay/auth":
+    get:
+      tags:
+      - applepay/auth
+      description: Returns details required to be able to submit a payment with Apple
+        Pay
+      operationId: GetV1ApplepayAuth
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/pay-pal-braintree-data-auth-data-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: applepay/auth
+  "/V1/attributeMetadata/customer":
+    get:
+      tags:
+      - attributeMetadata/customer
+      description: Get all attribute metadata.
+      operationId: GetV1AttributeMetadataCustomer
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/customer-data-attribute-metadata-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: attributeMetadata/customer
+  "/V1/attributeMetadata/customer/attribute/{attributeCode}":
+    get:
+      tags:
+      - attributeMetadata/customer/attribute/{attributeCode}
+      description: Retrieve attribute metadata.
+      operationId: GetV1AttributeMetadataCustomerAttributeAttributeCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-attribute-metadata-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: attributeMetadata/customer/attribute/{attributeCode}
+  "/V1/attributeMetadata/customer/custom":
+    get:
+      tags:
+      - attributeMetadata/customer/custom
+      description: Get custom attributes metadata for the given data interface.
+      operationId: GetV1AttributeMetadataCustomerCustom
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: dataInterfaceName
+        in: query
+        type: string
+        required: false
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/customer-data-attribute-metadata-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: attributeMetadata/customer/custom
+  "/V1/attributeMetadata/customer/form/{formCode}":
+    get:
+      tags:
+      - attributeMetadata/customer/form/{formCode}
+      description: Retrieve all attributes filtered by form code
+      operationId: GetV1AttributeMetadataCustomerFormFormCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: formCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/customer-data-attribute-metadata-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: attributeMetadata/customer/form/{formCode}
+  "/V1/attributeMetadata/customerAddress":
+    get:
+      tags:
+      - attributeMetadata/customerAddress
+      description: Get all attribute metadata.
+      operationId: GetV1AttributeMetadataCustomerAddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/customer-data-attribute-metadata-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: attributeMetadata/customerAddress
+  "/V1/attributeMetadata/customerAddress/attribute/{attributeCode}":
+    get:
+      tags:
+      - attributeMetadata/customerAddress/attribute/{attributeCode}
+      description: Retrieve attribute metadata.
+      operationId: GetV1AttributeMetadataCustomerAddressAttributeAttributeCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-attribute-metadata-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: attributeMetadata/customerAddress/attribute/{attributeCode}
+  "/V1/attributeMetadata/customerAddress/custom":
+    get:
+      tags:
+      - attributeMetadata/customerAddress/custom
+      description: Get custom attributes metadata for the given data interface.
+      operationId: GetV1AttributeMetadataCustomerAddressCustom
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: dataInterfaceName
+        in: query
+        type: string
+        required: false
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/customer-data-attribute-metadata-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: attributeMetadata/customerAddress/custom
+  "/V1/attributeMetadata/customerAddress/form/{formCode}":
+    get:
+      tags:
+      - attributeMetadata/customerAddress/form/{formCode}
+      description: Retrieve all attributes filtered by form code
+      operationId: GetV1AttributeMetadataCustomerAddressFormFormCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: formCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/customer-data-attribute-metadata-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: attributeMetadata/customerAddress/form/{formCode}
+  "/V1/braintree/mine/payment/vault":
+    post:
+      tags:
+      - braintree/mine/payment/vault
+      description: Vault a Payment nonce for a customer. Billing address is optional
+        but advised for Card vaulting.
+      operationId: PostV1BraintreeMinePaymentVault
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1BraintreeMinePaymentVaultBody
+        in: body
+        schema:
+          required:
+          - payment
+          properties:
+            payment:
+              "$ref": "#/definitions/pay-pal-braintree-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/customer-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: braintree/mine/payment/vault
+  "/V1/bulk":
+    get:
+      tags:
+      - bulk
+      description: Lists the bulk operation items that match specified search criteria.
+      operationId: GetV1Bulk
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/asynchronous-operations-data-operation-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: bulk
+  "/V1/bulk/{bulkUuid}/detailed-status":
+    get:
+      tags:
+      - bulk/{bulkUuid}/detailed-status
+      description: Get Bulk summary data with list of operations items full data.
+      operationId: GetV1BulkBulkUuidDetailedstatus
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: bulkUuid
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/asynchronous-operations-data-detailed-bulk-operations-status-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: bulk/{bulkUuid}/detailed-status
+  "/V1/bulk/{bulkUuid}/operation-status/{status}":
+    get:
+      tags:
+      - bulk/{bulkUuid}/operation-status/{status}
+      description: Get operations count by bulk uuid and status.
+      operationId: GetV1BulkBulkUuidOperationstatusStatus
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: bulkUuid
+        in: path
+        type: string
+        required: true
+      - name: status
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: bulk/{bulkUuid}/operation-status/{status}
+  "/V1/bulk/{bulkUuid}/status":
+    get:
+      tags:
+      - bulk/{bulkUuid}/status
+      description: Get Bulk summary data with list of operations items short data.
+      operationId: GetV1BulkBulkUuidStatus
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: bulkUuid
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/asynchronous-operations-data-bulk-operations-status-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: bulk/{bulkUuid}/status
+  "/V1/bundle-products/options/add":
+    post:
+      tags:
+      - bundle-products/options/add
+      description: Add new option for bundle product
+      operationId: PostV1BundleproductsOptionsAdd
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1BundleproductsOptionsAddBody
+        in: body
+        schema:
+          required:
+          - option
+          properties:
+            option:
+              "$ref": "#/definitions/bundle-data-option-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: bundle-products/options/add
+  "/V1/bundle-products/options/types":
+    get:
+      tags:
+      - bundle-products/options/types
+      description: Get all types for options for bundle products
+      operationId: GetV1BundleproductsOptionsTypes
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/bundle-data-option-type-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: bundle-products/options/types
+  "/V1/bundle-products/options/{optionId}":
+    put:
+      tags:
+      - bundle-products/options/{optionId}
+      description: Add new option for bundle product
+      operationId: PutV1BundleproductsOptionsOptionId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: optionId
+        in: path
+        type: string
+        required: true
+      - name: PutV1BundleproductsOptionsOptionIdBody
+        in: body
+        schema:
+          required:
+          - option
+          properties:
+            option:
+              "$ref": "#/definitions/bundle-data-option-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: bundle-products/options/{optionId}
+  "/V1/bundle-products/{productSku}/children":
+    get:
+      tags:
+      - bundle-products/{productSku}/children
+      description: Get all children for Bundle product
+      operationId: GetV1BundleproductsProductSkuChildren
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: productSku
+        in: path
+        type: string
+        required: true
+      - name: optionId
+        in: query
+        type: integer
+        required: false
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/bundle-data-link-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: bundle-products/{productSku}/children
+  "/V1/bundle-products/{sku}/links/{id}":
+    put:
+      tags:
+      - bundle-products/{sku}/links/{id}
+      description: ''
+      operationId: PutV1BundleproductsSkuLinksId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PutV1BundleproductsSkuLinksIdBody
+        in: body
+        schema:
+          required:
+          - linkedProduct
+          properties:
+            linkedProduct:
+              "$ref": "#/definitions/bundle-data-link-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: bundle-products/{sku}/links/{id}
+  "/V1/bundle-products/{sku}/links/{optionId}":
+    post:
+      tags:
+      - bundle-products/{sku}/links/{optionId}
+      description: Add child product to specified Bundle option by product sku
+      operationId: PostV1BundleproductsSkuLinksOptionId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: optionId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1BundleproductsSkuLinksOptionIdBody
+        in: body
+        schema:
+          required:
+          - linkedProduct
+          properties:
+            linkedProduct:
+              "$ref": "#/definitions/bundle-data-link-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: bundle-products/{sku}/links/{optionId}
+  "/V1/bundle-products/{sku}/options/all":
+    get:
+      tags:
+      - bundle-products/{sku}/options/all
+      description: Get all options for bundle product
+      operationId: GetV1BundleproductsSkuOptionsAll
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/bundle-data-option-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: bundle-products/{sku}/options/all
+  "/V1/bundle-products/{sku}/options/{optionId}":
+    get:
+      tags:
+      - bundle-products/{sku}/options/{optionId}
+      description: Get option for bundle product
+      operationId: GetV1BundleproductsSkuOptionsOptionId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: optionId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/bundle-data-option-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: bundle-products/{sku}/options/{optionId}
+    delete:
+      tags:
+      - bundle-products/{sku}/options/{optionId}
+      description: Remove bundle option
+      operationId: DeleteV1BundleproductsSkuOptionsOptionId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: optionId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: bundle-products/{sku}/options/{optionId}
+  "/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}":
+    delete:
+      tags:
+      - bundle-products/{sku}/options/{optionId}/children/{childSku}
+      description: Remove product from Bundle product option
+      operationId: DeleteV1BundleproductsSkuOptionsOptionIdChildrenChildSku
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: optionId
+        in: path
+        type: integer
+        required: true
+      - name: childSku
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: bundle-products/{sku}/options/{optionId}/children/{childSku}
+  "/V1/carts/":
+    post:
+      tags:
+      - carts/
+      description: Creates an empty cart and quote for a guest.
+      operationId: PostV1Carts
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Cart ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/
+  "/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}":
+    get:
+      tags:
+      - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
+      description: Check gift card balance if added to the cart.
+      operationId: GetV1CartsGuestcartsCartIdCheckGiftCardGiftCardCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: giftCardCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: number
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
+  "/V1/carts/guest-carts/{cartId}/giftCards":
+    post:
+      tags:
+      - carts/guest-carts/{cartId}/giftCards
+      description: Add gift card to the cart.
+      operationId: PostV1CartsGuestcartsCartIdGiftCards
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1CartsGuestcartsCartIdGiftCardsBody
+        in: body
+        schema:
+          required:
+          - giftCardAccountData
+          properties:
+            giftCardAccountData:
+              "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/guest-carts/{cartId}/giftCards
+  "/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}":
+    delete:
+      tags:
+      - carts/guest-carts/{cartId}/giftCards/{giftCardCode}
+      description: Remove GiftCard Account entity.
+      operationId: DeleteV1CartsGuestcartsCartIdGiftCardsGiftCardCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: giftCardCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/guest-carts/{cartId}/giftCards/{giftCardCode}
+  "/V1/carts/licence":
+    get:
+      tags:
+      - carts/licence
+      description: Lists active checkout agreements.
+      operationId: GetV1CartsLicence
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/checkout-agreements-data-agreement-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/licence
+  "/V1/carts/licence/list":
+    get:
+      tags:
+      - carts/licence/list
+      description: List of checkout agreements.
+      operationId: GetV1CartsLicenceList
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/checkout-agreements-data-agreement-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/licence/list
+  "/V1/carts/mine":
+    put:
+      tags:
+      - carts/mine
+      description: Save quote
+      operationId: PutV1CartsMine
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CartsMineBody
+        in: body
+        schema:
+          required:
+          - quote
+          properties:
+            quote:
+              "$ref": "#/definitions/quote-data-cart-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine
+    post:
+      tags:
+      - carts/mine
+      description: Creates an empty cart and quote for a specified customer if customer
+        does not have a cart yet.
+      operationId: PostV1CartsMine
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: new cart ID if customer did not have a cart or ID of the
+              existing cart otherwise.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine
+    get:
+      tags:
+      - carts/mine
+      description: Returns information for the cart for a specified customer.
+      operationId: GetV1CartsMine
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine
+  "/V1/carts/mine/balance/apply":
+    post:
+      tags:
+      - carts/mine/balance/apply
+      description: Apply store credit
+      operationId: PostV1CartsMineBalanceApply
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/balance/apply
+  "/V1/carts/mine/billing-address":
+    get:
+      tags:
+      - carts/mine/billing-address
+      description: Returns the billing address for a specified quote.
+      operationId: GetV1CartsMineBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-address-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/billing-address
+    post:
+      tags:
+      - carts/mine/billing-address
+      description: Assigns a specified billing address to a specified cart.
+      operationId: PostV1CartsMineBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMineBillingaddressBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+            useForShipping:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Address ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/billing-address
+  "/V1/carts/mine/checkGiftCard/{giftCardCode}":
+    get:
+      tags:
+      - carts/mine/checkGiftCard/{giftCardCode}
+      description: Check gift card balance if applied to given cart.
+      operationId: GetV1CartsMineCheckGiftCardGiftCardCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: giftCardCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: number
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/checkGiftCard/{giftCardCode}
+  "/V1/carts/mine/collect-totals":
+    put:
+      tags:
+      - carts/mine/collect-totals
+      description: Set shipping/billing methods and additional data for cart and collect
+        totals.
+      operationId: PutV1CartsMineCollecttotals
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CartsMineCollecttotalsBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            shippingCarrierCode:
+              type: string
+              description: The carrier code.
+            shippingMethodCode:
+              type: string
+              description: The shipping method code.
+            additionalData:
+              "$ref": "#/definitions/quote-data-totals-additional-data-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/collect-totals
+  "/V1/carts/mine/coupons":
+    get:
+      tags:
+      - carts/mine/coupons
+      description: Returns information for a coupon in a specified cart.
+      operationId: GetV1CartsMineCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: The coupon code data.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/coupons
+    delete:
+      tags:
+      - carts/mine/coupons
+      description: Deletes a coupon from a specified cart.
+      operationId: DeleteV1CartsMineCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/coupons
+  "/V1/carts/mine/coupons/{couponCode}":
+    put:
+      tags:
+      - carts/mine/coupons/{couponCode}
+      description: Adds a coupon by code to a specified cart.
+      operationId: PutV1CartsMineCouponsCouponCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: couponCode
+        in: path
+        type: string
+        required: true
+        description: The coupon code data.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/coupons/{couponCode}
+  "/V1/carts/mine/estimate-shipping-methods":
+    post:
+      tags:
+      - carts/mine/estimate-shipping-methods
+      description: Estimate shipping by address and return list of available shipping
+        methods
+      operationId: PostV1CartsMineEstimateshippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMineEstimateshippingmethodsBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/estimate-shipping-methods
+  "/V1/carts/mine/estimate-shipping-methods-by-address-id":
+    post:
+      tags:
+      - carts/mine/estimate-shipping-methods-by-address-id
+      description: Estimate shipping
+      operationId: PostV1CartsMineEstimateshippingmethodsbyaddressid
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMineEstimateshippingmethodsbyaddressidBody
+        in: body
+        schema:
+          required:
+          - addressId
+          properties:
+            addressId:
+              type: integer
+              description: The estimate address id
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/estimate-shipping-methods-by-address-id
+  "/V1/carts/mine/gift-message":
+    get:
+      tags:
+      - carts/mine/gift-message
+      description: Return the gift message for a specified order.
+      operationId: GetV1CartsMineGiftmessage
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-message-data-message-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/gift-message
+    post:
+      tags:
+      - carts/mine/gift-message
+      description: Set the gift message for an entire order.
+      operationId: PostV1CartsMineGiftmessage
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMineGiftmessageBody
+        in: body
+        schema:
+          required:
+          - giftMessage
+          properties:
+            giftMessage:
+              "$ref": "#/definitions/gift-message-data-message-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/gift-message
+  "/V1/carts/mine/gift-message/{itemId}":
+    get:
+      tags:
+      - carts/mine/gift-message/{itemId}
+      description: Return the gift message for a specified item in a specified shopping
+        cart.
+      operationId: GetV1CartsMineGiftmessageItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-message-data-message-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/gift-message/{itemId}
+    post:
+      tags:
+      - carts/mine/gift-message/{itemId}
+      description: Set the gift message for a specified item in a specified shopping
+        cart.
+      operationId: PostV1CartsMineGiftmessageItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID.
+      - name: PostV1CartsMineGiftmessageItemIdBody
+        in: body
+        schema:
+          required:
+          - giftMessage
+          properties:
+            giftMessage:
+              "$ref": "#/definitions/gift-message-data-message-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/gift-message/{itemId}
+  "/V1/carts/mine/giftCards":
+    post:
+      tags:
+      - carts/mine/giftCards
+      description: Add gift card to the cart.
+      operationId: PostV1CartsMineGiftCards
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMineGiftCardsBody
+        in: body
+        schema:
+          required:
+          - giftCardAccountData
+          properties:
+            giftCardAccountData:
+              "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/giftCards
+  "/V1/carts/mine/giftCards/{giftCardCode}":
+    delete:
+      tags:
+      - carts/mine/giftCards/{giftCardCode}
+      description: Remove GiftCard Account entity
+      operationId: DeleteV1CartsMineGiftCardsGiftCardCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: giftCardCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/giftCards/{giftCardCode}
+  "/V1/carts/mine/items":
+    get:
+      tags:
+      - carts/mine/items
+      description: Lists items that are assigned to a specified cart.
+      operationId: GetV1CartsMineItems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: Array of items.
+            items:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/items
+    post:
+      tags:
+      - carts/mine/items
+      description: Add/update the specified cart item.
+      operationId: PostV1CartsMineItems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMineItemsBody
+        in: body
+        schema:
+          required:
+          - cartItem
+          properties:
+            cartItem:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/items
+  "/V1/carts/mine/items/{itemId}":
+    put:
+      tags:
+      - carts/mine/items/{itemId}
+      description: Add/update the specified cart item.
+      operationId: PutV1CartsMineItemsItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: itemId
+        in: path
+        type: string
+        required: true
+      - name: PutV1CartsMineItemsItemIdBody
+        in: body
+        schema:
+          required:
+          - cartItem
+          properties:
+            cartItem:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/items/{itemId}
+    delete:
+      tags:
+      - carts/mine/items/{itemId}
+      description: Removes the specified item from the specified cart.
+      operationId: DeleteV1CartsMineItemsItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID of the item to be removed.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/items/{itemId}
+  "/V1/carts/mine/order":
+    put:
+      tags:
+      - carts/mine/order
+      description: Places an order for a specified cart.
+      operationId: PutV1CartsMineOrder
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CartsMineOrderBody
+        in: body
+        schema:
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/order
+  "/V1/carts/mine/payment-information":
+    post:
+      tags:
+      - carts/mine/payment-information
+      description: Set payment information and place order for a specified cart.
+      operationId: PostV1CartsMinePaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMinePaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/payment-information
+    get:
+      tags:
+      - carts/mine/payment-information
+      description: Get payment information
+      operationId: GetV1CartsMinePaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/payment-information
+  "/V1/carts/mine/payment-methods":
+    get:
+      tags:
+      - carts/mine/payment-methods
+      description: Lists available payment methods for a specified shopping cart.
+        This call returns an array of objects, but detailed information about each
+        object’s attributes might not be included.  See https://developer.adobe.com/commerce/webapi/rest/attributes#PaymentMethodManagementInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1CartsMinePaymentmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: Array of payment methods.
+            items:
+              "$ref": "#/definitions/quote-data-payment-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/payment-methods
+  "/V1/carts/mine/payment-order":
+    post:
+      tags:
+      - carts/mine/payment-order
+      description: Create a payment order for logged in customer
+      operationId: PostV1CartsMinePaymentorder
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMinePaymentorderBody
+        in: body
+        schema:
+          required:
+          - methodCode
+          - paymentSource
+          - location
+          properties:
+            methodCode:
+              type: string
+            paymentSource:
+              type: string
+            location:
+              type: string
+            vaultIntent:
+              type: boolean
+            threeDSMode:
+              type: string
+              description: "| null $threeDSMode"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/payment-order
+  "/V1/carts/mine/payment-order/{id}":
+    get:
+      tags:
+      - carts/mine/payment-order/{id}
+      description: Get payment order for logged in customer
+      operationId: GetV1CartsMinePaymentorderId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/payment-order/{id}
+    post:
+      tags:
+      - carts/mine/payment-order/{id}
+      description: Sync payment order for logged in customer
+      operationId: PostV1CartsMinePaymentorderId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/payment-order/{id}
+  "/V1/carts/mine/po-payment-information":
+    post:
+      tags:
+      - carts/mine/po-payment-information
+      description: Set payment information and place purchase order for a specified
+        cart.
+      operationId: PostV1CartsMinePopaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMinePopaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Purchase Order ID.
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/po-payment-information
+  "/V1/carts/mine/selected-payment-method":
+    get:
+      tags:
+      - carts/mine/selected-payment-method
+      description: Returns the payment method for a specified shopping cart.
+      operationId: GetV1CartsMineSelectedpaymentmethod
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-payment-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/selected-payment-method
+    put:
+      tags:
+      - carts/mine/selected-payment-method
+      description: Adds a specified payment method to a specified shopping cart.
+      operationId: PutV1CartsMineSelectedpaymentmethod
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CartsMineSelectedpaymentmethodBody
+        in: body
+        schema:
+          required:
+          - method
+          properties:
+            method:
+              "$ref": "#/definitions/quote-data-payment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: redirect url or error message.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/selected-payment-method
+  "/V1/carts/mine/set-payment-information":
+    post:
+      tags:
+      - carts/mine/set-payment-information
+      description: Set payment information for a specified cart.
+      operationId: PostV1CartsMineSetpaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMineSetpaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/set-payment-information
+  "/V1/carts/mine/shipping-information":
+    post:
+      tags:
+      - carts/mine/shipping-information
+      description: ''
+      operationId: PostV1CartsMineShippinginformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMineShippinginformationBody
+        in: body
+        schema:
+          required:
+          - addressInformation
+          properties:
+            addressInformation:
+              "$ref": "#/definitions/checkout-data-shipping-information-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/shipping-information
+  "/V1/carts/mine/shipping-methods":
+    get:
+      tags:
+      - carts/mine/shipping-methods
+      description: Lists applicable shipping methods for a specified quote.
+      operationId: GetV1CartsMineShippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/shipping-methods
+  "/V1/carts/mine/totals":
+    get:
+      tags:
+      - carts/mine/totals
+      description: Returns quote totals data for a specified cart.
+      operationId: GetV1CartsMineTotals
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/totals
+  "/V1/carts/mine/totals-information":
+    post:
+      tags:
+      - carts/mine/totals-information
+      description: Calculate quote totals based on address and shipping method.
+      operationId: PostV1CartsMineTotalsinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMineTotalsinformationBody
+        in: body
+        schema:
+          required:
+          - addressInformation
+          properties:
+            addressInformation:
+              "$ref": "#/definitions/checkout-data-totals-information-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/totals-information
+  "/V1/carts/search":
+    get:
+      tags:
+      - carts/search
+      description: Enables administrative users to list carts that match specified
+        search criteria. This call returns an array of objects, but detailed information
+        about each object’s attributes might not be included.  See https://developer.adobe.com/commerce/webapi/rest/attributes#CartRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1CartsSearch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/search
+  "/V1/carts/{cartId}":
+    get:
+      tags:
+      - carts/{cartId}
+      description: Enables an administrative user to return information for a specified
+        cart.
+      operationId: GetV1CartsCartId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}
+    put:
+      tags:
+      - carts/{cartId}
+      description: Assigns a specified customer to a specified shopping cart.
+      operationId: PutV1CartsCartId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      - name: PutV1CartsCartIdBody
+        in: body
+        schema:
+          required:
+          - customerId
+          - storeId
+          properties:
+            customerId:
+              type: integer
+              description: The customer ID.
+            storeId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}
+  "/V1/carts/{cartId}/billing-address":
+    get:
+      tags:
+      - carts/{cartId}/billing-address
+      description: Returns the billing address for a specified quote.
+      operationId: GetV1CartsCartIdBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-address-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/billing-address
+    post:
+      tags:
+      - carts/{cartId}/billing-address
+      description: Assigns a specified billing address to a specified cart.
+      operationId: PostV1CartsCartIdBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      - name: PostV1CartsCartIdBillingaddressBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+            useForShipping:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Address ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/billing-address
+  "/V1/carts/{cartId}/coupons":
+    get:
+      tags:
+      - carts/{cartId}/coupons
+      description: Returns information for a coupon in a specified cart.
+      operationId: GetV1CartsCartIdCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: The coupon code data.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/coupons
+    delete:
+      tags:
+      - carts/{cartId}/coupons
+      description: Deletes a coupon from a specified cart.
+      operationId: DeleteV1CartsCartIdCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/coupons
+  "/V1/carts/{cartId}/coupons/{couponCode}":
+    put:
+      tags:
+      - carts/{cartId}/coupons/{couponCode}
+      description: Adds a coupon by code to a specified cart.
+      operationId: PutV1CartsCartIdCouponsCouponCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      - name: couponCode
+        in: path
+        type: string
+        required: true
+        description: The coupon code data.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/coupons/{couponCode}
+  "/V1/carts/{cartId}/estimate-shipping-methods":
+    post:
+      tags:
+      - carts/{cartId}/estimate-shipping-methods
+      description: Estimate shipping by address and return list of available shipping
+        methods
+      operationId: PostV1CartsCartIdEstimateshippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1CartsCartIdEstimateshippingmethodsBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/estimate-shipping-methods
+  "/V1/carts/{cartId}/estimate-shipping-methods-by-address-id":
+    post:
+      tags:
+      - carts/{cartId}/estimate-shipping-methods-by-address-id
+      description: Estimate shipping
+      operationId: PostV1CartsCartIdEstimateshippingmethodsbyaddressid
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The shopping cart ID.
+      - name: PostV1CartsCartIdEstimateshippingmethodsbyaddressidBody
+        in: body
+        schema:
+          required:
+          - addressId
+          properties:
+            addressId:
+              type: integer
+              description: The estimate address id
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/estimate-shipping-methods-by-address-id
+  "/V1/carts/{cartId}/gift-message":
+    get:
+      tags:
+      - carts/{cartId}/gift-message
+      description: Return the gift message for a specified order.
+      operationId: GetV1CartsCartIdGiftmessage
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The shopping cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-message-data-message-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/gift-message
+    post:
+      tags:
+      - carts/{cartId}/gift-message
+      description: Set the gift message for an entire order.
+      operationId: PostV1CartsCartIdGiftmessage
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      - name: PostV1CartsCartIdGiftmessageBody
+        in: body
+        schema:
+          required:
+          - giftMessage
+          properties:
+            giftMessage:
+              "$ref": "#/definitions/gift-message-data-message-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/gift-message
+  "/V1/carts/{cartId}/gift-message/{itemId}":
+    get:
+      tags:
+      - carts/{cartId}/gift-message/{itemId}
+      description: Return the gift message for a specified item in a specified shopping
+        cart.
+      operationId: GetV1CartsCartIdGiftmessageItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The shopping cart ID.
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-message-data-message-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/gift-message/{itemId}
+    post:
+      tags:
+      - carts/{cartId}/gift-message/{itemId}
+      description: Set the gift message for a specified item in a specified shopping
+        cart.
+      operationId: PostV1CartsCartIdGiftmessageItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID.
+      - name: PostV1CartsCartIdGiftmessageItemIdBody
+        in: body
+        schema:
+          required:
+          - giftMessage
+          properties:
+            giftMessage:
+              "$ref": "#/definitions/gift-message-data-message-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/gift-message/{itemId}
+  "/V1/carts/{cartId}/giftCards":
+    put:
+      tags:
+      - carts/{cartId}/giftCards
+      description: Add gift card to the cart.
+      operationId: PutV1CartsCartIdGiftCards
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PutV1CartsCartIdGiftCardsBody
+        in: body
+        schema:
+          required:
+          - giftCardAccountData
+          properties:
+            giftCardAccountData:
+              "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/giftCards
+  "/V1/carts/{cartId}/giftCards/{giftCardCode}":
+    delete:
+      tags:
+      - carts/{cartId}/giftCards/{giftCardCode}
+      description: Remove GiftCard Account entity
+      operationId: DeleteV1CartsCartIdGiftCardsGiftCardCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: giftCardCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/giftCards/{giftCardCode}
+  "/V1/carts/{cartId}/items":
+    get:
+      tags:
+      - carts/{cartId}/items
+      description: Lists items that are assigned to a specified cart.
+      operationId: GetV1CartsCartIdItems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: Array of items.
+            items:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/items
+  "/V1/carts/{cartId}/items/{itemId}":
+    put:
+      tags:
+      - carts/{cartId}/items/{itemId}
+      description: Add/update the specified cart item.
+      operationId: PutV1CartsCartIdItemsItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: itemId
+        in: path
+        type: string
+        required: true
+      - name: PutV1CartsCartIdItemsItemIdBody
+        in: body
+        schema:
+          required:
+          - cartItem
+          properties:
+            cartItem:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/items/{itemId}
+    delete:
+      tags:
+      - carts/{cartId}/items/{itemId}
+      description: Removes the specified item from the specified cart.
+      operationId: DeleteV1CartsCartIdItemsItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID of the item to be removed.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/items/{itemId}
+  "/V1/carts/{cartId}/order":
+    put:
+      tags:
+      - carts/{cartId}/order
+      description: Places an order for a specified cart.
+      operationId: PutV1CartsCartIdOrder
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      - name: PutV1CartsCartIdOrderBody
+        in: body
+        schema:
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/order
+  "/V1/carts/{cartId}/payment-methods":
+    get:
+      tags:
+      - carts/{cartId}/payment-methods
+      description: Lists available payment methods for a specified shopping cart.
+        This call returns an array of objects, but detailed information about each
+        object’s attributes might not be included.  See https://developer.adobe.com/commerce/webapi/rest/attributes#PaymentMethodManagementInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1CartsCartIdPaymentmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: Array of payment methods.
+            items:
+              "$ref": "#/definitions/quote-data-payment-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/payment-methods
+  "/V1/carts/{cartId}/selected-payment-method":
+    get:
+      tags:
+      - carts/{cartId}/selected-payment-method
+      description: Returns the payment method for a specified shopping cart.
+      operationId: GetV1CartsCartIdSelectedpaymentmethod
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-payment-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/selected-payment-method
+    put:
+      tags:
+      - carts/{cartId}/selected-payment-method
+      description: Adds a specified payment method to a specified shopping cart.
+      operationId: PutV1CartsCartIdSelectedpaymentmethod
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      - name: PutV1CartsCartIdSelectedpaymentmethodBody
+        in: body
+        schema:
+          required:
+          - method
+          properties:
+            method:
+              "$ref": "#/definitions/quote-data-payment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: redirect url or error message.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/selected-payment-method
+  "/V1/carts/{cartId}/shipping-information":
+    post:
+      tags:
+      - carts/{cartId}/shipping-information
+      description: ''
+      operationId: PostV1CartsCartIdShippinginformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1CartsCartIdShippinginformationBody
+        in: body
+        schema:
+          required:
+          - addressInformation
+          properties:
+            addressInformation:
+              "$ref": "#/definitions/checkout-data-shipping-information-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/shipping-information
+  "/V1/carts/{cartId}/shipping-methods":
+    get:
+      tags:
+      - carts/{cartId}/shipping-methods
+      description: Lists applicable shipping methods for a specified quote.
+      operationId: GetV1CartsCartIdShippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The shopping cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/shipping-methods
+  "/V1/carts/{cartId}/totals":
+    get:
+      tags:
+      - carts/{cartId}/totals
+      description: Returns quote totals data for a specified cart.
+      operationId: GetV1CartsCartIdTotals
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/totals
+  "/V1/carts/{cartId}/totals-information":
+    post:
+      tags:
+      - carts/{cartId}/totals-information
+      description: Calculate quote totals based on address and shipping method.
+      operationId: PostV1CartsCartIdTotalsinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1CartsCartIdTotalsinformationBody
+        in: body
+        schema:
+          required:
+          - addressInformation
+          properties:
+            addressInformation:
+              "$ref": "#/definitions/checkout-data-totals-information-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/totals-information
+  "/V1/carts/{quoteId}/giftCards":
+    get:
+      tags:
+      - carts/{quoteId}/giftCards
+      description: Return GiftCard Account cards.
+      operationId: GetV1CartsQuoteIdGiftCards
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: quoteId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{quoteId}/giftCards
+  "/V1/carts/{quoteId}/items":
+    post:
+      tags:
+      - carts/{quoteId}/items
+      description: Add/update the specified cart item.
+      operationId: PostV1CartsQuoteIdItems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: quoteId
+        in: path
+        type: string
+        required: true
+      - name: PostV1CartsQuoteIdItemsBody
+        in: body
+        schema:
+          required:
+          - cartItem
+          properties:
+            cartItem:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{quoteId}/items
+  "/V1/categories":
+    post:
+      tags:
+      - categories
+      description: Create category service
+      operationId: PostV1Categories
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CategoriesBody
+        in: body
+        schema:
+          required:
+          - category
+          properties:
+            category:
+              "$ref": "#/definitions/catalog-data-category-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-category-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: categories
+    get:
+      tags:
+      - categories
+      description: Retrieve list of categories
+      operationId: GetV1Categories
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: rootCategoryId
+        in: query
+        type: integer
+        required: false
+      - name: depth
+        in: query
+        type: integer
+        required: false
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-category-tree-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: categories
+  "/V1/categories/attributes":
+    get:
+      tags:
+      - categories/attributes
+      description: Retrieve all attributes for entity type
+      operationId: GetV1CategoriesAttributes
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-category-attribute-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: categories/attributes
+  "/V1/categories/attributes/{attributeCode}":
+    get:
+      tags:
+      - categories/attributes/{attributeCode}
+      description: Retrieve specific attribute
+      operationId: GetV1CategoriesAttributesAttributeCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-category-attribute-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: categories/attributes/{attributeCode}
+  "/V1/categories/attributes/{attributeCode}/options":
+    get:
+      tags:
+      - categories/attributes/{attributeCode}/options
+      description: Retrieve list of attribute options
+      operationId: GetV1CategoriesAttributesAttributeCodeOptions
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/eav-data-attribute-option-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: categories/attributes/{attributeCode}/options
+  "/V1/categories/list":
+    get:
+      tags:
+      - categories/list
+      description: Get category list
+      operationId: GetV1CategoriesList
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-category-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: categories/list
+  "/V1/categories/{categoryId}":
+    delete:
+      tags:
+      - categories/{categoryId}
+      description: Delete category by identifier
+      operationId: DeleteV1CategoriesCategoryId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: categoryId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: Will returned True if deleted
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: categories/{categoryId}
+    get:
+      tags:
+      - categories/{categoryId}
+      description: Get info about category by category id
+      operationId: GetV1CategoriesCategoryId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: categoryId
+        in: path
+        type: integer
+        required: true
+      - name: storeId
+        in: query
+        type: integer
+        required: false
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-category-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: categories/{categoryId}
+  "/V1/categories/{categoryId}/move":
+    put:
+      tags:
+      - categories/{categoryId}/move
+      description: Move category
+      operationId: PutV1CategoriesCategoryIdMove
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: categoryId
+        in: path
+        type: integer
+        required: true
+      - name: PutV1CategoriesCategoryIdMoveBody
+        in: body
+        schema:
+          required:
+          - parentId
+          properties:
+            parentId:
+              type: integer
+            afterId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: categories/{categoryId}/move
+  "/V1/categories/{categoryId}/products":
+    get:
+      tags:
+      - categories/{categoryId}/products
+      description: Get products assigned to category
+      operationId: GetV1CategoriesCategoryIdProducts
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: categoryId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-category-product-link-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: categories/{categoryId}/products
+    post:
+      tags:
+      - categories/{categoryId}/products
+      description: Assign a product to the required category
+      operationId: PostV1CategoriesCategoryIdProducts
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: categoryId
+        in: path
+        type: string
+        required: true
+      - name: PostV1CategoriesCategoryIdProductsBody
+        in: body
+        schema:
+          required:
+          - productLink
+          properties:
+            productLink:
+              "$ref": "#/definitions/catalog-data-category-product-link-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: will returned True if assigned
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: categories/{categoryId}/products
+    put:
+      tags:
+      - categories/{categoryId}/products
+      description: Assign a product to the required category
+      operationId: PutV1CategoriesCategoryIdProducts
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: categoryId
+        in: path
+        type: string
+        required: true
+      - name: PutV1CategoriesCategoryIdProductsBody
+        in: body
+        schema:
+          required:
+          - productLink
+          properties:
+            productLink:
+              "$ref": "#/definitions/catalog-data-category-product-link-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: will returned True if assigned
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: categories/{categoryId}/products
+  "/V1/categories/{categoryId}/products/{sku}":
+    delete:
+      tags:
+      - categories/{categoryId}/products/{sku}
+      description: Remove the product assignment from the category by category id
+        and sku
+      operationId: DeleteV1CategoriesCategoryIdProductsSku
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: categoryId
+        in: path
+        type: integer
+        required: true
+      - name: sku
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: will returned True if products successfully deleted
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: categories/{categoryId}/products/{sku}
+  "/V1/categories/{id}":
+    put:
+      tags:
+      - categories/{id}
+      description: Create category service
+      operationId: PutV1CategoriesId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PutV1CategoriesIdBody
+        in: body
+        schema:
+          required:
+          - category
+          properties:
+            category:
+              "$ref": "#/definitions/catalog-data-category-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-category-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: categories/{id}
+  "/V1/cmsBlock":
+    post:
+      tags:
+      - cmsBlock
+      description: Save block.
+      operationId: PostV1CmsBlock
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CmsBlockBody
+        in: body
+        schema:
+          required:
+          - block
+          properties:
+            block:
+              "$ref": "#/definitions/cms-data-block-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/cms-data-block-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: cmsBlock
+  "/V1/cmsBlock/search":
+    get:
+      tags:
+      - cmsBlock/search
+      description: Retrieve blocks matching the specified criteria.
+      operationId: GetV1CmsBlockSearch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/cms-data-block-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: cmsBlock/search
+  "/V1/cmsBlock/{blockId}":
+    get:
+      tags:
+      - cmsBlock/{blockId}
+      description: Retrieve block.
+      operationId: GetV1CmsBlockBlockId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: blockId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/cms-data-block-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: cmsBlock/{blockId}
+    delete:
+      tags:
+      - cmsBlock/{blockId}
+      description: Delete block by ID.
+      operationId: DeleteV1CmsBlockBlockId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: blockId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: cmsBlock/{blockId}
+  "/V1/cmsBlock/{id}":
+    put:
+      tags:
+      - cmsBlock/{id}
+      description: Save block.
+      operationId: PutV1CmsBlockId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PutV1CmsBlockIdBody
+        in: body
+        schema:
+          required:
+          - block
+          properties:
+            block:
+              "$ref": "#/definitions/cms-data-block-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/cms-data-block-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: cmsBlock/{id}
+  "/V1/cmsPage":
+    post:
+      tags:
+      - cmsPage
+      description: Save page.
+      operationId: PostV1CmsPage
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CmsPageBody
+        in: body
+        schema:
+          required:
+          - page
+          properties:
+            page:
+              "$ref": "#/definitions/cms-data-page-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/cms-data-page-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: cmsPage
+  "/V1/cmsPage/search":
+    get:
+      tags:
+      - cmsPage/search
+      description: Retrieve pages matching the specified criteria.
+      operationId: GetV1CmsPageSearch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/cms-data-page-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: cmsPage/search
+  "/V1/cmsPage/{id}":
+    put:
+      tags:
+      - cmsPage/{id}
+      description: Save page.
+      operationId: PutV1CmsPageId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PutV1CmsPageIdBody
+        in: body
+        schema:
+          required:
+          - page
+          properties:
+            page:
+              "$ref": "#/definitions/cms-data-page-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/cms-data-page-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: cmsPage/{id}
+  "/V1/cmsPage/{pageId}":
+    get:
+      tags:
+      - cmsPage/{pageId}
+      description: Retrieve page.
+      operationId: GetV1CmsPagePageId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: pageId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/cms-data-page-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: cmsPage/{pageId}
+    delete:
+      tags:
+      - cmsPage/{pageId}
+      description: Delete page by ID.
+      operationId: DeleteV1CmsPagePageId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: pageId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: cmsPage/{pageId}
+  "/V1/company/":
+    get:
+      tags:
+      - company/
+      description: Returns the list of companies. The list is an array of objects,
+        and detailed information about item attributes might not be included.
+      operationId: GetV1Company
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-data-company-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/
+    post:
+      tags:
+      - company/
+      description: Create or update a company account.
+      operationId: PostV1Company
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CompanyBody
+        in: body
+        schema:
+          required:
+          - company
+          properties:
+            company:
+              "$ref": "#/definitions/company-data-company-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-data-company-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/
+  "/V1/company/assignRoles":
+    put:
+      tags:
+      - company/assignRoles
+      description: Change a role for a company user.
+      operationId: PutV1CompanyAssignRoles
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CompanyAssignRolesBody
+        in: body
+        schema:
+          required:
+          - userId
+          - roles
+          properties:
+            userId:
+              type: integer
+            roles:
+              type: array
+              items:
+                "$ref": "#/definitions/company-data-role-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/assignRoles
+  "/V1/company/relations":
+    get:
+      tags:
+      - company/relations
+      description: Get existing company relation(s)
+      operationId: GetV1CompanyRelations
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-relation-data-relation-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/relations
+  "/V1/company/role/":
+    get:
+      tags:
+      - company/role/
+      description: Returns the list of roles and permissions for a specified company.
+      operationId: GetV1CompanyRole
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-data-role-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/role/
+    post:
+      tags:
+      - company/role/
+      description: Create or update a role for a selected company.
+      operationId: PostV1CompanyRole
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CompanyRoleBody
+        in: body
+        schema:
+          required:
+          - role
+          properties:
+            role:
+              "$ref": "#/definitions/company-data-role-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-data-role-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/role/
+  "/V1/company/role/{id}":
+    put:
+      tags:
+      - company/role/{id}
+      description: Create or update a role for a selected company.
+      operationId: PutV1CompanyRoleId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PutV1CompanyRoleIdBody
+        in: body
+        schema:
+          required:
+          - role
+          properties:
+            role:
+              "$ref": "#/definitions/company-data-role-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-data-role-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/role/{id}
+  "/V1/company/role/{roleId}":
+    get:
+      tags:
+      - company/role/{roleId}
+      description: Returns the list of permissions for a specified role.
+      operationId: GetV1CompanyRoleRoleId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: roleId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-data-role-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/role/{roleId}
+    delete:
+      tags:
+      - company/role/{roleId}
+      description: Delete a role.
+      operationId: DeleteV1CompanyRoleRoleId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: roleId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/role/{roleId}
+  "/V1/company/role/{roleId}/users":
+    get:
+      tags:
+      - company/role/{roleId}/users
+      description: View the list of company users assigned to a specified role.
+      operationId: GetV1CompanyRoleRoleIdUsers
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: roleId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/customer-data-customer-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/role/{roleId}/users
+  "/V1/company/{companyId}":
+    get:
+      tags:
+      - company/{companyId}
+      description: Returns company details.
+      operationId: GetV1CompanyCompanyId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: companyId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-data-company-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/{companyId}
+    delete:
+      tags:
+      - company/{companyId}
+      description: Delete a company. Customers belonging to a company are not deleted
+        with this request.
+      operationId: DeleteV1CompanyCompanyId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: companyId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/{companyId}
+    put:
+      tags:
+      - company/{companyId}
+      description: Create or update a company account.
+      operationId: PutV1CompanyCompanyId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: companyId
+        in: path
+        type: string
+        required: true
+      - name: PutV1CompanyCompanyIdBody
+        in: body
+        schema:
+          required:
+          - company
+          properties:
+            company:
+              "$ref": "#/definitions/company-data-company-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-data-company-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/{companyId}
+  "/V1/company/{parentId}/relations":
+    post:
+      tags:
+      - company/{parentId}/relations
+      description: Create relation(s) between companies.
+      operationId: PostV1CompanyParentIdRelations
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: parentId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1CompanyParentIdRelationsBody
+        in: body
+        schema:
+          required:
+          - relations
+          properties:
+            relations:
+              type: array
+              items:
+                "$ref": "#/definitions/company-relation-data-relation-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/{parentId}/relations
+  "/V1/company/{parentId}/relations/{companyId}":
+    delete:
+      tags:
+      - company/{parentId}/relations/{companyId}
+      description: Delete relation of the company to the parent by respective ids.
+      operationId: DeleteV1CompanyParentIdRelationsCompanyId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: parentId
+        in: path
+        type: integer
+        required: true
+      - name: companyId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: company/{parentId}/relations/{companyId}
+  "/V1/companyCredits/":
+    get:
+      tags:
+      - companyCredits/
+      description: Returns the list of credits for specified companies.
+      operationId: GetV1CompanyCredits
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-credit-data-credit-limit-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: companyCredits/
+  "/V1/companyCredits/company/{companyId}":
+    get:
+      tags:
+      - companyCredits/company/{companyId}
+      description: Returns data on the credit limit for a specified company.
+      operationId: GetV1CompanyCreditsCompanyCompanyId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: companyId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-credit-data-credit-limit-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: companyCredits/company/{companyId}
+  "/V1/companyCredits/history":
+    get:
+      tags:
+      - companyCredits/history
+      description: Returns the credit history for one or more companies.
+      operationId: GetV1CompanyCreditsHistory
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-credit-data-history-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: companyCredits/history
+  "/V1/companyCredits/history/{historyId}":
+    put:
+      tags:
+      - companyCredits/history/{historyId}
+      description: Update the PO Number and/or comment for a Reimburse transaction.
+      operationId: PutV1CompanyCreditsHistoryHistoryId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: historyId
+        in: path
+        type: integer
+        required: true
+      - name: PutV1CompanyCreditsHistoryHistoryIdBody
+        in: body
+        schema:
+          properties:
+            purchaseOrder:
+              type: string
+              description: "[optional]"
+            comment:
+              type: string
+              description: "[optional]"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: companyCredits/history/{historyId}
+  "/V1/companyCredits/{creditId}":
+    get:
+      tags:
+      - companyCredits/{creditId}
+      description: Returns data on the credit limit for a specified credit limit ID.
+      operationId: GetV1CompanyCreditsCreditId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: creditId
+        in: path
+        type: integer
+        required: true
+      - name: reload
+        in: query
+        type: boolean
+        description: "[optional]"
+        required: false
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-credit-data-credit-limit-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: companyCredits/{creditId}
+  "/V1/companyCredits/{creditId}/decreaseBalance":
+    post:
+      tags:
+      - companyCredits/{creditId}/decreaseBalance
+      description: Decreases the company credit with an Update, Reimburse, or Purchase
+        transaction. This transaction increases company's outstanding balance and
+        decreases company's available credit.
+      operationId: PostV1CompanyCreditsCreditIdDecreaseBalance
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: creditId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1CompanyCreditsCreditIdDecreaseBalanceBody
+        in: body
+        schema:
+          required:
+          - value
+          - currency
+          - operationType
+          properties:
+            value:
+              type: number
+            currency:
+              type: string
+            operationType:
+              type: integer
+            comment:
+              type: string
+              description: "[optional]"
+            options:
+              "$ref": "#/definitions/company-credit-data-credit-balance-options-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: companyCredits/{creditId}/decreaseBalance
+  "/V1/companyCredits/{creditId}/increaseBalance":
+    post:
+      tags:
+      - companyCredits/{creditId}/increaseBalance
+      description: Increases the company credit with an Allocate, Update, Refund,
+        Revert, or Reimburse transaction. This transaction decreases company's outstanding
+        balance and increases company's available credit.
+      operationId: PostV1CompanyCreditsCreditIdIncreaseBalance
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: creditId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1CompanyCreditsCreditIdIncreaseBalanceBody
+        in: body
+        schema:
+          required:
+          - value
+          - currency
+          - operationType
+          properties:
+            value:
+              type: number
+            currency:
+              type: string
+            operationType:
+              type: integer
+            comment:
+              type: string
+              description: "[optional]"
+            options:
+              "$ref": "#/definitions/company-credit-data-credit-balance-options-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: companyCredits/{creditId}/increaseBalance
+  "/V1/companyCredits/{id}":
+    put:
+      tags:
+      - companyCredits/{id}
+      description: 'Update the following company credit attributes: credit currency,
+        credit limit and setting to exceed credit.'
+      operationId: PutV1CompanyCreditsId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PutV1CompanyCreditsIdBody
+        in: body
+        schema:
+          required:
+          - creditLimit
+          properties:
+            creditLimit:
+              "$ref": "#/definitions/company-credit-data-credit-limit-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-credit-data-credit-limit-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: companyCredits/{id}
+  "/V1/configurable-products/variation":
+    put:
+      tags:
+      - configurable-products/variation
+      description: Generate variation based on same product
+      operationId: PutV1ConfigurableproductsVariation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1ConfigurableproductsVariationBody
+        in: body
+        schema:
+          required:
+          - product
+          - options
+          properties:
+            product:
+              "$ref": "#/definitions/catalog-data-product-interface"
+            options:
+              type: array
+              items:
+                "$ref": "#/definitions/configurable-product-data-option-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-product-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: configurable-products/variation
+  "/V1/configurable-products/{sku}/child":
+    post:
+      tags:
+      - configurable-products/{sku}/child
+      description: ''
+      operationId: PostV1ConfigurableproductsSkuChild
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: PostV1ConfigurableproductsSkuChildBody
+        in: body
+        schema:
+          required:
+          - childSku
+          properties:
+            childSku:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: configurable-products/{sku}/child
+  "/V1/configurable-products/{sku}/children":
+    get:
+      tags:
+      - configurable-products/{sku}/children
+      description: Get all children for Configurable product
+      operationId: GetV1ConfigurableproductsSkuChildren
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-product-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: configurable-products/{sku}/children
+  "/V1/configurable-products/{sku}/children/{childSku}":
+    delete:
+      tags:
+      - configurable-products/{sku}/children/{childSku}
+      description: Remove configurable product option
+      operationId: DeleteV1ConfigurableproductsSkuChildrenChildSku
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: childSku
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: configurable-products/{sku}/children/{childSku}
+  "/V1/configurable-products/{sku}/options":
+    post:
+      tags:
+      - configurable-products/{sku}/options
+      description: Save option
+      operationId: PostV1ConfigurableproductsSkuOptions
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: PostV1ConfigurableproductsSkuOptionsBody
+        in: body
+        schema:
+          required:
+          - option
+          properties:
+            option:
+              "$ref": "#/definitions/configurable-product-data-option-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: configurable-products/{sku}/options
+  "/V1/configurable-products/{sku}/options/all":
+    get:
+      tags:
+      - configurable-products/{sku}/options/all
+      description: Get all options for configurable product
+      operationId: GetV1ConfigurableproductsSkuOptionsAll
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/configurable-product-data-option-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: configurable-products/{sku}/options/all
+  "/V1/configurable-products/{sku}/options/{id}":
+    get:
+      tags:
+      - configurable-products/{sku}/options/{id}
+      description: Get option for configurable product
+      operationId: GetV1ConfigurableproductsSkuOptionsId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/configurable-product-data-option-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: configurable-products/{sku}/options/{id}
+    put:
+      tags:
+      - configurable-products/{sku}/options/{id}
+      description: Save option
+      operationId: PutV1ConfigurableproductsSkuOptionsId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PutV1ConfigurableproductsSkuOptionsIdBody
+        in: body
+        schema:
+          required:
+          - option
+          properties:
+            option:
+              "$ref": "#/definitions/configurable-product-data-option-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: configurable-products/{sku}/options/{id}
+    delete:
+      tags:
+      - configurable-products/{sku}/options/{id}
+      description: Remove option from configurable product
+      operationId: DeleteV1ConfigurableproductsSkuOptionsId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: configurable-products/{sku}/options/{id}
+  "/V1/coupons":
+    post:
+      tags:
+      - coupons
+      description: Save a coupon.
+      operationId: PostV1Coupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CouponsBody
+        in: body
+        schema:
+          required:
+          - coupon
+          properties:
+            coupon:
+              "$ref": "#/definitions/sales-rule-data-coupon-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-rule-data-coupon-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: coupons
+  "/V1/coupons/deleteByCodes":
+    post:
+      tags:
+      - coupons/deleteByCodes
+      description: Delete coupon by coupon codes.
+      operationId: PostV1CouponsDeleteByCodes
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CouponsDeleteByCodesBody
+        in: body
+        schema:
+          required:
+          - codes
+          properties:
+            codes:
+              type: array
+              items:
+                type: string
+            ignoreInvalidCoupons:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-rule-data-coupon-mass-delete-result-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: coupons/deleteByCodes
+  "/V1/coupons/deleteByIds":
+    post:
+      tags:
+      - coupons/deleteByIds
+      description: Delete coupon by coupon ids.
+      operationId: PostV1CouponsDeleteByIds
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CouponsDeleteByIdsBody
+        in: body
+        schema:
+          required:
+          - ids
+          properties:
+            ids:
+              type: array
+              items:
+                type: integer
+            ignoreInvalidCoupons:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-rule-data-coupon-mass-delete-result-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: coupons/deleteByIds
+  "/V1/coupons/generate":
+    post:
+      tags:
+      - coupons/generate
+      description: Generate coupon for a rule
+      operationId: PostV1CouponsGenerate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CouponsGenerateBody
+        in: body
+        schema:
+          required:
+          - couponSpec
+          properties:
+            couponSpec:
+              "$ref": "#/definitions/sales-rule-data-coupon-generation-spec-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              type: string
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: coupons/generate
+  "/V1/coupons/search":
+    get:
+      tags:
+      - coupons/search
+      description: Retrieve a coupon using the specified search criteria. This call
+        returns an array of objects, but detailed information about each object’s
+        attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CouponRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1CouponsSearch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-rule-data-coupon-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: coupons/search
+  "/V1/coupons/{couponId}":
+    get:
+      tags:
+      - coupons/{couponId}
+      description: Get coupon by coupon id.
+      operationId: GetV1CouponsCouponId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: couponId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-rule-data-coupon-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: coupons/{couponId}
+    put:
+      tags:
+      - coupons/{couponId}
+      description: Save a coupon.
+      operationId: PutV1CouponsCouponId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: couponId
+        in: path
+        type: string
+        required: true
+      - name: PutV1CouponsCouponIdBody
+        in: body
+        schema:
+          required:
+          - coupon
+          properties:
+            coupon:
+              "$ref": "#/definitions/sales-rule-data-coupon-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-rule-data-coupon-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: coupons/{couponId}
+    delete:
+      tags:
+      - coupons/{couponId}
+      description: Delete coupon by coupon id.
+      operationId: DeleteV1CouponsCouponId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: couponId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: coupons/{couponId}
+  "/V1/creditmemo":
+    post:
+      tags:
+      - creditmemo
+      description: Performs persist operations for a specified credit memo.
+      operationId: PostV1Creditmemo
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CreditmemoBody
+        in: body
+        schema:
+          required:
+          - entity
+          properties:
+            entity:
+              "$ref": "#/definitions/sales-data-creditmemo-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-creditmemo-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: creditmemo
+  "/V1/creditmemo/refund":
+    post:
+      tags:
+      - creditmemo/refund
+      description: Prepare creditmemo to refund and save it.
+      operationId: PostV1CreditmemoRefund
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CreditmemoRefundBody
+        in: body
+        schema:
+          required:
+          - creditmemo
+          properties:
+            creditmemo:
+              "$ref": "#/definitions/sales-data-creditmemo-interface"
+            offlineRequested:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-creditmemo-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: creditmemo/refund
+  "/V1/creditmemo/{id}":
+    put:
+      tags:
+      - creditmemo/{id}
+      description: Cancels a specified credit memo.
+      operationId: PutV1CreditmemoId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The credit memo ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: creditmemo/{id}
+    get:
+      tags:
+      - creditmemo/{id}
+      description: Loads a specified credit memo.
+      operationId: GetV1CreditmemoId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The credit memo ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-creditmemo-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: creditmemo/{id}
+  "/V1/creditmemo/{id}/comments":
+    get:
+      tags:
+      - creditmemo/{id}/comments
+      description: Lists comments for a specified credit memo.
+      operationId: GetV1CreditmemoIdComments
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The credit memo ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-creditmemo-comment-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: creditmemo/{id}/comments
+    post:
+      tags:
+      - creditmemo/{id}/comments
+      description: Performs persist operations for a specified entity.
+      operationId: PostV1CreditmemoIdComments
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PostV1CreditmemoIdCommentsBody
+        in: body
+        schema:
+          required:
+          - entity
+          properties:
+            entity:
+              "$ref": "#/definitions/sales-data-creditmemo-comment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-creditmemo-comment-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: creditmemo/{id}/comments
+  "/V1/creditmemo/{id}/emails":
+    post:
+      tags:
+      - creditmemo/{id}/emails
+      description: Emails a user a specified credit memo.
+      operationId: PostV1CreditmemoIdEmails
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The credit memo ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: creditmemo/{id}/emails
+  "/V1/creditmemos":
+    get:
+      tags:
+      - creditmemos
+      description: Lists credit memos that match specified search criteria. This call
+        returns an array of objects, but detailed information about each object’s
+        attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CreditmemoRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1Creditmemos
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-creditmemo-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: creditmemos
+  "/V1/customerGroups":
+    post:
+      tags:
+      - customerGroups
+      description: Save customer group.
+      operationId: PostV1CustomerGroups
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CustomerGroupsBody
+        in: body
+        schema:
+          required:
+          - group
+          properties:
+            group:
+              "$ref": "#/definitions/customer-data-group-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-group-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customerGroups
+  "/V1/customerGroups/default":
+    get:
+      tags:
+      - customerGroups/default
+      description: Get default customer group.
+      operationId: GetV1CustomerGroupsDefault
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: storeId
+        in: query
+        type: integer
+        required: false
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-group-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customerGroups/default
+  "/V1/customerGroups/default/{id}":
+    put:
+      tags:
+      - customerGroups/default/{id}
+      description: Set system default customer group.
+      operationId: PutV1CustomerGroupsDefaultId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customerGroups/default/{id}
+  "/V1/customerGroups/default/{storeId}":
+    get:
+      tags:
+      - customerGroups/default/{storeId}
+      description: Get default customer group.
+      operationId: GetV1CustomerGroupsDefaultStoreId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: storeId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-group-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customerGroups/default/{storeId}
+  "/V1/customerGroups/search":
+    get:
+      tags:
+      - customerGroups/search
+      description: Retrieve customer groups. The list of groups can be filtered to
+        exclude the NOT_LOGGED_IN group using the first parameter and/or it can be
+        filtered by tax class. This call returns an array of objects, but detailed
+        information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#GroupRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1CustomerGroupsSearch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-group-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customerGroups/search
+  "/V1/customerGroups/{id}":
+    get:
+      tags:
+      - customerGroups/{id}
+      description: Get customer group by group ID.
+      operationId: GetV1CustomerGroupsId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-group-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customerGroups/{id}
+    put:
+      tags:
+      - customerGroups/{id}
+      description: Save customer group.
+      operationId: PutV1CustomerGroupsId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PutV1CustomerGroupsIdBody
+        in: body
+        schema:
+          required:
+          - group
+          properties:
+            group:
+              "$ref": "#/definitions/customer-data-group-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-group-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customerGroups/{id}
+    delete:
+      tags:
+      - customerGroups/{id}
+      description: Delete customer group by ID.
+      operationId: DeleteV1CustomerGroupsId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customerGroups/{id}
+  "/V1/customerGroups/{id}/permissions":
+    get:
+      tags:
+      - customerGroups/{id}/permissions
+      description: Check if customer group can be deleted.
+      operationId: GetV1CustomerGroupsIdPermissions
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customerGroups/{id}/permissions
+  "/V1/customers":
+    post:
+      tags:
+      - customers
+      description: Create customer account. Perform necessary business operations
+        like sending email.
+      operationId: PostV1Customers
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CustomersBody
+        in: body
+        schema:
+          required:
+          - customer
+          properties:
+            customer:
+              "$ref": "#/definitions/customer-data-customer-interface"
+            password:
+              type: string
+            redirectUrl:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-customer-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers
+  "/V1/customers/activate":
+    post:
+      tags:
+      - customers/activate
+      description: Activate a customer account using a key that was sent in a confirmation
+        email.
+      operationId: PostV1CustomersActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CustomersActivateBody
+        in: body
+        schema:
+          required:
+          - email
+          - confirmationKey
+          properties:
+            email:
+              type: string
+            confirmationKey:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-customer-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/activate
+  "/V1/customers/addresses/{addressId}":
+    get:
+      tags:
+      - customers/addresses/{addressId}
+      description: Retrieve customer address.
+      operationId: GetV1CustomersAddressesAddressId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: addressId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-address-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/addresses/{addressId}
+  "/V1/customers/companies":
+    post:
+      tags:
+      - customers/companies
+      description: Save customer attributes for company.
+      operationId: PostV1CustomersCompanies
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CustomersCompaniesBody
+        in: body
+        schema:
+          required:
+          - companyAttributes
+          properties:
+            companyAttributes:
+              "$ref": "#/definitions/company-data-company-customer-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/companies
+    get:
+      tags:
+      - customers/companies
+      description: Returns the list of company customer attributes.
+      operationId: GetV1CustomersCompanies
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: criteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: criteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: criteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: criteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: criteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: criteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: criteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-data-company-customer-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/companies
+  "/V1/customers/confirm":
+    post:
+      tags:
+      - customers/confirm
+      description: Resend confirmation email.
+      operationId: PostV1CustomersConfirm
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CustomersConfirmBody
+        in: body
+        schema:
+          required:
+          - email
+          - websiteId
+          properties:
+            email:
+              type: string
+            websiteId:
+              type: integer
+            redirectUrl:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/confirm
+  "/V1/customers/isEmailAvailable":
+    post:
+      tags:
+      - customers/isEmailAvailable
+      description: Check if given email is associated with a customer account in given
+        website.
+      operationId: PostV1CustomersIsEmailAvailable
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CustomersIsEmailAvailableBody
+        in: body
+        schema:
+          required:
+          - customerEmail
+          properties:
+            customerEmail:
+              type: string
+            websiteId:
+              type: integer
+              description: If not set, will use the current websiteId
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/isEmailAvailable
+  "/V1/customers/me":
+    put:
+      tags:
+      - customers/me
+      description: Create or update a customer.
+      operationId: PutV1CustomersMe
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CustomersMeBody
+        in: body
+        schema:
+          required:
+          - customer
+          properties:
+            customer:
+              "$ref": "#/definitions/customer-data-customer-interface"
+            passwordHash:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-customer-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/me
+    get:
+      tags:
+      - customers/me
+      description: Get customer by Customer ID.
+      operationId: GetV1CustomersMe
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-customer-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/me
+  "/V1/customers/me/activate":
+    put:
+      tags:
+      - customers/me/activate
+      description: Activate a customer account using a key that was sent in a confirmation
+        email.
+      operationId: PutV1CustomersMeActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CustomersMeActivateBody
+        in: body
+        schema:
+          required:
+          - confirmationKey
+          properties:
+            confirmationKey:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-customer-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/me/activate
+  "/V1/customers/me/billingAddress":
+    get:
+      tags:
+      - customers/me/billingAddress
+      description: Retrieve default billing address for the given customerId.
+      operationId: GetV1CustomersMeBillingAddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-address-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/me/billingAddress
+  "/V1/customers/me/password":
+    put:
+      tags:
+      - customers/me/password
+      description: Change customer password.
+      operationId: PutV1CustomersMePassword
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CustomersMePasswordBody
+        in: body
+        schema:
+          required:
+          - currentPassword
+          - newPassword
+          properties:
+            currentPassword:
+              type: string
+            newPassword:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/me/password
+  "/V1/customers/me/shippingAddress":
+    get:
+      tags:
+      - customers/me/shippingAddress
+      description: Retrieve default shipping address for the given customerId.
+      operationId: GetV1CustomersMeShippingAddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-address-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/me/shippingAddress
+  "/V1/customers/password":
+    put:
+      tags:
+      - customers/password
+      description: Send an email to the customer with a password reset link.
+      operationId: PutV1CustomersPassword
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CustomersPasswordBody
+        in: body
+        schema:
+          required:
+          - email
+          - template
+          properties:
+            email:
+              type: string
+            template:
+              type: string
+            websiteId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/password
+  "/V1/customers/resetPassword":
+    post:
+      tags:
+      - customers/resetPassword
+      description: Reset customer password.
+      operationId: PostV1CustomersResetPassword
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CustomersResetPasswordBody
+        in: body
+        schema:
+          required:
+          - email
+          - resetToken
+          - newPassword
+          properties:
+            email:
+              type: string
+              description: If empty value given then the customer will be matched
+                by the RP token.
+            resetToken:
+              type: string
+            newPassword:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/resetPassword
+  "/V1/customers/search":
+    get:
+      tags:
+      - customers/search
+      description: Retrieve customers which match a specified criteria. This call
+        returns an array of objects, but detailed information about each object’s
+        attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CustomerRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1CustomersSearch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-customer-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/search
+  "/V1/customers/validate":
+    put:
+      tags:
+      - customers/validate
+      description: Validate customer data.
+      operationId: PutV1CustomersValidate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CustomersValidateBody
+        in: body
+        schema:
+          required:
+          - customer
+          properties:
+            customer:
+              "$ref": "#/definitions/customer-data-customer-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-validation-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/validate
+  "/V1/customers/{customerId}":
+    get:
+      tags:
+      - customers/{customerId}
+      description: Get customer by Customer ID.
+      operationId: GetV1CustomersCustomerId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-customer-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}
+    put:
+      tags:
+      - customers/{customerId}
+      description: Create or update a customer.
+      operationId: PutV1CustomersCustomerId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: customerId
+        in: path
+        type: string
+        required: true
+      - name: PutV1CustomersCustomerIdBody
+        in: body
+        schema:
+          required:
+          - customer
+          properties:
+            customer:
+              "$ref": "#/definitions/customer-data-customer-interface"
+            passwordHash:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-customer-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}
+    delete:
+      tags:
+      - customers/{customerId}
+      description: Delete customer by Customer ID.
+      operationId: DeleteV1CustomersCustomerId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}
+  "/V1/customers/{customerId}/billingAddress":
+    get:
+      tags:
+      - customers/{customerId}/billingAddress
+      description: Retrieve default billing address for the given customerId.
+      operationId: GetV1CustomersCustomerIdBillingAddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-address-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}/billingAddress
+  "/V1/customers/{customerId}/carts":
+    post:
+      tags:
+      - customers/{customerId}/carts
+      description: Creates an empty cart and quote for a specified customer if customer
+        does not have a cart yet.
+      operationId: PostV1CustomersCustomerIdCarts
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+        description: The customer ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: new cart ID if customer did not have a cart or ID of the
+              existing cart otherwise.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}/carts
+  "/V1/customers/{customerId}/companies":
+    get:
+      tags:
+      - customers/{customerId}/companies
+      description: Returns a list of companies the customer is assigned to
+      operationId: GetV1CustomersCustomerIdCompanies
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/company-data-company-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}/companies
+  "/V1/customers/{customerId}/companies/{companyId}":
+    put:
+      tags:
+      - customers/{customerId}/companies/{companyId}
+      description: Assigns customer as a company user.
+      operationId: PutV1CustomersCustomerIdCompaniesCompanyId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: companyId
+        in: path
+        type: integer
+        required: true
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}/companies/{companyId}
+    delete:
+      tags:
+      - customers/{customerId}/companies/{companyId}
+      description: Unassigns customer from the company.
+      operationId: DeleteV1CustomersCustomerIdCompaniesCompanyId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: companyId
+        in: path
+        type: integer
+        required: true
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}/companies/{companyId}
+    get:
+      tags:
+      - customers/{customerId}/companies/{companyId}
+      description: Returns customer attributes for company by ID.
+      operationId: GetV1CustomersCustomerIdCompaniesCompanyId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+      - name: companyId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-data-company-customer-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}/companies/{companyId}
+  "/V1/customers/{customerId}/confirm":
+    get:
+      tags:
+      - customers/{customerId}/confirm
+      description: Gets the account confirmation status.
+      operationId: GetV1CustomersCustomerIdConfirm
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}/confirm
+  "/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":
+    get:
+      tags:
+      - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
+      description: Check if password reset token is valid.
+      operationId: GetV1CustomersCustomerIdPasswordResetLinkTokenResetPasswordLinkToken
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+        description: If null is given then a customer will be matched by the RP token.
+      - name: resetPasswordLinkToken
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: True if the token is valid
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
+  "/V1/customers/{customerId}/permissions/readonly":
+    get:
+      tags:
+      - customers/{customerId}/permissions/readonly
+      description: Check if customer can be deleted.
+      operationId: GetV1CustomersCustomerIdPermissionsReadonly
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}/permissions/readonly
+  "/V1/customers/{customerId}/shippingAddress":
+    get:
+      tags:
+      - customers/{customerId}/shippingAddress
+      description: Retrieve default shipping address for the given customerId.
+      operationId: GetV1CustomersCustomerIdShippingAddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-address-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}/shippingAddress
+  "/V1/customers/{customerId}/token":
+    post:
+      tags:
+      - customers/{customerId}/token
+      description: Generate a customer token based on the provided customer ID.
+      operationId: PostV1CustomersCustomerIdToken
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+        description: The ID of the customer for whom the token is to be generated.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: The generated customer token.
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}/token
+  "/V1/customers/{email}/activate":
+    put:
+      tags:
+      - customers/{email}/activate
+      description: Activate a customer account using a key that was sent in a confirmation
+        email.
+      operationId: PutV1CustomersEmailActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: email
+        in: path
+        type: string
+        required: true
+      - name: PutV1CustomersEmailActivateBody
+        in: body
+        schema:
+          required:
+          - confirmationKey
+          properties:
+            confirmationKey:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-customer-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{email}/activate
+  "/V1/directory/countries":
+    get:
+      tags:
+      - directory/countries
+      description: Get all countries and regions information for the store.
+      operationId: GetV1DirectoryCountries
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/directory-data-country-information-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: directory/countries
+  "/V1/directory/countries/{countryId}":
+    get:
+      tags:
+      - directory/countries/{countryId}
+      description: Get country and region information for the store.
+      operationId: GetV1DirectoryCountriesCountryId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: countryId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/directory-data-country-information-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: directory/countries/{countryId}
+  "/V1/directory/currency":
+    get:
+      tags:
+      - directory/currency
+      description: Get currency information for the store.
+      operationId: GetV1DirectoryCurrency
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/directory-data-currency-information-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: directory/currency
+  "/V1/eav/attribute-sets":
+    post:
+      tags:
+      - eav/attribute-sets
+      description: Create attribute set from data
+      operationId: PostV1EavAttributesets
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1EavAttributesetsBody
+        in: body
+        schema:
+          required:
+          - entityTypeCode
+          - attributeSet
+          - skeletonId
+          properties:
+            entityTypeCode:
+              type: string
+            attributeSet:
+              "$ref": "#/definitions/eav-data-attribute-set-interface"
+            skeletonId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/eav-data-attribute-set-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eav/attribute-sets
+  "/V1/eav/attribute-sets/list":
+    get:
+      tags:
+      - eav/attribute-sets/list
+      description: Retrieve list of Attribute Sets This call returns an array of objects,
+        but detailed information about each object’s attributes might not be included.
+        See https://developer.adobe.com/commerce/webapi/rest/attributes#AttributeSetRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1EavAttributesetsList
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/eav-data-attribute-set-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eav/attribute-sets/list
+  "/V1/eav/attribute-sets/{attributeSetId}":
+    get:
+      tags:
+      - eav/attribute-sets/{attributeSetId}
+      description: Retrieve attribute set information based on given ID
+      operationId: GetV1EavAttributesetsAttributeSetId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeSetId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/eav-data-attribute-set-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eav/attribute-sets/{attributeSetId}
+    delete:
+      tags:
+      - eav/attribute-sets/{attributeSetId}
+      description: Remove attribute set by given ID
+      operationId: DeleteV1EavAttributesetsAttributeSetId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeSetId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eav/attribute-sets/{attributeSetId}
+    put:
+      tags:
+      - eav/attribute-sets/{attributeSetId}
+      description: Save attribute set data
+      operationId: PutV1EavAttributesetsAttributeSetId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeSetId
+        in: path
+        type: string
+        required: true
+      - name: PutV1EavAttributesetsAttributeSetIdBody
+        in: body
+        schema:
+          required:
+          - attributeSet
+          properties:
+            attributeSet:
+              "$ref": "#/definitions/eav-data-attribute-set-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/eav-data-attribute-set-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eav/attribute-sets/{attributeSetId}
+  "/V1/eventing/eventProvider":
+    get:
+      tags:
+      - eventing/eventProvider
+      description: Returns the list of event providers
+      operationId: GetV1EventingEventProvider
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eventing/eventProvider
+    post:
+      tags:
+      - eventing/eventProvider
+      description: Create or update the event provider
+      operationId: PostV1EventingEventProvider
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1EventingEventProviderBody
+        in: body
+        schema:
+          required:
+          - eventProvider
+          properties:
+            eventProvider:
+              "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eventing/eventProvider
+    put:
+      tags:
+      - eventing/eventProvider
+      description: Create or update the event provider
+      operationId: PutV1EventingEventProvider
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1EventingEventProviderBody
+        in: body
+        schema:
+          required:
+          - eventProvider
+          properties:
+            eventProvider:
+              "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eventing/eventProvider
+  "/V1/eventing/eventProvider/{providerId}":
+    get:
+      tags:
+      - eventing/eventProvider/{providerId}
+      description: Get a single event provider by provider ID
+      operationId: GetV1EventingEventProviderProviderId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: providerId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eventing/eventProvider/{providerId}
+    delete:
+      tags:
+      - eventing/eventProvider/{providerId}
+      description: Delete an event provider by provider ID
+      operationId: DeleteV1EventingEventProviderProviderId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: providerId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eventing/eventProvider/{providerId}
+  "/V1/eventing/eventSubscribe":
+    post:
+      tags:
+      - eventing/eventSubscribe
+      description: Subscribes to the event.
+      operationId: PostV1EventingEventSubscribe
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1EventingEventSubscribeBody
+        in: body
+        schema:
+          required:
+          - event
+          properties:
+            event:
+              "$ref": "#/definitions/adobe-commerce-events-client-data-event-data-interface"
+            force:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eventing/eventSubscribe
+  "/V1/eventing/eventSubscribe/{name}":
+    put:
+      tags:
+      - eventing/eventSubscribe/{name}
+      description: Update the event subscription.
+      operationId: PutV1EventingEventSubscribeName
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: name
+        in: path
+        type: string
+        required: true
+      - name: PutV1EventingEventSubscribeNameBody
+        in: body
+        schema:
+          required:
+          - event
+          properties:
+            event:
+              "$ref": "#/definitions/adobe-commerce-events-client-data-event-data-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eventing/eventSubscribe/{name}
+  "/V1/eventing/eventUnsubscribe/{name}":
+    post:
+      tags:
+      - eventing/eventUnsubscribe/{name}
+      description: Unsubscribes from the event with the provided name.
+      operationId: PostV1EventingEventUnsubscribeName
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: name
+        in: path
+        type: string
+        required: true
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eventing/eventUnsubscribe/{name}
+  "/V1/eventing/getEventProviders":
+    get:
+      tags:
+      - eventing/getEventProviders
+      description: Returns the list of event providers
+      operationId: GetV1EventingGetEventProviders
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eventing/getEventProviders
+  "/V1/eventing/getEventSubscriptions":
+    get:
+      tags:
+      - eventing/getEventSubscriptions
+      description: Returns the list of all subscribed events
+      operationId: GetV1EventingGetEventSubscriptions
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/adobe-commerce-events-client-data-event-data-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eventing/getEventSubscriptions
+  "/V1/eventing/updateConfiguration":
+    put:
+      tags:
+      - eventing/updateConfiguration
+      description: Updates eventing configuration
+      operationId: PutV1EventingUpdateConfiguration
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1EventingUpdateConfigurationBody
+        in: body
+        schema:
+          required:
+          - config
+          properties:
+            config:
+              "$ref": "#/definitions/adobe-commerce-events-client-data-configuration-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: eventing/updateConfiguration
+  "/V1/gift-wrappings":
+    post:
+      tags:
+      - gift-wrappings
+      description: Create/Update new gift wrapping with data object values
+      operationId: PostV1Giftwrappings
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1GiftwrappingsBody
+        in: body
+        schema:
+          required:
+          - data
+          properties:
+            data:
+              "$ref": "#/definitions/gift-wrapping-data-wrapping-interface"
+            storeId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-wrapping-data-wrapping-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: gift-wrappings
+    get:
+      tags:
+      - gift-wrappings
+      description: Return list of gift wrapping data objects based on search criteria
+      operationId: GetV1Giftwrappings
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-wrapping-data-wrapping-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: gift-wrappings
+  "/V1/gift-wrappings/{id}":
+    get:
+      tags:
+      - gift-wrappings/{id}
+      description: Return data object for specified wrapping ID and store.
+      operationId: GetV1GiftwrappingsId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      - name: storeId
+        in: query
+        type: integer
+        required: false
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-wrapping-data-wrapping-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: gift-wrappings/{id}
+    delete:
+      tags:
+      - gift-wrappings/{id}
+      description: Delete gift wrapping
+      operationId: DeleteV1GiftwrappingsId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: gift-wrappings/{id}
+  "/V1/gift-wrappings/{wrappingId}":
+    put:
+      tags:
+      - gift-wrappings/{wrappingId}
+      description: Create/Update new gift wrapping with data object values
+      operationId: PutV1GiftwrappingsWrappingId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: wrappingId
+        in: path
+        type: string
+        required: true
+      - name: PutV1GiftwrappingsWrappingIdBody
+        in: body
+        schema:
+          required:
+          - data
+          properties:
+            data:
+              "$ref": "#/definitions/gift-wrapping-data-wrapping-interface"
+            storeId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-wrapping-data-wrapping-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: gift-wrappings/{wrappingId}
+  "/V1/giftregistry/mine/estimate-shipping-methods":
+    post:
+      tags:
+      - giftregistry/mine/estimate-shipping-methods
+      description: Estimate shipping
+      operationId: PostV1GiftregistryMineEstimateshippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1GiftregistryMineEstimateshippingmethodsBody
+        in: body
+        schema:
+          required:
+          - registryId
+          properties:
+            registryId:
+              type: integer
+              description: The estimate registry id
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: giftregistry/mine/estimate-shipping-methods
+  "/V1/guest-carts":
+    post:
+      tags:
+      - guest-carts
+      description: Enable an customer or guest user to create an empty cart and quote
+        for an anonymous customer.
+      operationId: PostV1Guestcarts
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: Cart ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts
+  "/V1/guest-carts/{cartId}":
+    get:
+      tags:
+      - guest-carts/{cartId}
+      description: Enable a guest user to return information for a specified cart.
+      operationId: GetV1GuestcartsCartId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}
+    put:
+      tags:
+      - guest-carts/{cartId}
+      description: Assign a specified customer to a specified shopping cart.
+      operationId: PutV1GuestcartsCartId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PutV1GuestcartsCartIdBody
+        in: body
+        schema:
+          required:
+          - storeId
+          properties:
+            storeId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}
+  "/V1/guest-carts/{cartId}/billing-address":
+    get:
+      tags:
+      - guest-carts/{cartId}/billing-address
+      description: Return the billing address for a specified quote.
+      operationId: GetV1GuestcartsCartIdBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-address-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/billing-address
+    post:
+      tags:
+      - guest-carts/{cartId}/billing-address
+      description: Assign a specified billing address to a specified cart.
+      operationId: PostV1GuestcartsCartIdBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PostV1GuestcartsCartIdBillingaddressBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+            useForShipping:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Address ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/billing-address
+  "/V1/guest-carts/{cartId}/collect-totals":
+    put:
+      tags:
+      - guest-carts/{cartId}/collect-totals
+      description: Set shipping/billing methods and additional data for cart and collect
+        totals for guest.
+      operationId: PutV1GuestcartsCartIdCollecttotals
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PutV1GuestcartsCartIdCollecttotalsBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            shippingCarrierCode:
+              type: string
+              description: The carrier code.
+            shippingMethodCode:
+              type: string
+              description: The shipping method code.
+            additionalData:
+              "$ref": "#/definitions/quote-data-totals-additional-data-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/collect-totals
+  "/V1/guest-carts/{cartId}/coupons":
+    get:
+      tags:
+      - guest-carts/{cartId}/coupons
+      description: Return information for a coupon in a specified cart.
+      operationId: GetV1GuestcartsCartIdCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: The coupon code data.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/coupons
+    delete:
+      tags:
+      - guest-carts/{cartId}/coupons
+      description: Delete a coupon from a specified cart.
+      operationId: DeleteV1GuestcartsCartIdCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/coupons
+  "/V1/guest-carts/{cartId}/coupons/{couponCode}":
+    put:
+      tags:
+      - guest-carts/{cartId}/coupons/{couponCode}
+      description: Add a coupon by code to a specified cart.
+      operationId: PutV1GuestcartsCartIdCouponsCouponCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: couponCode
+        in: path
+        type: string
+        required: true
+        description: The coupon code data.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/coupons/{couponCode}
+  "/V1/guest-carts/{cartId}/estimate-shipping-methods":
+    post:
+      tags:
+      - guest-carts/{cartId}/estimate-shipping-methods
+      description: Estimate shipping by address and return list of available shipping
+        methods
+      operationId: PostV1GuestcartsCartIdEstimateshippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdEstimateshippingmethodsBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/estimate-shipping-methods
+  "/V1/guest-carts/{cartId}/gift-message":
+    get:
+      tags:
+      - guest-carts/{cartId}/gift-message
+      description: Return the gift message for a specified order.
+      operationId: GetV1GuestcartsCartIdGiftmessage
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The shopping cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-message-data-message-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/gift-message
+    post:
+      tags:
+      - guest-carts/{cartId}/gift-message
+      description: Set the gift message for an entire order.
+      operationId: PostV1GuestcartsCartIdGiftmessage
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PostV1GuestcartsCartIdGiftmessageBody
+        in: body
+        schema:
+          required:
+          - giftMessage
+          properties:
+            giftMessage:
+              "$ref": "#/definitions/gift-message-data-message-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/gift-message
+  "/V1/guest-carts/{cartId}/gift-message/{itemId}":
+    get:
+      tags:
+      - guest-carts/{cartId}/gift-message/{itemId}
+      description: Return the gift message for a specified item in a specified shopping
+        cart.
+      operationId: GetV1GuestcartsCartIdGiftmessageItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The shopping cart ID.
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-message-data-message-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/gift-message/{itemId}
+    post:
+      tags:
+      - guest-carts/{cartId}/gift-message/{itemId}
+      description: Set the gift message for a specified item in a specified shopping
+        cart.
+      operationId: PostV1GuestcartsCartIdGiftmessageItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID.
+      - name: PostV1GuestcartsCartIdGiftmessageItemIdBody
+        in: body
+        schema:
+          required:
+          - giftMessage
+          properties:
+            giftMessage:
+              "$ref": "#/definitions/gift-message-data-message-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/gift-message/{itemId}
+  "/V1/guest-carts/{cartId}/items":
+    get:
+      tags:
+      - guest-carts/{cartId}/items
+      description: List items that are assigned to a specified cart.
+      operationId: GetV1GuestcartsCartIdItems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: Array of items.
+            items:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/items
+    post:
+      tags:
+      - guest-carts/{cartId}/items
+      description: Add/update the specified cart item.
+      operationId: PostV1GuestcartsCartIdItems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdItemsBody
+        in: body
+        schema:
+          required:
+          - cartItem
+          properties:
+            cartItem:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/items
+  "/V1/guest-carts/{cartId}/items/{itemId}":
+    put:
+      tags:
+      - guest-carts/{cartId}/items/{itemId}
+      description: Add/update the specified cart item.
+      operationId: PutV1GuestcartsCartIdItemsItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: itemId
+        in: path
+        type: string
+        required: true
+      - name: PutV1GuestcartsCartIdItemsItemIdBody
+        in: body
+        schema:
+          required:
+          - cartItem
+          properties:
+            cartItem:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/items/{itemId}
+    delete:
+      tags:
+      - guest-carts/{cartId}/items/{itemId}
+      description: Remove the specified item from the specified cart.
+      operationId: DeleteV1GuestcartsCartIdItemsItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID of the item to be removed.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/items/{itemId}
+  "/V1/guest-carts/{cartId}/order":
+    put:
+      tags:
+      - guest-carts/{cartId}/order
+      description: Place an order for a specified cart.
+      operationId: PutV1GuestcartsCartIdOrder
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PutV1GuestcartsCartIdOrderBody
+        in: body
+        schema:
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/order
+  "/V1/guest-carts/{cartId}/payment-information":
+    post:
+      tags:
+      - guest-carts/{cartId}/payment-information
+      description: Set payment information and place order for a specified cart.
+      operationId: PostV1GuestcartsCartIdPaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdPaymentinformationBody
+        in: body
+        schema:
+          required:
+          - email
+          - paymentMethod
+          properties:
+            email:
+              type: string
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-information
+    get:
+      tags:
+      - guest-carts/{cartId}/payment-information
+      description: Get payment information
+      operationId: GetV1GuestcartsCartIdPaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-information
+  "/V1/guest-carts/{cartId}/payment-methods":
+    get:
+      tags:
+      - guest-carts/{cartId}/payment-methods
+      description: List available payment methods for a specified shopping cart. This
+        call returns an array of objects, but detailed information about each object’s
+        attributes might not be included.  See https://developer.adobe.com/commerce/webapi/rest/attributes#GuestPaymentMethodManagementInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1GuestcartsCartIdPaymentmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: Array of payment methods.
+            items:
+              "$ref": "#/definitions/quote-data-payment-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-methods
+  "/V1/guest-carts/{cartId}/payment-order":
+    post:
+      tags:
+      - guest-carts/{cartId}/payment-order
+      description: Create a payment order for guest customer
+      operationId: PostV1GuestcartsCartIdPaymentorder
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdPaymentorderBody
+        in: body
+        schema:
+          required:
+          - methodCode
+          - paymentSource
+          - location
+          properties:
+            methodCode:
+              type: string
+            paymentSource:
+              type: string
+            location:
+              type: string
+            vaultIntent:
+              type: boolean
+            threeDSMode:
+              type: string
+              description: "| null $threeDSMode"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-order
+  "/V1/guest-carts/{cartId}/payment-order/{id}":
+    get:
+      tags:
+      - guest-carts/{cartId}/payment-order/{id}
+      description: Get payment order for guest customer
+      operationId: GetV1GuestcartsCartIdPaymentorderId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: id
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-order/{id}
+    post:
+      tags:
+      - guest-carts/{cartId}/payment-order/{id}
+      description: Sync payment order for guest customer
+      operationId: PostV1GuestcartsCartIdPaymentorderId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: id
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-order/{id}
+  "/V1/guest-carts/{cartId}/selected-payment-method":
+    get:
+      tags:
+      - guest-carts/{cartId}/selected-payment-method
+      description: Return the payment method for a specified shopping cart.
+      operationId: GetV1GuestcartsCartIdSelectedpaymentmethod
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-payment-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/selected-payment-method
+    put:
+      tags:
+      - guest-carts/{cartId}/selected-payment-method
+      description: Add a specified payment method to a specified shopping cart.
+      operationId: PutV1GuestcartsCartIdSelectedpaymentmethod
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PutV1GuestcartsCartIdSelectedpaymentmethodBody
+        in: body
+        schema:
+          required:
+          - method
+          properties:
+            method:
+              "$ref": "#/definitions/quote-data-payment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Payment method ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/selected-payment-method
+  "/V1/guest-carts/{cartId}/set-payment-information":
+    post:
+      tags:
+      - guest-carts/{cartId}/set-payment-information
+      description: Set payment information for a specified cart.
+      operationId: PostV1GuestcartsCartIdSetpaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdSetpaymentinformationBody
+        in: body
+        schema:
+          required:
+          - email
+          - paymentMethod
+          properties:
+            email:
+              type: string
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/set-payment-information
+  "/V1/guest-carts/{cartId}/shipping-information":
+    post:
+      tags:
+      - guest-carts/{cartId}/shipping-information
+      description: ''
+      operationId: PostV1GuestcartsCartIdShippinginformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdShippinginformationBody
+        in: body
+        schema:
+          required:
+          - addressInformation
+          properties:
+            addressInformation:
+              "$ref": "#/definitions/checkout-data-shipping-information-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/shipping-information
+  "/V1/guest-carts/{cartId}/shipping-methods":
+    get:
+      tags:
+      - guest-carts/{cartId}/shipping-methods
+      description: List applicable shipping methods for a specified quote.
+      operationId: GetV1GuestcartsCartIdShippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The shopping cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/shipping-methods
+  "/V1/guest-carts/{cartId}/totals":
+    get:
+      tags:
+      - guest-carts/{cartId}/totals
+      description: Return quote totals data for a specified cart.
+      operationId: GetV1GuestcartsCartIdTotals
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/totals
+  "/V1/guest-carts/{cartId}/totals-information":
+    post:
+      tags:
+      - guest-carts/{cartId}/totals-information
+      description: Calculate quote totals based on address and shipping method.
+      operationId: PostV1GuestcartsCartIdTotalsinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdTotalsinformationBody
+        in: body
+        schema:
+          required:
+          - addressInformation
+          properties:
+            addressInformation:
+              "$ref": "#/definitions/checkout-data-totals-information-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/totals-information
+  "/V1/guest-giftregistry/{cartId}/estimate-shipping-methods":
+    post:
+      tags:
+      - guest-giftregistry/{cartId}/estimate-shipping-methods
+      description: Estimate shipping
+      operationId: PostV1GuestgiftregistryCartIdEstimateshippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The shopping cart ID.
+      - name: PostV1GuestgiftregistryCartIdEstimateshippingmethodsBody
+        in: body
+        schema:
+          required:
+          - registryId
+          properties:
+            registryId:
+              type: integer
+              description: The estimate registry id
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-giftregistry/{cartId}/estimate-shipping-methods
+  "/V1/hierarchy/move/{id}":
+    put:
+      tags:
+      - hierarchy/move/{id}
+      description: Moves teams and users within the company structure.
+      operationId: PutV1HierarchyMoveId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      - name: PutV1HierarchyMoveIdBody
+        in: body
+        schema:
+          required:
+          - newParentId
+          properties:
+            newParentId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: hierarchy/move/{id}
+  "/V1/hierarchy/{id}":
+    get:
+      tags:
+      - hierarchy/{id}
+      description: Returns the list of teams and company users in the company structure.
+      operationId: GetV1HierarchyId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/company-data-hierarchy-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: hierarchy/{id}
+  "/V1/import/csv":
+    post:
+      tags:
+      - import/csv
+      description: Start import operation
+      operationId: PostV1ImportCsv
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ImportCsvBody
+        in: body
+        schema:
+          required:
+          - source
+          properties:
+            source:
+              "$ref": "#/definitions/import-csv-api-data-localized-source-data-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              type: string
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: import/csv
+  "/V1/import/json":
+    post:
+      tags:
+      - import/json
+      description: Starts import operation.
+      operationId: PostV1ImportJson
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ImportJsonBody
+        in: body
+        schema:
+          required:
+          - source
+          properties:
+            source:
+              "$ref": "#/definitions/import-json-api-data-source-data-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              type: string
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: import/json
+  "/V1/integration/admin/token":
+    post:
+      tags:
+      - integration/admin/token
+      description: Create access token for admin given the admin credentials.
+      operationId: PostV1IntegrationAdminToken
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1IntegrationAdminTokenBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: Token created
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: integration/admin/token
+  "/V1/integration/customer/revoke-customer-token":
+    post:
+      tags:
+      - integration/customer/revoke-customer-token
+      description: Revoke token by customer id.
+      operationId: PostV1IntegrationCustomerRevokecustomertoken
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: integration/customer/revoke-customer-token
+  "/V1/integration/customer/token":
+    post:
+      tags:
+      - integration/customer/token
+      description: Create access token for admin given the customer credentials.
+      operationId: PostV1IntegrationCustomerToken
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1IntegrationCustomerTokenBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: Token created
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: integration/customer/token
+  "/V1/inventory/are-product-salable-for-requested-qty/":
+    get:
+      tags:
+      - inventory/are-product-salable-for-requested-qty/
+      description: Get whether products are salable in requested Qty for given set
+        of SKUs in specified stock.
+      operationId: GetV1InventoryAreproductsalableforrequestedqty
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: skuRequests[0][sku]
+        in: query
+        type: string
+        description: Product sku.
+      - name: skuRequests[0][qty]
+        in: query
+        type: number
+        description: Product quantity.
+      - name: stockId
+        in: query
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/inventory-sales-api-data-is-product-salable-for-requested-qty-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/are-product-salable-for-requested-qty/
+  "/V1/inventory/are-products-salable":
+    get:
+      tags:
+      - inventory/are-products-salable
+      description: Get products salable status for given SKUs and given Stock.
+      operationId: GetV1InventoryAreproductssalable
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: skus
+        in: query
+        type: array
+        items:
+          type: string
+        required: true
+      - name: stockId
+        in: query
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/inventory-sales-api-data-is-product-salable-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/are-products-salable
+  "/V1/inventory/bulk-partial-source-transfer":
+    post:
+      tags:
+      - inventory/bulk-partial-source-transfer
+      description: Run bulk partial inventory transfer for specified items.
+      operationId: PostV1InventoryBulkpartialsourcetransfer
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventoryBulkpartialsourcetransferBody
+        in: body
+        schema:
+          required:
+          - originSourceCode
+          - destinationSourceCode
+          - items
+          properties:
+            originSourceCode:
+              type: string
+            destinationSourceCode:
+              type: string
+            items:
+              type: array
+              items:
+                "$ref": "#/definitions/inventory-catalog-api-data-partial-inventory-transfer-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/bulk-partial-source-transfer
+  "/V1/inventory/bulk-product-source-assign":
+    post:
+      tags:
+      - inventory/bulk-product-source-assign
+      description: Run mass product to source assignment
+      operationId: PostV1InventoryBulkproductsourceassign
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventoryBulkproductsourceassignBody
+        in: body
+        schema:
+          required:
+          - skus
+          - sourceCodes
+          properties:
+            skus:
+              type: array
+              items:
+                type: string
+            sourceCodes:
+              type: array
+              items:
+                type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/bulk-product-source-assign
+  "/V1/inventory/bulk-product-source-transfer":
+    post:
+      tags:
+      - inventory/bulk-product-source-transfer
+      description: Run bulk inventory transfer
+      operationId: PostV1InventoryBulkproductsourcetransfer
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventoryBulkproductsourcetransferBody
+        in: body
+        schema:
+          required:
+          - skus
+          - originSource
+          - destinationSource
+          - unassignFromOrigin
+          properties:
+            skus:
+              type: array
+              items:
+                type: string
+            originSource:
+              type: string
+            destinationSource:
+              type: string
+            unassignFromOrigin:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/bulk-product-source-transfer
+  "/V1/inventory/bulk-product-source-unassign":
+    post:
+      tags:
+      - inventory/bulk-product-source-unassign
+      description: Run mass product to source un-assignment
+      operationId: PostV1InventoryBulkproductsourceunassign
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventoryBulkproductsourceunassignBody
+        in: body
+        schema:
+          required:
+          - skus
+          - sourceCodes
+          properties:
+            skus:
+              type: array
+              items:
+                type: string
+            sourceCodes:
+              type: array
+              items:
+                type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/bulk-product-source-unassign
+  "/V1/inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode}":
+    get:
+      tags:
+      - inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode}
+      description: Provides stock index export from inventory_stock_% table
+      operationId: GetV1InventoryDumpstockindexdataSalesChannelTypeSalesChannelCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: salesChannelType
+        in: path
+        type: string
+        required: true
+      - name: salesChannelCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/inventory-export-stock-api-data-product-stock-index-data-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode}
+  "/V1/inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode}":
+    get:
+      tags:
+      - inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode}
+      description: Export product stock data filtered by search criteria.
+      operationId: GetV1InventoryExportstocksalableqtySalesChannelTypeSalesChannelCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: salesChannelType
+        in: path
+        type: string
+        required: true
+      - name: salesChannelCode
+        in: path
+        type: string
+        required: true
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-export-stock-api-data-export-stock-salable-qty-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode}
+  "/V1/inventory/get-distance":
+    get:
+      tags:
+      - inventory/get-distance
+      description: Get distance between two points
+      operationId: GetV1InventoryGetdistance
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: source[lat]
+        in: query
+        type: number
+        description: Latitude
+      - name: source[lng]
+        in: query
+        type: number
+        description: Longitude
+      - name: destination[lat]
+        in: query
+        type: number
+        description: Latitude
+      - name: destination[lng]
+        in: query
+        type: number
+        description: Longitude
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: number
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/get-distance
+  "/V1/inventory/get-distance-provider-code":
+    get:
+      tags:
+      - inventory/get-distance-provider-code
+      description: Get Default distance provider code
+      operationId: GetV1InventoryGetdistanceprovidercode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/get-distance-provider-code
+  "/V1/inventory/get-latlng-from-address":
+    get:
+      tags:
+      - inventory/get-latlng-from-address
+      description: Get latitude and longitude object from address
+      operationId: GetV1InventoryGetlatlngfromaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: address[country]
+        in: query
+        type: string
+        description: Shipping country
+      - name: address[postcode]
+        in: query
+        type: string
+        description: Shipping postcode
+      - name: address[street]
+        in: query
+        type: string
+        description: Shipping street address
+      - name: address[region]
+        in: query
+        type: string
+        description: Shipping region
+      - name: address[city]
+        in: query
+        type: string
+        description: Shipping city
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-distance-based-source-selection-api-data-lat-lng-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/get-latlng-from-address
+  "/V1/inventory/get-latslngs-from-address":
+    get:
+      tags:
+      - inventory/get-latslngs-from-address
+      description: Get all available latitude and longitude objects from address.
+      operationId: GetV1InventoryGetlatslngsfromaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: address[country]
+        in: query
+        type: string
+        description: Shipping country
+      - name: address[postcode]
+        in: query
+        type: string
+        description: Shipping postcode
+      - name: address[street]
+        in: query
+        type: string
+        description: Shipping street address
+      - name: address[region]
+        in: query
+        type: string
+        description: Shipping region
+      - name: address[city]
+        in: query
+        type: string
+        description: Shipping city
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/inventory-distance-based-source-selection-api-data-lat-lng-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/get-latslngs-from-address
+  "/V1/inventory/get-product-salable-quantity/{sku}/{stockId}":
+    get:
+      tags:
+      - inventory/get-product-salable-quantity/{sku}/{stockId}
+      description: Get Product Quantity for given SKU and Stock
+      operationId: GetV1InventoryGetproductsalablequantitySkuStockId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: stockId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: number
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/get-product-salable-quantity/{sku}/{stockId}
+  "/V1/inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId}":
+    get:
+      tags:
+      - inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId}
+      description: Get Sources assigned to Stock ordered by priority If Stock with
+        given id doesn't exist then return an empty array
+      operationId: GetV1InventoryGetsourcesassignedtostockorderedbypriorityStockId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: stockId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/inventory-api-data-source-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId}
+  "/V1/inventory/in-store-pickup/pickup-locations/":
+    get:
+      tags:
+      - inventory/in-store-pickup/pickup-locations/
+      description: Get Pickup Locations according to the results of filtration by
+        Search Request.
+      operationId: GetV1InventoryInstorepickupPickuplocations
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchRequest[area][radius]
+        in: query
+        type: integer
+        description: Search radius in KM.
+      - name: searchRequest[area][searchTerm]
+        in: query
+        type: string
+        description: Search term string.
+      - name: searchRequest[filters][country][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][country][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][postcode][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][postcode][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][region][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][region][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][regionId][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][regionId][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][city][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][city][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][street][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][street][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][name][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][name][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][pickupLocationCode][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][pickupLocationCode][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchRequest[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      - name: searchRequest[scopeType]
+        in: query
+        type: string
+        description: Sales Channel Type.
+      - name: searchRequest[scopeCode]
+        in: query
+        type: string
+        description: Sales Channel code.
+      - name: searchRequest[sort][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchRequest[sort][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchRequest[extensionAttributes][productsInfo][0][sku]
+        in: query
+        type: string
+        description: Product SKU.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/in-store-pickup/pickup-locations/
+    post:
+      tags:
+      - inventory/in-store-pickup/pickup-locations/
+      description: Get Pickup Locations according to the results of filtration by
+        Search Request.
+      operationId: PostV1InventoryInstorepickupPickuplocations
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventoryInstorepickupPickuplocationsBody
+        in: body
+        schema:
+          required:
+          - searchRequest
+          properties:
+            searchRequest:
+              "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/in-store-pickup/pickup-locations/
+  "/V1/inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty}":
+    get:
+      tags:
+      - inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty}
+      description: Get is product salable for given SKU in a given Stock for a certain
+        Qty
+      operationId: GetV1InventoryIsproductsalableforrequestedqtySkuStockIdRequestedQty
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: stockId
+        in: path
+        type: integer
+        required: true
+      - name: requestedQty
+        in: path
+        type: number
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-sales-api-data-product-salable-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty}
+  "/V1/inventory/is-product-salable/{sku}/{stockId}":
+    get:
+      tags:
+      - inventory/is-product-salable/{sku}/{stockId}
+      description: Get is product in salable for given SKU in a given Stock
+      operationId: GetV1InventoryIsproductsalableSkuStockId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: stockId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/is-product-salable/{sku}/{stockId}
+  "/V1/inventory/low-quantity-notification":
+    post:
+      tags:
+      - inventory/low-quantity-notification
+      description: Save an array of SourceItemConfigurationInterface objects passed
+        as parameter.
+      operationId: PostV1InventoryLowquantitynotification
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventoryLowquantitynotificationBody
+        in: body
+        schema:
+          required:
+          - sourceItemConfigurations
+          properties:
+            sourceItemConfigurations:
+              type: array
+              items:
+                "$ref": "#/definitions/inventory-low-quantity-notification-api-data-source-item-configuration-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/low-quantity-notification
+  "/V1/inventory/low-quantity-notification/{sourceCode}/{sku}":
+    get:
+      tags:
+      - inventory/low-quantity-notification/{sourceCode}/{sku}
+      description: Get the source item configuration
+      operationId: GetV1InventoryLowquantitynotificationSourceCodeSku
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sourceCode
+        in: path
+        type: string
+        required: true
+      - name: sku
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-low-quantity-notification-api-data-source-item-configuration-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/low-quantity-notification/{sourceCode}/{sku}
+  "/V1/inventory/low-quantity-notifications-delete":
+    post:
+      tags:
+      - inventory/low-quantity-notifications-delete
+      description: Delete multiple source items configuration for low quantity
+      operationId: PostV1InventoryLowquantitynotificationsdelete
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventoryLowquantitynotificationsdeleteBody
+        in: body
+        schema:
+          required:
+          - sourceItems
+          properties:
+            sourceItems:
+              type: array
+              items:
+                "$ref": "#/definitions/inventory-api-data-source-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/low-quantity-notifications-delete
+  "/V1/inventory/source-items":
+    get:
+      tags:
+      - inventory/source-items
+      description: Find SourceItems by SearchCriteria We need to have this method
+        for direct work with SourceItems because this object contains additional data
+        like as qty, status (for example can be searchable by additional field)
+      operationId: GetV1InventorySourceitems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-api-data-source-item-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/source-items
+    post:
+      tags:
+      - inventory/source-items
+      description: Save Multiple Source item data
+      operationId: PostV1InventorySourceitems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventorySourceitemsBody
+        in: body
+        schema:
+          required:
+          - sourceItems
+          properties:
+            sourceItems:
+              type: array
+              items:
+                "$ref": "#/definitions/inventory-api-data-source-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/source-items
+  "/V1/inventory/source-items-delete":
+    post:
+      tags:
+      - inventory/source-items-delete
+      description: Delete Multiple Source item data
+      operationId: PostV1InventorySourceitemsdelete
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventorySourceitemsdeleteBody
+        in: body
+        schema:
+          required:
+          - sourceItems
+          properties:
+            sourceItems:
+              type: array
+              items:
+                "$ref": "#/definitions/inventory-api-data-source-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/source-items-delete
+  "/V1/inventory/source-selection-algorithm-list":
+    get:
+      tags:
+      - inventory/source-selection-algorithm-list
+      description: Returns a list of registered Source Selection Algorithm (SSA) data
+        interfaces available in the system.
+      operationId: GetV1InventorySourceselectionalgorithmlist
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-algorithm-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/source-selection-algorithm-list
+  "/V1/inventory/source-selection-algorithm-result":
+    post:
+      tags:
+      - inventory/source-selection-algorithm-result
+      description: Executes the source selection service using the provided inventory
+        request and algorithm code.
+      operationId: PostV1InventorySourceselectionalgorithmresult
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventorySourceselectionalgorithmresultBody
+        in: body
+        schema:
+          required:
+          - inventoryRequest
+          - algorithmCode
+          properties:
+            inventoryRequest:
+              "$ref": "#/definitions/inventory-source-selection-api-data-inventory-request-interface"
+            algorithmCode:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/source-selection-algorithm-result
+  "/V1/inventory/sources":
+    get:
+      tags:
+      - inventory/sources
+      description: Find Sources by SearchCriteria SearchCriteria is not required because
+        load all stocks is useful case
+      operationId: GetV1InventorySources
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-api-data-source-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/sources
+    post:
+      tags:
+      - inventory/sources
+      description: Save Source data
+      operationId: PostV1InventorySources
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventorySourcesBody
+        in: body
+        schema:
+          required:
+          - source
+          properties:
+            source:
+              "$ref": "#/definitions/inventory-api-data-source-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/sources
+  "/V1/inventory/sources/{sourceCode}":
+    get:
+      tags:
+      - inventory/sources/{sourceCode}
+      description: Get Source data by given code. If you want to create plugin on
+        get method, also you need to create separate Plugin on getList method, because
+        entity loading way is different for these methods
+      operationId: GetV1InventorySourcesSourceCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sourceCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-api-data-source-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/sources/{sourceCode}
+    put:
+      tags:
+      - inventory/sources/{sourceCode}
+      description: Save Source data
+      operationId: PutV1InventorySourcesSourceCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sourceCode
+        in: path
+        type: string
+        required: true
+      - name: PutV1InventorySourcesSourceCodeBody
+        in: body
+        schema:
+          required:
+          - source
+          properties:
+            source:
+              "$ref": "#/definitions/inventory-api-data-source-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/sources/{sourceCode}
+  "/V1/inventory/stock-resolver/{type}/{code}":
+    get:
+      tags:
+      - inventory/stock-resolver/{type}/{code}
+      description: Resolve Stock by Sales Channel type and code
+      operationId: GetV1InventoryStockresolverTypeCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: type
+        in: path
+        type: string
+        required: true
+      - name: code
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-api-data-stock-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/stock-resolver/{type}/{code}
+  "/V1/inventory/stock-source-links":
+    get:
+      tags:
+      - inventory/stock-source-links
+      description: Find StockSourceLink list by given SearchCriteria
+      operationId: GetV1InventoryStocksourcelinks
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-api-data-stock-source-link-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/stock-source-links
+    post:
+      tags:
+      - inventory/stock-source-links
+      description: Save StockSourceLink list data
+      operationId: PostV1InventoryStocksourcelinks
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventoryStocksourcelinksBody
+        in: body
+        schema:
+          required:
+          - links
+          properties:
+            links:
+              type: array
+              items:
+                "$ref": "#/definitions/inventory-api-data-stock-source-link-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/stock-source-links
+  "/V1/inventory/stock-source-links-delete":
+    post:
+      tags:
+      - inventory/stock-source-links-delete
+      description: Remove StockSourceLink list list
+      operationId: PostV1InventoryStocksourcelinksdelete
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventoryStocksourcelinksdeleteBody
+        in: body
+        schema:
+          required:
+          - links
+          properties:
+            links:
+              type: array
+              items:
+                "$ref": "#/definitions/inventory-api-data-stock-source-link-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/stock-source-links-delete
+  "/V1/inventory/stocks":
+    get:
+      tags:
+      - inventory/stocks
+      description: Find Stocks by given SearchCriteria SearchCriteria is not required
+        because load all stocks is useful case
+      operationId: GetV1InventoryStocks
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-api-data-stock-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/stocks
+    post:
+      tags:
+      - inventory/stocks
+      description: Save Stock data
+      operationId: PostV1InventoryStocks
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventoryStocksBody
+        in: body
+        schema:
+          required:
+          - stock
+          properties:
+            stock:
+              "$ref": "#/definitions/inventory-api-data-stock-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/stocks
+  "/V1/inventory/stocks/{stockId}":
+    get:
+      tags:
+      - inventory/stocks/{stockId}
+      description: Get Stock data by given stockId. If you want to create plugin on
+        get method, also you need to create separate Plugin on getList method, because
+        entity loading way is different for these methods
+      operationId: GetV1InventoryStocksStockId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: stockId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-api-data-stock-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/stocks/{stockId}
+    delete:
+      tags:
+      - inventory/stocks/{stockId}
+      description: Delete the Stock data by stockId. If stock is not found do nothing
+      operationId: DeleteV1InventoryStocksStockId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: stockId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/stocks/{stockId}
+    put:
+      tags:
+      - inventory/stocks/{stockId}
+      description: Save Stock data
+      operationId: PutV1InventoryStocksStockId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: stockId
+        in: path
+        type: string
+        required: true
+      - name: PutV1InventoryStocksStockIdBody
+        in: body
+        schema:
+          required:
+          - stock
+          properties:
+            stock:
+              "$ref": "#/definitions/inventory-api-data-stock-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/stocks/{stockId}
+  "/V1/invoice/{invoiceId}/refund":
+    post:
+      tags:
+      - invoice/{invoiceId}/refund
+      description: Create refund for invoice
+      operationId: PostV1InvoiceInvoiceIdRefund
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: invoiceId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1InvoiceInvoiceIdRefundBody
+        in: body
+        schema:
+          properties:
+            items:
+              type: array
+              items:
+                "$ref": "#/definitions/sales-data-creditmemo-item-creation-interface"
+            isOnline:
+              type: boolean
+            notify:
+              type: boolean
+            appendComment:
+              type: boolean
+            comment:
+              "$ref": "#/definitions/sales-data-creditmemo-comment-creation-interface"
+            arguments:
+              "$ref": "#/definitions/sales-data-creditmemo-creation-arguments-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: invoice/{invoiceId}/refund
+  "/V1/invoices":
+    get:
+      tags:
+      - invoices
+      description: Lists invoices that match specified search criteria. This call
+        returns an array of objects, but detailed information about each object’s
+        attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#InvoiceRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1Invoices
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-invoice-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: invoices
+  "/V1/invoices/":
+    post:
+      tags:
+      - invoices/
+      description: Performs persist operations for a specified invoice.
+      operationId: PostV1Invoices
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InvoicesBody
+        in: body
+        schema:
+          required:
+          - entity
+          properties:
+            entity:
+              "$ref": "#/definitions/sales-data-invoice-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-invoice-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: invoices/
+  "/V1/invoices/comments":
+    post:
+      tags:
+      - invoices/comments
+      description: Performs persist operations for a specified invoice comment.
+      operationId: PostV1InvoicesComments
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InvoicesCommentsBody
+        in: body
+        schema:
+          required:
+          - entity
+          properties:
+            entity:
+              "$ref": "#/definitions/sales-data-invoice-comment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-invoice-comment-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: invoices/comments
+  "/V1/invoices/{id}":
+    get:
+      tags:
+      - invoices/{id}
+      description: Loads a specified invoice.
+      operationId: GetV1InvoicesId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The invoice ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-invoice-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: invoices/{id}
+  "/V1/invoices/{id}/capture":
+    post:
+      tags:
+      - invoices/{id}/capture
+      description: Sets invoice capture.
+      operationId: PostV1InvoicesIdCapture
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: invoices/{id}/capture
+  "/V1/invoices/{id}/comments":
+    get:
+      tags:
+      - invoices/{id}/comments
+      description: Lists comments for a specified invoice.
+      operationId: GetV1InvoicesIdComments
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The invoice ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-invoice-comment-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: invoices/{id}/comments
+  "/V1/invoices/{id}/emails":
+    post:
+      tags:
+      - invoices/{id}/emails
+      description: Emails a user a specified invoice.
+      operationId: PostV1InvoicesIdEmails
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The invoice ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: invoices/{id}/emails
+  "/V1/invoices/{id}/void":
+    post:
+      tags:
+      - invoices/{id}/void
+      description: Voids a specified invoice.
+      operationId: PostV1InvoicesIdVoid
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The invoice ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: invoices/{id}/void
+  "/V1/modules":
+    get:
+      tags:
+      - modules
+      description: Returns an array of enabled modules
+      operationId: GetV1Modules
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              type: string
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: modules
+  "/V1/negotiable-cart-item-note":
+    post:
+      tags:
+      - negotiable-cart-item-note
+      description: Set the note for an item in negotiable quote.
+      operationId: PostV1Negotiablecartitemnote
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiablecartitemnoteBody
+        in: body
+        schema:
+          required:
+          - itemNote
+          properties:
+            itemNote:
+              "$ref": "#/definitions/negotiable-quote-data-item-note-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-cart-item-note
+  "/V1/negotiable-cart-item-note/search":
+    get:
+      tags:
+      - negotiable-cart-item-note/search
+      description: Get list of item notes
+      operationId: GetV1NegotiablecartitemnoteSearch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/negotiable-quote-data-item-note-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-cart-item-note/search
+  "/V1/negotiable-cart-item-note/{noteId}":
+    get:
+      tags:
+      - negotiable-cart-item-note/{noteId}
+      description: Get item note by ID
+      operationId: GetV1NegotiablecartitemnoteNoteId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: noteId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/negotiable-quote-data-item-note-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-cart-item-note/{noteId}
+    delete:
+      tags:
+      - negotiable-cart-item-note/{noteId}
+      description: Delete item note by ID.
+      operationId: DeleteV1NegotiablecartitemnoteNoteId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: noteId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-cart-item-note/{noteId}
+  "/V1/negotiable-carts/{cartId}/billing-address":
+    get:
+      tags:
+      - negotiable-carts/{cartId}/billing-address
+      description: Returns the billing address for a specified quote.
+      operationId: GetV1NegotiablecartsCartIdBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-address-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/billing-address
+    post:
+      tags:
+      - negotiable-carts/{cartId}/billing-address
+      description: Assigns a specified billing address to a specified cart.
+      operationId: PostV1NegotiablecartsCartIdBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      - name: PostV1NegotiablecartsCartIdBillingaddressBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+            useForShipping:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Address ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/billing-address
+  "/V1/negotiable-carts/{cartId}/coupons":
+    delete:
+      tags:
+      - negotiable-carts/{cartId}/coupons
+      description: Deletes a coupon from a specified cart.
+      operationId: DeleteV1NegotiablecartsCartIdCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/coupons
+  "/V1/negotiable-carts/{cartId}/coupons/{couponCode}":
+    put:
+      tags:
+      - negotiable-carts/{cartId}/coupons/{couponCode}
+      description: Adds a coupon by code to a specified cart.
+      operationId: PutV1NegotiablecartsCartIdCouponsCouponCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      - name: couponCode
+        in: path
+        type: string
+        required: true
+        description: The coupon code data.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/coupons/{couponCode}
+  "/V1/negotiable-carts/{cartId}/estimate-shipping-methods":
+    post:
+      tags:
+      - negotiable-carts/{cartId}/estimate-shipping-methods
+      description: Estimate shipping by address and return list of available shipping
+        methods
+      operationId: PostV1NegotiablecartsCartIdEstimateshippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1NegotiablecartsCartIdEstimateshippingmethodsBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/estimate-shipping-methods
+  "/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id":
+    post:
+      tags:
+      - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
+      description: Estimate shipping
+      operationId: PostV1NegotiablecartsCartIdEstimateshippingmethodsbyaddressid
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The shopping cart ID.
+      - name: PostV1NegotiablecartsCartIdEstimateshippingmethodsbyaddressidBody
+        in: body
+        schema:
+          required:
+          - addressId
+          properties:
+            addressId:
+              type: integer
+              description: The estimate address id
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
+  "/V1/negotiable-carts/{cartId}/giftCards":
+    post:
+      tags:
+      - negotiable-carts/{cartId}/giftCards
+      description: ''
+      operationId: PostV1NegotiablecartsCartIdGiftCards
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1NegotiablecartsCartIdGiftCardsBody
+        in: body
+        schema:
+          required:
+          - giftCardAccountData
+          properties:
+            giftCardAccountData:
+              "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/giftCards
+  "/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}":
+    delete:
+      tags:
+      - negotiable-carts/{cartId}/giftCards/{giftCardCode}
+      description: Remove GiftCard Account entity
+      operationId: DeleteV1NegotiablecartsCartIdGiftCardsGiftCardCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: giftCardCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/giftCards/{giftCardCode}
+  "/V1/negotiable-carts/{cartId}/payment-information":
+    post:
+      tags:
+      - negotiable-carts/{cartId}/payment-information
+      description: Set payment information and place order for a specified cart.
+      operationId: PostV1NegotiablecartsCartIdPaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1NegotiablecartsCartIdPaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/payment-information
+    get:
+      tags:
+      - negotiable-carts/{cartId}/payment-information
+      description: Get payment information
+      operationId: GetV1NegotiablecartsCartIdPaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/payment-information
+  "/V1/negotiable-carts/{cartId}/po-payment-information":
+    post:
+      tags:
+      - negotiable-carts/{cartId}/po-payment-information
+      description: Set payment information and place purchase order for a specified
+        negotiable quote.
+      operationId: PostV1NegotiablecartsCartIdPopaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1NegotiablecartsCartIdPopaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Purchase Order ID.
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/po-payment-information
+  "/V1/negotiable-carts/{cartId}/set-payment-information":
+    post:
+      tags:
+      - negotiable-carts/{cartId}/set-payment-information
+      description: Set payment information for a specified cart.
+      operationId: PostV1NegotiablecartsCartIdSetpaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1NegotiablecartsCartIdSetpaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/set-payment-information
+  "/V1/negotiable-carts/{cartId}/shipping-information":
+    post:
+      tags:
+      - negotiable-carts/{cartId}/shipping-information
+      description: ''
+      operationId: PostV1NegotiablecartsCartIdShippinginformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1NegotiablecartsCartIdShippinginformationBody
+        in: body
+        schema:
+          required:
+          - addressInformation
+          properties:
+            addressInformation:
+              "$ref": "#/definitions/checkout-data-shipping-information-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/shipping-information
+  "/V1/negotiable-carts/{cartId}/totals":
+    get:
+      tags:
+      - negotiable-carts/{cartId}/totals
+      description: Returns quote totals data for a specified cart.
+      operationId: GetV1NegotiablecartsCartIdTotals
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/totals
+  "/V1/negotiableQuote/attachmentContent":
+    get:
+      tags:
+      - negotiableQuote/attachmentContent
+      description: Returns content for one or more files attached on the quote comment.
+      operationId: GetV1NegotiableQuoteAttachmentContent
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attachmentIds
+        in: query
+        type: array
+        items:
+          type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuote/attachmentContent
+  "/V1/negotiableQuote/decline":
+    post:
+      tags:
+      - negotiableQuote/decline
+      description: Decline the B2B quote. All custom pricing will be removed from
+        this quote. The buyer will be able to place an order using their standard
+        catalog prices and discounts.
+      operationId: PostV1NegotiableQuoteDecline
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteDeclineBody
+        in: body
+        schema:
+          required:
+          - quoteId
+          - reason
+          properties:
+            quoteId:
+              type: integer
+            reason:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuote/decline
+  "/V1/negotiableQuote/draft":
+    post:
+      tags:
+      - negotiableQuote/draft
+      description: Create a new empty B2B quote with NegotiableQuoteInterface::STATUS_DRAFT_BY_ADMIN
+        status.
+      operationId: PostV1NegotiableQuoteDraft
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteDraftBody
+        in: body
+        schema:
+          required:
+          - customerId
+          properties:
+            customerId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Quote Id
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuote/draft
+  "/V1/negotiableQuote/pricesUpdated":
+    post:
+      tags:
+      - negotiableQuote/pricesUpdated
+      description: Refreshes item prices, taxes, discounts, cart rules in the negotiable
+        quote as per the latest changes in the catalog / shared catalog and in the
+        price rules. Depending on the negotiable quote state and totals, all or just
+        some of quote numbers will be recalculated. 'Update Prices' parameter forces
+        refresh on any quote that is not locked for admin user, including the quotes
+        with a negotiated price. The request can be applied to one or more quotes
+        at the same time.
+      operationId: PostV1NegotiableQuotePricesUpdated
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuotePricesUpdatedBody
+        in: body
+        schema:
+          required:
+          - quoteIds
+          properties:
+            quoteIds:
+              type: array
+              items:
+                type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuote/pricesUpdated
+  "/V1/negotiableQuote/request":
+    post:
+      tags:
+      - negotiableQuote/request
+      description: Create a B2B quote based on a regular Magento quote. If the B2B
+        quote requires a shipping address (for negotiation or tax calculations), add
+        it to the regular quote before you create a B2B quote.
+      operationId: PostV1NegotiableQuoteRequest
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteRequestBody
+        in: body
+        schema:
+          required:
+          - quoteId
+          - quoteName
+          properties:
+            quoteId:
+              type: integer
+            quoteName:
+              type: string
+            comment:
+              type: string
+            files:
+              type: array
+              items:
+                "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuote/request
+  "/V1/negotiableQuote/submitToCustomer":
+    post:
+      tags:
+      - negotiableQuote/submitToCustomer
+      description: Submit the B2B quote to the customer. The quote status for the
+        customer will be changed to 'Updated', and the customer can work with the
+        quote.
+      operationId: PostV1NegotiableQuoteSubmitToCustomer
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteSubmitToCustomerBody
+        in: body
+        schema:
+          required:
+          - quoteId
+          properties:
+            quoteId:
+              type: integer
+            comment:
+              type: string
+            files:
+              type: array
+              items:
+                "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuote/submitToCustomer
+  "/V1/negotiableQuote/{negotiableQuoteId}/duplicate":
+    post:
+      tags:
+      - negotiableQuote/{negotiableQuoteId}/duplicate
+      description: Duplicate Negotiable Quote based on the ID of existing negotiable
+        quote. Returns ID of a duplicated quote.
+      operationId: PostV1NegotiableQuoteNegotiableQuoteIdDuplicate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: negotiableQuoteId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuote/{negotiableQuoteId}/duplicate
+  "/V1/negotiableQuote/{quoteId}":
+    put:
+      tags:
+      - negotiableQuote/{quoteId}
+      description: Save quote
+      operationId: PutV1NegotiableQuoteQuoteId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: quoteId
+        in: path
+        type: string
+        required: true
+      - name: PutV1NegotiableQuoteQuoteIdBody
+        in: body
+        schema:
+          required:
+          - quote
+          properties:
+            quote:
+              "$ref": "#/definitions/quote-data-cart-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuote/{quoteId}
+  "/V1/negotiableQuote/{quoteId}/comments":
+    get:
+      tags:
+      - negotiableQuote/{quoteId}/comments
+      description: Returns comments for a specified negotiable quote.
+      operationId: GetV1NegotiableQuoteQuoteIdComments
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: quoteId
+        in: path
+        type: integer
+        required: true
+        description: Negotiable Quote ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of quote comments.
+            items:
+              "$ref": "#/definitions/negotiable-quote-data-comment-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuote/{quoteId}/comments
+  "/V1/negotiableQuote/{quoteId}/shippingMethod":
+    put:
+      tags:
+      - negotiableQuote/{quoteId}/shippingMethod
+      description: Updates the shipping method on a negotiable quote.
+      operationId: PutV1NegotiableQuoteQuoteIdShippingMethod
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: quoteId
+        in: path
+        type: integer
+        required: true
+        description: Negotiable Quote id
+      - name: PutV1NegotiableQuoteQuoteIdShippingMethodBody
+        in: body
+        schema:
+          required:
+          - shippingMethod
+          properties:
+            shippingMethod:
+              type: string
+              description: The shipping method code.
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuote/{quoteId}/shippingMethod
+  "/V1/negotiableQuoteTemplate":
+    get:
+      tags:
+      - negotiableQuoteTemplate
+      description: Get list of quote templates
+      operationId: GetV1NegotiableQuoteTemplate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/framework-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate
+    put:
+      tags:
+      - negotiableQuoteTemplate
+      description: Edit a quote template.
+      operationId: PutV1NegotiableQuoteTemplate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1NegotiableQuoteTemplateBody
+        in: body
+        schema:
+          required:
+          - template
+          properties:
+            template:
+              "$ref": "#/definitions/negotiable-quote-template-data-template-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate
+  "/V1/negotiableQuoteTemplate/accept":
+    post:
+      tags:
+      - negotiableQuoteTemplate/accept
+      description: Create quote template from quote
+      operationId: PostV1NegotiableQuoteTemplateAccept
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateAcceptBody
+        in: body
+        schema:
+          required:
+          - templateId
+          properties:
+            templateId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/accept
+  "/V1/negotiableQuoteTemplate/cancel":
+    post:
+      tags:
+      - negotiableQuoteTemplate/cancel
+      description: Cancel a quote template.
+      operationId: PostV1NegotiableQuoteTemplateCancel
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateCancelBody
+        in: body
+        schema:
+          required:
+          - templateId
+          properties:
+            templateId:
+              type: integer
+            comment:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/cancel
+  "/V1/negotiableQuoteTemplate/cancel/me":
+    post:
+      tags:
+      - negotiableQuoteTemplate/cancel/me
+      description: Cancel a quote template.
+      operationId: PostV1NegotiableQuoteTemplateCancelMe
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateCancelMeBody
+        in: body
+        schema:
+          required:
+          - templateId
+          properties:
+            templateId:
+              type: integer
+            comment:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/cancel/me
+  "/V1/negotiableQuoteTemplate/decline":
+    post:
+      tags:
+      - negotiableQuoteTemplate/decline
+      description: Decline a quote template.
+      operationId: PostV1NegotiableQuoteTemplateDecline
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateDeclineBody
+        in: body
+        schema:
+          required:
+          - templateId
+          - reason
+          properties:
+            templateId:
+              type: integer
+            reason:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/decline
+  "/V1/negotiableQuoteTemplate/draft":
+    post:
+      tags:
+      - negotiableQuoteTemplate/draft
+      description: Create a new empty B2B quote template with NegotiableQuoteInterface::STATUS_DRAFT_BY_ADMIN
+        status.
+      operationId: PostV1NegotiableQuoteTemplateDraft
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateDraftBody
+        in: body
+        schema:
+          required:
+          - customerId
+          properties:
+            customerId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/negotiable-quote-template-data-template-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/draft
+  "/V1/negotiableQuoteTemplate/generateQuote":
+    post:
+      tags:
+      - negotiableQuoteTemplate/generateQuote
+      description: Generate quote from template
+      operationId: PostV1NegotiableQuoteTemplateGenerateQuote
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateGenerateQuoteBody
+        in: body
+        schema:
+          required:
+          - templateId
+          properties:
+            templateId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/generateQuote
+  "/V1/negotiableQuoteTemplate/me":
+    put:
+      tags:
+      - negotiableQuoteTemplate/me
+      description: Edit a quote template.
+      operationId: PutV1NegotiableQuoteTemplateMe
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1NegotiableQuoteTemplateMeBody
+        in: body
+        schema:
+          required:
+          - template
+          properties:
+            template:
+              "$ref": "#/definitions/negotiable-quote-template-data-template-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/me
+  "/V1/negotiableQuoteTemplate/me/{templateId}":
+    delete:
+      tags:
+      - negotiableQuoteTemplate/me/{templateId}
+      description: Delete a quote template.
+      operationId: DeleteV1NegotiableQuoteTemplateMeTemplateId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: templateId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/me/{templateId}
+  "/V1/negotiableQuoteTemplate/open":
+    post:
+      tags:
+      - negotiableQuoteTemplate/open
+      description: Open template
+      operationId: PostV1NegotiableQuoteTemplateOpen
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateOpenBody
+        in: body
+        schema:
+          required:
+          - templateId
+          properties:
+            templateId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/open
+  "/V1/negotiableQuoteTemplate/open/me":
+    post:
+      tags:
+      - negotiableQuoteTemplate/open/me
+      description: Open template
+      operationId: PostV1NegotiableQuoteTemplateOpenMe
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateOpenMeBody
+        in: body
+        schema:
+          required:
+          - templateId
+          properties:
+            templateId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/open/me
+  "/V1/negotiableQuoteTemplate/referenceDocumentLink":
+    get:
+      tags:
+      - negotiableQuoteTemplate/referenceDocumentLink
+      description: Get list of reference document links
+      operationId: GetV1NegotiableQuoteTemplateReferenceDocumentLink
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/framework-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/referenceDocumentLink
+    put:
+      tags:
+      - negotiableQuoteTemplate/referenceDocumentLink
+      description: Save reference document link
+      operationId: PutV1NegotiableQuoteTemplateReferenceDocumentLink
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1NegotiableQuoteTemplateReferenceDocumentLinkBody
+        in: body
+        schema:
+          required:
+          - referenceDocumentLink
+          properties:
+            referenceDocumentLink:
+              "$ref": "#/definitions/negotiable-quote-template-data-reference-document-link-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/referenceDocumentLink
+  "/V1/negotiableQuoteTemplate/referenceDocumentLink/{linkId}":
+    get:
+      tags:
+      - negotiableQuoteTemplate/referenceDocumentLink/{linkId}
+      description: Get reference document link by id
+      operationId: GetV1NegotiableQuoteTemplateReferenceDocumentLinkLinkId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: linkId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/negotiable-quote-template-data-reference-document-link-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/referenceDocumentLink/{linkId}
+    delete:
+      tags:
+      - negotiableQuoteTemplate/referenceDocumentLink/{linkId}
+      description: Delete a quote template reference document link
+      operationId: DeleteV1NegotiableQuoteTemplateReferenceDocumentLinkLinkId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: linkId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/referenceDocumentLink/{linkId}
+  "/V1/negotiableQuoteTemplate/request":
+    post:
+      tags:
+      - negotiableQuoteTemplate/request
+      description: Create a template for a quote.
+      operationId: PostV1NegotiableQuoteTemplateRequest
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateRequestBody
+        in: body
+        schema:
+          required:
+          - quoteId
+          properties:
+            quoteId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/negotiable-quote-template-data-template-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/request
+  "/V1/negotiableQuoteTemplate/request/me":
+    post:
+      tags:
+      - negotiableQuoteTemplate/request/me
+      description: Create a template for a quote.
+      operationId: PostV1NegotiableQuoteTemplateRequestMe
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateRequestMeBody
+        in: body
+        schema:
+          required:
+          - quoteId
+          properties:
+            quoteId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/negotiable-quote-template-data-template-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/request/me
+  "/V1/negotiableQuoteTemplate/submitToCustomer":
+    post:
+      tags:
+      - negotiableQuoteTemplate/submitToCustomer
+      description: Seller send action
+      operationId: PostV1NegotiableQuoteTemplateSubmitToCustomer
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateSubmitToCustomerBody
+        in: body
+        schema:
+          required:
+          - templateId
+          properties:
+            templateId:
+              type: integer
+            commentText:
+              type: string
+            files:
+              type: array
+              items:
+                "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/submitToCustomer
+  "/V1/negotiableQuoteTemplate/submitToSeller":
+    post:
+      tags:
+      - negotiableQuoteTemplate/submitToSeller
+      description: Send template to seller
+      operationId: PostV1NegotiableQuoteTemplateSubmitToSeller
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateSubmitToSellerBody
+        in: body
+        schema:
+          required:
+          - templateId
+          properties:
+            templateId:
+              type: integer
+            commentText:
+              type: string
+            files:
+              type: array
+              items:
+                "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/submitToSeller
+  "/V1/negotiableQuoteTemplate/{templateId}":
+    get:
+      tags:
+      - negotiableQuoteTemplate/{templateId}
+      description: Return the negotiable quote template for a specified quote ID.
+      operationId: GetV1NegotiableQuoteTemplateTemplateId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: templateId
+        in: path
+        type: integer
+        required: true
+        description: template id
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/negotiable-quote-template-data-template-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/{templateId}
+    delete:
+      tags:
+      - negotiableQuoteTemplate/{templateId}
+      description: Delete a quote template.
+      operationId: DeleteV1NegotiableQuoteTemplateTemplateId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: templateId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/{templateId}
+  "/V1/order/notify-orders-are-ready-for-pickup":
+    post:
+      tags:
+      - order/notify-orders-are-ready-for-pickup
+      description: Notify customer that the orders is ready for pickup.
+      operationId: PostV1OrderNotifyordersarereadyforpickup
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1OrderNotifyordersarereadyforpickupBody
+        in: body
+        schema:
+          required:
+          - orderIds
+          properties:
+            orderIds:
+              type: array
+              items:
+                type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-in-store-pickup-sales-api-data-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: order/notify-orders-are-ready-for-pickup
+  "/V1/order/{orderId}/invoice":
+    post:
+      tags:
+      - order/{orderId}/invoice
+      description: ''
+      operationId: PostV1OrderOrderIdInvoice
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: orderId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1OrderOrderIdInvoiceBody
+        in: body
+        schema:
+          properties:
+            capture:
+              type: boolean
+            items:
+              type: array
+              items:
+                "$ref": "#/definitions/sales-data-invoice-item-creation-interface"
+            notify:
+              type: boolean
+            appendComment:
+              type: boolean
+            comment:
+              "$ref": "#/definitions/sales-data-invoice-comment-creation-interface"
+            arguments:
+              "$ref": "#/definitions/sales-data-invoice-creation-arguments-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: order/{orderId}/invoice
+  "/V1/order/{orderId}/refund":
+    post:
+      tags:
+      - order/{orderId}/refund
+      description: Create offline refund for order
+      operationId: PostV1OrderOrderIdRefund
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: orderId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1OrderOrderIdRefundBody
+        in: body
+        schema:
+          properties:
+            items:
+              type: array
+              items:
+                "$ref": "#/definitions/sales-data-creditmemo-item-creation-interface"
+            notify:
+              type: boolean
+            appendComment:
+              type: boolean
+            comment:
+              "$ref": "#/definitions/sales-data-creditmemo-comment-creation-interface"
+            arguments:
+              "$ref": "#/definitions/sales-data-creditmemo-creation-arguments-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: order/{orderId}/refund
+  "/V1/order/{orderId}/ship":
+    post:
+      tags:
+      - order/{orderId}/ship
+      description: Creates new Shipment for given Order.
+      operationId: PostV1OrderOrderIdShip
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: orderId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1OrderOrderIdShipBody
+        in: body
+        schema:
+          properties:
+            items:
+              type: array
+              items:
+                "$ref": "#/definitions/sales-data-shipment-item-creation-interface"
+            notify:
+              type: boolean
+            appendComment:
+              type: boolean
+            comment:
+              "$ref": "#/definitions/sales-data-shipment-comment-creation-interface"
+            tracks:
+              type: array
+              items:
+                "$ref": "#/definitions/sales-data-shipment-track-creation-interface"
+            packages:
+              type: array
+              items:
+                "$ref": "#/definitions/sales-data-shipment-package-creation-interface"
+            arguments:
+              "$ref": "#/definitions/sales-data-shipment-creation-arguments-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Id of created Shipment.
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: order/{orderId}/ship
+  "/V1/orders":
+    get:
+      tags:
+      - orders
+      description: Lists orders that match specified search criteria. This call returns
+        an array of objects, but detailed information about each object’s attributes
+        might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#OrderRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1Orders
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-order-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: orders
+    post:
+      tags:
+      - orders
+      description: Performs persist operations for a specified order.
+      operationId: PostV1Orders
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1OrdersBody
+        in: body
+        schema:
+          required:
+          - entity
+          properties:
+            entity:
+              "$ref": "#/definitions/sales-data-order-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-order-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: orders
+  "/V1/orders/create":
+    put:
+      tags:
+      - orders/create
+      description: Performs persist operations for a specified order.
+      operationId: PutV1OrdersCreate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1OrdersCreateBody
+        in: body
+        schema:
+          required:
+          - entity
+          properties:
+            entity:
+              "$ref": "#/definitions/sales-data-order-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-order-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: orders/create
+  "/V1/orders/items":
+    get:
+      tags:
+      - orders/items
+      description: Lists order items that match specified search criteria. This call
+        returns an array of objects, but detailed information about each object’s
+        attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#OrderItemRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1OrdersItems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-order-item-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: orders/items
+  "/V1/orders/items/{id}":
+    get:
+      tags:
+      - orders/items/{id}
+      description: Loads a specified order item.
+      operationId: GetV1OrdersItemsId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The order item ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-order-item-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: orders/items/{id}
+  "/V1/orders/{id}":
+    get:
+      tags:
+      - orders/{id}
+      description: Loads a specified order.
+      operationId: GetV1OrdersId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The order ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-order-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: orders/{id}
+  "/V1/orders/{id}/cancel":
+    post:
+      tags:
+      - orders/{id}/cancel
+      description: Cancels a specified order.
+      operationId: PostV1OrdersIdCancel
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The order ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: orders/{id}/cancel
+  "/V1/orders/{id}/comments":
+    post:
+      tags:
+      - orders/{id}/comments
+      description: Adds a comment to a specified order.
+      operationId: PostV1OrdersIdComments
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The order ID.
+      - name: PostV1OrdersIdCommentsBody
+        in: body
+        schema:
+          required:
+          - statusHistory
+          properties:
+            statusHistory:
+              "$ref": "#/definitions/sales-data-order-status-history-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: orders/{id}/comments
+    get:
+      tags:
+      - orders/{id}/comments
+      description: Lists comments for a specified order.
+      operationId: GetV1OrdersIdComments
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The order ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-order-status-history-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: orders/{id}/comments
+  "/V1/orders/{id}/emails":
+    post:
+      tags:
+      - orders/{id}/emails
+      description: Emails a user a specified order.
+      operationId: PostV1OrdersIdEmails
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The order ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: orders/{id}/emails
+  "/V1/orders/{id}/hold":
+    post:
+      tags:
+      - orders/{id}/hold
+      description: Holds a specified order.
+      operationId: PostV1OrdersIdHold
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The order ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: orders/{id}/hold
+  "/V1/orders/{id}/statuses":
+    get:
+      tags:
+      - orders/{id}/statuses
+      description: Gets the status for a specified order.
+      operationId: GetV1OrdersIdStatuses
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The order ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: Order status.
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: orders/{id}/statuses
+  "/V1/orders/{id}/unhold":
+    post:
+      tags:
+      - orders/{id}/unhold
+      description: Releases a specified order from hold status.
+      operationId: PostV1OrdersIdUnhold
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The order ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: orders/{id}/unhold
+  "/V1/orders/{parent_id}":
+    put:
+      tags:
+      - orders/{parent_id}
+      description: Performs persist operations for a specified order address.
+      operationId: PutV1OrdersParent_id
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: parent_id
+        in: path
+        type: string
+        required: true
+      - name: PutV1OrdersParent_idBody
+        in: body
+        schema:
+          required:
+          - entity
+          properties:
+            entity:
+              "$ref": "#/definitions/sales-data-order-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-order-address-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: orders/{parent_id}
+  "/V1/payment-order/completeOrder":
+    post:
+      tags:
+      - payment-order/completeOrder
+      description: Rest API endpoint to place an order
+      operationId: PostV1PaymentorderCompleteOrder
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1PaymentorderCompleteOrderBody
+        in: body
+        schema:
+          required:
+          - orderId
+          properties:
+            orderId:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payment-order/completeOrder
+  "/V1/payments-config/apple-pay/{location}":
+    get:
+      tags:
+      - payments-config/apple-pay/{location}
+      description: Get Apple Pay Config.
+      operationId: GetV1PaymentsconfigApplepayLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/apple-pay/{location}
+  "/V1/payments-config/google-pay/{location}":
+    get:
+      tags:
+      - payments-config/google-pay/{location}
+      description: Get Google Pay Config.
+      operationId: GetV1PaymentsconfigGooglepayLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/google-pay/{location}
+  "/V1/payments-config/hosted-fields/{location}":
+    get:
+      tags:
+      - payments-config/hosted-fields/{location}
+      description: Get Hosted Fields Config.
+      operationId: GetV1PaymentsconfigHostedfieldsLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/hosted-fields/{location}
+  "/V1/payments-config/smart-buttons/{location}":
+    get:
+      tags:
+      - payments-config/smart-buttons/{location}
+      description: Get Smart Buttons Config.
+      operationId: GetV1PaymentsconfigSmartbuttonsLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/smart-buttons/{location}
+  "/V1/payments-config/{location}":
+    get:
+      tags:
+      - payments-config/{location}
+      description: Get Config.
+      operationId: GetV1PaymentsconfigLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-payment-config-response-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/{location}
+  "/V1/payments-sdk/{location}":
+    get:
+      tags:
+      - payments-sdk/{location}
+      description: Get payment sdk url by location
+      operationId: GetV1PaymentssdkLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-sdk/{location}
+  "/V1/payments-sdk/{location}/{methodCode}":
+    get:
+      tags:
+      - payments-sdk/{location}/{methodCode}
+      description: Get payment sdk url by location and methodCode
+      operationId: GetV1PaymentssdkLocationMethodCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+      - name: methodCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-sdk/{location}/{methodCode}
+  "/V1/paypal/lineItems":
+    post:
+      tags:
+      - paypal/lineItems
+      description: Rest endpoint to calculate totals and line items
+      operationId: PostV1PaypalLineItems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1PaypalLineItemsBody
+        in: body
+        schema:
+          required:
+          - method
+          - cartId
+          properties:
+            method:
+              type: string
+            cartId:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: paypal/lineItems
+  "/V1/paypal/oneClick":
+    post:
+      tags:
+      - paypal/oneClick
+      description: Rest endpoint to add product to cart (mainly use for PayPal button
+        from PDP)
+      operationId: PostV1PaypalOneClick
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1PaypalOneClickBody
+        in: body
+        schema:
+          required:
+          - method
+          - productData
+          properties:
+            method:
+              type: string
+            productData:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: paypal/oneClick
+  "/V1/paypal/validatePhoneNumber":
+    post:
+      tags:
+      - paypal/validatePhoneNumber
+      description: Get & validate phone number and get shipping/billing email address
+      operationId: PostV1PaypalValidatePhoneNumber
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1PaypalValidatePhoneNumberBody
+        in: body
+        schema:
+          required:
+          - cartId
+          properties:
+            cartId:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: paypal/validatePhoneNumber
+  "/V1/products":
+    post:
+      tags:
+      - products
+      description: Create product
+      operationId: PostV1Products
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsBody
+        in: body
+        schema:
+          required:
+          - product
+          properties:
+            product:
+              "$ref": "#/definitions/catalog-data-product-interface"
+            saveOptions:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products
+    get:
+      tags:
+      - products
+      description: Get product list
+      operationId: GetV1Products
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products
+  "/V1/products-render-info":
+    get:
+      tags:
+      - products-render-info
+      description: Collect and retrieve the list of product render info. This info
+        contains raw prices and formatted prices, product name, stock status, store_id,
+        etc.
+      operationId: GetV1Productsrenderinfo
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      - name: storeId
+        in: query
+        type: integer
+        required: true
+      - name: currencyCode
+        in: query
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-render-search-results-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products-render-info
+  "/V1/products/attribute-sets":
+    post:
+      tags:
+      - products/attribute-sets
+      description: Create attribute set from data
+      operationId: PostV1ProductsAttributesets
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsAttributesetsBody
+        in: body
+        schema:
+          required:
+          - attributeSet
+          - skeletonId
+          properties:
+            attributeSet:
+              "$ref": "#/definitions/eav-data-attribute-set-interface"
+            skeletonId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/eav-data-attribute-set-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attribute-sets
+  "/V1/products/attribute-sets/attributes":
+    post:
+      tags:
+      - products/attribute-sets/attributes
+      description: Assign attribute to attribute set
+      operationId: PostV1ProductsAttributesetsAttributes
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsAttributesetsAttributesBody
+        in: body
+        schema:
+          required:
+          - attributeSetId
+          - attributeGroupId
+          - attributeCode
+          - sortOrder
+          properties:
+            attributeSetId:
+              type: integer
+            attributeGroupId:
+              type: integer
+            attributeCode:
+              type: string
+            sortOrder:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attribute-sets/attributes
+  "/V1/products/attribute-sets/groups":
+    post:
+      tags:
+      - products/attribute-sets/groups
+      description: Save attribute group
+      operationId: PostV1ProductsAttributesetsGroups
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsAttributesetsGroupsBody
+        in: body
+        schema:
+          required:
+          - group
+          properties:
+            group:
+              "$ref": "#/definitions/eav-data-attribute-group-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/eav-data-attribute-group-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attribute-sets/groups
+  "/V1/products/attribute-sets/groups/list":
+    get:
+      tags:
+      - products/attribute-sets/groups/list
+      description: Retrieve list of attribute groups
+      operationId: GetV1ProductsAttributesetsGroupsList
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/eav-data-attribute-group-search-results-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attribute-sets/groups/list
+  "/V1/products/attribute-sets/groups/{groupId}":
+    delete:
+      tags:
+      - products/attribute-sets/groups/{groupId}
+      description: Remove attribute group by id
+      operationId: DeleteV1ProductsAttributesetsGroupsGroupId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: groupId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attribute-sets/groups/{groupId}
+  "/V1/products/attribute-sets/sets/list":
+    get:
+      tags:
+      - products/attribute-sets/sets/list
+      description: Retrieve list of Attribute Sets
+      operationId: GetV1ProductsAttributesetsSetsList
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/eav-data-attribute-set-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attribute-sets/sets/list
+  "/V1/products/attribute-sets/{attributeSetId}":
+    get:
+      tags:
+      - products/attribute-sets/{attributeSetId}
+      description: Retrieve attribute set information based on given ID
+      operationId: GetV1ProductsAttributesetsAttributeSetId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeSetId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/eav-data-attribute-set-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attribute-sets/{attributeSetId}
+    delete:
+      tags:
+      - products/attribute-sets/{attributeSetId}
+      description: Remove attribute set by given ID
+      operationId: DeleteV1ProductsAttributesetsAttributeSetId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeSetId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attribute-sets/{attributeSetId}
+    put:
+      tags:
+      - products/attribute-sets/{attributeSetId}
+      description: Save attribute set data
+      operationId: PutV1ProductsAttributesetsAttributeSetId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeSetId
+        in: path
+        type: string
+        required: true
+      - name: PutV1ProductsAttributesetsAttributeSetIdBody
+        in: body
+        schema:
+          required:
+          - attributeSet
+          properties:
+            attributeSet:
+              "$ref": "#/definitions/eav-data-attribute-set-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/eav-data-attribute-set-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attribute-sets/{attributeSetId}
+  "/V1/products/attribute-sets/{attributeSetId}/attributes":
+    get:
+      tags:
+      - products/attribute-sets/{attributeSetId}/attributes
+      description: Retrieve related attributes based on given attribute set ID
+      operationId: GetV1ProductsAttributesetsAttributeSetIdAttributes
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeSetId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-product-attribute-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attribute-sets/{attributeSetId}/attributes
+  "/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}":
+    delete:
+      tags:
+      - products/attribute-sets/{attributeSetId}/attributes/{attributeCode}
+      description: Remove attribute from attribute set
+      operationId: DeleteV1ProductsAttributesetsAttributeSetIdAttributesAttributeCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeSetId
+        in: path
+        type: string
+        required: true
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attribute-sets/{attributeSetId}/attributes/{attributeCode}
+  "/V1/products/attribute-sets/{attributeSetId}/groups":
+    put:
+      tags:
+      - products/attribute-sets/{attributeSetId}/groups
+      description: Save attribute group
+      operationId: PutV1ProductsAttributesetsAttributeSetIdGroups
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeSetId
+        in: path
+        type: string
+        required: true
+      - name: PutV1ProductsAttributesetsAttributeSetIdGroupsBody
+        in: body
+        schema:
+          required:
+          - group
+          properties:
+            group:
+              "$ref": "#/definitions/eav-data-attribute-group-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/eav-data-attribute-group-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attribute-sets/{attributeSetId}/groups
+  "/V1/products/attributes":
+    get:
+      tags:
+      - products/attributes
+      description: Retrieve all attributes for entity type
+      operationId: GetV1ProductsAttributes
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-attribute-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attributes
+    post:
+      tags:
+      - products/attributes
+      description: Save attribute data
+      operationId: PostV1ProductsAttributes
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsAttributesBody
+        in: body
+        schema:
+          required:
+          - attribute
+          properties:
+            attribute:
+              "$ref": "#/definitions/catalog-data-product-attribute-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-attribute-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attributes
+  "/V1/products/attributes/types":
+    get:
+      tags:
+      - products/attributes/types
+      description: Retrieve list of product attribute types
+      operationId: GetV1ProductsAttributesTypes
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-product-attribute-type-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attributes/types
+  "/V1/products/attributes/{attributeCode}":
+    get:
+      tags:
+      - products/attributes/{attributeCode}
+      description: Retrieve specific attribute
+      operationId: GetV1ProductsAttributesAttributeCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-attribute-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attributes/{attributeCode}
+    put:
+      tags:
+      - products/attributes/{attributeCode}
+      description: Save attribute data
+      operationId: PutV1ProductsAttributesAttributeCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      - name: PutV1ProductsAttributesAttributeCodeBody
+        in: body
+        schema:
+          required:
+          - attribute
+          properties:
+            attribute:
+              "$ref": "#/definitions/catalog-data-product-attribute-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-attribute-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attributes/{attributeCode}
+    delete:
+      tags:
+      - products/attributes/{attributeCode}
+      description: Delete Attribute by id
+      operationId: DeleteV1ProductsAttributesAttributeCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attributes/{attributeCode}
+  "/V1/products/attributes/{attributeCode}/is-filterable":
+    get:
+      tags:
+      - products/attributes/{attributeCode}/is-filterable
+      description: Retrieve 'is_filterable' property for specific attribute as integer
+      operationId: GetV1ProductsAttributesAttributeCodeIsfilterable
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attributes/{attributeCode}/is-filterable
+  "/V1/products/attributes/{attributeCode}/is-filterable/{isFilterable}":
+    put:
+      tags:
+      - products/attributes/{attributeCode}/is-filterable/{isFilterable}
+      description: Set 'is_filterable' property for specific attribute as integer
+      operationId: PutV1ProductsAttributesAttributeCodeIsfilterableIsFilterable
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      - name: isFilterable
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attributes/{attributeCode}/is-filterable/{isFilterable}
+  "/V1/products/attributes/{attributeCode}/options":
+    get:
+      tags:
+      - products/attributes/{attributeCode}/options
+      description: Retrieve list of attribute options
+      operationId: GetV1ProductsAttributesAttributeCodeOptions
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/eav-data-attribute-option-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attributes/{attributeCode}/options
+    post:
+      tags:
+      - products/attributes/{attributeCode}/options
+      description: Add option to attribute
+      operationId: PostV1ProductsAttributesAttributeCodeOptions
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      - name: PostV1ProductsAttributesAttributeCodeOptionsBody
+        in: body
+        schema:
+          required:
+          - option
+          properties:
+            option:
+              "$ref": "#/definitions/eav-data-attribute-option-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attributes/{attributeCode}/options
+  "/V1/products/attributes/{attributeCode}/options/{optionId}":
+    delete:
+      tags:
+      - products/attributes/{attributeCode}/options/{optionId}
+      description: Delete option from attribute
+      operationId: DeleteV1ProductsAttributesAttributeCodeOptionsOptionId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      - name: optionId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attributes/{attributeCode}/options/{optionId}
+    put:
+      tags:
+      - products/attributes/{attributeCode}/options/{optionId}
+      description: Update attribute option
+      operationId: PutV1ProductsAttributesAttributeCodeOptionsOptionId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      - name: optionId
+        in: path
+        type: integer
+        required: true
+      - name: PutV1ProductsAttributesAttributeCodeOptionsOptionIdBody
+        in: body
+        schema:
+          required:
+          - option
+          properties:
+            option:
+              "$ref": "#/definitions/eav-data-attribute-option-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/attributes/{attributeCode}/options/{optionId}
+  "/V1/products/base-prices":
+    post:
+      tags:
+      - products/base-prices
+      description: Add or update product prices. Input item should correspond \Magento\Catalog\Api\Data\CostInterface.
+        If any items will have invalid price, store id or sku, they will be marked
+        as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[]
+        with problem description will be returned. If there were no failed items during
+        update empty array will be returned. If error occurred during the update exception
+        will be thrown.
+      operationId: PostV1ProductsBaseprices
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsBasepricesBody
+        in: body
+        schema:
+          required:
+          - prices
+          properties:
+            prices:
+              type: array
+              items:
+                "$ref": "#/definitions/catalog-data-base-price-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-price-update-result-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/base-prices
+  "/V1/products/base-prices-information":
+    post:
+      tags:
+      - products/base-prices-information
+      description: Return product prices. In case of at least one of skus is not found
+        exception will be thrown.
+      operationId: PostV1ProductsBasepricesinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsBasepricesinformationBody
+        in: body
+        schema:
+          required:
+          - skus
+          properties:
+            skus:
+              type: array
+              items:
+                type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-base-price-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/base-prices-information
+  "/V1/products/cost":
+    post:
+      tags:
+      - products/cost
+      description: Add or update product cost. Input item should correspond to \Magento\Catalog\Api\Data\CostInterface.
+        If any items will have invalid cost, store id or sku, they will be marked
+        as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[]
+        with problem description will be returned. If there were no failed items during
+        update empty array will be returned. If error occurred during the update exception
+        will be thrown.
+      operationId: PostV1ProductsCost
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsCostBody
+        in: body
+        schema:
+          required:
+          - prices
+          properties:
+            prices:
+              type: array
+              items:
+                "$ref": "#/definitions/catalog-data-cost-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-price-update-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/cost
+  "/V1/products/cost-delete":
+    post:
+      tags:
+      - products/cost-delete
+      description: Delete product cost. In case of at least one of skus is not found
+        exception will be thrown. If error occurred during the delete exception will
+        be thrown.
+      operationId: PostV1ProductsCostdelete
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsCostdeleteBody
+        in: body
+        schema:
+          required:
+          - skus
+          properties:
+            skus:
+              type: array
+              items:
+                type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: Will return True if deleted.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/cost-delete
+  "/V1/products/cost-information":
+    post:
+      tags:
+      - products/cost-information
+      description: Return product prices. In case of at least one of skus is not found
+        exception will be thrown.
+      operationId: PostV1ProductsCostinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsCostinformationBody
+        in: body
+        schema:
+          required:
+          - skus
+          properties:
+            skus:
+              type: array
+              items:
+                type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-cost-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/cost-information
+  "/V1/products/downloadable-links/samples/{id}":
+    delete:
+      tags:
+      - products/downloadable-links/samples/{id}
+      description: Delete downloadable sample
+      operationId: DeleteV1ProductsDownloadablelinksSamplesId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/downloadable-links/samples/{id}
+  "/V1/products/downloadable-links/{id}":
+    delete:
+      tags:
+      - products/downloadable-links/{id}
+      description: Delete downloadable link
+      operationId: DeleteV1ProductsDownloadablelinksId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/downloadable-links/{id}
+  "/V1/products/links/types":
+    get:
+      tags:
+      - products/links/types
+      description: Retrieve information about available product link types
+      operationId: GetV1ProductsLinksTypes
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-product-link-type-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/links/types
+  "/V1/products/links/{type}/attributes":
+    get:
+      tags:
+      - products/links/{type}/attributes
+      description: Provide a list of the product link type attributes
+      operationId: GetV1ProductsLinksTypeAttributes
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: type
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-product-link-attribute-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/links/{type}/attributes
+  "/V1/products/media/types/{attributeSetName}":
+    get:
+      tags:
+      - products/media/types/{attributeSetName}
+      description: Retrieve the list of media attributes (fronted input type is media_image)
+        assigned to the given attribute set.
+      operationId: GetV1ProductsMediaTypesAttributeSetName
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeSetName
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: list of media attributes
+            items:
+              "$ref": "#/definitions/catalog-data-product-attribute-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/media/types/{attributeSetName}
+  "/V1/products/options":
+    post:
+      tags:
+      - products/options
+      description: Save Custom Option
+      operationId: PostV1ProductsOptions
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsOptionsBody
+        in: body
+        schema:
+          required:
+          - option
+          properties:
+            option:
+              "$ref": "#/definitions/catalog-data-product-custom-option-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-custom-option-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/options
+  "/V1/products/options/types":
+    get:
+      tags:
+      - products/options/types
+      description: Get custom option types
+      operationId: GetV1ProductsOptionsTypes
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-product-custom-option-type-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/options/types
+  "/V1/products/options/{optionId}":
+    put:
+      tags:
+      - products/options/{optionId}
+      description: Save Custom Option
+      operationId: PutV1ProductsOptionsOptionId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: optionId
+        in: path
+        type: string
+        required: true
+      - name: PutV1ProductsOptionsOptionIdBody
+        in: body
+        schema:
+          required:
+          - option
+          properties:
+            option:
+              "$ref": "#/definitions/catalog-data-product-custom-option-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-custom-option-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/options/{optionId}
+  "/V1/products/special-price":
+    post:
+      tags:
+      - products/special-price
+      description: Add or update product's special price. If any items will have invalid
+        price, store id, sku or dates, they will be marked as failed and excluded
+        from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[]
+        with problem description will be returned. If there were no failed items during
+        update empty array will be returned. If error occurred during the update exception
+        will be thrown.
+      operationId: PostV1ProductsSpecialprice
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsSpecialpriceBody
+        in: body
+        schema:
+          required:
+          - prices
+          properties:
+            prices:
+              type: array
+              items:
+                "$ref": "#/definitions/catalog-data-special-price-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-price-update-result-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/special-price
+  "/V1/products/special-price-delete":
+    post:
+      tags:
+      - products/special-price-delete
+      description: Delete product's special price. If any items will have invalid
+        price, store id, sku or dates, they will be marked as failed and excluded
+        from delete list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[]
+        with problem description will be returned. If there were no failed items during
+        update empty array will be returned. If error occurred during the delete exception
+        will be thrown.
+      operationId: PostV1ProductsSpecialpricedelete
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsSpecialpricedeleteBody
+        in: body
+        schema:
+          required:
+          - prices
+          properties:
+            prices:
+              type: array
+              items:
+                "$ref": "#/definitions/catalog-data-special-price-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-price-update-result-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/special-price-delete
+  "/V1/products/special-price-information":
+    post:
+      tags:
+      - products/special-price-information
+      description: Return product's special price. In case of at least one of skus
+        is not found exception will be thrown.
+      operationId: PostV1ProductsSpecialpriceinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsSpecialpriceinformationBody
+        in: body
+        schema:
+          required:
+          - skus
+          properties:
+            skus:
+              type: array
+              items:
+                type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-special-price-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/special-price-information
+  "/V1/products/tier-prices":
+    post:
+      tags:
+      - products/tier-prices
+      description: Add or update product prices. If any items will have invalid price,
+        price type, website id, sku, customer group or quantity, they will be marked
+        as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[]
+        with problem description will be returned. If there were no failed items during
+        update empty array will be returned. If error occurred during the update exception
+        will be thrown.
+      operationId: PostV1ProductsTierprices
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsTierpricesBody
+        in: body
+        schema:
+          required:
+          - prices
+          properties:
+            prices:
+              type: array
+              items:
+                "$ref": "#/definitions/catalog-data-tier-price-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-price-update-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/tier-prices
+    put:
+      tags:
+      - products/tier-prices
+      description: Remove existing tier prices and replace them with the new ones.
+        If any items will have invalid price, price type, website id, sku, customer
+        group or quantity, they will be marked as failed and excluded from replace
+        list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem
+        description will be returned. If there were no failed items during update
+        empty array will be returned. If error occurred during the update exception
+        will be thrown.
+      operationId: PutV1ProductsTierprices
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1ProductsTierpricesBody
+        in: body
+        schema:
+          required:
+          - prices
+          properties:
+            prices:
+              type: array
+              items:
+                "$ref": "#/definitions/catalog-data-tier-price-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-price-update-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/tier-prices
+  "/V1/products/tier-prices-delete":
+    post:
+      tags:
+      - products/tier-prices-delete
+      description: Delete product tier prices. If any items will have invalid price,
+        price type, website id, sku, customer group or quantity, they will be marked
+        as failed and excluded from delete list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[]
+        with problem description will be returned. If there were no failed items during
+        update empty array will be returned. If error occurred during the update exception
+        will be thrown.
+      operationId: PostV1ProductsTierpricesdelete
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsTierpricesdeleteBody
+        in: body
+        schema:
+          required:
+          - prices
+          properties:
+            prices:
+              type: array
+              items:
+                "$ref": "#/definitions/catalog-data-tier-price-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-price-update-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/tier-prices-delete
+  "/V1/products/tier-prices-information":
+    post:
+      tags:
+      - products/tier-prices-information
+      description: Return product prices. In case of at least one of skus is not found
+        exception will be thrown.
+      operationId: PostV1ProductsTierpricesinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ProductsTierpricesinformationBody
+        in: body
+        schema:
+          required:
+          - skus
+          properties:
+            skus:
+              type: array
+              items:
+                type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-tier-price-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/tier-prices-information
+  "/V1/products/types":
+    get:
+      tags:
+      - products/types
+      description: Retrieve available product types
+      operationId: GetV1ProductsTypes
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-product-type-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/types
+  "/V1/products/{productSku}/stockItems/{itemId}":
+    put:
+      tags:
+      - products/{productSku}/stockItems/{itemId}
+      description: ''
+      operationId: PutV1ProductsProductSkuStockItemsItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: productSku
+        in: path
+        type: string
+        required: true
+      - name: itemId
+        in: path
+        type: string
+        required: true
+      - name: PutV1ProductsProductSkuStockItemsItemIdBody
+        in: body
+        schema:
+          required:
+          - stockItem
+          properties:
+            stockItem:
+              "$ref": "#/definitions/catalog-inventory-data-stock-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{productSku}/stockItems/{itemId}
+  "/V1/products/{sku}":
+    put:
+      tags:
+      - products/{sku}
+      description: Create product
+      operationId: PutV1ProductsSku
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: PutV1ProductsSkuBody
+        in: body
+        schema:
+          required:
+          - product
+          properties:
+            product:
+              "$ref": "#/definitions/catalog-data-product-interface"
+            saveOptions:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}
+    delete:
+      tags:
+      - products/{sku}
+      description: ''
+      operationId: DeleteV1ProductsSku
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: Will returned True if deleted
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}
+    get:
+      tags:
+      - products/{sku}
+      description: Get info about product by product SKU
+      operationId: GetV1ProductsSku
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: editMode
+        in: query
+        type: boolean
+        required: false
+      - name: storeId
+        in: query
+        type: integer
+        required: false
+      - name: forceReload
+        in: query
+        type: boolean
+        required: false
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}
+  "/V1/products/{sku}/downloadable-links":
+    get:
+      tags:
+      - products/{sku}/downloadable-links
+      description: List of links with associated samples
+      operationId: GetV1ProductsSkuDownloadablelinks
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/downloadable-data-link-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/downloadable-links
+    post:
+      tags:
+      - products/{sku}/downloadable-links
+      description: Update downloadable link of the given product (link type and its
+        resources cannot be changed)
+      operationId: PostV1ProductsSkuDownloadablelinks
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: PostV1ProductsSkuDownloadablelinksBody
+        in: body
+        schema:
+          required:
+          - link
+          properties:
+            link:
+              "$ref": "#/definitions/downloadable-data-link-interface"
+            isGlobalScopeContent:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/downloadable-links
+  "/V1/products/{sku}/downloadable-links/samples":
+    get:
+      tags:
+      - products/{sku}/downloadable-links/samples
+      description: List of samples for downloadable product
+      operationId: GetV1ProductsSkuDownloadablelinksSamples
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/downloadable-data-sample-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/downloadable-links/samples
+    post:
+      tags:
+      - products/{sku}/downloadable-links/samples
+      description: Update downloadable sample of the given product
+      operationId: PostV1ProductsSkuDownloadablelinksSamples
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: PostV1ProductsSkuDownloadablelinksSamplesBody
+        in: body
+        schema:
+          required:
+          - sample
+          properties:
+            sample:
+              "$ref": "#/definitions/downloadable-data-sample-interface"
+            isGlobalScopeContent:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/downloadable-links/samples
+  "/V1/products/{sku}/downloadable-links/samples/{id}":
+    put:
+      tags:
+      - products/{sku}/downloadable-links/samples/{id}
+      description: Update downloadable sample of the given product
+      operationId: PutV1ProductsSkuDownloadablelinksSamplesId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PutV1ProductsSkuDownloadablelinksSamplesIdBody
+        in: body
+        schema:
+          required:
+          - sample
+          properties:
+            sample:
+              "$ref": "#/definitions/downloadable-data-sample-interface"
+            isGlobalScopeContent:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/downloadable-links/samples/{id}
+  "/V1/products/{sku}/downloadable-links/{id}":
+    put:
+      tags:
+      - products/{sku}/downloadable-links/{id}
+      description: Update downloadable link of the given product (link type and its
+        resources cannot be changed)
+      operationId: PutV1ProductsSkuDownloadablelinksId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PutV1ProductsSkuDownloadablelinksIdBody
+        in: body
+        schema:
+          required:
+          - link
+          properties:
+            link:
+              "$ref": "#/definitions/downloadable-data-link-interface"
+            isGlobalScopeContent:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/downloadable-links/{id}
+  "/V1/products/{sku}/group-prices/{customerGroupId}/tiers":
+    get:
+      tags:
+      - products/{sku}/group-prices/{customerGroupId}/tiers
+      description: Get tier price of product
+      operationId: GetV1ProductsSkuGrouppricesCustomerGroupIdTiers
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: customerGroupId
+        in: path
+        type: string
+        required: true
+        description: "'all' can be used to specify 'ALL GROUPS'"
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-product-tier-price-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/group-prices/{customerGroupId}/tiers
+  "/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}":
+    delete:
+      tags:
+      - products/{sku}/group-prices/{customerGroupId}/tiers/{qty}
+      description: Remove tier price from product
+      operationId: DeleteV1ProductsSkuGrouppricesCustomerGroupIdTiersQty
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: customerGroupId
+        in: path
+        type: string
+        required: true
+        description: "'all' can be used to specify 'ALL GROUPS'"
+      - name: qty
+        in: path
+        type: number
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/group-prices/{customerGroupId}/tiers/{qty}
+  "/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}":
+    post:
+      tags:
+      - products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}
+      description: Create tier price for product
+      operationId: PostV1ProductsSkuGrouppricesCustomerGroupIdTiersQtyPricePrice
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: customerGroupId
+        in: path
+        type: string
+        required: true
+        description: "'all' can be used to specify 'ALL GROUPS'"
+      - name: price
+        in: path
+        type: number
+        required: true
+      - name: qty
+        in: path
+        type: number
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}
+  "/V1/products/{sku}/links":
+    post:
+      tags:
+      - products/{sku}/links
+      description: Assign a product link to another product
+      operationId: PostV1ProductsSkuLinks
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: PostV1ProductsSkuLinksBody
+        in: body
+        schema:
+          required:
+          - items
+          properties:
+            items:
+              type: array
+              items:
+                "$ref": "#/definitions/catalog-data-product-link-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/links
+    put:
+      tags:
+      - products/{sku}/links
+      description: Save product link
+      operationId: PutV1ProductsSkuLinks
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: PutV1ProductsSkuLinksBody
+        in: body
+        schema:
+          required:
+          - entity
+          properties:
+            entity:
+              "$ref": "#/definitions/catalog-data-product-link-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/links
+  "/V1/products/{sku}/links/{type}":
+    get:
+      tags:
+      - products/{sku}/links/{type}
+      description: Provide the list of links for a specific product
+      operationId: GetV1ProductsSkuLinksType
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: type
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-product-link-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/links/{type}
+  "/V1/products/{sku}/links/{type}/{linkedProductSku}":
+    delete:
+      tags:
+      - products/{sku}/links/{type}/{linkedProductSku}
+      description: ''
+      operationId: DeleteV1ProductsSkuLinksTypeLinkedProductSku
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: type
+        in: path
+        type: string
+        required: true
+      - name: linkedProductSku
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/links/{type}/{linkedProductSku}
+  "/V1/products/{sku}/media":
+    post:
+      tags:
+      - products/{sku}/media
+      description: Create new gallery entry
+      operationId: PostV1ProductsSkuMedia
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: PostV1ProductsSkuMediaBody
+        in: body
+        schema:
+          required:
+          - entry
+          properties:
+            entry:
+              "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: gallery entry ID
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/media
+    get:
+      tags:
+      - products/{sku}/media
+      description: Retrieve the list of gallery entries associated with given product
+      operationId: GetV1ProductsSkuMedia
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/media
+  "/V1/products/{sku}/media/{entryId}":
+    get:
+      tags:
+      - products/{sku}/media/{entryId}
+      description: Return information about gallery entry
+      operationId: GetV1ProductsSkuMediaEntryId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: entryId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/media/{entryId}
+    put:
+      tags:
+      - products/{sku}/media/{entryId}
+      description: Update gallery entry
+      operationId: PutV1ProductsSkuMediaEntryId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: entryId
+        in: path
+        type: string
+        required: true
+      - name: PutV1ProductsSkuMediaEntryIdBody
+        in: body
+        schema:
+          required:
+          - entry
+          properties:
+            entry:
+              "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/media/{entryId}
+    delete:
+      tags:
+      - products/{sku}/media/{entryId}
+      description: Remove gallery entry
+      operationId: DeleteV1ProductsSkuMediaEntryId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: entryId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/media/{entryId}
+  "/V1/products/{sku}/options":
+    get:
+      tags:
+      - products/{sku}/options
+      description: Get the list of custom options for a specific product
+      operationId: GetV1ProductsSkuOptions
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/catalog-data-product-custom-option-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/options
+  "/V1/products/{sku}/options/{optionId}":
+    get:
+      tags:
+      - products/{sku}/options/{optionId}
+      description: Get custom option for a specific product
+      operationId: GetV1ProductsSkuOptionsOptionId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: optionId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-custom-option-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/options/{optionId}
+    delete:
+      tags:
+      - products/{sku}/options/{optionId}
+      description: ''
+      operationId: DeleteV1ProductsSkuOptionsOptionId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: optionId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/options/{optionId}
+  "/V1/products/{sku}/websites":
+    post:
+      tags:
+      - products/{sku}/websites
+      description: Assign a product to the website
+      operationId: PostV1ProductsSkuWebsites
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: PostV1ProductsSkuWebsitesBody
+        in: body
+        schema:
+          required:
+          - productWebsiteLink
+          properties:
+            productWebsiteLink:
+              "$ref": "#/definitions/catalog-data-product-website-link-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: will returned True if website successfully assigned to product
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/websites
+    put:
+      tags:
+      - products/{sku}/websites
+      description: Assign a product to the website
+      operationId: PutV1ProductsSkuWebsites
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: PutV1ProductsSkuWebsitesBody
+        in: body
+        schema:
+          required:
+          - productWebsiteLink
+          properties:
+            productWebsiteLink:
+              "$ref": "#/definitions/catalog-data-product-website-link-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: will returned True if website successfully assigned to product
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/websites
+  "/V1/products/{sku}/websites/{websiteId}":
+    delete:
+      tags:
+      - products/{sku}/websites/{websiteId}
+      description: Remove the website assignment from the product by product sku
+      operationId: DeleteV1ProductsSkuWebsitesWebsiteId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sku
+        in: path
+        type: string
+        required: true
+      - name: websiteId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: will returned True if website successfully unassigned from
+              product
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products/{sku}/websites/{websiteId}
+  "/V1/purchase-order-carts/{cartId}/billing-address":
+    post:
+      tags:
+      - purchase-order-carts/{cartId}/billing-address
+      description: Assigns a specified billing address to a specified cart.
+      operationId: PostV1PurchaseordercartsCartIdBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      - name: PostV1PurchaseordercartsCartIdBillingaddressBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+            useForShipping:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Address ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: purchase-order-carts/{cartId}/billing-address
+  "/V1/purchase-order-carts/{cartId}/estimate-shipping-methods":
+    post:
+      tags:
+      - purchase-order-carts/{cartId}/estimate-shipping-methods
+      description: Estimate shipping by address and return list of available shipping
+        methods
+      operationId: PostV1PurchaseordercartsCartIdEstimateshippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1PurchaseordercartsCartIdEstimateshippingmethodsBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: purchase-order-carts/{cartId}/estimate-shipping-methods
+  "/V1/purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id":
+    post:
+      tags:
+      - purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id
+      description: Estimate shipping
+      operationId: PostV1PurchaseordercartsCartIdEstimateshippingmethodsbyaddressid
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The shopping cart ID.
+      - name: PostV1PurchaseordercartsCartIdEstimateshippingmethodsbyaddressidBody
+        in: body
+        schema:
+          required:
+          - addressId
+          properties:
+            addressId:
+              type: integer
+              description: The estimate address id
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id
+  "/V1/purchase-order-carts/{cartId}/giftCards":
+    post:
+      tags:
+      - purchase-order-carts/{cartId}/giftCards
+      description: Add gift card to the cart.
+      operationId: PostV1PurchaseordercartsCartIdGiftCards
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1PurchaseordercartsCartIdGiftCardsBody
+        in: body
+        schema:
+          required:
+          - giftCardAccountData
+          properties:
+            giftCardAccountData:
+              "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: purchase-order-carts/{cartId}/giftCards
+  "/V1/purchase-order-carts/{cartId}/giftCards/{giftCardCode}":
+    delete:
+      tags:
+      - purchase-order-carts/{cartId}/giftCards/{giftCardCode}
+      description: Remove GiftCard Account entity
+      operationId: DeleteV1PurchaseordercartsCartIdGiftCardsGiftCardCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: giftCardCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: purchase-order-carts/{cartId}/giftCards/{giftCardCode}
+  "/V1/purchase-order-carts/{cartId}/payment-information":
+    post:
+      tags:
+      - purchase-order-carts/{cartId}/payment-information
+      description: Set payment information and place order for a specified cart.
+      operationId: PostV1PurchaseordercartsCartIdPaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1PurchaseordercartsCartIdPaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: purchase-order-carts/{cartId}/payment-information
+    get:
+      tags:
+      - purchase-order-carts/{cartId}/payment-information
+      description: Get payment information
+      operationId: GetV1PurchaseordercartsCartIdPaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: purchase-order-carts/{cartId}/payment-information
+  "/V1/purchase-order-carts/{cartId}/set-payment-information":
+    post:
+      tags:
+      - purchase-order-carts/{cartId}/set-payment-information
+      description: Set payment information for a specified cart.
+      operationId: PostV1PurchaseordercartsCartIdSetpaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1PurchaseordercartsCartIdSetpaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: purchase-order-carts/{cartId}/set-payment-information
+  "/V1/purchase-order-carts/{cartId}/totals":
+    get:
+      tags:
+      - purchase-order-carts/{cartId}/totals
+      description: Returns quote totals data for a specified cart.
+      operationId: GetV1PurchaseordercartsCartIdTotals
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: purchase-order-carts/{cartId}/totals
+  "/V1/requisition_lists":
+    post:
+      tags:
+      - requisition_lists
+      description: Save Requisition List
+      operationId: PostV1Requisition_lists
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1Requisition_listsBody
+        in: body
+        schema:
+          required:
+          - requisitionList
+          properties:
+            requisitionList:
+              "$ref": "#/definitions/requisition-list-data-requisition-list-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/requisition-list-data-requisition-list-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: requisition_lists
+  "/V1/returns":
+    post:
+      tags:
+      - returns
+      description: Save RMA
+      operationId: PostV1Returns
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ReturnsBody
+        in: body
+        schema:
+          required:
+          - rmaDataObject
+          properties:
+            rmaDataObject:
+              "$ref": "#/definitions/rma-data-rma-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/rma-data-rma-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returns
+    get:
+      tags:
+      - returns
+      description: Return list of rma data objects based on search criteria
+      operationId: GetV1Returns
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/rma-data-rma-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returns
+  "/V1/returns/{id}":
+    get:
+      tags:
+      - returns/{id}
+      description: Return data object for specified RMA id
+      operationId: GetV1ReturnsId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/rma-data-rma-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returns/{id}
+    delete:
+      tags:
+      - returns/{id}
+      description: Delete RMA
+      operationId: DeleteV1ReturnsId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: DeleteV1ReturnsIdBody
+        in: body
+        schema:
+          required:
+          - rmaDataObject
+          properties:
+            rmaDataObject:
+              "$ref": "#/definitions/rma-data-rma-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returns/{id}
+    put:
+      tags:
+      - returns/{id}
+      description: Save RMA
+      operationId: PutV1ReturnsId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PutV1ReturnsIdBody
+        in: body
+        schema:
+          required:
+          - rmaDataObject
+          properties:
+            rmaDataObject:
+              "$ref": "#/definitions/rma-data-rma-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/rma-data-rma-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returns/{id}
+  "/V1/returns/{id}/comments":
+    post:
+      tags:
+      - returns/{id}/comments
+      description: Add comment
+      operationId: PostV1ReturnsIdComments
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PostV1ReturnsIdCommentsBody
+        in: body
+        schema:
+          required:
+          - data
+          properties:
+            data:
+              "$ref": "#/definitions/rma-data-comment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returns/{id}/comments
+    get:
+      tags:
+      - returns/{id}/comments
+      description: Comments list
+      operationId: GetV1ReturnsIdComments
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/rma-data-comment-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returns/{id}/comments
+  "/V1/returns/{id}/labels":
+    get:
+      tags:
+      - returns/{id}/labels
+      description: Get shipping label int the PDF format
+      operationId: GetV1ReturnsIdLabels
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returns/{id}/labels
+  "/V1/returns/{id}/tracking-numbers":
+    post:
+      tags:
+      - returns/{id}/tracking-numbers
+      description: Add track
+      operationId: PostV1ReturnsIdTrackingnumbers
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      - name: PostV1ReturnsIdTrackingnumbersBody
+        in: body
+        schema:
+          required:
+          - track
+          properties:
+            track:
+              "$ref": "#/definitions/rma-data-track-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returns/{id}/tracking-numbers
+    get:
+      tags:
+      - returns/{id}/tracking-numbers
+      description: Get track list
+      operationId: GetV1ReturnsIdTrackingnumbers
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/rma-data-track-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returns/{id}/tracking-numbers
+  "/V1/returns/{id}/tracking-numbers/{trackId}":
+    delete:
+      tags:
+      - returns/{id}/tracking-numbers/{trackId}
+      description: Remove track by id
+      operationId: DeleteV1ReturnsIdTrackingnumbersTrackId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      - name: trackId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returns/{id}/tracking-numbers/{trackId}
+  "/V1/returnsAttributeMetadata":
+    get:
+      tags:
+      - returnsAttributeMetadata
+      description: Get all attribute metadata.
+      operationId: GetV1ReturnsAttributeMetadata
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/customer-data-attribute-metadata-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returnsAttributeMetadata
+  "/V1/returnsAttributeMetadata/custom":
+    get:
+      tags:
+      - returnsAttributeMetadata/custom
+      description: Get custom attribute metadata for the given Data object's attribute
+        set
+      operationId: GetV1ReturnsAttributeMetadataCustom
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: dataObjectClassName
+        in: query
+        type: string
+        description: Data object class name
+        required: false
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/framework-metadata-object-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returnsAttributeMetadata/custom
+  "/V1/returnsAttributeMetadata/form/{formCode}":
+    get:
+      tags:
+      - returnsAttributeMetadata/form/{formCode}
+      description: Retrieve all attributes filtered by form code
+      operationId: GetV1ReturnsAttributeMetadataFormFormCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: formCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/customer-data-attribute-metadata-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returnsAttributeMetadata/form/{formCode}
+  "/V1/returnsAttributeMetadata/{attributeCode}":
+    get:
+      tags:
+      - returnsAttributeMetadata/{attributeCode}
+      description: Retrieve attribute metadata.
+      operationId: GetV1ReturnsAttributeMetadataAttributeCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: attributeCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-attribute-metadata-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: returnsAttributeMetadata/{attributeCode}
+  "/V1/reward/mine/use-reward":
+    post:
+      tags:
+      - reward/mine/use-reward
+      description: Set reward points to quote
+      operationId: PostV1RewardMineUsereward
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: reward/mine/use-reward
+  "/V1/salesRules":
+    post:
+      tags:
+      - salesRules
+      description: Save sales rule.
+      operationId: PostV1SalesRules
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1SalesRulesBody
+        in: body
+        schema:
+          required:
+          - rule
+          properties:
+            rule:
+              "$ref": "#/definitions/sales-rule-data-rule-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-rule-data-rule-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: salesRules
+  "/V1/salesRules/search":
+    get:
+      tags:
+      - salesRules/search
+      description: Retrieve sales rules that match te specified criteria. This call
+        returns an array of objects, but detailed information about each object’s
+        attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#RuleRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1SalesRulesSearch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-rule-data-rule-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: salesRules/search
+  "/V1/salesRules/{ruleId}":
+    get:
+      tags:
+      - salesRules/{ruleId}
+      description: Get rule by ID.
+      operationId: GetV1SalesRulesRuleId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: ruleId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-rule-data-rule-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: salesRules/{ruleId}
+    put:
+      tags:
+      - salesRules/{ruleId}
+      description: Save sales rule.
+      operationId: PutV1SalesRulesRuleId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: ruleId
+        in: path
+        type: string
+        required: true
+      - name: PutV1SalesRulesRuleIdBody
+        in: body
+        schema:
+          required:
+          - rule
+          properties:
+            rule:
+              "$ref": "#/definitions/sales-rule-data-rule-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-rule-data-rule-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: salesRules/{ruleId}
+    delete:
+      tags:
+      - salesRules/{ruleId}
+      description: Delete rule by ID.
+      operationId: DeleteV1SalesRulesRuleId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: ruleId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: salesRules/{ruleId}
+  "/V1/search":
+    get:
+      tags:
+      - search
+      description: Make Full Text Search and return found Documents
+      operationId: GetV1Search
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[requestName]
+        in: query
+        type: string
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/framework-search-search-result-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: search
+  "/V1/sharedCatalog":
+    post:
+      tags:
+      - sharedCatalog
+      description: Create or update Shared Catalog service.
+      operationId: PostV1SharedCatalog
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1SharedCatalogBody
+        in: body
+        schema:
+          required:
+          - sharedCatalog
+          properties:
+            sharedCatalog:
+              "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog
+  "/V1/sharedCatalog/":
+    get:
+      tags:
+      - sharedCatalog/
+      description: Return the list of shared catalogs and basic properties for each
+        catalog.
+      operationId: GetV1SharedCatalog
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/shared-catalog-data-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/
+  "/V1/sharedCatalog/{id}":
+    put:
+      tags:
+      - sharedCatalog/{id}
+      description: Create or update Shared Catalog service.
+      operationId: PutV1SharedCatalogId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PutV1SharedCatalogIdBody
+        in: body
+        schema:
+          required:
+          - sharedCatalog
+          properties:
+            sharedCatalog:
+              "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/{id}
+  "/V1/sharedCatalog/{id}/assignCategories":
+    post:
+      tags:
+      - sharedCatalog/{id}/assignCategories
+      description: Add categories into the shared catalog.
+      operationId: PostV1SharedCatalogIdAssignCategories
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      - name: PostV1SharedCatalogIdAssignCategoriesBody
+        in: body
+        schema:
+          required:
+          - categories
+          properties:
+            categories:
+              type: array
+              items:
+                "$ref": "#/definitions/catalog-data-category-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/{id}/assignCategories
+  "/V1/sharedCatalog/{id}/assignProducts":
+    post:
+      tags:
+      - sharedCatalog/{id}/assignProducts
+      description: Add products into the shared catalog.
+      operationId: PostV1SharedCatalogIdAssignProducts
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      - name: PostV1SharedCatalogIdAssignProductsBody
+        in: body
+        schema:
+          required:
+          - products
+          properties:
+            products:
+              type: array
+              items:
+                "$ref": "#/definitions/catalog-data-product-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/{id}/assignProducts
+  "/V1/sharedCatalog/{id}/categories":
+    get:
+      tags:
+      - sharedCatalog/{id}/categories
+      description: Return the list of categories in the selected shared catalog.
+      operationId: GetV1SharedCatalogIdCategories
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              type: integer
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/{id}/categories
+  "/V1/sharedCatalog/{id}/products":
+    get:
+      tags:
+      - sharedCatalog/{id}/products
+      description: Return the list of product SKUs in the selected shared catalog.
+      operationId: GetV1SharedCatalogIdProducts
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              type: string
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/{id}/products
+  "/V1/sharedCatalog/{id}/unassignCategories":
+    post:
+      tags:
+      - sharedCatalog/{id}/unassignCategories
+      description: Remove the specified categories from the shared catalog.
+      operationId: PostV1SharedCatalogIdUnassignCategories
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      - name: PostV1SharedCatalogIdUnassignCategoriesBody
+        in: body
+        schema:
+          required:
+          - categories
+          properties:
+            categories:
+              type: array
+              items:
+                "$ref": "#/definitions/catalog-data-category-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/{id}/unassignCategories
+  "/V1/sharedCatalog/{id}/unassignProducts":
+    post:
+      tags:
+      - sharedCatalog/{id}/unassignProducts
+      description: Remove the specified products from the shared catalog.
+      operationId: PostV1SharedCatalogIdUnassignProducts
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+      - name: PostV1SharedCatalogIdUnassignProductsBody
+        in: body
+        schema:
+          required:
+          - products
+          properties:
+            products:
+              type: array
+              items:
+                "$ref": "#/definitions/catalog-data-product-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/{id}/unassignProducts
+  "/V1/sharedCatalog/{sharedCatalogId}":
+    get:
+      tags:
+      - sharedCatalog/{sharedCatalogId}
+      description: 'Return the following properties for the selected shared catalog:
+        ID, Store Group ID, Name, Type, Description, Customer Group, Tax Class.'
+      operationId: GetV1SharedCatalogSharedCatalogId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sharedCatalogId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/{sharedCatalogId}
+    delete:
+      tags:
+      - sharedCatalog/{sharedCatalogId}
+      description: Delete a shared catalog by ID.
+      operationId: DeleteV1SharedCatalogSharedCatalogId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sharedCatalogId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/{sharedCatalogId}
+  "/V1/sharedCatalog/{sharedCatalogId}/assignCompanies":
+    post:
+      tags:
+      - sharedCatalog/{sharedCatalogId}/assignCompanies
+      description: Assign companies to a shared catalog.
+      operationId: PostV1SharedCatalogSharedCatalogIdAssignCompanies
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sharedCatalogId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1SharedCatalogSharedCatalogIdAssignCompaniesBody
+        in: body
+        schema:
+          required:
+          - companies
+          properties:
+            companies:
+              type: array
+              items:
+                "$ref": "#/definitions/company-data-company-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/{sharedCatalogId}/assignCompanies
+  "/V1/sharedCatalog/{sharedCatalogId}/assignTierPrices":
+    post:
+      tags:
+      - sharedCatalog/{sharedCatalogId}/assignTierPrices
+      description: Assign custom prices
+      operationId: PostV1SharedCatalogSharedCatalogIdAssignTierPrices
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sharedCatalogId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1SharedCatalogSharedCatalogIdAssignTierPricesBody
+        in: body
+        schema:
+          required:
+          - prices
+          properties:
+            prices:
+              type: array
+              items:
+                "$ref": "#/definitions/catalog-data-tier-price-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/{sharedCatalogId}/assignTierPrices
+  "/V1/sharedCatalog/{sharedCatalogId}/companies":
+    get:
+      tags:
+      - sharedCatalog/{sharedCatalogId}/companies
+      description: Return the list of company IDs for the companies assigned to the
+        selected catalog.
+      operationId: GetV1SharedCatalogSharedCatalogIdCompanies
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sharedCatalogId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/{sharedCatalogId}/companies
+  "/V1/sharedCatalog/{sharedCatalogId}/resetTierPrices":
+    post:
+      tags:
+      - sharedCatalog/{sharedCatalogId}/resetTierPrices
+      description: Reset custom prices
+      operationId: PostV1SharedCatalogSharedCatalogIdResetTierPrices
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sharedCatalogId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1SharedCatalogSharedCatalogIdResetTierPricesBody
+        in: body
+        schema:
+          required:
+          - skus
+          properties:
+            skus:
+              type: array
+              items:
+                type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/{sharedCatalogId}/resetTierPrices
+  "/V1/sharedCatalog/{sharedCatalogId}/unassignCompanies":
+    post:
+      tags:
+      - sharedCatalog/{sharedCatalogId}/unassignCompanies
+      description: Unassign companies from a shared catalog.
+      operationId: PostV1SharedCatalogSharedCatalogIdUnassignCompanies
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: sharedCatalogId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1SharedCatalogSharedCatalogIdUnassignCompaniesBody
+        in: body
+        schema:
+          required:
+          - companies
+          properties:
+            companies:
+              type: array
+              items:
+                "$ref": "#/definitions/company-data-company-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: sharedCatalog/{sharedCatalogId}/unassignCompanies
+  "/V1/shipment/":
+    post:
+      tags:
+      - shipment/
+      description: Performs persist operations for a specified shipment.
+      operationId: PostV1Shipment
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ShipmentBody
+        in: body
+        schema:
+          required:
+          - entity
+          properties:
+            entity:
+              "$ref": "#/definitions/sales-data-shipment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-shipment-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: shipment/
+  "/V1/shipment/track":
+    post:
+      tags:
+      - shipment/track
+      description: Performs persist operations for a specified shipment track.
+      operationId: PostV1ShipmentTrack
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1ShipmentTrackBody
+        in: body
+        schema:
+          required:
+          - entity
+          properties:
+            entity:
+              "$ref": "#/definitions/sales-data-shipment-track-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-shipment-track-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: shipment/track
+  "/V1/shipment/track/{id}":
+    delete:
+      tags:
+      - shipment/track/{id}
+      description: Deletes a specified shipment track by ID.
+      operationId: DeleteV1ShipmentTrackId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The shipment track ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: shipment/track/{id}
+  "/V1/shipment/{id}":
+    get:
+      tags:
+      - shipment/{id}
+      description: Loads a specified shipment.
+      operationId: GetV1ShipmentId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The shipment ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-shipment-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: shipment/{id}
+  "/V1/shipment/{id}/comments":
+    get:
+      tags:
+      - shipment/{id}/comments
+      description: Lists comments for a specified shipment.
+      operationId: GetV1ShipmentIdComments
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The shipment ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-shipment-comment-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: shipment/{id}/comments
+    post:
+      tags:
+      - shipment/{id}/comments
+      description: Performs persist operations for a specified shipment comment.
+      operationId: PostV1ShipmentIdComments
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      - name: PostV1ShipmentIdCommentsBody
+        in: body
+        schema:
+          required:
+          - entity
+          properties:
+            entity:
+              "$ref": "#/definitions/sales-data-shipment-comment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-shipment-comment-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: shipment/{id}/comments
+  "/V1/shipment/{id}/emails":
+    post:
+      tags:
+      - shipment/{id}/emails
+      description: Emails user a specified shipment.
+      operationId: PostV1ShipmentIdEmails
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The shipment ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: shipment/{id}/emails
+  "/V1/shipment/{id}/label":
+    get:
+      tags:
+      - shipment/{id}/label
+      description: Gets a specified shipment label.
+      operationId: GetV1ShipmentIdLabel
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The shipment label ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: Shipment label.
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: shipment/{id}/label
+  "/V1/shipments":
+    get:
+      tags:
+      - shipments
+      description: Lists shipments that match specified search criteria. This call
+        returns an array of objects, but detailed information about each object’s
+        attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#ShipmentRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1Shipments
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-shipment-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: shipments
+  "/V1/stockItems/lowStock/":
+    get:
+      tags:
+      - stockItems/lowStock/
+      description: Retrieves a list of SKU's with low inventory qty
+      operationId: GetV1StockItemsLowStock
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: scopeId
+        in: query
+        type: integer
+        required: true
+      - name: qty
+        in: query
+        type: number
+        required: true
+      - name: currentPage
+        in: query
+        type: integer
+        required: false
+      - name: pageSize
+        in: query
+        type: integer
+        required: false
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-inventory-data-stock-item-collection-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: stockItems/lowStock/
+  "/V1/stockItems/{productSku}":
+    get:
+      tags:
+      - stockItems/{productSku}
+      description: ''
+      operationId: GetV1StockItemsProductSku
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: productSku
+        in: path
+        type: string
+        required: true
+      - name: scopeId
+        in: query
+        type: integer
+        required: false
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-inventory-data-stock-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: stockItems/{productSku}
+  "/V1/stockStatuses/{productSku}":
+    get:
+      tags:
+      - stockStatuses/{productSku}
+      description: ''
+      operationId: GetV1StockStatusesProductSku
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: productSku
+        in: path
+        type: string
+        required: true
+      - name: scopeId
+        in: query
+        type: integer
+        required: false
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-inventory-data-stock-status-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: stockStatuses/{productSku}
+  "/V1/store/storeConfigs":
+    get:
+      tags:
+      - store/storeConfigs
+      description: ''
+      operationId: GetV1StoreStoreConfigs
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: storeCodes
+        in: query
+        type: array
+        items:
+          type: string
+        required: false
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/store-data-store-config-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: store/storeConfigs
+  "/V1/store/storeGroups":
+    get:
+      tags:
+      - store/storeGroups
+      description: Retrieve list of all groups
+      operationId: GetV1StoreStoreGroups
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/store-data-group-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: store/storeGroups
+  "/V1/store/storeViews":
+    get:
+      tags:
+      - store/storeViews
+      description: Retrieve list of all stores
+      operationId: GetV1StoreStoreViews
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/store-data-store-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: store/storeViews
+  "/V1/store/websites":
+    get:
+      tags:
+      - store/websites
+      description: Retrieve list of all websites
+      operationId: GetV1StoreWebsites
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/store-data-website-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: store/websites
+  "/V1/taxClasses":
+    post:
+      tags:
+      - taxClasses
+      description: Create a Tax Class
+      operationId: PostV1TaxClasses
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TaxClassesBody
+        in: body
+        schema:
+          required:
+          - taxClass
+          properties:
+            taxClass:
+              "$ref": "#/definitions/tax-data-tax-class-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: id for the newly created Tax class
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxClasses
+  "/V1/taxClasses/search":
+    get:
+      tags:
+      - taxClasses/search
+      description: Retrieve tax classes which match a specific criteria. This call
+        returns an array of objects, but detailed information about each object’s
+        attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#TaxClassRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1TaxClassesSearch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/tax-data-tax-class-search-results-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxClasses/search
+  "/V1/taxClasses/{classId}":
+    put:
+      tags:
+      - taxClasses/{classId}
+      description: Create a Tax Class
+      operationId: PutV1TaxClassesClassId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: classId
+        in: path
+        type: string
+        required: true
+      - name: PutV1TaxClassesClassIdBody
+        in: body
+        schema:
+          required:
+          - taxClass
+          properties:
+            taxClass:
+              "$ref": "#/definitions/tax-data-tax-class-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: id for the newly created Tax class
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxClasses/{classId}
+  "/V1/taxClasses/{taxClassId}":
+    get:
+      tags:
+      - taxClasses/{taxClassId}
+      description: Get a tax class with the given tax class id.
+      operationId: GetV1TaxClassesTaxClassId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: taxClassId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/tax-data-tax-class-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxClasses/{taxClassId}
+    delete:
+      tags:
+      - taxClasses/{taxClassId}
+      description: Delete a tax class with the given tax class id.
+      operationId: DeleteV1TaxClassesTaxClassId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: taxClassId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: True if the tax class was deleted, false otherwise
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxClasses/{taxClassId}
+  "/V1/taxRates":
+    post:
+      tags:
+      - taxRates
+      description: Create or update tax rate
+      operationId: PostV1TaxRates
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TaxRatesBody
+        in: body
+        schema:
+          required:
+          - taxRate
+          properties:
+            taxRate:
+              "$ref": "#/definitions/tax-data-tax-rate-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/tax-data-tax-rate-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxRates
+    put:
+      tags:
+      - taxRates
+      description: Create or update tax rate
+      operationId: PutV1TaxRates
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1TaxRatesBody
+        in: body
+        schema:
+          required:
+          - taxRate
+          properties:
+            taxRate:
+              "$ref": "#/definitions/tax-data-tax-rate-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/tax-data-tax-rate-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxRates
+  "/V1/taxRates/search":
+    get:
+      tags:
+      - taxRates/search
+      description: Search TaxRates This call returns an array of objects, but detailed
+        information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#TaxRateRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1TaxRatesSearch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/tax-data-tax-rate-search-results-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxRates/search
+  "/V1/taxRates/{rateId}":
+    get:
+      tags:
+      - taxRates/{rateId}
+      description: Get tax rate
+      operationId: GetV1TaxRatesRateId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: rateId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/tax-data-tax-rate-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxRates/{rateId}
+    delete:
+      tags:
+      - taxRates/{rateId}
+      description: Delete tax rate
+      operationId: DeleteV1TaxRatesRateId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: rateId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxRates/{rateId}
+  "/V1/taxRules":
+    post:
+      tags:
+      - taxRules
+      description: Save TaxRule
+      operationId: PostV1TaxRules
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TaxRulesBody
+        in: body
+        schema:
+          required:
+          - rule
+          properties:
+            rule:
+              "$ref": "#/definitions/tax-data-tax-rule-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/tax-data-tax-rule-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxRules
+    put:
+      tags:
+      - taxRules
+      description: Save TaxRule
+      operationId: PutV1TaxRules
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1TaxRulesBody
+        in: body
+        schema:
+          required:
+          - rule
+          properties:
+            rule:
+              "$ref": "#/definitions/tax-data-tax-rule-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/tax-data-tax-rule-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxRules
+  "/V1/taxRules/search":
+    get:
+      tags:
+      - taxRules/search
+      description: Search TaxRules This call returns an array of objects, but detailed
+        information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#TaxRuleRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1TaxRulesSearch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/tax-data-tax-rule-search-results-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxRules/search
+  "/V1/taxRules/{ruleId}":
+    delete:
+      tags:
+      - taxRules/{ruleId}
+      description: Delete TaxRule
+      operationId: DeleteV1TaxRulesRuleId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: ruleId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxRules/{ruleId}
+    get:
+      tags:
+      - taxRules/{ruleId}
+      description: Get TaxRule
+      operationId: GetV1TaxRulesRuleId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: ruleId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/tax-data-tax-rule-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: taxRules/{ruleId}
+  "/V1/team/":
+    get:
+      tags:
+      - team/
+      description: Returns the list of teams for the specified search criteria (team
+        name or description).
+      operationId: GetV1Team
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-data-team-search-results-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: team/
+  "/V1/team/{companyId}":
+    post:
+      tags:
+      - team/{companyId}
+      description: Create a team in the company structure.
+      operationId: PostV1TeamCompanyId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: companyId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1TeamCompanyIdBody
+        in: body
+        schema:
+          required:
+          - team
+          properties:
+            team:
+              "$ref": "#/definitions/company-data-team-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: team/{companyId}
+  "/V1/team/{teamId}":
+    get:
+      tags:
+      - team/{teamId}
+      description: Returns data for a team in the company, by entity id.
+      operationId: GetV1TeamTeamId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: teamId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/company-data-team-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: team/{teamId}
+    delete:
+      tags:
+      - team/{teamId}
+      description: Delete a team from the company structure.
+      operationId: DeleteV1TeamTeamId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: teamId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: team/{teamId}
+    put:
+      tags:
+      - team/{teamId}
+      description: Update a team in the company structure.
+      operationId: PutV1TeamTeamId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: teamId
+        in: path
+        type: string
+        required: true
+      - name: PutV1TeamTeamIdBody
+        in: body
+        schema:
+          required:
+          - team
+          properties:
+            team:
+              "$ref": "#/definitions/company-data-team-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: team/{teamId}
+  "/V1/tfa/default-provider-code/{userId}":
+    put:
+      tags:
+      - tfa/default-provider-code/{userId}
+      description: Set default provider code
+      operationId: PutV1TfaDefaultprovidercodeUserId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: userId
+        in: path
+        type: integer
+        required: true
+      - name: PutV1TfaDefaultprovidercodeUserIdBody
+        in: body
+        schema:
+          required:
+          - providerCode
+          properties:
+            providerCode:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/default-provider-code/{userId}
+    get:
+      tags:
+      - tfa/default-provider-code/{userId}
+      description: Get default provider
+      operationId: GetV1TfaDefaultprovidercodeUserId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: userId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/default-provider-code/{userId}
+  "/V1/tfa/forced-providers":
+    get:
+      tags:
+      - tfa/forced-providers
+      description: Retrieve forced providers list
+      operationId: GetV1TfaForcedproviders
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/two-factor-auth-provider-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/forced-providers
+  "/V1/tfa/installed-providers":
+    get:
+      tags:
+      - tfa/installed-providers
+      description: Get a list of providers
+      operationId: GetV1TfaInstalledproviders
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/two-factor-auth-provider-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/installed-providers
+  "/V1/tfa/provider/authy/activate":
+    post:
+      tags:
+      - tfa/provider/authy/activate
+      description: Activate the provider and get an admin token
+      operationId: PostV1TfaProviderAuthyActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderAuthyActivateBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          - otp
+          properties:
+            tfaToken:
+              type: string
+            otp:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/activate
+  "/V1/tfa/provider/authy/authenticate":
+    post:
+      tags:
+      - tfa/provider/authy/authenticate
+      description: Get an admin token using authy 2fa
+      operationId: PostV1TfaProviderAuthyAuthenticate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderAuthyAuthenticateBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          - otp
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+            otp:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: "$otp"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/authenticate
+  "/V1/tfa/provider/authy/authenticate-onetouch":
+    post:
+      tags:
+      - tfa/provider/authy/authenticate-onetouch
+      description: Authenticate using the present one touch response and get an admin
+        token
+      operationId: PostV1TfaProviderAuthyAuthenticateonetouch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderAuthyAuthenticateonetouchBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/authenticate-onetouch
+  "/V1/tfa/provider/authy/configure":
+    post:
+      tags:
+      - tfa/provider/authy/configure
+      description: Get the information required to configure google
+      operationId: PostV1TfaProviderAuthyConfigure
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderAuthyConfigureBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          - deviceData
+          properties:
+            tfaToken:
+              type: string
+            deviceData:
+              "$ref": "#/definitions/two-factor-auth-data-authy-device-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/configure
+  "/V1/tfa/provider/authy/send-token/{via}":
+    post:
+      tags:
+      - tfa/provider/authy/send-token/{via}
+      description: Send a one time password to a device using authy
+      operationId: PostV1TfaProviderAuthySendtokenVia
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: via
+        in: path
+        type: string
+        required: true
+      - name: PostV1TfaProviderAuthySendtokenViaBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/send-token/{via}
+  "/V1/tfa/provider/duo_security/activate":
+    post:
+      tags:
+      - tfa/provider/duo_security/activate
+      description: Activate the provider and get an admin token
+      operationId: PostV1TfaProviderDuo_securityActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderDuo_securityActivateBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          properties:
+            tfaToken:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/duo_security/activate
+  "/V1/tfa/provider/duo_security/authenticate":
+    post:
+      tags:
+      - tfa/provider/duo_security/authenticate
+      description: Authenticate and get an admin token with passcode
+      operationId: PostV1TfaProviderDuo_securityAuthenticate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderDuo_securityAuthenticateBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          - passcode
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+            passcode:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/duo_security/authenticate
+  "/V1/tfa/provider/duo_security/configure":
+    post:
+      tags:
+      - tfa/provider/duo_security/configure
+      description: Configure duo for first time user
+      operationId: PostV1TfaProviderDuo_securityConfigure
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderDuo_securityConfigureBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          properties:
+            tfaToken:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/duo_security/configure
+  "/V1/tfa/provider/google/activate":
+    post:
+      tags:
+      - tfa/provider/google/activate
+      description: Activate the provider and get an admin token
+      operationId: PostV1TfaProviderGoogleActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderGoogleActivateBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          - otp
+          properties:
+            tfaToken:
+              type: string
+            otp:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/google/activate
+  "/V1/tfa/provider/google/authenticate":
+    post:
+      tags:
+      - tfa/provider/google/authenticate
+      description: Get an admin token by authenticating using google
+      operationId: PostV1TfaProviderGoogleAuthenticate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderGoogleAuthenticateBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          - otp
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+            otp:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/google/authenticate
+  "/V1/tfa/provider/google/configure":
+    post:
+      tags:
+      - tfa/provider/google/configure
+      description: Get the information required to configure google
+      operationId: PostV1TfaProviderGoogleConfigure
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderGoogleConfigureBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          properties:
+            tfaToken:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/two-factor-auth-data-google-configure-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/google/configure
+  "/V1/tfa/provider/u2fkey/activate":
+    post:
+      tags:
+      - tfa/provider/u2fkey/activate
+      description: Activate the provider and get a token
+      operationId: PostV1TfaProviderU2fkeyActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderU2fkeyActivateBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          - publicKeyCredentialJson
+          properties:
+            tfaToken:
+              type: string
+            publicKeyCredentialJson:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/u2fkey/activate
+  "/V1/tfa/provider/u2fkey/authentication-challenge":
+    post:
+      tags:
+      - tfa/provider/u2fkey/authentication-challenge
+      description: Get the information to initiate a WebAuthn registration ceremony
+      operationId: PostV1TfaProviderU2fkeyAuthenticationchallenge
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderU2fkeyAuthenticationchallengeBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/u2fkey/authentication-challenge
+  "/V1/tfa/provider/u2fkey/configure":
+    post:
+      tags:
+      - tfa/provider/u2fkey/configure
+      description: Get the information to initiate a WebAuthn registration ceremony
+      operationId: PostV1TfaProviderU2fkeyConfigure
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderU2fkeyConfigureBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          properties:
+            tfaToken:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/u2fkey/configure
+  "/V1/tfa/provider/u2fkey/verify":
+    post:
+      tags:
+      - tfa/provider/u2fkey/verify
+      description: Authenticate with the provider and get a token
+      operationId: PostV1TfaProviderU2fkeyVerify
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderU2fkeyVerifyBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          - publicKeyCredentialJson
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+            publicKeyCredentialJson:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/u2fkey/verify
+  "/V1/tfa/providers-to-activate/{userId}":
+    get:
+      tags:
+      - tfa/providers-to-activate/{userId}
+      description: Returns a list of providers to configure/enroll
+      operationId: GetV1TfaProviderstoactivateUserId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: userId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/two-factor-auth-provider-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/providers-to-activate/{userId}
+  "/V1/tfa/tfat-providers-to-activate":
+    get:
+      tags:
+      - tfa/tfat-providers-to-activate
+      description: Get the providers that the user still needs to configure
+      operationId: GetV1TfaTfatproviderstoactivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: tfaToken
+        in: query
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/two-factor-auth-provider-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/tfat-providers-to-activate
+  "/V1/tfa/tfat-user-providers":
+    get:
+      tags:
+      - tfa/tfat-user-providers
+      description: Get the providers that the user is able to use for 2fa
+      operationId: GetV1TfaTfatuserproviders
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: tfaToken
+        in: query
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/two-factor-auth-provider-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/tfat-user-providers
+  "/V1/tfa/user-providers/{userId}":
+    get:
+      tags:
+      - tfa/user-providers/{userId}
+      description: Get a user provider
+      operationId: GetV1TfaUserprovidersUserId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: userId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/two-factor-auth-provider-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/user-providers/{userId}
+    put:
+      tags:
+      - tfa/user-providers/{userId}
+      description: Set providers
+      operationId: PutV1TfaUserprovidersUserId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: userId
+        in: path
+        type: integer
+        required: true
+      - name: PutV1TfaUserprovidersUserIdBody
+        in: body
+        schema:
+          required:
+          - providersCodes
+          properties:
+            providersCodes:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/user-providers/{userId}
+  "/V1/transactions":
+    get:
+      tags:
+      - transactions
+      description: Lists transactions that match specified search criteria. This call
+        returns an array of objects, but detailed information about each object’s
+        attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#TransactionRepositoryInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1Transactions
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-transaction-search-result-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: transactions
+  "/V1/transactions/{id}":
+    get:
+      tags:
+      - transactions/{id}
+      description: Loads a specified transaction.
+      operationId: GetV1TransactionsId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: integer
+        required: true
+        description: The transaction ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/sales-data-transaction-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: transactions/{id}
+  "/V1/webhooks/list":
+    get:
+      tags:
+      - webhooks/list
+      description: Returns the list of all subscribed webhooks
+      operationId: GetV1WebhooksList
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: webhooks/list
+  "/V1/webhooks/subscribe":
+    post:
+      tags:
+      - webhooks/subscribe
+      description: Subscribes to the webhook.
+      operationId: PostV1WebhooksSubscribe
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1WebhooksSubscribeBody
+        in: body
+        schema:
+          required:
+          - webhook
+          properties:
+            webhook:
+              "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: webhooks/subscribe
+  "/V1/webhooks/unsubscribe":
+    post:
+      tags:
+      - webhooks/unsubscribe
+      description: Unsubscribes from the webhook.
+      operationId: PostV1WebhooksUnsubscribe
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1WebhooksUnsubscribeBody
+        in: body
+        schema:
+          required:
+          - webhook
+          properties:
+            webhook:
+              "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: webhooks/unsubscribe
+  "/V2/carts/mine/coupons":
+    get:
+      tags:
+      - carts/mine/coupons
+      description: Returns information for all coupons in a specified cart.
+      operationId: GetV2CartsMineCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: The coupon code data.
+            items:
+              type: string
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/coupons
+    post:
+      tags:
+      - carts/mine/coupons
+      description: Append the coupon code(s) to cart
+      operationId: PostV2CartsMineCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV2CartsMineCouponsBody
+        in: body
+        schema:
+          required:
+          - couponCodes
+          properties:
+            couponCodes:
+              type: array
+              items:
+                type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/coupons
+    put:
+      tags:
+      - carts/mine/coupons
+      description: Replace the coupon code(s) in cart with the new code(s)
+      operationId: PutV2CartsMineCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV2CartsMineCouponsBody
+        in: body
+        schema:
+          required:
+          - couponCodes
+          properties:
+            couponCodes:
+              type: array
+              items:
+                type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/coupons
+  "/V2/carts/mine/coupons/deleteByCodes":
+    post:
+      tags:
+      - carts/mine/coupons/deleteByCodes
+      description: Deletes coupon(s) from a specified cart.
+      operationId: PostV2CartsMineCouponsDeleteByCodes
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV2CartsMineCouponsDeleteByCodesBody
+        in: body
+        schema:
+          properties:
+            couponCodes:
+              type: array
+              description: coupon codes
+              items:
+                type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/coupons/deleteByCodes
+  "/V2/carts/{cartId}/coupons":
+    get:
+      tags:
+      - carts/{cartId}/coupons
+      description: Returns information for all coupons in a specified cart.
+      operationId: GetV2CartsCartIdCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: The coupon code data.
+            items:
+              type: string
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/coupons
+    post:
+      tags:
+      - carts/{cartId}/coupons
+      description: Append the coupon code(s) to cart
+      operationId: PostV2CartsCartIdCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV2CartsCartIdCouponsBody
+        in: body
+        schema:
+          required:
+          - couponCodes
+          properties:
+            couponCodes:
+              type: array
+              items:
+                type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/coupons
+    put:
+      tags:
+      - carts/{cartId}/coupons
+      description: Replace the coupon code(s) in cart with the new code(s)
+      operationId: PutV2CartsCartIdCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PutV2CartsCartIdCouponsBody
+        in: body
+        schema:
+          required:
+          - couponCodes
+          properties:
+            couponCodes:
+              type: array
+              items:
+                type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/coupons
+  "/V2/carts/{cartId}/coupons/deleteByCodes":
+    post:
+      tags:
+      - carts/{cartId}/coupons/deleteByCodes
+      description: Deletes coupon(s) from a specified cart.
+      operationId: PostV2CartsCartIdCouponsDeleteByCodes
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      - name: PostV2CartsCartIdCouponsDeleteByCodesBody
+        in: body
+        schema:
+          properties:
+            couponCodes:
+              type: array
+              description: coupon codes
+              items:
+                type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/{cartId}/coupons/deleteByCodes
+definitions:
+  error-response:
+    type: object
+    properties:
+      message:
+        type: string
+        description: Error message
+      errors:
+        "$ref": "#/definitions/error-errors"
+      code:
+        type: integer
+        description: Error code
+      parameters:
+        "$ref": "#/definitions/error-parameters"
+      trace:
+        type: string
+        description: Stack trace
+    required:
+    - message
+  error-errors:
+    type: array
+    description: Errors list
+    items:
+      "$ref": "#/definitions/error-errors-item"
+  error-errors-item:
+    type: object
+    description: Error details
+    properties:
+      message:
+        type: string
+        description: Error message
+      parameters:
+        "$ref": "#/definitions/error-parameters"
+  error-parameters:
+    type: array
+    description: Error parameters list
+    items:
+      "$ref": "#/definitions/error-parameters-item"
+  error-parameters-item:
+    type: object
+    description: Error parameters item
+    properties:
+      resources:
+        type: string
+        description: ACL resource
+      fieldName:
+        type: string
+        description: Missing or invalid field name
+      fieldValue:
+        type: string
+        description: Incorrect field value
+  store-data-store-interface:
+    type: object
+    description: Store interface
+    properties:
+      id:
+        type: integer
+      code:
+        type: string
+      name:
+        type: string
+        description: Store name
+      website_id:
+        type: integer
+      store_group_id:
+        type: integer
+      is_active:
+        type: integer
+      extension_attributes:
+        "$ref": "#/definitions/store-data-store-extension-interface"
+    required:
+    - id
+    - code
+    - name
+    - website_id
+    - store_group_id
+    - is_active
+  store-data-store-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Store\Api\Data\StoreInterface
+  store-data-group-interface:
+    type: object
+    description: Group interface
+    properties:
+      id:
+        type: integer
+      website_id:
+        type: integer
+      root_category_id:
+        type: integer
+      default_store_id:
+        type: integer
+      name:
+        type: string
+      code:
+        type: string
+        description: Group code.
+      extension_attributes:
+        "$ref": "#/definitions/store-data-group-extension-interface"
+    required:
+    - id
+    - website_id
+    - root_category_id
+    - default_store_id
+    - name
+    - code
+  store-data-group-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Store\Api\Data\GroupInterface
+  store-data-website-interface:
+    type: object
+    description: Website interface
+    properties:
+      id:
+        type: integer
+      code:
+        type: string
+      name:
+        type: string
+        description: Website name
+      default_group_id:
+        type: integer
+      extension_attributes:
+        "$ref": "#/definitions/store-data-website-extension-interface"
+    required:
+    - id
+    - code
+    - name
+    - default_group_id
+  store-data-website-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Store\Api\Data\WebsiteInterface
+  store-data-store-config-interface:
+    type: object
+    description: Interface for store config
+    properties:
+      id:
+        type: integer
+        description: Store id
+      code:
+        type: string
+        description: Store code
+      website_id:
+        type: integer
+        description: Website id of the store
+      locale:
+        type: string
+        description: Store locale
+      base_currency_code:
+        type: string
+        description: Base currency code
+      default_display_currency_code:
+        type: string
+        description: Default display currency code
+      timezone:
+        type: string
+        description: Timezone of the store
+      weight_unit:
+        type: string
+        description: The unit of weight
+      base_url:
+        type: string
+        description: Base URL for the store
+      base_link_url:
+        type: string
+        description: Base link URL for the store
+      base_static_url:
+        type: string
+        description: Base static URL for the store
+      base_media_url:
+        type: string
+        description: Base media URL for the store
+      secure_base_url:
+        type: string
+        description: Secure base URL for the store
+      secure_base_link_url:
+        type: string
+        description: Secure base link URL for the store
+      secure_base_static_url:
+        type: string
+        description: Secure base static URL for the store
+      secure_base_media_url:
+        type: string
+        description: Secure base media URL for the store
+      extension_attributes:
+        "$ref": "#/definitions/store-data-store-config-extension-interface"
+    required:
+    - id
+    - code
+    - website_id
+    - locale
+    - base_currency_code
+    - default_display_currency_code
+    - timezone
+    - weight_unit
+    - base_url
+    - base_link_url
+    - base_static_url
+    - base_media_url
+    - secure_base_url
+    - secure_base_link_url
+    - secure_base_static_url
+    - secure_base_media_url
+  store-data-store-config-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Store\Api\Data\StoreConfigInterface
+  directory-data-currency-information-interface:
+    type: object
+    description: Currency Information interface.
+    properties:
+      base_currency_code:
+        type: string
+        description: The base currency code for the store.
+      base_currency_symbol:
+        type: string
+        description: The currency symbol of the base currency for the store.
+      default_display_currency_code:
+        type: string
+        description: The default display currency code for the store.
+      default_display_currency_symbol:
+        type: string
+        description: The currency symbol of the default display currency for the store.
+      available_currency_codes:
+        type: array
+        description: The list of allowed currency codes for the store.
+        items:
+          type: string
+      exchange_rates:
+        type: array
+        description: The list of exchange rate information for the store.
+        items:
+          "$ref": "#/definitions/directory-data-exchange-rate-interface"
+      extension_attributes:
+        "$ref": "#/definitions/directory-data-currency-information-extension-interface"
+    required:
+    - base_currency_code
+    - base_currency_symbol
+    - default_display_currency_code
+    - default_display_currency_symbol
+    - available_currency_codes
+    - exchange_rates
+  directory-data-exchange-rate-interface:
+    type: object
+    description: Exchange Rate interface.
+    properties:
+      currency_to:
+        type: string
+        description: The currency code associated with the exchange rate.
+      rate:
+        type: number
+        description: The exchange rate for the associated currency and the store's
+          base currency.
+      extension_attributes:
+        "$ref": "#/definitions/directory-data-exchange-rate-extension-interface"
+    required:
+    - currency_to
+    - rate
+  directory-data-exchange-rate-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Directory\Api\Data\ExchangeRateInterface
+  directory-data-currency-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CurrencyInformationInterface
+  directory-data-country-information-interface:
+    type: object
+    description: Country Information interface.
+    properties:
+      id:
+        type: string
+        description: The country id for the store.
+      two_letter_abbreviation:
+        type: string
+        description: The country 2 letter abbreviation for the store.
+      three_letter_abbreviation:
+        type: string
+        description: The country 3 letter abbreviation for the store.
+      full_name_locale:
+        type: string
+        description: The country full name (in store locale) for the store.
+      full_name_english:
+        type: string
+        description: The country full name (in English) for the store.
+      available_regions:
+        type: array
+        description: The available regions for the store.
+        items:
+          "$ref": "#/definitions/directory-data-region-information-interface"
+      extension_attributes:
+        "$ref": "#/definitions/directory-data-country-information-extension-interface"
+    required:
+    - id
+    - two_letter_abbreviation
+    - three_letter_abbreviation
+    - full_name_locale
+    - full_name_english
+  directory-data-region-information-interface:
+    type: object
+    description: Region Information interface.
+    properties:
+      id:
+        type: string
+        description: Region id
+      code:
+        type: string
+        description: Region code
+      name:
+        type: string
+        description: Region name
+      extension_attributes:
+        "$ref": "#/definitions/directory-data-region-information-extension-interface"
+    required:
+    - id
+    - code
+    - name
+  directory-data-region-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Directory\Api\Data\RegionInformationInterface
+  directory-data-country-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CountryInformationInterface
+  eav-data-attribute-set-search-results-interface:
+    type: object
+    description: Interface AttributeSetSearchResultsInterface
+    properties:
+      items:
+        type: array
+        description: Attribute sets list.
+        items:
+          "$ref": "#/definitions/eav-data-attribute-set-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  eav-data-attribute-set-interface:
+    type: object
+    description: Interface AttributeSetInterface
+    properties:
+      attribute_set_id:
+        type: integer
+        description: Attribute set ID
+      attribute_set_name:
+        type: string
+        description: Attribute set name
+      sort_order:
+        type: integer
+        description: Attribute set sort order index
+      entity_type_id:
+        type: integer
+        description: Attribute set entity type id
+      extension_attributes:
+        "$ref": "#/definitions/eav-data-attribute-set-extension-interface"
+    required:
+    - attribute_set_name
+    - sort_order
+  eav-data-attribute-set-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Eav\Api\Data\AttributeSetInterface
+  framework-search-criteria-interface:
+    type: object
+    description: Search criteria interface.
+    properties:
+      filter_groups:
+        type: array
+        description: A list of filter groups.
+        items:
+          "$ref": "#/definitions/framework-search-filter-group"
+      sort_orders:
+        type: array
+        description: Sort order.
+        items:
+          "$ref": "#/definitions/framework-sort-order"
+      page_size:
+        type: integer
+        description: Page size.
+      current_page:
+        type: integer
+        description: Current page.
+    required:
+    - filter_groups
+  framework-search-filter-group:
+    type: object
+    description: Groups two or more filters together using a logical OR
+    properties:
+      filters:
+        type: array
+        description: A list of filters in this group
+        items:
+          "$ref": "#/definitions/framework-filter"
+  framework-filter:
+    type: object
+    description: Filter which can be used by any methods from service layer.
+    properties:
+      field:
+        type: string
+        description: Field
+      value:
+        type: string
+        description: Value
+      condition_type:
+        type: string
+        description: Condition type
+    required:
+    - field
+    - value
+  framework-sort-order:
+    type: object
+    description: Data object for sort order.
+    properties:
+      field:
+        type: string
+        description: Sorting field.
+      direction:
+        type: string
+        description: Sorting direction.
+    required:
+    - field
+    - direction
+  adobe-io-events-client-configuration-check-result-interface:
+    type: object
+    description: Contains configuration status for each necessary config setting
+    properties:
+      status:
+        type: string
+        description: Ok/error status of the configuration
+      technical_service_account_configured:
+        type: boolean
+        description: The technical service account is configured
+      technical_service_account_can_connect_to_io_events:
+        type: boolean
+        description: Providers are configured to allow the service account to connect
+      provider_id_configured:
+        type: string
+        description: The provider id if configured
+      provider_id_valid:
+        type: boolean
+        description: A configured provider id is valid
+    required:
+    - status
+    - technical_service_account_configured
+    - technical_service_account_can_connect_to_io_events
+    - provider_id_configured
+    - provider_id_valid
+  customer-data-group-interface:
+    type: object
+    description: Customer group interface.
+    properties:
+      id:
+        type: integer
+        description: Id
+      code:
+        type: string
+        description: Code
+      tax_class_id:
+        type: integer
+        description: Tax class id
+      tax_class_name:
+        type: string
+        description: Tax class name
+      extension_attributes:
+        "$ref": "#/definitions/customer-data-group-extension-interface"
+    required:
+    - code
+    - tax_class_id
+  customer-data-group-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Customer\Api\Data\GroupInterface
+    properties:
+      exclude_website_ids:
+        type: array
+        items:
+          type: integer
+  customer-data-group-search-results-interface:
+    type: object
+    description: Interface for customer groups search results.
+    properties:
+      items:
+        type: array
+        description: Customer groups list.
+        items:
+          "$ref": "#/definitions/customer-data-group-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  customer-data-attribute-metadata-interface:
+    type: object
+    description: Customer attribute metadata interface.
+    properties:
+      frontend_input:
+        type: string
+        description: HTML for input element.
+      input_filter:
+        type: string
+        description: Template used for input (e.g. "date")
+      store_label:
+        type: string
+        description: Label of the store.
+      validation_rules:
+        type: array
+        description: Validation rules.
+        items:
+          "$ref": "#/definitions/customer-data-validation-rule-interface"
+      multiline_count:
+        type: integer
+        description: Of lines of the attribute value.
+      visible:
+        type: boolean
+        description: Attribute is visible on frontend.
+      required:
+        type: boolean
+        description: Attribute is required.
+      data_model:
+        type: string
+        description: Data model for attribute.
+      options:
+        type: array
+        description: Options of the attribute (key => value pairs for select)
+        items:
+          "$ref": "#/definitions/customer-data-option-interface"
+      frontend_class:
+        type: string
+        description: Class which is used to display the attribute on frontend.
+      user_defined:
+        type: boolean
+        description: Current attribute has been defined by a user.
+      sort_order:
+        type: integer
+        description: Attributes sort order.
+      frontend_label:
+        type: string
+        description: Label which supposed to be displayed on frontend.
+      note:
+        type: string
+        description: The note attribute for the element.
+      system:
+        type: boolean
+        description: This is a system attribute.
+      backend_type:
+        type: string
+        description: Backend type.
+      is_used_in_grid:
+        type: boolean
+        description: It is used in customer grid
+      is_visible_in_grid:
+        type: boolean
+        description: It is visible in customer grid
+      is_filterable_in_grid:
+        type: boolean
+        description: It is filterable in customer grid
+      is_searchable_in_grid:
+        type: boolean
+        description: It is searchable in customer grid
+      attribute_code:
+        type: string
+        description: Code of the attribute.
+    required:
+    - frontend_input
+    - input_filter
+    - store_label
+    - validation_rules
+    - multiline_count
+    - visible
+    - required
+    - data_model
+    - options
+    - frontend_class
+    - user_defined
+    - sort_order
+    - frontend_label
+    - note
+    - system
+    - backend_type
+    - attribute_code
+  customer-data-validation-rule-interface:
+    type: object
+    description: Validation rule interface.
+    properties:
+      name:
+        type: string
+        description: Validation rule name
+      value:
+        type: string
+        description: Validation rule value
+    required:
+    - name
+    - value
+  customer-data-option-interface:
+    type: object
+    description: Option interface.
+    properties:
+      label:
+        type: string
+        description: Option label
+      value:
+        type: string
+        description: Option value
+      options:
+        type: array
+        description: Nested options
+        items:
+          "$ref": "#/definitions/customer-data-option-interface"
+    required:
+    - label
+  customer-data-customer-interface:
+    type: object
+    description: Customer entity interface for API handling.
+    properties:
+      id:
+        type: integer
+        description: Customer id
+      group_id:
+        type: integer
+        description: Group id
+      default_billing:
+        type: string
+        description: Default billing address id
+      default_shipping:
+        type: string
+        description: Default shipping address id
+      confirmation:
+        type: string
+        description: Confirmation
+      created_at:
+        type: string
+        description: Created at time
+      updated_at:
+        type: string
+        description: Updated at time
+      created_in:
+        type: string
+        description: Created in area
+      dob:
+        type: string
+        description: In keeping with current security and privacy best practices,
+          be sure you are aware of any potential legal and security risks associated
+          with the storage of customers’ full date of birth (month, day, year) along
+          with other personal identifiers (e.g., full name) before collecting or processing
+          such data.
+      email:
+        type: string
+        description: Email address
+      firstname:
+        type: string
+        description: First name
+      lastname:
+        type: string
+        description: Last name
+      middlename:
+        type: string
+        description: Middle name
+      prefix:
+        type: string
+        description: Prefix
+      suffix:
+        type: string
+        description: Suffix
+      gender:
+        type: integer
+        description: Gender
+      store_id:
+        type: integer
+        description: Store id
+      taxvat:
+        type: string
+        description: Tax Vat
+      website_id:
+        type: integer
+        description: Website id
+      addresses:
+        type: array
+        description: Customer addresses.
+        items:
+          "$ref": "#/definitions/customer-data-address-interface"
+      disable_auto_group_change:
+        type: integer
+        description: Disable auto group change flag.
+      extension_attributes:
+        "$ref": "#/definitions/customer-data-customer-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - email
+    - firstname
+    - lastname
+  customer-data-address-interface:
+    type: object
+    description: Customer address interface.
+    properties:
+      id:
+        type: integer
+        description: ID
+      customer_id:
+        type: integer
+        description: Customer ID
+      region:
+        "$ref": "#/definitions/customer-data-region-interface"
+      region_id:
+        type: integer
+        description: Region ID
+      country_id:
+        type: string
+        description: Country code in ISO_3166-2 format
+      street:
+        type: array
+        description: Street
+        items:
+          type: string
+      company:
+        type: string
+        description: Company
+      telephone:
+        type: string
+        description: Telephone number
+      fax:
+        type: string
+        description: Fax number
+      postcode:
+        type: string
+        description: Postcode
+      city:
+        type: string
+        description: City name
+      firstname:
+        type: string
+        description: First name
+      lastname:
+        type: string
+        description: Last name
+      middlename:
+        type: string
+        description: Middle name
+      prefix:
+        type: string
+        description: Prefix
+      suffix:
+        type: string
+        description: Suffix
+      vat_id:
+        type: string
+        description: Vat id
+      default_shipping:
+        type: boolean
+        description: If this address is default shipping address.
+      default_billing:
+        type: boolean
+        description: If this address is default billing address
+      extension_attributes:
+        "$ref": "#/definitions/customer-data-address-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+  customer-data-region-interface:
+    type: object
+    description: Customer address region interface.
+    properties:
+      region_code:
+        type: string
+        description: Region code
+      region:
+        type: string
+        description: Region
+      region_id:
+        type: integer
+        description: Region id
+      extension_attributes:
+        "$ref": "#/definitions/customer-data-region-extension-interface"
+    required:
+    - region_code
+    - region
+    - region_id
+  customer-data-region-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface
+  customer-data-address-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface
+  framework-attribute-interface:
+    type: object
+    description: Interface for custom attribute value.
+    properties:
+      attribute_code:
+        type: string
+        description: Attribute code
+      value:
+        type: string
+        description: Attribute value
+    required:
+    - attribute_code
+    - value
+  customer-data-customer-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface
+    properties:
+      company_attributes:
+        "$ref": "#/definitions/company-data-company-customer-interface"
+      all_company_attributes:
+        type: array
+        items:
+          "$ref": "#/definitions/company-data-company-customer-interface"
+      is_subscribed:
+        type: boolean
+      assistance_allowed:
+        type: integer
+  company-data-company-customer-interface:
+    type: object
+    description: Extended customer custom attributes interface.
+    properties:
+      customer_id:
+        type: integer
+        description: Customer ID.
+      company_id:
+        type: integer
+        description: Company ID.
+      job_title:
+        type: string
+        description: Job title.
+      status:
+        type: integer
+        description: Customer status.
+      telephone:
+        type: string
+        description: Telephone.
+      is_default:
+        type: boolean
+        description: Is default
+      extension_attributes:
+        "$ref": "#/definitions/company-data-company-customer-extension-interface"
+  company-data-company-customer-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface
+  customer-data-customer-search-results-interface:
+    type: object
+    description: Interface for customer search results.
+    properties:
+      items:
+        type: array
+        description: Customers list.
+        items:
+          "$ref": "#/definitions/customer-data-customer-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  customer-data-validation-results-interface:
+    type: object
+    description: Validation results interface.
+    properties:
+      valid:
+        type: boolean
+        description: If the provided data is valid.
+      messages:
+        type: array
+        description: Error messages as array in case of validation failure, else return
+          empty array.
+        items:
+          type: string
+    required:
+    - valid
+    - messages
+  adobe-commerce-events-client-data-event-data-interface:
+    type: object
+    description: Interface for event data from webapi requests
+    properties:
+      name:
+        type: string
+        description: Event name
+      parent:
+        type: string
+        description: Event parent name
+      fields:
+        type: array
+        description: Event fields
+        items:
+          "$ref": "#/definitions/adobe-commerce-events-client-data-event-field-interface"
+      rules:
+        type: array
+        description: Event fields
+        items:
+          "$ref": "#/definitions/adobe-commerce-events-client-data-event-rule-interface"
+      destination:
+        type: string
+        description: Event destination
+      priority:
+        type: boolean
+        description: Event priority
+      hipaa_audit_required:
+        type: boolean
+        description: If event is required to be HIPAA audited
+      provider_id:
+        type: string
+        description: Event provider id
+    required:
+    - name
+    - parent
+    - fields
+    - rules
+    - destination
+    - priority
+    - hipaa_audit_required
+    - provider_id
+  adobe-commerce-events-client-data-event-field-interface:
+    type: object
+    description: Interface for event field data from webapi requests
+    properties:
+      name:
+        type: string
+        description: Event field name
+      converter:
+        type: string
+        description: Event field converter
+      source:
+        type: string
+        description: Event field source
+    required:
+    - name
+    - converter
+    - source
+  adobe-commerce-events-client-data-event-rule-interface:
+    type: object
+    description: Interface for event rule data from webapi requests
+    properties:
+      field:
+        type: string
+        description: Event rule field name
+      operator:
+        type: string
+        description: Event rule operator
+      value:
+        type: string
+        description: Event rule value
+    required:
+    - field
+    - operator
+    - value
+  adobe-commerce-events-client-data-configuration-interface:
+    type: object
+    description: Eventing configuration
+    properties:
+      enabled:
+        type: boolean
+        description: If is enabled
+      merchant_id:
+        type: string
+        description: Merchant id
+      environment_id:
+        type: string
+        description: Environment id
+      provider_id:
+        type: string
+        description: Provider id
+      instance_id:
+        type: string
+        description: Instance id
+      workspace_configuration:
+        type: string
+        description: Workspace configuration
+    required:
+    - enabled
+    - merchant_id
+    - environment_id
+    - provider_id
+    - instance_id
+    - workspace_configuration
+  adobe-commerce-events-client-data-event-provider-interface:
+    type: object
+    description: Interface for event provider
+    properties:
+      id:
+        type: integer
+        description: ID of the event provider record
+      provider_id:
+        type: string
+        description: Event provider id
+      instance_id:
+        type: string
+        description: Event provider instance id
+      label:
+        type: string
+        description: Event provider label
+      description:
+        type: string
+        description: Event provider description
+      workspace_configuration:
+        type: string
+        description: Event provider workspace configuration
+    required:
+    - provider_id
+    - instance_id
+    - label
+    - description
+    - workspace_configuration
+  framework-search-search-result-interface:
+    type: object
+    description: Interface SearchResultInterface
+    properties:
+      items:
+        type: array
+        items:
+          "$ref": "#/definitions/framework-search-document-interface"
+      aggregations:
+        "$ref": "#/definitions/framework-search-aggregation-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - aggregations
+    - search_criteria
+    - total_count
+  framework-search-document-interface:
+    type: object
+    description: Interface Search Document
+    properties:
+      id:
+        type: integer
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - id
+  framework-search-aggregation-interface:
+    type: object
+    description: Interface Aggregation to get faceted data
+    properties:
+      buckets:
+        type: array
+        description: All Document fields
+        items:
+          "$ref": "#/definitions/framework-search-bucket-interface"
+      bucket_names:
+        type: array
+        description: Document field names
+        items:
+          type: string
+    required:
+    - buckets
+    - bucket_names
+  framework-search-bucket-interface:
+    type: object
+    description: Interface for facet Bucket
+    properties:
+      name:
+        type: string
+        description: Field name
+      values:
+        type: array
+        description: Field values
+        items:
+          "$ref": "#/definitions/framework-search-aggregation-value-interface"
+    required:
+    - name
+    - values
+  framework-search-aggregation-value-interface:
+    type: object
+    description: Interface Aggregation Value
+    properties:
+      value:
+        type: string
+        description: Aggregation
+      metrics:
+        type: array
+        description: Metrics
+        items:
+          type: string
+    required:
+    - value
+    - metrics
+  framework-search-search-criteria-interface:
+    type: object
+    description: Interface SearchCriteriaInterface
+    properties:
+      request_name:
+        type: string
+      filter_groups:
+        type: array
+        description: A list of filter groups.
+        items:
+          "$ref": "#/definitions/framework-search-filter-group"
+      sort_orders:
+        type: array
+        description: Sort order.
+        items:
+          "$ref": "#/definitions/framework-sort-order"
+      page_size:
+        type: integer
+        description: Page size.
+      current_page:
+        type: integer
+        description: Current page.
+    required:
+    - request_name
+    - filter_groups
+  cms-data-page-interface:
+    type: object
+    description: CMS page interface.
+    properties:
+      id:
+        type: integer
+        description: ID
+      identifier:
+        type: string
+        description: Identifier
+      title:
+        type: string
+        description: Title
+      page_layout:
+        type: string
+        description: Page layout
+      meta_title:
+        type: string
+        description: Meta title
+      meta_keywords:
+        type: string
+        description: Meta keywords
+      meta_description:
+        type: string
+        description: Meta description
+      content_heading:
+        type: string
+        description: Content heading
+      content:
+        type: string
+        description: Content
+      creation_time:
+        type: string
+        description: Creation time
+      update_time:
+        type: string
+        description: Update time
+      sort_order:
+        type: string
+        description: Sort order
+      layout_update_xml:
+        type: string
+        description: Layout update xml
+      custom_theme:
+        type: string
+        description: Custom theme
+      custom_root_template:
+        type: string
+        description: Custom root template
+      custom_layout_update_xml:
+        type: string
+        description: Custom layout update xml
+      custom_theme_from:
+        type: string
+        description: Custom theme from
+      custom_theme_to:
+        type: string
+        description: Custom theme to
+      active:
+        type: boolean
+        description: Active
+    required:
+    - identifier
+  cms-data-page-search-results-interface:
+    type: object
+    description: Interface for cms page search results.
+    properties:
+      items:
+        type: array
+        description: Pages list.
+        items:
+          "$ref": "#/definitions/cms-data-page-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  cms-data-block-interface:
+    type: object
+    description: CMS block interface.
+    properties:
+      id:
+        type: integer
+        description: ID
+      identifier:
+        type: string
+        description: Identifier
+      title:
+        type: string
+        description: Title
+      content:
+        type: string
+        description: Content
+      creation_time:
+        type: string
+        description: Creation time
+      update_time:
+        type: string
+        description: Update time
+      active:
+        type: boolean
+        description: Active
+    required:
+    - identifier
+  cms-data-block-search-results-interface:
+    type: object
+    description: Interface for cms block search results.
+    properties:
+      items:
+        type: array
+        description: Blocks list.
+        items:
+          "$ref": "#/definitions/cms-data-block-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  catalog-data-product-interface:
+    type: object
+    description: ''
+    properties:
+      id:
+        type: integer
+        description: Id
+      sku:
+        type: string
+        description: Sku
+      name:
+        type: string
+        description: Name
+      attribute_set_id:
+        type: integer
+        description: Attribute set id
+      price:
+        type: number
+        description: Price
+      status:
+        type: integer
+        description: Status
+      visibility:
+        type: integer
+        description: Visibility
+      type_id:
+        type: string
+        description: Type id
+      created_at:
+        type: string
+        description: Created date
+      updated_at:
+        type: string
+        description: Updated date
+      weight:
+        type: number
+        description: Weight
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-extension-interface"
+      product_links:
+        type: array
+        description: Product links info
+        items:
+          "$ref": "#/definitions/catalog-data-product-link-interface"
+      options:
+        type: array
+        description: List of product options
+        items:
+          "$ref": "#/definitions/catalog-data-product-custom-option-interface"
+      media_gallery_entries:
+        type: array
+        description: Media gallery entries
+        items:
+          "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"
+      tier_prices:
+        type: array
+        description: List of product tier prices
+        items:
+          "$ref": "#/definitions/catalog-data-product-tier-price-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - sku
+  catalog-data-product-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductInterface
+    properties:
+      website_ids:
+        type: array
+        items:
+          type: integer
+      category_links:
+        type: array
+        items:
+          "$ref": "#/definitions/catalog-data-category-link-interface"
+      stock_item:
+        "$ref": "#/definitions/catalog-inventory-data-stock-item-interface"
+      discounts:
+        type: array
+        items:
+          "$ref": "#/definitions/sales-rule-data-rule-discount-interface"
+      bundle_product_options:
+        type: array
+        items:
+          "$ref": "#/definitions/bundle-data-option-interface"
+      downloadable_product_links:
+        type: array
+        items:
+          "$ref": "#/definitions/downloadable-data-link-interface"
+      downloadable_product_samples:
+        type: array
+        items:
+          "$ref": "#/definitions/downloadable-data-sample-interface"
+      giftcard_amounts:
+        type: array
+        items:
+          "$ref": "#/definitions/gift-card-data-giftcard-amount-interface"
+      configurable_product_options:
+        type: array
+        items:
+          "$ref": "#/definitions/configurable-product-data-option-interface"
+      configurable_product_links:
+        type: array
+        items:
+          type: integer
+  catalog-data-category-link-interface:
+    type: object
+    description: ''
+    properties:
+      position:
+        type: integer
+      category_id:
+        type: string
+        description: Category id
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-category-link-extension-interface"
+    required:
+    - category_id
+  catalog-data-category-link-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryLinkInterface
+  catalog-inventory-data-stock-item-interface:
+    type: object
+    description: Interface StockItem
+    properties:
+      item_id:
+        type: integer
+      product_id:
+        type: integer
+      stock_id:
+        type: integer
+        description: Stock identifier
+      qty:
+        type: number
+      is_in_stock:
+        type: boolean
+        description: Stock Availability
+      is_qty_decimal:
+        type: boolean
+      show_default_notification_message:
+        type: boolean
+      use_config_min_qty:
+        type: boolean
+      min_qty:
+        type: number
+        description: Minimal quantity available for item status in stock
+      use_config_min_sale_qty:
+        type: integer
+      min_sale_qty:
+        type: number
+        description: Minimum Qty Allowed in Shopping Cart or NULL when there is no
+          limitation
+      use_config_max_sale_qty:
+        type: boolean
+      max_sale_qty:
+        type: number
+        description: Maximum Qty Allowed in Shopping Cart data wrapper
+      use_config_backorders:
+        type: boolean
+      backorders:
+        type: integer
+        description: Backorders status
+      use_config_notify_stock_qty:
+        type: boolean
+      notify_stock_qty:
+        type: number
+        description: Notify for Quantity Below data wrapper
+      use_config_qty_increments:
+        type: boolean
+      qty_increments:
+        type: number
+        description: Quantity Increments data wrapper
+      use_config_enable_qty_inc:
+        type: boolean
+      enable_qty_increments:
+        type: boolean
+        description: Whether Quantity Increments is enabled
+      use_config_manage_stock:
+        type: boolean
+      manage_stock:
+        type: boolean
+        description: Can Manage Stock
+      low_stock_date:
+        type: string
+      is_decimal_divided:
+        type: boolean
+      stock_status_changed_auto:
+        type: integer
+      extension_attributes:
+        "$ref": "#/definitions/catalog-inventory-data-stock-item-extension-interface"
+    required:
+    - qty
+    - is_in_stock
+    - is_qty_decimal
+    - show_default_notification_message
+    - use_config_min_qty
+    - min_qty
+    - use_config_min_sale_qty
+    - min_sale_qty
+    - use_config_max_sale_qty
+    - max_sale_qty
+    - use_config_backorders
+    - backorders
+    - use_config_notify_stock_qty
+    - notify_stock_qty
+    - use_config_qty_increments
+    - qty_increments
+    - use_config_enable_qty_inc
+    - enable_qty_increments
+    - use_config_manage_stock
+    - manage_stock
+    - low_stock_date
+    - is_decimal_divided
+    - stock_status_changed_auto
+  catalog-inventory-data-stock-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockItemInterface
+  sales-rule-data-rule-discount-interface:
+    type: object
+    description: Rule discount Interface
+    properties:
+      discount_data:
+        "$ref": "#/definitions/sales-rule-data-discount-data-interface"
+      rule_label:
+        type: string
+        description: Rule Label
+      rule_i_d:
+        type: integer
+        description: Rule ID
+    required:
+    - discount_data
+    - rule_label
+    - rule_i_d
+  sales-rule-data-discount-data-interface:
+    type: object
+    description: Discount Data Interface
+    properties:
+      amount:
+        type: number
+        description: Amount
+      base_amount:
+        type: number
+        description: Base Amount
+      original_amount:
+        type: number
+        description: Original Amount
+      base_original_amount:
+        type: number
+        description: Base Original Amount
+    required:
+    - amount
+    - base_amount
+    - original_amount
+    - base_original_amount
+  bundle-data-option-interface:
+    type: object
+    description: Interface OptionInterface
+    properties:
+      option_id:
+        type: integer
+        description: Option id
+      title:
+        type: string
+        description: Option title
+      required:
+        type: boolean
+        description: Is required option
+      type:
+        type: string
+        description: Input type
+      position:
+        type: integer
+        description: Option position
+      sku:
+        type: string
+        description: Product sku
+      product_links:
+        type: array
+        description: Product links
+        items:
+          "$ref": "#/definitions/bundle-data-link-interface"
+      extension_attributes:
+        "$ref": "#/definitions/bundle-data-option-extension-interface"
+  bundle-data-link-interface:
+    type: object
+    description: Interface LinkInterface
+    properties:
+      id:
+        type: string
+        description: The identifier
+      sku:
+        type: string
+        description: Linked product sku
+      option_id:
+        type: integer
+        description: Option id
+      qty:
+        type: number
+        description: Qty
+      position:
+        type: integer
+        description: Position
+      is_default:
+        type: boolean
+        description: Is default
+      price:
+        type: number
+        description: Price
+      price_type:
+        type: integer
+        description: Price type
+      can_change_quantity:
+        type: integer
+        description: Whether quantity could be changed
+      extension_attributes:
+        "$ref": "#/definitions/bundle-data-link-extension-interface"
+    required:
+    - is_default
+    - price
+    - price_type
+  bundle-data-link-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\LinkInterface
+  bundle-data-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\OptionInterface
+  downloadable-data-link-interface:
+    type: object
+    description: ''
+    properties:
+      id:
+        type: integer
+        description: Sample(or link) id
+      title:
+        type: string
+      sort_order:
+        type: integer
+      is_shareable:
+        type: integer
+        description: Shareable status
+      price:
+        type: number
+        description: Price
+      number_of_downloads:
+        type: integer
+        description: Of downloads per user
+      link_type:
+        type: string
+      link_file:
+        type: string
+        description: relative file path
+      link_file_content:
+        "$ref": "#/definitions/downloadable-data-file-content-interface"
+      link_url:
+        type: string
+        description: Link url or null when type is 'file'
+      sample_type:
+        type: string
+      sample_file:
+        type: string
+        description: relative file path
+      sample_file_content:
+        "$ref": "#/definitions/downloadable-data-file-content-interface"
+      sample_url:
+        type: string
+        description: file URL
+      extension_attributes:
+        "$ref": "#/definitions/downloadable-data-link-extension-interface"
+    required:
+    - sort_order
+    - is_shareable
+    - price
+    - link_type
+    - sample_type
+  downloadable-data-file-content-interface:
+    type: object
+    description: ''
+    properties:
+      file_data:
+        type: string
+        description: Data (base64 encoded content)
+      name:
+        type: string
+        description: File name
+      extension_attributes:
+        "$ref": "#/definitions/downloadable-data-file-content-extension-interface"
+    required:
+    - file_data
+    - name
+  downloadable-data-file-content-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Downloadable\Api\Data\File\ContentInterface
+  downloadable-data-link-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Downloadable\Api\Data\LinkInterface
+  downloadable-data-sample-interface:
+    type: object
+    description: ''
+    properties:
+      id:
+        type: integer
+        description: Sample(or link) id
+      title:
+        type: string
+        description: Title
+      sort_order:
+        type: integer
+        description: Order index for sample
+      sample_type:
+        type: string
+      sample_file:
+        type: string
+        description: relative file path
+      sample_file_content:
+        "$ref": "#/definitions/downloadable-data-file-content-interface"
+      sample_url:
+        type: string
+        description: file URL
+      extension_attributes:
+        "$ref": "#/definitions/downloadable-data-sample-extension-interface"
+    required:
+    - title
+    - sort_order
+    - sample_type
+  downloadable-data-sample-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Downloadable\Api\Data\SampleInterface
+  gift-card-data-giftcard-amount-interface:
+    type: object
+    description: 'Interface GiftcardAmountInterface: this interface is used to serialize
+      and deserialize EAV attribute giftcard_amounts'
+    properties:
+      attribute_id:
+        type: integer
+        description: AttributeId
+      website_id:
+        type: integer
+        description: WebsiteId
+      value:
+        type: number
+        description: Value
+      website_value:
+        type: number
+        description: WebsiteValue
+      extension_attributes:
+        "$ref": "#/definitions/gift-card-data-giftcard-amount-extension-interface"
+    required:
+    - attribute_id
+    - website_id
+    - value
+    - website_value
+  gift-card-data-giftcard-amount-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftcardAmountInterface
+  configurable-product-data-option-interface:
+    type: object
+    description: Interface OptionInterface
+    properties:
+      id:
+        type: integer
+      attribute_id:
+        type: string
+      label:
+        type: string
+      position:
+        type: integer
+      is_use_default:
+        type: boolean
+      values:
+        type: array
+        items:
+          "$ref": "#/definitions/configurable-product-data-option-value-interface"
+      extension_attributes:
+        "$ref": "#/definitions/configurable-product-data-option-extension-interface"
+      product_id:
+        type: integer
+  configurable-product-data-option-value-interface:
+    type: object
+    description: Interface OptionValueInterface
+    properties:
+      value_index:
+        type: integer
+      extension_attributes:
+        "$ref": "#/definitions/configurable-product-data-option-value-extension-interface"
+    required:
+    - value_index
+  configurable-product-data-option-value-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\OptionValueInterface
+  configurable-product-data-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\OptionInterface
+  catalog-data-product-link-interface:
+    type: object
+    description: ''
+    properties:
+      sku:
+        type: string
+        description: SKU
+      link_type:
+        type: string
+        description: Link type
+      linked_product_sku:
+        type: string
+        description: Linked product sku
+      linked_product_type:
+        type: string
+        description: Linked product type (simple, virtual, etc)
+      position:
+        type: integer
+        description: Linked item position
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-link-extension-interface"
+    required:
+    - sku
+    - link_type
+    - linked_product_sku
+    - linked_product_type
+    - position
+  catalog-data-product-link-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductLinkInterface
+    properties:
+      qty:
+        type: number
+  catalog-data-product-custom-option-interface:
+    type: object
+    description: ''
+    properties:
+      product_sku:
+        type: string
+        description: Product SKU
+      option_id:
+        type: integer
+        description: Option id
+      title:
+        type: string
+        description: Option title
+      type:
+        type: string
+        description: Option type
+      sort_order:
+        type: integer
+        description: Sort order
+      is_require:
+        type: boolean
+        description: Is require
+      price:
+        type: number
+        description: Price
+      price_type:
+        type: string
+        description: Price type
+      sku:
+        type: string
+        description: Sku
+      file_extension:
+        type: string
+        description: File extension
+      max_characters:
+        type: integer
+        description: Max characters
+      image_size_x:
+        type: integer
+        description: Image x size
+      image_size_y:
+        type: integer
+        description: Image Y size
+      values:
+        type: array
+        description: Values
+        items:
+          "$ref": "#/definitions/catalog-data-product-custom-option-values-interface"
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-custom-option-extension-interface"
+    required:
+    - product_sku
+    - title
+    - type
+    - sort_order
+    - is_require
+  catalog-data-product-custom-option-values-interface:
+    type: object
+    description: ''
+    properties:
+      title:
+        type: string
+        description: Option title
+      sort_order:
+        type: integer
+        description: Sort order
+      price:
+        type: number
+        description: Price
+      price_type:
+        type: string
+        description: Price type
+      sku:
+        type: string
+        description: Sku
+      option_type_id:
+        type: integer
+        description: Option type id
+    required:
+    - title
+    - sort_order
+    - price
+    - price_type
+  catalog-data-product-custom-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductCustomOptionInterface
+  catalog-data-product-attribute-media-gallery-entry-interface:
+    type: object
+    description: ''
+    properties:
+      id:
+        type: integer
+        description: Gallery entry ID
+      media_type:
+        type: string
+        description: Media type
+      label:
+        type: string
+        description: Gallery entry alternative text
+      position:
+        type: integer
+        description: Gallery entry position (sort order)
+      disabled:
+        type: boolean
+        description: If gallery entry is hidden from product page
+      types:
+        type: array
+        description: Gallery entry image types (thumbnail, image, small_image etc)
+        items:
+          type: string
+      file:
+        type: string
+        description: File path
+      content:
+        "$ref": "#/definitions/framework-data-image-content-interface"
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-extension-interface"
+    required:
+    - media_type
+    - label
+    - position
+    - disabled
+    - types
+  framework-data-image-content-interface:
+    type: object
+    description: Image Content data interface
+    properties:
+      base64_encoded_data:
+        type: string
+        description: Media data (base64 encoded content)
+      type:
+        type: string
+        description: MIME type
+      name:
+        type: string
+        description: Image name
+    required:
+    - base64_encoded_data
+    - type
+    - name
+  catalog-data-product-attribute-media-gallery-entry-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryInterface
+    properties:
+      video_content:
+        "$ref": "#/definitions/framework-data-video-content-interface"
+  framework-data-video-content-interface:
+    type: object
+    description: Video Content data interface
+    properties:
+      media_type:
+        type: string
+        description: MIME type
+      video_provider:
+        type: string
+        description: Provider
+      video_url:
+        type: string
+        description: Video URL
+      video_title:
+        type: string
+        description: Title
+      video_description:
+        type: string
+        description: Video Description
+      video_metadata:
+        type: string
+        description: Metadata
+    required:
+    - media_type
+    - video_provider
+    - video_url
+    - video_title
+    - video_description
+    - video_metadata
+  catalog-data-product-tier-price-interface:
+    type: object
+    description: ''
+    properties:
+      customer_group_id:
+        type: integer
+        description: Customer group id
+      qty:
+        type: number
+        description: Tier qty
+      value:
+        type: number
+        description: Price value
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-tier-price-extension-interface"
+    required:
+    - customer_group_id
+    - qty
+    - value
+  catalog-data-product-tier-price-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductTierPriceInterface
+    properties:
+      percentage_value:
+        type: number
+      website_id:
+        type: integer
+  catalog-data-product-search-results-interface:
+    type: object
+    description: ''
+    properties:
+      items:
+        type: array
+        description: Attributes list.
+        items:
+          "$ref": "#/definitions/catalog-data-product-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  catalog-data-product-attribute-type-interface:
+    type: object
+    description: ''
+    properties:
+      value:
+        type: string
+        description: Value
+      label:
+        type: string
+        description: Type label
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-attribute-type-extension-interface"
+    required:
+    - value
+    - label
+  catalog-data-product-attribute-type-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductAttributeTypeInterface
+  catalog-data-product-attribute-interface:
+    type: object
+    description: ''
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/eav-data-attribute-extension-interface"
+      is_wysiwyg_enabled:
+        type: boolean
+        description: WYSIWYG flag
+      is_html_allowed_on_front:
+        type: boolean
+        description: The HTML tags are allowed on the frontend
+      used_for_sort_by:
+        type: boolean
+        description: It is used for sorting in product listing
+      is_filterable:
+        type: boolean
+        description: It used in layered navigation
+      is_filterable_in_search:
+        type: boolean
+        description: It is used in search results layered navigation
+      is_used_in_grid:
+        type: boolean
+        description: It is used in catalog product grid
+      is_visible_in_grid:
+        type: boolean
+        description: It is visible in catalog product grid
+      is_filterable_in_grid:
+        type: boolean
+        description: It is filterable in catalog product grid
+      position:
+        type: integer
+        description: Position
+      apply_to:
+        type: array
+        description: Apply to value for the element
+        items:
+          type: string
+      is_searchable:
+        type: string
+        description: The attribute can be used in Quick Search
+      is_visible_in_advanced_search:
+        type: string
+        description: The attribute can be used in Advanced Search
+      is_comparable:
+        type: string
+        description: The attribute can be compared on the frontend
+      is_used_for_promo_rules:
+        type: string
+        description: The attribute can be used for promo rules
+      is_visible_on_front:
+        type: string
+        description: The attribute is visible on the frontend
+      used_in_product_listing:
+        type: string
+        description: The attribute can be used in product listing
+      is_visible:
+        type: boolean
+        description: Attribute is visible on frontend.
+      scope:
+        type: string
+        description: Attribute scope
+      attribute_id:
+        type: integer
+        description: Id of the attribute.
+      attribute_code:
+        type: string
+        description: Code of the attribute.
+      frontend_input:
+        type: string
+        description: HTML for input element.
+      entity_type_id:
+        type: string
+        description: Entity type id
+      is_required:
+        type: boolean
+        description: Attribute is required.
+      options:
+        type: array
+        description: Options of the attribute (key => value pairs for select)
+        items:
+          "$ref": "#/definitions/eav-data-attribute-option-interface"
+      is_user_defined:
+        type: boolean
+        description: Current attribute has been defined by a user.
+      default_frontend_label:
+        type: string
+        description: Frontend label for default store
+      frontend_labels:
+        type: array
+        description: Frontend label for each store
+        items:
+          "$ref": "#/definitions/eav-data-attribute-frontend-label-interface"
+      note:
+        type: string
+        description: The note attribute for the element.
+      backend_type:
+        type: string
+        description: Backend type.
+      backend_model:
+        type: string
+        description: Backend model
+      source_model:
+        type: string
+        description: Source model
+      default_value:
+        type: string
+        description: Default value for the element.
+      is_unique:
+        type: string
+        description: This is a unique attribute
+      frontend_class:
+        type: string
+        description: Frontend class of attribute
+      validation_rules:
+        type: array
+        description: Validation rules.
+        items:
+          "$ref": "#/definitions/eav-data-attribute-validation-rule-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - attribute_code
+    - frontend_input
+    - entity_type_id
+    - is_required
+    - frontend_labels
+  eav-data-attribute-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Eav\Api\Data\AttributeInterface
+    properties:
+      is_pagebuilder_enabled:
+        type: boolean
+  eav-data-attribute-option-interface:
+    type: object
+    description: 'Created from:'
+    properties:
+      label:
+        type: string
+        description: Option label
+      value:
+        type: string
+        description: Option value
+      sort_order:
+        type: integer
+        description: Option order
+      is_default:
+        type: boolean
+        description: Default
+      store_labels:
+        type: array
+        description: Option label for store scopes
+        items:
+          "$ref": "#/definitions/eav-data-attribute-option-label-interface"
+    required:
+    - label
+    - value
+  eav-data-attribute-option-label-interface:
+    type: object
+    description: Interface AttributeOptionLabelInterface
+    properties:
+      store_id:
+        type: integer
+        description: Store id
+      label:
+        type: string
+        description: Option label
+  eav-data-attribute-frontend-label-interface:
+    type: object
+    description: Interface AttributeFrontendLabelInterface
+    properties:
+      store_id:
+        type: integer
+        description: Store id
+      label:
+        type: string
+        description: Option label
+  eav-data-attribute-validation-rule-interface:
+    type: object
+    description: Interface AttributeValidationRuleInterface
+    properties:
+      key:
+        type: string
+        description: Object key
+      value:
+        type: string
+        description: Object value
+    required:
+    - key
+    - value
+  catalog-data-product-attribute-search-results-interface:
+    type: object
+    description: ''
+    properties:
+      items:
+        type: array
+        description: Attributes list.
+        items:
+          "$ref": "#/definitions/catalog-data-product-attribute-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  catalog-data-category-attribute-interface:
+    type: object
+    description: ''
+    properties:
+      is_wysiwyg_enabled:
+        type: boolean
+        description: WYSIWYG flag
+      is_html_allowed_on_front:
+        type: boolean
+        description: The HTML tags are allowed on the frontend
+      used_for_sort_by:
+        type: boolean
+        description: It is used for sorting in product listing
+      is_filterable:
+        type: boolean
+        description: It used in layered navigation
+      is_filterable_in_search:
+        type: boolean
+        description: It is used in search results layered navigation
+      is_used_in_grid:
+        type: boolean
+        description: It is used in catalog product grid
+      is_visible_in_grid:
+        type: boolean
+        description: It is visible in catalog product grid
+      is_filterable_in_grid:
+        type: boolean
+        description: It is filterable in catalog product grid
+      position:
+        type: integer
+        description: Position
+      apply_to:
+        type: array
+        description: Apply to value for the element
+        items:
+          type: string
+      is_searchable:
+        type: string
+        description: The attribute can be used in Quick Search
+      is_visible_in_advanced_search:
+        type: string
+        description: The attribute can be used in Advanced Search
+      is_comparable:
+        type: string
+        description: The attribute can be compared on the frontend
+      is_used_for_promo_rules:
+        type: string
+        description: The attribute can be used for promo rules
+      is_visible_on_front:
+        type: string
+        description: The attribute is visible on the frontend
+      used_in_product_listing:
+        type: string
+        description: The attribute can be used in product listing
+      is_visible:
+        type: boolean
+        description: Attribute is visible on frontend.
+      scope:
+        type: string
+        description: Attribute scope
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-eav-attribute-extension-interface"
+      attribute_id:
+        type: integer
+        description: Id of the attribute.
+      attribute_code:
+        type: string
+        description: Code of the attribute.
+      frontend_input:
+        type: string
+        description: HTML for input element.
+      entity_type_id:
+        type: string
+        description: Entity type id
+      is_required:
+        type: boolean
+        description: Attribute is required.
+      options:
+        type: array
+        description: Options of the attribute (key => value pairs for select)
+        items:
+          "$ref": "#/definitions/eav-data-attribute-option-interface"
+      is_user_defined:
+        type: boolean
+        description: Current attribute has been defined by a user.
+      default_frontend_label:
+        type: string
+        description: Frontend label for default store
+      frontend_labels:
+        type: array
+        description: Frontend label for each store
+        items:
+          "$ref": "#/definitions/eav-data-attribute-frontend-label-interface"
+      note:
+        type: string
+        description: The note attribute for the element.
+      backend_type:
+        type: string
+        description: Backend type.
+      backend_model:
+        type: string
+        description: Backend model
+      source_model:
+        type: string
+        description: Source model
+      default_value:
+        type: string
+        description: Default value for the element.
+      is_unique:
+        type: string
+        description: This is a unique attribute
+      frontend_class:
+        type: string
+        description: Frontend class of attribute
+      validation_rules:
+        type: array
+        description: Validation rules.
+        items:
+          "$ref": "#/definitions/eav-data-attribute-validation-rule-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - attribute_code
+    - frontend_input
+    - entity_type_id
+    - is_required
+    - frontend_labels
+  catalog-data-eav-attribute-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\EavAttributeInterface
+  catalog-data-category-attribute-search-results-interface:
+    type: object
+    description: ''
+    properties:
+      items:
+        type: array
+        description: Attributes list.
+        items:
+          "$ref": "#/definitions/catalog-data-category-attribute-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  catalog-data-product-type-interface:
+    type: object
+    description: Product type details
+    properties:
+      name:
+        type: string
+        description: Product type code
+      label:
+        type: string
+        description: Product type label
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-type-extension-interface"
+    required:
+    - name
+    - label
+  catalog-data-product-type-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductTypeInterface
+  eav-data-attribute-group-search-results-interface:
+    type: object
+    description: Interface AttributeGroupSearchResultsInterface
+    properties:
+      items:
+        type: array
+        description: Attribute sets list.
+        items:
+          "$ref": "#/definitions/eav-data-attribute-group-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  eav-data-attribute-group-interface:
+    type: object
+    description: Interface AttributeGroupInterface
+    properties:
+      attribute_group_id:
+        type: string
+        description: Id
+      attribute_group_name:
+        type: string
+        description: Name
+      attribute_set_id:
+        type: integer
+        description: Attribute set id
+      extension_attributes:
+        "$ref": "#/definitions/eav-data-attribute-group-extension-interface"
+  eav-data-attribute-group-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Eav\Api\Data\AttributeGroupInterface
+    properties:
+      attribute_group_code:
+        type: string
+      sort_order:
+        type: string
+  catalog-data-tier-price-interface:
+    type: object
+    description: Tier price interface.
+    properties:
+      price:
+        type: number
+        description: Tier price.
+      price_type:
+        type: string
+        description: Tier price type.
+      website_id:
+        type: integer
+        description: Website id.
+      sku:
+        type: string
+        description: SKU.
+      customer_group:
+        type: string
+        description: Customer group.
+      quantity:
+        type: number
+        description: Quantity.
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-tier-price-extension-interface"
+    required:
+    - price
+    - price_type
+    - website_id
+    - sku
+    - customer_group
+    - quantity
+  catalog-data-tier-price-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\TierPriceInterface
+  catalog-data-price-update-result-interface:
+    type: object
+    description: Interface returned in case of incorrect price passed to efficient
+      price API.
+    properties:
+      message:
+        type: string
+        description: Error message, that contains description of error occurred during
+          price update.
+      parameters:
+        type: array
+        description: Parameters, that could be displayed in error message placeholders.
+        items:
+          type: string
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-price-update-result-extension-interface"
+    required:
+    - message
+    - parameters
+  catalog-data-price-update-result-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\PriceUpdateResultInterface
+  catalog-data-base-price-interface:
+    type: object
+    description: Price interface.
+    properties:
+      price:
+        type: number
+        description: Price.
+      store_id:
+        type: integer
+        description: Store id.
+      sku:
+        type: string
+        description: SKU.
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-base-price-extension-interface"
+    required:
+    - price
+    - store_id
+    - sku
+  catalog-data-base-price-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\BasePriceInterface
+  catalog-data-cost-interface:
+    type: object
+    description: Cost interface.
+    properties:
+      cost:
+        type: number
+        description: Cost value.
+      store_id:
+        type: integer
+        description: Store id.
+      sku:
+        type: string
+        description: SKU.
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-cost-extension-interface"
+    required:
+    - cost
+    - store_id
+    - sku
+  catalog-data-cost-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CostInterface
+  catalog-data-special-price-interface:
+    type: object
+    description: Product Special Price Interface is used to encapsulate data that
+      can be processed by efficient price API.
+    properties:
+      price:
+        type: number
+        description: Product special price value.
+      store_id:
+        type: integer
+        description: ID of store, that contains special price value.
+      sku:
+        type: string
+        description: SKU of product, that contains special price value.
+      price_from:
+        type: string
+        description: Start date for special price in Y-m-d H:i:s format.
+      price_to:
+        type: string
+        description: End date for special price in Y-m-d H:i:s format.
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-special-price-extension-interface"
+    required:
+    - price
+    - store_id
+    - sku
+    - price_from
+    - price_to
+  catalog-data-special-price-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\SpecialPriceInterface
+  catalog-data-category-interface:
+    type: object
+    description: Category data interface.
+    properties:
+      id:
+        type: integer
+        description: Category id.
+      parent_id:
+        type: integer
+        description: Parent category ID
+      name:
+        type: string
+        description: Category name
+      is_active:
+        type: boolean
+        description: Whether category is active
+      position:
+        type: integer
+        description: Category position
+      level:
+        type: integer
+        description: Category level
+      children:
+        type: string
+        description: Children ids comma separated.
+      created_at:
+        type: string
+        description: Category creation date and time.
+      updated_at:
+        type: string
+        description: Category last update date and time.
+      path:
+        type: string
+        description: Category full path.
+      available_sort_by:
+        type: array
+        description: Available sort by for category.
+        items:
+          type: string
+      include_in_menu:
+        type: boolean
+        description: Category is included in menu.
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-category-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+  catalog-data-category-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryInterface
+  catalog-data-category-tree-interface:
+    type: object
+    description: ''
+    properties:
+      id:
+        type: integer
+        description: Id
+      parent_id:
+        type: integer
+        description: Parent category ID
+      name:
+        type: string
+        description: Category name
+      is_active:
+        type: boolean
+        description: Whether category is active
+      position:
+        type: integer
+        description: Category position
+      level:
+        type: integer
+        description: Category level
+      product_count:
+        type: integer
+        description: Product count
+      children_data:
+        type: array
+        description: Children Data
+        items:
+          "$ref": "#/definitions/catalog-data-category-tree-interface"
+    required:
+    - parent_id
+    - name
+    - is_active
+    - position
+    - level
+    - product_count
+    - children_data
+  catalog-data-category-search-results-interface:
+    type: object
+    description: ''
+    properties:
+      items:
+        type: array
+        description: Categories
+        items:
+          "$ref": "#/definitions/catalog-data-category-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  catalog-data-product-custom-option-type-interface:
+    type: object
+    description: ''
+    properties:
+      label:
+        type: string
+        description: Option type label
+      code:
+        type: string
+        description: Option type code
+      group:
+        type: string
+        description: Option type group
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-custom-option-type-extension-interface"
+    required:
+    - label
+    - code
+    - group
+  catalog-data-product-custom-option-type-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductCustomOptionTypeInterface
+  catalog-data-product-link-type-interface:
+    type: object
+    description: ''
+    properties:
+      code:
+        type: integer
+        description: Link type code
+      name:
+        type: string
+        description: Link type name
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-link-type-extension-interface"
+    required:
+    - code
+    - name
+  catalog-data-product-link-type-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductLinkTypeInterface
+  catalog-data-product-link-attribute-interface:
+    type: object
+    description: ''
+    properties:
+      code:
+        type: string
+        description: Attribute code
+      type:
+        type: string
+        description: Attribute type
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-link-attribute-extension-interface"
+    required:
+    - code
+    - type
+  catalog-data-product-link-attribute-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductLinkAttributeInterface
+  catalog-data-category-product-link-interface:
+    type: object
+    description: ''
+    properties:
+      sku:
+        type: string
+      position:
+        type: integer
+      category_id:
+        type: string
+        description: Category id
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-category-product-link-extension-interface"
+    required:
+    - category_id
+  catalog-data-category-product-link-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryProductLinkInterface
+  catalog-data-product-website-link-interface:
+    type: object
+    description: ''
+    properties:
+      sku:
+        type: string
+      website_id:
+        type: integer
+        description: Website ids
+    required:
+    - sku
+    - website_id
+  catalog-data-product-render-search-results-interface:
+    type: object
+    description: Dto that holds render information about products
+    properties:
+      items:
+        type: array
+        description: List of products rendered information
+        items:
+          "$ref": "#/definitions/catalog-data-product-render-interface"
+    required:
+    - items
+  catalog-data-product-render-interface:
+    type: object
+    description: Represents Data Object which holds enough information to render product
+      This information is put into part as Add To Cart or Add to Compare Data or Price
+      Data
+    properties:
+      add_to_cart_button:
+        "$ref": "#/definitions/catalog-data-product-render-button-interface"
+      add_to_compare_button:
+        "$ref": "#/definitions/catalog-data-product-render-button-interface"
+      price_info:
+        "$ref": "#/definitions/catalog-data-product-render-price-info-interface"
+      images:
+        type: array
+        description: Enough information, that needed to render image on front
+        items:
+          "$ref": "#/definitions/catalog-data-product-render-image-interface"
+      url:
+        type: string
+        description: Product url
+      id:
+        type: integer
+        description: Product identifier
+      name:
+        type: string
+        description: Product name
+      type:
+        type: string
+        description: Product type. Such as bundle, grouped, simple, etc...
+      is_salable:
+        type: string
+        description: Information about product saleability (In Stock)
+      store_id:
+        type: integer
+        description: Information about current store id or requested store id
+      currency_code:
+        type: string
+        description: Current or desired currency code to product
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-extension-interface"
+    required:
+    - add_to_cart_button
+    - add_to_compare_button
+    - price_info
+    - images
+    - url
+    - id
+    - name
+    - type
+    - is_salable
+    - store_id
+    - currency_code
+    - extension_attributes
+  catalog-data-product-render-button-interface:
+    type: object
+    description: 'Button interface. This interface represents all manner of product
+      buttons: add to cart, add to compare, etc... The buttons describes by this interface
+      should have interaction with backend'
+    properties:
+      post_data:
+        type: string
+        description: Post data
+      url:
+        type: string
+        description: Url, needed to add product to cart
+      required_options:
+        type: boolean
+        description: Flag whether a product has options or not
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-button-extension-interface"
+    required:
+    - post_data
+    - url
+    - required_options
+  catalog-data-product-render-button-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface
+  catalog-data-product-render-price-info-interface:
+    type: object
+    description: Price interface.
+    properties:
+      final_price:
+        type: number
+        description: Final price
+      max_price:
+        type: number
+        description: Max price of a product
+      max_regular_price:
+        type: number
+        description: Max regular price
+      minimal_regular_price:
+        type: number
+        description: Minimal regular price
+      special_price:
+        type: number
+        description: Special price
+      minimal_price:
+        type: number
+        description: Minimal price
+      regular_price:
+        type: number
+        description: Regular price
+      formatted_prices:
+        "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-interface"
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-price-info-extension-interface"
+    required:
+    - final_price
+    - max_price
+    - max_regular_price
+    - minimal_regular_price
+    - special_price
+    - minimal_price
+    - regular_price
+    - formatted_prices
+  catalog-data-product-render-formatted-price-info-interface:
+    type: object
+    description: 'Formatted Price interface. Aggregate formatted html with price representations.
+      E.g.: $9.00 Consider currency, rounding and html'
+    properties:
+      final_price:
+        type: string
+        description: Html with final price
+      max_price:
+        type: string
+        description: Max price of a product
+      minimal_price:
+        type: string
+        description: The minimal price of the product or variation
+      max_regular_price:
+        type: string
+        description: Max regular price
+      minimal_regular_price:
+        type: string
+        description: Minimal regular price
+      special_price:
+        type: string
+        description: Special price
+      regular_price:
+        type: string
+        description: Price - is price of product without discounts and special price
+          with taxes and fixed product tax
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-extension-interface"
+    required:
+    - final_price
+    - max_price
+    - minimal_price
+    - max_regular_price
+    - minimal_regular_price
+    - special_price
+    - regular_price
+  catalog-data-product-render-formatted-price-info-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\FormattedPriceInfoInterface
+  catalog-data-product-render-price-info-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface
+    properties:
+      msrp:
+        "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-interface"
+      tax_adjustments:
+        "$ref": "#/definitions/catalog-data-product-render-price-info-interface"
+      weee_attributes:
+        type: array
+        items:
+          "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-interface"
+      weee_adjustment:
+        type: string
+  msrp-data-product-render-msrp-price-info-interface:
+    type: object
+    description: Price interface.
+    properties:
+      msrp_price:
+        type: string
+      is_applicable:
+        type: string
+      is_shown_price_on_gesture:
+        type: string
+      msrp_message:
+        type: string
+      explanation_message:
+        type: string
+      extension_attributes:
+        "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-extension-interface"
+    required:
+    - msrp_price
+    - is_applicable
+    - is_shown_price_on_gesture
+    - msrp_message
+    - explanation_message
+  msrp-data-product-render-msrp-price-info-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface
+  weee-data-product-render-weee-adjustment-attribute-interface:
+    type: object
+    description: List of all weee attributes, their amounts, etc.., that product has
+    properties:
+      amount:
+        type: string
+        description: Weee attribute amount
+      tax_amount:
+        type: string
+        description: Tax which is calculated to fixed product tax attribute
+      tax_amount_incl_tax:
+        type: string
+        description: Tax amount of weee attribute
+      amount_excl_tax:
+        type: string
+        description: Product amount exclude tax
+      attribute_code:
+        type: string
+        description: Weee attribute code
+      extension_attributes:
+        "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface"
+    required:
+    - amount
+    - tax_amount
+    - tax_amount_incl_tax
+    - amount_excl_tax
+    - attribute_code
+    - extension_attributes
+  weee-data-product-render-weee-adjustment-attribute-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Weee\Api\Data\ProductRender\WeeeAdjustmentAttributeInterface
+  catalog-data-product-render-image-interface:
+    type: object
+    description: Product Render image interface. Represents physical characteristics
+      of image, that can be used in product listing or product view
+    properties:
+      url:
+        type: string
+        description: Image url
+      code:
+        type: string
+        description: Image code
+      height:
+        type: number
+        description: Image height
+      width:
+        type: number
+        description: Image width in px
+      label:
+        type: string
+        description: Image label
+      resized_width:
+        type: number
+        description: Resize width
+      resized_height:
+        type: number
+        description: Resize height
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-image-extension-interface"
+    required:
+    - url
+    - code
+    - height
+    - width
+    - label
+    - resized_width
+    - resized_height
+  catalog-data-product-render-image-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ImageInterface
+  catalog-data-product-render-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRenderInterface
+    properties:
+      wishlist_button:
+        "$ref": "#/definitions/catalog-data-product-render-button-interface"
+      review_html:
+        type: string
+  quote-data-cart-interface:
+    type: object
+    description: Interface CartInterface
+    properties:
+      id:
+        type: integer
+        description: Cart/quote ID.
+      created_at:
+        type: string
+        description: Cart creation date and time. Otherwise, null.
+      updated_at:
+        type: string
+        description: Cart last update date and time. Otherwise, null.
+      converted_at:
+        type: string
+        description: Cart conversion date and time. Otherwise, null.
+      is_active:
+        type: boolean
+        description: Active status flag value. Otherwise, null.
+      is_virtual:
+        type: boolean
+        description: Virtual flag value. Otherwise, null.
+      items:
+        type: array
+        description: Array of items. Otherwise, null.
+        items:
+          "$ref": "#/definitions/quote-data-cart-item-interface"
+      items_count:
+        type: integer
+        description: Number of different items or products in the cart. Otherwise,
+          null.
+      items_qty:
+        type: number
+        description: Total quantity of all cart items. Otherwise, null.
+      customer:
+        "$ref": "#/definitions/customer-data-customer-interface"
+      billing_address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      reserved_order_id:
+        type: string
+        description: Reserved order ID. Otherwise, null.
+      orig_order_id:
+        type: integer
+        description: Original order ID. Otherwise, null.
+      currency:
+        "$ref": "#/definitions/quote-data-currency-interface"
+      customer_is_guest:
+        type: boolean
+        description: For guest customers, false for logged in customers
+      customer_note:
+        type: string
+        description: Notice text
+      customer_note_notify:
+        type: boolean
+        description: Customer notification flag
+      customer_tax_class_id:
+        type: integer
+        description: Customer tax class ID.
+      store_id:
+        type: integer
+        description: Store identifier
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-cart-extension-interface"
+    required:
+    - id
+    - customer
+    - store_id
+  quote-data-cart-item-interface:
+    type: object
+    description: Interface CartItemInterface
+    properties:
+      item_id:
+        type: integer
+        description: Item ID. Otherwise, null.
+      sku:
+        type: string
+        description: Product SKU. Otherwise, null.
+      qty:
+        type: number
+        description: Product quantity.
+      name:
+        type: string
+        description: Product name. Otherwise, null.
+      price:
+        type: number
+        description: Product price. Otherwise, null.
+      product_type:
+        type: string
+        description: Product type. Otherwise, null.
+      quote_id:
+        type: string
+        description: Quote id.
+      product_option:
+        "$ref": "#/definitions/quote-data-product-option-interface"
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-cart-item-extension-interface"
+    required:
+    - qty
+    - quote_id
+  quote-data-product-option-interface:
+    type: object
+    description: Product option interface
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-product-option-extension-interface"
+  quote-data-product-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface
+    properties:
+      custom_options:
+        type: array
+        items:
+          "$ref": "#/definitions/catalog-data-custom-option-interface"
+      bundle_options:
+        type: array
+        items:
+          "$ref": "#/definitions/bundle-data-bundle-option-interface"
+      downloadable_option:
+        "$ref": "#/definitions/downloadable-data-downloadable-option-interface"
+      giftcard_item_option:
+        "$ref": "#/definitions/gift-card-data-gift-card-option-interface"
+      configurable_item_options:
+        type: array
+        items:
+          "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-interface"
+      grouped_options:
+        type: array
+        items:
+          "$ref": "#/definitions/grouped-product-data-grouped-options-interface"
+  catalog-data-custom-option-interface:
+    type: object
+    description: Interface CustomOptionInterface
+    properties:
+      option_id:
+        type: string
+        description: Option id
+      option_value:
+        type: string
+        description: Option value
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-custom-option-extension-interface"
+    required:
+    - option_id
+    - option_value
+  catalog-data-custom-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface
+    properties:
+      file_info:
+        "$ref": "#/definitions/framework-data-image-content-interface"
+  bundle-data-bundle-option-interface:
+    type: object
+    description: Interface BundleOptionInterface
+    properties:
+      option_id:
+        type: integer
+        description: Bundle option id.
+      option_qty:
+        type: integer
+        description: Bundle option quantity.
+      option_selections:
+        type: array
+        description: Bundle option selection ids.
+        items:
+          type: integer
+      extension_attributes:
+        "$ref": "#/definitions/bundle-data-bundle-option-extension-interface"
+    required:
+    - option_id
+    - option_qty
+    - option_selections
+  bundle-data-bundle-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface
+  downloadable-data-downloadable-option-interface:
+    type: object
+    description: Downloadable Option
+    properties:
+      downloadable_links:
+        type: array
+        description: The list of downloadable links
+        items:
+          type: integer
+    required:
+    - downloadable_links
+  gift-card-data-gift-card-option-interface:
+    type: object
+    description: Interface GiftCardOptionInterface
+    properties:
+      giftcard_amount:
+        type: string
+        description: Gift card amount.
+      custom_giftcard_amount:
+        type: number
+        description: Gift card open amount value.
+      giftcard_sender_name:
+        type: string
+        description: Gift card sender name.
+      giftcard_recipient_name:
+        type: string
+        description: Gift card recipient name.
+      giftcard_sender_email:
+        type: string
+        description: Gift card sender email.
+      giftcard_recipient_email:
+        type: string
+        description: Gift card recipient email.
+      giftcard_message:
+        type: string
+        description: Giftcard message.
+      extension_attributes:
+        "$ref": "#/definitions/gift-card-data-gift-card-option-extension-interface"
+    required:
+    - giftcard_amount
+    - giftcard_sender_name
+    - giftcard_recipient_name
+    - giftcard_sender_email
+    - giftcard_recipient_email
+  gift-card-data-gift-card-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface
+    properties:
+      giftcard_created_codes:
+        type: array
+        items:
+          type: string
+  configurable-product-data-configurable-item-option-value-interface:
+    type: object
+    description: Interface ConfigurableItemOptionValueInterface
+    properties:
+      option_id:
+        type: string
+        description: Option SKU
+      option_value:
+        type: integer
+        description: Item id
+      extension_attributes:
+        "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-extension-interface"
+    required:
+    - option_id
+  configurable-product-data-configurable-item-option-value-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface
+  grouped-product-data-grouped-options-interface:
+    type: object
+    description: Represents `product item id with qty` of a grouped product.
+    properties:
+      id:
+        type: integer
+        description: Associated product id
+      qty:
+        type: integer
+        description: Associated product qty
+      extension_attributes:
+        "$ref": "#/definitions/grouped-product-data-grouped-options-extension-interface"
+  grouped-product-data-grouped-options-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface
+  quote-data-cart-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface
+    properties:
+      discounts:
+        type: array
+        items:
+          "$ref": "#/definitions/sales-rule-data-rule-discount-interface"
+      negotiable_quote_item:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-interface"
+  negotiable-quote-data-negotiable-quote-item-interface:
+    type: object
+    description: Interface CompanyQuoteConfigInterface
+    properties:
+      item_id:
+        type: integer
+        description: Quote item id
+      original_price:
+        type: number
+        description: Quote item original price
+      original_tax_amount:
+        type: number
+        description: Quote item original tax amount
+      original_discount_amount:
+        type: number
+        description: Quote item original discount amount
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-extension-interface"
+    required:
+    - item_id
+    - original_price
+    - original_tax_amount
+    - original_discount_amount
+  negotiable-quote-data-negotiable-quote-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface
+    properties:
+      negotiated_price_type:
+        type: integer
+      negotiated_price_value:
+        type: number
+      last_item_notes:
+        type: array
+        items:
+          "$ref": "#/definitions/negotiable-quote-data-item-note-interface"
+      is_discounting_locked:
+        type: boolean
+      min_qty:
+        type: number
+      max_qty:
+        type: number
+  negotiable-quote-data-item-note-interface:
+    type: object
+    description: Interface ItemNoteInterface
+    properties:
+      note_id:
+        type: integer
+        description: Note ID.
+      negotiable_quote_item_id:
+        type: integer
+        description: Negotiable quote item Id
+      creator_type:
+        type: integer
+        description: The note creator type.
+      creator_id:
+        type: integer
+        description: Note creator ID.
+      note:
+        type: string
+        description: Note.
+      created_at:
+        type: string
+        description: Comment created at.
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-item-note-extension-interface"
+    required:
+    - negotiable_quote_item_id
+    - creator_type
+    - creator_id
+    - note
+  negotiable-quote-data-item-note-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\ItemNoteInterface
+  quote-data-address-interface:
+    type: object
+    description: Interface AddressInterface
+    properties:
+      id:
+        type: integer
+        description: Id
+      region:
+        type: string
+        description: Region name
+      region_id:
+        type: integer
+        description: Region id
+      region_code:
+        type: string
+        description: Region code
+      country_id:
+        type: string
+        description: Country id
+      street:
+        type: array
+        description: Street
+        items:
+          type: string
+      company:
+        type: string
+        description: Company
+      telephone:
+        type: string
+        description: Telephone number
+      fax:
+        type: string
+        description: Fax number
+      postcode:
+        type: string
+        description: Postcode
+      city:
+        type: string
+        description: City name
+      firstname:
+        type: string
+        description: First name
+      lastname:
+        type: string
+        description: Last name
+      middlename:
+        type: string
+        description: Middle name
+      prefix:
+        type: string
+        description: Prefix
+      suffix:
+        type: string
+        description: Suffix
+      vat_id:
+        type: string
+        description: Vat id
+      customer_id:
+        type: integer
+        description: Customer id
+      email:
+        type: string
+        description: Billing/shipping email
+      same_as_billing:
+        type: integer
+        description: Same as billing flag
+      customer_address_id:
+        type: integer
+        description: Customer address id
+      save_in_address_book:
+        type: integer
+        description: Save in address book flag
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-address-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - region
+    - region_id
+    - region_code
+    - country_id
+    - street
+    - telephone
+    - postcode
+    - city
+    - firstname
+    - lastname
+    - email
+  quote-data-address-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface
+    properties:
+      discounts:
+        type: array
+        items:
+          "$ref": "#/definitions/sales-rule-data-rule-discount-interface"
+      gift_registry_id:
+        type: integer
+      pickup_location_code:
+        type: string
+  quote-data-currency-interface:
+    type: object
+    description: Interface CurrencyInterface
+    properties:
+      global_currency_code:
+        type: string
+        description: Global currency code
+      base_currency_code:
+        type: string
+        description: Base currency code
+      store_currency_code:
+        type: string
+        description: Store currency code
+      quote_currency_code:
+        type: string
+        description: Quote currency code
+      store_to_base_rate:
+        type: number
+        description: Store currency to base currency rate
+      store_to_quote_rate:
+        type: number
+        description: Store currency to quote currency rate
+      base_to_global_rate:
+        type: number
+        description: Base currency to global currency rate
+      base_to_quote_rate:
+        type: number
+        description: Base currency to quote currency rate
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-currency-extension-interface"
+  quote-data-currency-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface
+  quote-data-cart-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface
+    properties:
+      shipping_assignments:
+        type: array
+        items:
+          "$ref": "#/definitions/quote-data-shipping-assignment-interface"
+      negotiable_quote:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-interface"
+      company_id:
+        type: integer
+      coupon_codes:
+        type: array
+        items:
+          type: string
+  quote-data-shipping-assignment-interface:
+    type: object
+    description: Interface ShippingAssignmentInterface
+    properties:
+      shipping:
+        "$ref": "#/definitions/quote-data-shipping-interface"
+      items:
+        type: array
+        items:
+          "$ref": "#/definitions/quote-data-cart-item-interface"
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-shipping-assignment-extension-interface"
+    required:
+    - shipping
+    - items
+  quote-data-shipping-interface:
+    type: object
+    description: Interface ShippingInterface
+    properties:
+      address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      method:
+        type: string
+        description: Shipping method
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-shipping-extension-interface"
+    required:
+    - address
+    - method
+  quote-data-shipping-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface
+  quote-data-shipping-assignment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface
+  negotiable-quote-data-negotiable-quote-interface:
+    type: object
+    description: Interface NegotiableQuoteInterface
+    properties:
+      quote_id:
+        type: integer
+        description: Negotiable quote ID.
+      is_regular_quote:
+        type: boolean
+        description: Is regular quote.
+      status:
+        type: string
+        description: Negotiable quote status.
+      negotiated_price_type:
+        type: integer
+        description: Negotiated price type.
+      negotiated_price_value:
+        type: number
+        description: Negotiated price value.
+      shipping_price:
+        type: number
+        description: Proposed shipping price.
+      quote_name:
+        type: string
+        description: Negotiable quote name.
+      expiration_period:
+        type: string
+        description: Expiration period.
+      email_notification_status:
+        type: integer
+        description: Email notification status.
+      has_unconfirmed_changes:
+        type: boolean
+        description: Has unconfirmed changes.
+      is_shipping_tax_changed:
+        type: boolean
+        description: Shipping tax changes.
+      is_customer_price_changed:
+        type: boolean
+        description: Customer price changes.
+      notifications:
+        type: integer
+        description: Quote notifications.
+      applied_rule_ids:
+        type: string
+        description: Quote rules.
+      is_address_draft:
+        type: boolean
+        description: Is address draft.
+      deleted_sku:
+        type: string
+        description: Deleted products sku.
+      creator_id:
+        type: integer
+        description: Quote creator id.
+      creator_type:
+        type: integer
+        description: Quote creator type.
+      original_total_price:
+        type: number
+        description: Quote original total price.
+      base_original_total_price:
+        type: number
+        description: Quote original total price in base currency.
+      negotiated_total_price:
+        type: number
+        description: Quote negotiated total price.
+      base_negotiated_total_price:
+        type: number
+        description: Quote negotiated total price in base currency.
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-extension-interface"
+    required:
+    - quote_id
+    - is_regular_quote
+    - status
+    - negotiated_price_type
+    - negotiated_price_value
+    - shipping_price
+    - quote_name
+    - expiration_period
+    - email_notification_status
+    - has_unconfirmed_changes
+    - is_shipping_tax_changed
+    - is_customer_price_changed
+    - notifications
+    - applied_rule_ids
+    - is_address_draft
+    - deleted_sku
+    - creator_id
+    - creator_type
+  negotiable-quote-data-negotiable-quote-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface
+  quote-data-cart-search-results-interface:
+    type: object
+    description: Interface CartSearchResultsInterface
+    properties:
+      items:
+        type: array
+        description: Carts list.
+        items:
+          "$ref": "#/definitions/quote-data-cart-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  quote-data-payment-interface:
+    type: object
+    description: Interface PaymentInterface
+    properties:
+      po_number:
+        type: string
+        description: Purchase order number
+      method:
+        type: string
+        description: Payment method code
+      additional_data:
+        type: array
+        description: Payment additional details
+        items:
+          type: string
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-payment-extension-interface"
+    required:
+    - method
+  quote-data-payment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface
+    properties:
+      agreement_ids:
+        type: array
+        items:
+          type: string
+  quote-data-shipping-method-interface:
+    type: object
+    description: Interface ShippingMethodInterface
+    properties:
+      carrier_code:
+        type: string
+        description: Shipping carrier code.
+      method_code:
+        type: string
+        description: Shipping method code.
+      carrier_title:
+        type: string
+        description: Shipping carrier title. Otherwise, null.
+      method_title:
+        type: string
+        description: Shipping method title. Otherwise, null.
+      amount:
+        type: number
+        description: Shipping amount in store currency.
+      base_amount:
+        type: number
+        description: Shipping amount in base currency.
+      available:
+        type: boolean
+        description: The value of the availability flag for the current shipping method.
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-shipping-method-extension-interface"
+      error_message:
+        type: string
+        description: Shipping Error message.
+      price_excl_tax:
+        type: number
+        description: Shipping price excl tax.
+      price_incl_tax:
+        type: number
+        description: Shipping price incl tax.
+    required:
+    - carrier_code
+    - method_code
+    - amount
+    - base_amount
+    - available
+    - error_message
+    - price_excl_tax
+    - price_incl_tax
+  quote-data-shipping-method-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface
+  quote-data-payment-method-interface:
+    type: object
+    description: Interface PaymentMethodInterface
+    properties:
+      code:
+        type: string
+        description: Payment method code
+      title:
+        type: string
+        description: Payment method title
+    required:
+    - code
+    - title
+  quote-data-totals-interface:
+    type: object
+    description: Interface TotalsInterface
+    properties:
+      grand_total:
+        type: number
+        description: Grand total in quote currency
+      base_grand_total:
+        type: number
+        description: Grand total in base currency
+      subtotal:
+        type: number
+        description: Subtotal in quote currency
+      base_subtotal:
+        type: number
+        description: Subtotal in base currency
+      discount_amount:
+        type: number
+        description: Discount amount in quote currency
+      base_discount_amount:
+        type: number
+        description: Discount amount in base currency
+      subtotal_with_discount:
+        type: number
+        description: Subtotal in quote currency with applied discount
+      base_subtotal_with_discount:
+        type: number
+        description: Subtotal in base currency with applied discount
+      shipping_amount:
+        type: number
+        description: Shipping amount in quote currency
+      base_shipping_amount:
+        type: number
+        description: Shipping amount in base currency
+      shipping_discount_amount:
+        type: number
+        description: Shipping discount amount in quote currency
+      base_shipping_discount_amount:
+        type: number
+        description: Shipping discount amount in base currency
+      tax_amount:
+        type: number
+        description: Tax amount in quote currency
+      base_tax_amount:
+        type: number
+        description: Tax amount in base currency
+      weee_tax_applied_amount:
+        type: number
+        description: Item weee tax applied amount in quote currency.
+      shipping_tax_amount:
+        type: number
+        description: Shipping tax amount in quote currency
+      base_shipping_tax_amount:
+        type: number
+        description: Shipping tax amount in base currency
+      subtotal_incl_tax:
+        type: number
+        description: Subtotal including tax in quote currency
+      base_subtotal_incl_tax:
+        type: number
+        description: Subtotal including tax in base currency
+      shipping_incl_tax:
+        type: number
+        description: Shipping including tax in quote currency
+      base_shipping_incl_tax:
+        type: number
+        description: Shipping including tax in base currency
+      base_currency_code:
+        type: string
+        description: Base currency code
+      quote_currency_code:
+        type: string
+        description: Quote currency code
+      coupon_code:
+        type: string
+        description: Applied coupon code
+      items_qty:
+        type: integer
+        description: Items qty
+      items:
+        type: array
+        description: Totals by items
+        items:
+          "$ref": "#/definitions/quote-data-totals-item-interface"
+      total_segments:
+        type: array
+        description: Dynamically calculated totals
+        items:
+          "$ref": "#/definitions/quote-data-total-segment-interface"
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-totals-extension-interface"
+    required:
+    - weee_tax_applied_amount
+    - total_segments
+  quote-data-totals-item-interface:
+    type: object
+    description: Interface TotalsItemInterface
+    properties:
+      item_id:
+        type: integer
+        description: Item id
+      price:
+        type: number
+        description: Item price in quote currency.
+      base_price:
+        type: number
+        description: Item price in base currency.
+      qty:
+        type: number
+        description: Item quantity.
+      row_total:
+        type: number
+        description: Row total in quote currency.
+      base_row_total:
+        type: number
+        description: Row total in base currency.
+      row_total_with_discount:
+        type: number
+        description: Row total with discount in quote currency. Otherwise, null.
+      tax_amount:
+        type: number
+        description: Tax amount in quote currency. Otherwise, null.
+      base_tax_amount:
+        type: number
+        description: Tax amount in base currency. Otherwise, null.
+      tax_percent:
+        type: number
+        description: Tax percent. Otherwise, null.
+      discount_amount:
+        type: number
+        description: Discount amount in quote currency. Otherwise, null.
+      base_discount_amount:
+        type: number
+        description: Discount amount in base currency. Otherwise, null.
+      discount_percent:
+        type: number
+        description: Discount percent. Otherwise, null.
+      price_incl_tax:
+        type: number
+        description: Price including tax in quote currency. Otherwise, null.
+      base_price_incl_tax:
+        type: number
+        description: Price including tax in base currency. Otherwise, null.
+      row_total_incl_tax:
+        type: number
+        description: Row total including tax in quote currency. Otherwise, null.
+      base_row_total_incl_tax:
+        type: number
+        description: Row total including tax in base currency. Otherwise, null.
+      options:
+        type: string
+        description: Item price in quote currency.
+      weee_tax_applied_amount:
+        type: number
+        description: Item weee tax applied amount in quote currency.
+      weee_tax_applied:
+        type: string
+        description: Item weee tax applied in quote currency.
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-totals-item-extension-interface"
+      name:
+        type: string
+        description: Product name. Otherwise, null.
+    required:
+    - item_id
+    - price
+    - base_price
+    - qty
+    - row_total
+    - base_row_total
+    - options
+    - weee_tax_applied_amount
+    - weee_tax_applied
+  quote-data-totals-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface
+    properties:
+      negotiable_quote_item_totals:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface"
+  negotiable-quote-data-negotiable-quote-item-totals-interface:
+    type: object
+    description: Extension attribute for quote item totals model.
+    properties:
+      cost:
+        type: number
+        description: Cost for quote item.
+      catalog_price:
+        type: number
+        description: Catalog price for quote item.
+      base_catalog_price:
+        type: number
+        description: Catalog price for quote item in base currency.
+      catalog_price_incl_tax:
+        type: number
+        description: Catalog price with included tax for quote item.
+      base_catalog_price_incl_tax:
+        type: number
+        description: Catalog price with included tax for quote item in base currency.
+      cart_price:
+        type: number
+        description: Cart price for quote item.
+      base_cart_price:
+        type: number
+        description: Cart price for quote item in base currency.
+      cart_tax:
+        type: number
+        description: Tax from catalog price for quote item.
+      base_cart_tax:
+        type: number
+        description: Tax from catalog price for quote item in base currency.
+      cart_price_incl_tax:
+        type: number
+        description: Cart price with included tax for quote item.
+      base_cart_price_incl_tax:
+        type: number
+        description: Cart price with included tax for quote item in base currency.
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface"
+    required:
+    - cost
+    - catalog_price
+    - base_catalog_price
+    - catalog_price_incl_tax
+    - base_catalog_price_incl_tax
+    - cart_price
+    - base_cart_price
+    - cart_tax
+    - base_cart_tax
+    - cart_price_incl_tax
+    - base_cart_price_incl_tax
+  negotiable-quote-data-negotiable-quote-item-totals-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface
+  quote-data-total-segment-interface:
+    type: object
+    description: Interface TotalsInterface
+    properties:
+      code:
+        type: string
+        description: Code
+      title:
+        type: string
+        description: Total title
+      value:
+        type: number
+        description: Total value
+      area:
+        type: string
+        description: Display area code.
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-total-segment-extension-interface"
+    required:
+    - code
+    - value
+  quote-data-total-segment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface
+    properties:
+      tax_grandtotal_details:
+        type: array
+        items:
+          "$ref": "#/definitions/tax-data-grand-total-details-interface"
+      gift_cards:
+        type: string
+      gw_order_id:
+        type: string
+      gw_item_ids:
+        type: array
+        items:
+          type: string
+      gw_allow_gift_receipt:
+        type: string
+      gw_add_card:
+        type: string
+      gw_price:
+        type: string
+      gw_base_price:
+        type: string
+      gw_items_price:
+        type: string
+      gw_items_base_price:
+        type: string
+      gw_card_price:
+        type: string
+      gw_card_base_price:
+        type: string
+      gw_base_tax_amount:
+        type: string
+      gw_tax_amount:
+        type: string
+      gw_items_base_tax_amount:
+        type: string
+      gw_items_tax_amount:
+        type: string
+      gw_card_base_tax_amount:
+        type: string
+      gw_card_tax_amount:
+        type: string
+      gw_price_incl_tax:
+        type: string
+      gw_base_price_incl_tax:
+        type: string
+      gw_card_price_incl_tax:
+        type: string
+      gw_card_base_price_incl_tax:
+        type: string
+      gw_items_price_incl_tax:
+        type: string
+      gw_items_base_price_incl_tax:
+        type: string
+  tax-data-grand-total-details-interface:
+    type: object
+    description: Interface GrandTotalDetailsInterface
+    properties:
+      amount:
+        type: number
+        description: Tax amount value
+      rates:
+        type: array
+        description: Tax rates info
+        items:
+          "$ref": "#/definitions/tax-data-grand-total-rates-interface"
+      group_id:
+        type: integer
+        description: Group identifier
+    required:
+    - amount
+    - rates
+    - group_id
+  tax-data-grand-total-rates-interface:
+    type: object
+    description: Interface GrandTotalRatesInterface
+    properties:
+      percent:
+        type: string
+        description: Tax percentage value
+      title:
+        type: string
+        description: Rate title
+    required:
+    - percent
+    - title
+  quote-data-totals-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface
+    properties:
+      coupon_label:
+        type: string
+      negotiable_quote_totals:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-totals-interface"
+      base_customer_balance_amount:
+        type: number
+      customer_balance_amount:
+        type: number
+      coupon_codes:
+        type: array
+        items:
+          type: string
+      coupons_labels:
+        type: array
+        items:
+          type: string
+      reward_points_balance:
+        type: number
+      reward_currency_amount:
+        type: number
+      base_reward_currency_amount:
+        type: number
+  negotiable-quote-data-negotiable-quote-totals-interface:
+    type: object
+    description: Extension attribute for quote totals model.
+    properties:
+      items_count:
+        type: integer
+        description: The number of different items or products in the cart.
+      quote_status:
+        type: string
+        description: Negotiable quote status.
+      created_at:
+        type: string
+        description: The cart creation date and time.
+      updated_at:
+        type: string
+        description: The cart last update date and time.
+      customer_group:
+        type: integer
+        description: Customer group id.
+      base_to_quote_rate:
+        type: number
+        description: Base currency to quote currency rate.
+      cost_total:
+        type: number
+        description: Total cost for quote.
+      base_cost_total:
+        type: number
+        description: Total cost for quote in base currency.
+      original_total:
+        type: number
+        description: Original quote total.
+      base_original_total:
+        type: number
+        description: Original quote total in base currency.
+      original_tax:
+        type: number
+        description: Original tax amount for quote.
+      base_original_tax:
+        type: number
+        description: Original tax amount for quote in base currency.
+      original_price_incl_tax:
+        type: number
+        description: Original price with included tax for quote.
+      base_original_price_incl_tax:
+        type: number
+        description: Original price with included tax for quote in base currency.
+      negotiated_price_type:
+        type: integer
+        description: Negotiable quote type.
+      negotiated_price_value:
+        type: number
+        description: Negotiable price value for quote.
+    required:
+    - items_count
+    - quote_status
+    - created_at
+    - updated_at
+    - customer_group
+    - base_to_quote_rate
+    - cost_total
+    - base_cost_total
+    - original_total
+    - base_original_total
+    - original_tax
+    - base_original_tax
+    - original_price_incl_tax
+    - base_original_price_incl_tax
+    - negotiated_price_type
+    - negotiated_price_value
+  quote-data-totals-additional-data-interface:
+    type: object
+    description: Additional data for totals collection.
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-totals-additional-data-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+  quote-data-totals-additional-data-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface
+    properties:
+      gift_messages:
+        type: array
+        items:
+          "$ref": "#/definitions/gift-message-data-message-interface"
+  gift-message-data-message-interface:
+    type: object
+    description: Interface MessageInterface
+    properties:
+      gift_message_id:
+        type: integer
+        description: Gift message ID. Otherwise, null.
+      customer_id:
+        type: integer
+        description: Customer ID. Otherwise, null.
+      sender:
+        type: string
+        description: Sender name.
+      recipient:
+        type: string
+        description: Recipient name.
+      message:
+        type: string
+        description: Message text.
+      extension_attributes:
+        "$ref": "#/definitions/gift-message-data-message-extension-interface"
+    required:
+    - sender
+    - recipient
+    - message
+  gift-message-data-message-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface
+    properties:
+      entity_id:
+        type: string
+      entity_type:
+        type: string
+      wrapping_id:
+        type: integer
+      wrapping_allow_gift_receipt:
+        type: boolean
+      wrapping_add_printed_card:
+        type: boolean
+  catalog-inventory-data-stock-item-collection-interface:
+    type: object
+    description: Interface StockItemCollectionInterface
+    properties:
+      items:
+        type: array
+        description: Items
+        items:
+          "$ref": "#/definitions/catalog-inventory-data-stock-item-interface"
+      search_criteria:
+        "$ref": "#/definitions/catalog-inventory-stock-item-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  catalog-inventory-stock-item-criteria-interface:
+    type: object
+    description: Interface StockItemCriteriaInterface
+    properties:
+      mapper_interface_name:
+        type: string
+        description: Associated Mapper Interface name
+      criteria_list:
+        type: array
+        description: Criteria objects added to current Composite Criteria
+        items:
+          "$ref": "#/definitions/framework-criteria-interface"
+      filters:
+        type: array
+        description: List of filters
+        items:
+          type: string
+      orders:
+        type: array
+        description: Ordering criteria
+        items:
+          type: string
+      limit:
+        type: array
+        description: Limit
+        items:
+          type: string
+    required:
+    - mapper_interface_name
+    - criteria_list
+    - filters
+    - orders
+    - limit
+  framework-criteria-interface:
+    type: object
+    description: Interface CriteriaInterface
+    properties:
+      mapper_interface_name:
+        type: string
+        description: Associated Mapper Interface name
+      criteria_list:
+        type: array
+        description: Criteria objects added to current Composite Criteria
+        items:
+          "$ref": "#/definitions/framework-criteria-interface"
+      filters:
+        type: array
+        description: List of filters
+        items:
+          type: string
+      orders:
+        type: array
+        description: Ordering criteria
+        items:
+          type: string
+      limit:
+        type: array
+        description: Limit
+        items:
+          type: string
+    required:
+    - mapper_interface_name
+    - criteria_list
+    - filters
+    - orders
+    - limit
+  catalog-inventory-data-stock-status-interface:
+    type: object
+    description: Interface StockStatusInterface
+    properties:
+      product_id:
+        type: integer
+      stock_id:
+        type: integer
+      qty:
+        type: integer
+      stock_status:
+        type: integer
+      stock_item:
+        "$ref": "#/definitions/catalog-inventory-data-stock-item-interface"
+      extension_attributes:
+        "$ref": "#/definitions/catalog-inventory-data-stock-status-extension-interface"
+    required:
+    - product_id
+    - stock_id
+    - qty
+    - stock_status
+    - stock_item
+  catalog-inventory-data-stock-status-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockStatusInterface
+  sales-data-order-interface:
+    type: object
+    description: Order interface. An order is a document that a web store issues to
+      a customer. Magento generates a sales order that lists the product items, billing
+      and shipping addresses, and shipping and payment methods. A corresponding external
+      document, known as a purchase order, is emailed to the customer.
+    properties:
+      adjustment_negative:
+        type: number
+        description: Negative adjustment value.
+      adjustment_positive:
+        type: number
+        description: Positive adjustment value.
+      applied_rule_ids:
+        type: string
+        description: Applied rule IDs.
+      base_adjustment_negative:
+        type: number
+        description: Base negative adjustment value.
+      base_adjustment_positive:
+        type: number
+        description: Base positive adjustment value.
+      base_currency_code:
+        type: string
+        description: Base currency code.
+      base_discount_amount:
+        type: number
+        description: Base discount amount.
+      base_discount_canceled:
+        type: number
+        description: Base discount canceled.
+      base_discount_invoiced:
+        type: number
+        description: Base discount invoiced.
+      base_discount_refunded:
+        type: number
+        description: Base discount refunded.
+      base_grand_total:
+        type: number
+        description: Base grand total.
+      base_discount_tax_compensation_amount:
+        type: number
+        description: Base discount tax compensation amount.
+      base_discount_tax_compensation_invoiced:
+        type: number
+        description: Base discount tax compensation invoiced.
+      base_discount_tax_compensation_refunded:
+        type: number
+        description: Base discount tax compensation refunded.
+      base_shipping_amount:
+        type: number
+        description: Base shipping amount.
+      base_shipping_canceled:
+        type: number
+        description: Base shipping canceled.
+      base_shipping_discount_amount:
+        type: number
+        description: Base shipping discount amount.
+      base_shipping_discount_tax_compensation_amnt:
+        type: number
+        description: Base shipping discount tax compensation amount.
+      base_shipping_incl_tax:
+        type: number
+        description: Base shipping including tax.
+      base_shipping_invoiced:
+        type: number
+        description: Base shipping invoiced.
+      base_shipping_refunded:
+        type: number
+        description: Base shipping refunded.
+      base_shipping_tax_amount:
+        type: number
+        description: Base shipping tax amount.
+      base_shipping_tax_refunded:
+        type: number
+        description: Base shipping tax refunded.
+      base_subtotal:
+        type: number
+        description: Base subtotal.
+      base_subtotal_canceled:
+        type: number
+        description: Base subtotal canceled.
+      base_subtotal_incl_tax:
+        type: number
+        description: Base subtotal including tax.
+      base_subtotal_invoiced:
+        type: number
+        description: Base subtotal invoiced.
+      base_subtotal_refunded:
+        type: number
+        description: Base subtotal refunded.
+      base_tax_amount:
+        type: number
+        description: Base tax amount.
+      base_tax_canceled:
+        type: number
+        description: Base tax canceled.
+      base_tax_invoiced:
+        type: number
+        description: Base tax invoiced.
+      base_tax_refunded:
+        type: number
+        description: Base tax refunded.
+      base_total_canceled:
+        type: number
+        description: Base total canceled.
+      base_total_due:
+        type: number
+        description: Base total due.
+      base_total_invoiced:
+        type: number
+        description: Base total invoiced.
+      base_total_invoiced_cost:
+        type: number
+        description: Base total invoiced cost.
+      base_total_offline_refunded:
+        type: number
+        description: Base total offline refunded.
+      base_total_online_refunded:
+        type: number
+        description: Base total online refunded.
+      base_total_paid:
+        type: number
+        description: Base total paid.
+      base_total_qty_ordered:
+        type: number
+        description: Base total quantity ordered.
+      base_total_refunded:
+        type: number
+        description: Base total refunded.
+      base_to_global_rate:
+        type: number
+        description: Base-to-global rate.
+      base_to_order_rate:
+        type: number
+        description: Base-to-order rate.
+      billing_address_id:
+        type: integer
+        description: Billing address ID.
+      can_ship_partially:
+        type: integer
+        description: Can-ship-partially flag value.
+      can_ship_partially_item:
+        type: integer
+        description: Can-ship-partially-item flag value.
+      coupon_code:
+        type: string
+        description: Coupon code.
+      created_at:
+        type: string
+        description: Created-at timestamp.
+      customer_dob:
+        type: string
+        description: In keeping with current security and privacy best practices,
+          be sure you are aware of any potential legal and security risks associated
+          with the storage of customers’ full date of birth (month, day, year) along
+          with other personal identifiers (e.g., full name) before collecting or processing
+          such data.
+      customer_email:
+        type: string
+        description: Customer email address.
+      customer_firstname:
+        type: string
+        description: Customer first name.
+      customer_gender:
+        type: integer
+        description: Customer gender.
+      customer_group_id:
+        type: integer
+        description: Customer group ID.
+      customer_id:
+        type: integer
+        description: Customer ID.
+      customer_is_guest:
+        type: integer
+        description: Customer-is-guest flag value.
+      customer_lastname:
+        type: string
+        description: Customer last name.
+      customer_middlename:
+        type: string
+        description: Customer middle name.
+      customer_note:
+        type: string
+        description: Customer note.
+      customer_note_notify:
+        type: integer
+        description: Customer-note-notify flag value.
+      customer_prefix:
+        type: string
+        description: Customer prefix.
+      customer_suffix:
+        type: string
+        description: Customer suffix.
+      customer_taxvat:
+        type: string
+        description: Customer value-added tax (VAT).
+      discount_amount:
+        type: number
+        description: Discount amount.
+      discount_canceled:
+        type: number
+        description: Discount canceled.
+      discount_description:
+        type: string
+        description: Discount description.
+      discount_invoiced:
+        type: number
+        description: Discount invoiced.
+      discount_refunded:
+        type: number
+        description: Discount refunded amount.
+      edit_increment:
+        type: integer
+        description: Edit increment value.
+      email_sent:
+        type: integer
+        description: Email-sent flag value.
+      entity_id:
+        type: integer
+        description: Order ID.
+      ext_customer_id:
+        type: string
+        description: External customer ID.
+      ext_order_id:
+        type: string
+        description: External order ID.
+      forced_shipment_with_invoice:
+        type: integer
+        description: Forced-shipment-with-invoice flag value.
+      global_currency_code:
+        type: string
+        description: Global currency code.
+      grand_total:
+        type: number
+        description: Grand total.
+      discount_tax_compensation_amount:
+        type: number
+        description: Discount tax compensation amount.
+      discount_tax_compensation_invoiced:
+        type: number
+        description: Discount tax compensation invoiced amount.
+      discount_tax_compensation_refunded:
+        type: number
+        description: Discount tax compensation refunded amount.
+      hold_before_state:
+        type: string
+        description: Hold before state.
+      hold_before_status:
+        type: string
+        description: Hold before status.
+      increment_id:
+        type: string
+        description: Increment ID.
+      is_virtual:
+        type: integer
+        description: Is-virtual flag value.
+      order_currency_code:
+        type: string
+        description: Order currency code.
+      original_increment_id:
+        type: string
+        description: Original increment ID.
+      payment_authorization_amount:
+        type: number
+        description: Payment authorization amount.
+      payment_auth_expiration:
+        type: integer
+        description: Payment authorization expiration date.
+      protect_code:
+        type: string
+        description: Protect code.
+      quote_address_id:
+        type: integer
+        description: Quote address ID.
+      quote_id:
+        type: integer
+        description: Quote ID.
+      relation_child_id:
+        type: string
+        description: Relation child ID.
+      relation_child_real_id:
+        type: string
+        description: Relation child real ID.
+      relation_parent_id:
+        type: string
+        description: Relation parent ID.
+      relation_parent_real_id:
+        type: string
+        description: Relation parent real ID.
+      remote_ip:
+        type: string
+        description: Remote IP address.
+      shipping_amount:
+        type: number
+        description: Shipping amount.
+      shipping_canceled:
+        type: number
+        description: Shipping canceled amount.
+      shipping_description:
+        type: string
+        description: Shipping description.
+      shipping_discount_amount:
+        type: number
+        description: Shipping discount amount.
+      shipping_discount_tax_compensation_amount:
+        type: number
+        description: Shipping discount tax compensation amount.
+      shipping_incl_tax:
+        type: number
+        description: Shipping including tax amount.
+      shipping_invoiced:
+        type: number
+        description: Shipping invoiced amount.
+      shipping_refunded:
+        type: number
+        description: Shipping refunded amount.
+      shipping_tax_amount:
+        type: number
+        description: Shipping tax amount.
+      shipping_tax_refunded:
+        type: number
+        description: Shipping tax refunded amount.
+      state:
+        type: string
+        description: State.
+      status:
+        type: string
+        description: Status.
+      store_currency_code:
+        type: string
+        description: Store currency code.
+      store_id:
+        type: integer
+        description: Store ID.
+      store_name:
+        type: string
+        description: Store name.
+      store_to_base_rate:
+        type: number
+        description: Store-to-base rate.
+      store_to_order_rate:
+        type: number
+        description: Store-to-order rate.
+      subtotal:
+        type: number
+        description: Subtotal.
+      subtotal_canceled:
+        type: number
+        description: Subtotal canceled amount.
+      subtotal_incl_tax:
+        type: number
+        description: Subtotal including tax amount.
+      subtotal_invoiced:
+        type: number
+        description: Subtotal invoiced amount.
+      subtotal_refunded:
+        type: number
+        description: Subtotal refunded amount.
+      tax_amount:
+        type: number
+        description: Tax amount.
+      tax_canceled:
+        type: number
+        description: Tax canceled amount.
+      tax_invoiced:
+        type: number
+        description: Tax invoiced amount.
+      tax_refunded:
+        type: number
+        description: Tax refunded amount.
+      total_canceled:
+        type: number
+        description: Total canceled.
+      total_due:
+        type: number
+        description: Total due.
+      total_invoiced:
+        type: number
+        description: Total invoiced amount.
+      total_item_count:
+        type: integer
+        description: Total item count.
+      total_offline_refunded:
+        type: number
+        description: Total offline refunded amount.
+      total_online_refunded:
+        type: number
+        description: Total online refunded amount.
+      total_paid:
+        type: number
+        description: Total paid.
+      total_qty_ordered:
+        type: number
+        description: Total quantity ordered.
+      total_refunded:
+        type: number
+        description: Total amount refunded.
+      updated_at:
+        type: string
+        description: Updated-at timestamp.
+      weight:
+        type: number
+        description: Weight.
+      x_forwarded_for:
+        type: string
+        description: X-Forwarded-For field value.
+      items:
+        type: array
+        description: Array of items.
+        items:
+          "$ref": "#/definitions/sales-data-order-item-interface"
+      billing_address:
+        "$ref": "#/definitions/sales-data-order-address-interface"
+      payment:
+        "$ref": "#/definitions/sales-data-order-payment-interface"
+      status_histories:
+        type: array
+        description: Array of status histories.
+        items:
+          "$ref": "#/definitions/sales-data-order-status-history-interface"
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-order-extension-interface"
+    required:
+    - base_grand_total
+    - customer_email
+    - grand_total
+    - items
+  sales-data-order-item-interface:
+    type: object
+    description: Order item interface. An order is a document that a web store issues
+      to a customer. Magento generates a sales order that lists the product items,
+      billing and shipping addresses, and shipping and payment methods. A corresponding
+      external document, known as a purchase order, is emailed to the customer.
+    properties:
+      additional_data:
+        type: string
+        description: Additional data.
+      amount_refunded:
+        type: number
+        description: Amount refunded.
+      applied_rule_ids:
+        type: string
+        description: Applied rule IDs.
+      base_amount_refunded:
+        type: number
+        description: Base amount refunded.
+      base_cost:
+        type: number
+        description: Base cost.
+      base_discount_amount:
+        type: number
+        description: Base discount amount.
+      base_discount_invoiced:
+        type: number
+        description: Base discount invoiced.
+      base_discount_refunded:
+        type: number
+        description: Base discount refunded.
+      base_discount_tax_compensation_amount:
+        type: number
+        description: Base discount tax compensation amount.
+      base_discount_tax_compensation_invoiced:
+        type: number
+        description: Base discount tax compensation invoiced.
+      base_discount_tax_compensation_refunded:
+        type: number
+        description: Base discount tax compensation refunded.
+      base_original_price:
+        type: number
+        description: Base original price.
+      base_price:
+        type: number
+        description: Base price.
+      base_price_incl_tax:
+        type: number
+        description: Base price including tax.
+      base_row_invoiced:
+        type: number
+        description: Base row invoiced.
+      base_row_total:
+        type: number
+        description: Base row total.
+      base_row_total_incl_tax:
+        type: number
+        description: Base row total including tax.
+      base_tax_amount:
+        type: number
+        description: Base tax amount.
+      base_tax_before_discount:
+        type: number
+        description: Base tax before discount.
+      base_tax_invoiced:
+        type: number
+        description: Base tax invoiced.
+      base_tax_refunded:
+        type: number
+        description: Base tax refunded.
+      base_weee_tax_applied_amount:
+        type: number
+        description: Base WEEE tax applied amount.
+      base_weee_tax_applied_row_amnt:
+        type: number
+        description: Base WEEE tax applied row amount.
+      base_weee_tax_disposition:
+        type: number
+        description: Base WEEE tax disposition.
+      base_weee_tax_row_disposition:
+        type: number
+        description: Base WEEE tax row disposition.
+      created_at:
+        type: string
+        description: Created-at timestamp.
+      description:
+        type: string
+        description: Description.
+      discount_amount:
+        type: number
+        description: Discount amount.
+      discount_invoiced:
+        type: number
+        description: Discount invoiced.
+      discount_percent:
+        type: number
+        description: Discount percent.
+      discount_refunded:
+        type: number
+        description: Discount refunded.
+      event_id:
+        type: integer
+        description: Event ID.
+      ext_order_item_id:
+        type: string
+        description: External order item ID.
+      free_shipping:
+        type: integer
+        description: Free-shipping flag value.
+      gw_base_price:
+        type: number
+        description: GW base price.
+      gw_base_price_invoiced:
+        type: number
+        description: GW base price invoiced.
+      gw_base_price_refunded:
+        type: number
+        description: GW base price refunded.
+      gw_base_tax_amount:
+        type: number
+        description: GW base tax amount.
+      gw_base_tax_amount_invoiced:
+        type: number
+        description: GW base tax amount invoiced.
+      gw_base_tax_amount_refunded:
+        type: number
+        description: GW base tax amount refunded.
+      gw_id:
+        type: integer
+        description: GW ID.
+      gw_price:
+        type: number
+        description: GW price.
+      gw_price_invoiced:
+        type: number
+        description: GW price invoiced.
+      gw_price_refunded:
+        type: number
+        description: GW price refunded.
+      gw_tax_amount:
+        type: number
+        description: GW tax amount.
+      gw_tax_amount_invoiced:
+        type: number
+        description: GW tax amount invoiced.
+      gw_tax_amount_refunded:
+        type: number
+        description: GW tax amount refunded.
+      discount_tax_compensation_amount:
+        type: number
+        description: Discount tax compensation amount.
+      discount_tax_compensation_canceled:
+        type: number
+        description: Discount tax compensation canceled.
+      discount_tax_compensation_invoiced:
+        type: number
+        description: Discount tax compensation invoiced.
+      discount_tax_compensation_refunded:
+        type: number
+        description: Discount tax compensation refunded.
+      is_qty_decimal:
+        type: integer
+        description: Is-quantity-decimal flag value.
+      is_virtual:
+        type: integer
+        description: Is-virtual flag value.
+      item_id:
+        type: integer
+        description: Item ID.
+      locked_do_invoice:
+        type: integer
+        description: Locked DO invoice flag value.
+      locked_do_ship:
+        type: integer
+        description: Locked DO ship flag value.
+      name:
+        type: string
+        description: Name.
+      no_discount:
+        type: integer
+        description: No-discount flag value.
+      order_id:
+        type: integer
+        description: Order ID.
+      original_price:
+        type: number
+        description: Original price.
+      parent_item_id:
+        type: integer
+        description: Parent item ID.
+      price:
+        type: number
+        description: Price.
+      price_incl_tax:
+        type: number
+        description: Price including tax.
+      product_id:
+        type: integer
+        description: Product ID.
+      product_type:
+        type: string
+        description: Product type.
+      qty_backordered:
+        type: number
+        description: Quantity backordered.
+      qty_canceled:
+        type: number
+        description: Quantity canceled.
+      qty_invoiced:
+        type: number
+        description: Quantity invoiced.
+      qty_ordered:
+        type: number
+        description: Quantity ordered.
+      qty_refunded:
+        type: number
+        description: Quantity refunded.
+      qty_returned:
+        type: number
+        description: Quantity returned.
+      qty_shipped:
+        type: number
+        description: Quantity shipped.
+      quote_item_id:
+        type: integer
+        description: Quote item ID.
+      row_invoiced:
+        type: number
+        description: Row invoiced.
+      row_total:
+        type: number
+        description: Row total.
+      row_total_incl_tax:
+        type: number
+        description: Row total including tax.
+      row_weight:
+        type: number
+        description: Row weight.
+      sku:
+        type: string
+        description: SKU.
+      store_id:
+        type: integer
+        description: Store ID.
+      tax_amount:
+        type: number
+        description: Tax amount.
+      tax_before_discount:
+        type: number
+        description: Tax before discount.
+      tax_canceled:
+        type: number
+        description: Tax canceled.
+      tax_invoiced:
+        type: number
+        description: Tax invoiced.
+      tax_percent:
+        type: number
+        description: Tax percent.
+      tax_refunded:
+        type: number
+        description: Tax refunded.
+      updated_at:
+        type: string
+        description: Updated-at timestamp.
+      weee_tax_applied:
+        type: string
+        description: WEEE tax applied.
+      weee_tax_applied_amount:
+        type: number
+        description: WEEE tax applied amount.
+      weee_tax_applied_row_amount:
+        type: number
+        description: WEEE tax applied row amount.
+      weee_tax_disposition:
+        type: number
+        description: WEEE tax disposition.
+      weee_tax_row_disposition:
+        type: number
+        description: WEEE tax row disposition.
+      weight:
+        type: number
+        description: Weight.
+      parent_item:
+        "$ref": "#/definitions/sales-data-order-item-interface"
+      product_option:
+        "$ref": "#/definitions/catalog-data-product-option-interface"
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-order-item-extension-interface"
+    required:
+    - sku
+  catalog-data-product-option-interface:
+    type: object
+    description: Product option interface
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-option-extension-interface"
+  catalog-data-product-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductOptionInterface
+    properties:
+      custom_options:
+        type: array
+        items:
+          "$ref": "#/definitions/catalog-data-custom-option-interface"
+      bundle_options:
+        type: array
+        items:
+          "$ref": "#/definitions/bundle-data-bundle-option-interface"
+      downloadable_option:
+        "$ref": "#/definitions/downloadable-data-downloadable-option-interface"
+      giftcard_item_option:
+        "$ref": "#/definitions/gift-card-data-gift-card-option-interface"
+      configurable_item_options:
+        type: array
+        items:
+          "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-interface"
+  sales-data-order-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderItemInterface
+    properties:
+      itemized_taxes:
+        type: array
+        items:
+          "$ref": "#/definitions/tax-data-order-tax-item-interface"
+      gift_message:
+        "$ref": "#/definitions/gift-message-data-message-interface"
+      gw_id:
+        type: string
+      gw_base_price:
+        type: string
+      gw_price:
+        type: string
+      gw_base_tax_amount:
+        type: string
+      gw_tax_amount:
+        type: string
+      gw_base_price_invoiced:
+        type: string
+      gw_price_invoiced:
+        type: string
+      gw_base_tax_amount_invoiced:
+        type: string
+      gw_tax_amount_invoiced:
+        type: string
+      gw_base_price_refunded:
+        type: string
+      gw_price_refunded:
+        type: string
+      gw_base_tax_amount_refunded:
+        type: string
+      gw_tax_amount_refunded:
+        type: string
+  tax-data-order-tax-item-interface:
+    type: object
+    description: ''
+    properties:
+      tax_item_id:
+        type: integer
+        description: Tax item ID
+      tax_id:
+        type: integer
+        description: Tax ID
+      item_id:
+        type: integer
+        description: Order item ID
+      tax_code:
+        type: string
+        description: Tax code
+      tax_percent:
+        type: number
+        description: Tax percent
+      amount:
+        type: number
+        description: Tax amount
+      base_amount:
+        type: number
+        description: Tax amount in base currency
+      real_amount:
+        type: number
+        description: Real tax amount
+      real_base_amount:
+        type: number
+        description: Real tax amount in base currency
+      associated_item_id:
+        type: integer
+        description: Associated order item ID
+      taxable_item_type:
+        type: string
+        description: shipping, product, weee, quote_gw, etc...
+      extension_attributes:
+        "$ref": "#/definitions/tax-data-order-tax-item-extension-interface"
+    required:
+    - tax_percent
+    - amount
+    - base_amount
+    - real_amount
+    - real_base_amount
+  tax-data-order-tax-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Tax\Api\Data\OrderTaxItemInterface
+  sales-data-order-address-interface:
+    type: object
+    description: Order address interface. An order is a document that a web store
+      issues to a customer. Magento generates a sales order that lists the product
+      items, billing and shipping addresses, and shipping and payment methods. A corresponding
+      external document, known as a purchase order, is emailed to the customer.
+    properties:
+      address_type:
+        type: string
+        description: Address type.
+      city:
+        type: string
+        description: City.
+      company:
+        type: string
+        description: Company.
+      country_id:
+        type: string
+        description: Country ID.
+      customer_address_id:
+        type: integer
+        description: Country address ID.
+      customer_id:
+        type: integer
+        description: Customer ID.
+      email:
+        type: string
+        description: Email address.
+      entity_id:
+        type: integer
+        description: Order address ID.
+      fax:
+        type: string
+        description: Fax number.
+      firstname:
+        type: string
+        description: First name.
+      lastname:
+        type: string
+        description: Last name.
+      middlename:
+        type: string
+        description: Middle name.
+      parent_id:
+        type: integer
+        description: Parent ID.
+      postcode:
+        type: string
+        description: Postal code.
+      prefix:
+        type: string
+        description: Prefix.
+      region:
+        type: string
+        description: Region.
+      region_code:
+        type: string
+        description: Region code.
+      region_id:
+        type: integer
+        description: Region ID.
+      street:
+        type: array
+        description: Array of any street values. Otherwise, null.
+        items:
+          type: string
+      suffix:
+        type: string
+        description: Suffix.
+      telephone:
+        type: string
+        description: Telephone number.
+      vat_id:
+        type: string
+        description: VAT ID.
+      vat_is_valid:
+        type: integer
+        description: VAT-is-valid flag value.
+      vat_request_date:
+        type: string
+        description: VAT request date.
+      vat_request_id:
+        type: string
+        description: VAT request ID.
+      vat_request_success:
+        type: integer
+        description: VAT-request-success flag value.
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-order-address-extension-interface"
+    required:
+    - address_type
+    - city
+    - country_id
+    - firstname
+    - lastname
+    - postcode
+    - telephone
+  sales-data-order-address-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderAddressInterface
+  sales-data-order-payment-interface:
+    type: object
+    description: Order payment interface. An order is a document that a web store
+      issues to a customer. Magento generates a sales order that lists the product
+      items, billing and shipping addresses, and shipping and payment methods. A corresponding
+      external document, known as a purchase order, is emailed to the customer.
+    properties:
+      account_status:
+        type: string
+        description: Account status.
+      additional_data:
+        type: string
+        description: Additional data.
+      additional_information:
+        type: array
+        description: Array of additional information.
+        items:
+          type: string
+      address_status:
+        type: string
+        description: Address status.
+      amount_authorized:
+        type: number
+        description: Amount authorized.
+      amount_canceled:
+        type: number
+        description: Amount canceled.
+      amount_ordered:
+        type: number
+        description: Amount ordered.
+      amount_paid:
+        type: number
+        description: Amount paid.
+      amount_refunded:
+        type: number
+        description: Amount refunded.
+      anet_trans_method:
+        type: string
+        description: Anet transaction method.
+      base_amount_authorized:
+        type: number
+        description: Base amount authorized.
+      base_amount_canceled:
+        type: number
+        description: Base amount canceled.
+      base_amount_ordered:
+        type: number
+        description: Base amount ordered.
+      base_amount_paid:
+        type: number
+        description: Base amount paid.
+      base_amount_paid_online:
+        type: number
+        description: Base amount paid online.
+      base_amount_refunded:
+        type: number
+        description: Base amount refunded.
+      base_amount_refunded_online:
+        type: number
+        description: Base amount refunded online.
+      base_shipping_amount:
+        type: number
+        description: Base shipping amount.
+      base_shipping_captured:
+        type: number
+        description: Base shipping captured amount.
+      base_shipping_refunded:
+        type: number
+        description: Base shipping refunded amount.
+      cc_approval:
+        type: string
+        description: Credit card approval.
+      cc_avs_status:
+        type: string
+        description: Credit card avs status.
+      cc_cid_status:
+        type: string
+        description: Credit card CID status.
+      cc_debug_request_body:
+        type: string
+        description: Credit card debug request body.
+      cc_debug_response_body:
+        type: string
+        description: Credit card debug response body.
+      cc_debug_response_serialized:
+        type: string
+        description: Credit card debug response serialized.
+      cc_exp_month:
+        type: string
+        description: Credit card expiration month.
+      cc_exp_year:
+        type: string
+        description: Credit card expiration year.
+      cc_last4:
+        type: string
+        description: Last four digits of the credit card.
+      cc_number_enc:
+        type: string
+        description: Encrypted credit card number.
+      cc_owner:
+        type: string
+        description: Credit card number.
+      cc_secure_verify:
+        type: string
+        description: Credit card secure verify.
+      cc_ss_issue:
+        type: string
+        description: Credit card SS issue.
+      cc_ss_start_month:
+        type: string
+        description: Credit card SS start month.
+      cc_ss_start_year:
+        type: string
+        description: Credit card SS start year.
+      cc_status:
+        type: string
+        description: Credit card status.
+      cc_status_description:
+        type: string
+        description: Credit card status description.
+      cc_trans_id:
+        type: string
+        description: Credit card transaction ID.
+      cc_type:
+        type: string
+        description: Credit card type.
+      echeck_account_name:
+        type: string
+        description: eCheck account name.
+      echeck_account_type:
+        type: string
+        description: eCheck account type.
+      echeck_bank_name:
+        type: string
+        description: eCheck bank name.
+      echeck_routing_number:
+        type: string
+        description: eCheck routing number.
+      echeck_type:
+        type: string
+        description: eCheck type.
+      entity_id:
+        type: integer
+        description: Entity ID.
+      last_trans_id:
+        type: string
+        description: Last transaction ID.
+      method:
+        type: string
+        description: Method.
+      parent_id:
+        type: integer
+        description: Parent ID.
+      po_number:
+        type: string
+        description: PO number.
+      protection_eligibility:
+        type: string
+        description: Protection eligibility.
+      quote_payment_id:
+        type: integer
+        description: Quote payment ID.
+      shipping_amount:
+        type: number
+        description: Shipping amount.
+      shipping_captured:
+        type: number
+        description: Shipping captured.
+      shipping_refunded:
+        type: number
+        description: Shipping refunded.
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-order-payment-extension-interface"
+    required:
+    - account_status
+    - additional_information
+    - cc_last4
+    - method
+  sales-data-order-payment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderPaymentInterface
+    properties:
+      notification_message:
+        type: string
+      vault_payment_token:
+        "$ref": "#/definitions/vault-data-payment-token-interface"
+  vault-data-payment-token-interface:
+    type: object
+    description: Gateway vault payment token interface.
+    properties:
+      entity_id:
+        type: integer
+        description: Entity ID.
+      customer_id:
+        type: integer
+        description: Customer ID.
+      public_hash:
+        type: string
+        description: Public hash
+      payment_method_code:
+        type: string
+        description: Payment method code
+      type:
+        type: string
+        description: Type
+      created_at:
+        type: string
+        description: Token creation timestamp
+      expires_at:
+        type: string
+        description: Token expiration timestamp
+      gateway_token:
+        type: string
+        description: Gateway token ID
+      token_details:
+        type: string
+        description: Token details
+      is_active:
+        type: boolean
+        description: Is active.
+      is_visible:
+        type: boolean
+        description: Is visible.
+      website_id:
+        type: integer
+        description: website id.
+    required:
+    - public_hash
+    - payment_method_code
+    - type
+    - gateway_token
+    - token_details
+    - is_active
+    - is_visible
+    - website_id
+  sales-data-order-status-history-interface:
+    type: object
+    description: Order status history interface. An order is a document that a web
+      store issues to a customer. Magento generates a sales order that lists the product
+      items, billing and shipping addresses, and shipping and payment methods. A corresponding
+      external document, known as a purchase order, is emailed to the customer.
+    properties:
+      comment:
+        type: string
+        description: Comment.
+      created_at:
+        type: string
+        description: Created-at timestamp.
+      entity_id:
+        type: integer
+        description: Order status history ID.
+      entity_name:
+        type: string
+        description: Entity name.
+      is_customer_notified:
+        type: integer
+        description: Is-customer-notified flag value.
+      is_visible_on_front:
+        type: integer
+        description: Is-visible-on-storefront flag value.
+      parent_id:
+        type: integer
+        description: Parent ID.
+      status:
+        type: string
+        description: Status.
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-order-status-history-extension-interface"
+    required:
+    - comment
+    - is_customer_notified
+    - is_visible_on_front
+    - parent_id
+  sales-data-order-status-history-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderStatusHistoryInterface
+  sales-data-order-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderInterface
+    properties:
+      shipping_assignments:
+        type: array
+        items:
+          "$ref": "#/definitions/sales-data-shipping-assignment-interface"
+      payment_additional_info:
+        type: array
+        items:
+          "$ref": "#/definitions/payment-data-payment-additional-info-interface"
+      company_order_attributes:
+        "$ref": "#/definitions/company-data-company-order-interface"
+      custom_fees:
+        type: array
+        items:
+          "$ref": "#/definitions/admin-ui-sdk-custom-fees-data-custom-fees-interface"
+      applied_taxes:
+        type: array
+        items:
+          "$ref": "#/definitions/tax-data-order-tax-details-applied-tax-interface"
+      item_applied_taxes:
+        type: array
+        items:
+          "$ref": "#/definitions/tax-data-order-tax-details-item-interface"
+      converting_from_quote:
+        type: boolean
+      taxes:
+        type: array
+        items:
+          "$ref": "#/definitions/tax-data-order-tax-interface"
+      additional_itemized_taxes:
+        type: array
+        items:
+          "$ref": "#/definitions/tax-data-order-tax-item-interface"
+      base_customer_balance_amount:
+        type: number
+      customer_balance_amount:
+        type: number
+      base_customer_balance_invoiced:
+        type: number
+      customer_balance_invoiced:
+        type: number
+      base_customer_balance_refunded:
+        type: number
+      customer_balance_refunded:
+        type: number
+      base_customer_balance_total_refunded:
+        type: number
+      customer_balance_total_refunded:
+        type: number
+      gift_cards:
+        type: array
+        items:
+          "$ref": "#/definitions/gift-card-account-data-gift-card-interface"
+      base_gift_cards_amount:
+        type: number
+      gift_cards_amount:
+        type: number
+      base_gift_cards_invoiced:
+        type: number
+      gift_cards_invoiced:
+        type: number
+      base_gift_cards_refunded:
+        type: number
+      gift_cards_refunded:
+        type: number
+      gift_message:
+        "$ref": "#/definitions/gift-message-data-message-interface"
+      gw_id:
+        type: string
+      gw_allow_gift_receipt:
+        type: string
+      gw_add_card:
+        type: string
+      gw_base_price:
+        type: string
+      gw_price:
+        type: string
+      gw_items_base_price:
+        type: string
+      gw_items_price:
+        type: string
+      gw_card_base_price:
+        type: string
+      gw_card_price:
+        type: string
+      gw_base_tax_amount:
+        type: string
+      gw_tax_amount:
+        type: string
+      gw_items_base_tax_amount:
+        type: string
+      gw_items_tax_amount:
+        type: string
+      gw_card_base_tax_amount:
+        type: string
+      gw_card_tax_amount:
+        type: string
+      gw_base_price_incl_tax:
+        type: string
+      gw_price_incl_tax:
+        type: string
+      gw_items_base_price_incl_tax:
+        type: string
+      gw_items_price_incl_tax:
+        type: string
+      gw_card_base_price_incl_tax:
+        type: string
+      gw_card_price_incl_tax:
+        type: string
+      gw_base_price_invoiced:
+        type: string
+      gw_price_invoiced:
+        type: string
+      gw_items_base_price_invoiced:
+        type: string
+      gw_items_price_invoiced:
+        type: string
+      gw_card_base_price_invoiced:
+        type: string
+      gw_card_price_invoiced:
+        type: string
+      gw_base_tax_amount_invoiced:
+        type: string
+      gw_tax_amount_invoiced:
+        type: string
+      gw_items_base_tax_invoiced:
+        type: string
+      gw_items_tax_invoiced:
+        type: string
+      gw_card_base_tax_invoiced:
+        type: string
+      gw_card_tax_invoiced:
+        type: string
+      gw_base_price_refunded:
+        type: string
+      gw_price_refunded:
+        type: string
+      gw_items_base_price_refunded:
+        type: string
+      gw_items_price_refunded:
+        type: string
+      gw_card_base_price_refunded:
+        type: string
+      gw_card_price_refunded:
+        type: string
+      gw_base_tax_amount_refunded:
+        type: string
+      gw_tax_amount_refunded:
+        type: string
+      gw_items_base_tax_refunded:
+        type: string
+      gw_items_tax_refunded:
+        type: string
+      gw_card_base_tax_refunded:
+        type: string
+      gw_card_tax_refunded:
+        type: string
+      pickup_location_code:
+        type: string
+      notification_sent:
+        type: integer
+      send_notification:
+        type: integer
+      coupon_codes:
+        type: array
+        items:
+          type: string
+      coupon_discounts:
+        type: array
+        items:
+          type: string
+      reward_points_balance:
+        type: integer
+      reward_currency_amount:
+        type: number
+      base_reward_currency_amount:
+        type: number
+  sales-data-shipping-assignment-interface:
+    type: object
+    description: Interface ShippingAssignmentInterface
+    properties:
+      shipping:
+        "$ref": "#/definitions/sales-data-shipping-interface"
+      items:
+        type: array
+        description: Order items of shipping assignment
+        items:
+          "$ref": "#/definitions/sales-data-order-item-interface"
+      stock_id:
+        type: integer
+        description: Stock id
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-shipping-assignment-extension-interface"
+    required:
+    - shipping
+    - items
+  sales-data-shipping-interface:
+    type: object
+    description: Interface ShippingInterface
+    properties:
+      address:
+        "$ref": "#/definitions/sales-data-order-address-interface"
+      method:
+        type: string
+        description: Shipping method
+      total:
+        "$ref": "#/definitions/sales-data-total-interface"
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-shipping-extension-interface"
+  sales-data-total-interface:
+    type: object
+    description: Interface TotalInterface
+    properties:
+      base_shipping_amount:
+        type: number
+        description: Base shipping amount.
+      base_shipping_canceled:
+        type: number
+        description: Base shipping canceled.
+      base_shipping_discount_amount:
+        type: number
+        description: Base shipping discount amount.
+      base_shipping_discount_tax_compensation_amnt:
+        type: number
+        description: Base shipping discount tax compensation amount.
+      base_shipping_incl_tax:
+        type: number
+        description: Base shipping including tax.
+      base_shipping_invoiced:
+        type: number
+        description: Base shipping invoiced.
+      base_shipping_refunded:
+        type: number
+        description: Base shipping refunded.
+      base_shipping_tax_amount:
+        type: number
+        description: Base shipping tax amount.
+      base_shipping_tax_refunded:
+        type: number
+        description: Base shipping tax refunded.
+      shipping_amount:
+        type: number
+        description: Shipping amount.
+      shipping_canceled:
+        type: number
+        description: Shipping canceled amount.
+      shipping_discount_amount:
+        type: number
+        description: Shipping discount amount.
+      shipping_discount_tax_compensation_amount:
+        type: number
+        description: Shipping discount tax compensation amount.
+      shipping_incl_tax:
+        type: number
+        description: Shipping including tax amount.
+      shipping_invoiced:
+        type: number
+        description: Shipping invoiced amount.
+      shipping_refunded:
+        type: number
+        description: Shipping refunded amount.
+      shipping_tax_amount:
+        type: number
+        description: Shipping tax amount.
+      shipping_tax_refunded:
+        type: number
+        description: Shipping tax refunded amount.
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-total-extension-interface"
+  sales-data-total-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\TotalInterface
+  sales-data-shipping-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShippingInterface
+  sales-data-shipping-assignment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShippingAssignmentInterface
+  payment-data-payment-additional-info-interface:
+    type: object
+    description: Payment additional info interface.
+    properties:
+      key:
+        type: string
+        description: Object key
+      value:
+        type: string
+        description: Object value
+    required:
+    - key
+    - value
+  company-data-company-order-interface:
+    type: object
+    description: Order company extension attributes interface. Adds new company attributes
+      to orders.
+    properties:
+      order_id:
+        type: integer
+        description: Order ID.
+      company_id:
+        type: integer
+        description: Company ID.
+      company_name:
+        type: string
+        description: Company name.
+      extension_attributes:
+        "$ref": "#/definitions/company-data-company-order-extension-interface"
+  company-data-company-order-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyOrderInterface
+  admin-ui-sdk-custom-fees-data-custom-fees-interface:
+    type: object
+    description: Interface CustomFeesInterface
+    properties:
+      id:
+        type: string
+        description: Id.
+      order_id:
+        type: string
+        description: The order id
+      custom_fee_code:
+        type: string
+        description: Custom fee code.
+      custom_fee_label:
+        type: string
+        description: Custom fee label.
+      custom_fee_amount:
+        type: number
+        description: Custom fee amount.
+      base_custom_fee_amount:
+        type: number
+        description: Base custom fee amount.
+      custom_fee_amount_invoiced:
+        type: number
+        description: Custom fee amount invoiced.
+      base_custom_fee_amount_invoiced:
+        type: number
+        description: Base custom fee amount invoiced.
+      custom_fee_amount_refunded:
+        type: number
+        description: Custom fee amount refunded.
+      base_custom_fee_amount_refunded:
+        type: number
+        description: Base custom fee amount refunded.
+      apply_fee_on_last_invoice:
+        type: boolean
+        description: If apply fee is set on last invoice.
+      apply_fee_on_last_creditmemo:
+        type: boolean
+        description: If apply fee is set on last credit memo.
+      invoice_id:
+        type: string
+        description: Invoice id.
+      creditmemo_id:
+        type: string
+        description: Credit memo id.
+    required:
+    - order_id
+    - custom_fee_code
+    - custom_fee_label
+    - custom_fee_amount
+    - base_custom_fee_amount
+    - custom_fee_amount_invoiced
+    - base_custom_fee_amount_invoiced
+    - custom_fee_amount_refunded
+    - base_custom_fee_amount_refunded
+    - apply_fee_on_last_invoice
+    - apply_fee_on_last_creditmemo
+  tax-data-order-tax-details-applied-tax-interface:
+    type: object
+    description: Interface OrderTaxDetailsAppliedTaxInterface
+    properties:
+      code:
+        type: string
+        description: Code
+      title:
+        type: string
+        description: Title
+      percent:
+        type: number
+        description: Tax Percent
+      amount:
+        type: number
+        description: Tax amount
+      base_amount:
+        type: number
+        description: Tax amount in base currency
+      extension_attributes:
+        "$ref": "#/definitions/tax-data-order-tax-details-applied-tax-extension-interface"
+    required:
+    - amount
+    - base_amount
+  tax-data-order-tax-details-applied-tax-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Tax\Api\Data\OrderTaxDetailsAppliedTaxInterface
+    properties:
+      rates:
+        type: array
+        items:
+          "$ref": "#/definitions/tax-data-applied-tax-rate-interface"
+  tax-data-applied-tax-rate-interface:
+    type: object
+    description: Applied tax rate interface.
+    properties:
+      code:
+        type: string
+        description: Code
+      title:
+        type: string
+        description: Title
+      percent:
+        type: number
+        description: Tax Percent
+      extension_attributes:
+        "$ref": "#/definitions/tax-data-applied-tax-rate-extension-interface"
+  tax-data-applied-tax-rate-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Tax\Api\Data\AppliedTaxRateInterface
+  tax-data-order-tax-details-item-interface:
+    type: object
+    description: Interface OrderTaxDetailsItemInterface
+    properties:
+      type:
+        type: string
+        description: Type (shipping, product, weee, gift wrapping, etc)
+      item_id:
+        type: integer
+        description: Item id if this item is a product
+      associated_item_id:
+        type: integer
+        description: Associated item id if this item is associated with another item,
+          null otherwise
+      applied_taxes:
+        type: array
+        description: Applied taxes
+        items:
+          "$ref": "#/definitions/tax-data-order-tax-details-applied-tax-interface"
+      extension_attributes:
+        "$ref": "#/definitions/tax-data-order-tax-details-item-extension-interface"
+  tax-data-order-tax-details-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Tax\Api\Data\OrderTaxDetailsItemInterface
+  tax-data-order-tax-interface:
+    type: object
+    description: ''
+    properties:
+      tax_id:
+        type: integer
+        description: Tax ID
+      order_id:
+        type: integer
+        description: Order ID
+      code:
+        type: string
+        description: Code
+      title:
+        type: string
+        description: Title
+      percent:
+        type: number
+        description: Percent
+      amount:
+        type: number
+        description: Amount
+      base_amount:
+        type: number
+        description: Tax amount in base currency
+      base_real_amount:
+        type: number
+        description: Real tax amount in base currency
+      priority:
+        type: integer
+        description: Priority
+      position:
+        type: integer
+        description: Position
+      process:
+        type: integer
+        description: Process
+      extension_attributes:
+        "$ref": "#/definitions/tax-data-order-tax-extension-interface"
+    required:
+    - percent
+    - amount
+    - base_amount
+    - base_real_amount
+    - priority
+    - position
+    - process
+  tax-data-order-tax-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Tax\Api\Data\OrderTaxInterface
+  gift-card-account-data-gift-card-interface:
+    type: object
+    description: Gift Card data
+    properties:
+      id:
+        type: integer
+        description: Id
+      code:
+        type: string
+        description: Code
+      amount:
+        type: number
+        description: Amount
+      base_amount:
+        type: number
+        description: Base Amount
+    required:
+    - id
+    - code
+    - amount
+    - base_amount
+  sales-data-order-search-result-interface:
+    type: object
+    description: Order search result interface. An order is a document that a web
+      store issues to a customer. Magento generates a sales order that lists the product
+      items, billing and shipping addresses, and shipping and payment methods. A corresponding
+      external document, known as a purchase order, is emailed to the customer.
+    properties:
+      items:
+        type: array
+        description: Array of collection items.
+        items:
+          "$ref": "#/definitions/sales-data-order-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  sales-data-order-status-history-search-result-interface:
+    type: object
+    description: Order status history search result interface. An order is a document
+      that a web store issues to a customer. Magento generates a sales order that
+      lists the product items, billing and shipping addresses, and shipping and payment
+      methods. A corresponding external document, known as a purchase order, is emailed
+      to the customer.
+    properties:
+      items:
+        type: array
+        description: Array of collection items.
+        items:
+          "$ref": "#/definitions/sales-data-order-status-history-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  sales-data-order-item-search-result-interface:
+    type: object
+    description: Order item search result interface. An order is a document that a
+      web store issues to a customer. Magento generates a sales order that lists the
+      product items, billing and shipping addresses, and shipping and payment methods.
+      A corresponding external document, known as a purchase order, is emailed to
+      the customer.
+    properties:
+      items:
+        type: array
+        description: Array of collection items.
+        items:
+          "$ref": "#/definitions/sales-data-order-item-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  sales-data-invoice-interface:
+    type: object
+    description: Invoice interface. An invoice is a record of the receipt of payment
+      for an order.
+    properties:
+      base_currency_code:
+        type: string
+        description: Base currency code.
+      base_discount_amount:
+        type: number
+        description: Base discount amount.
+      base_grand_total:
+        type: number
+        description: Base grand total.
+      base_discount_tax_compensation_amount:
+        type: number
+        description: Base discount tax compensation amount.
+      base_shipping_amount:
+        type: number
+        description: Base shipping amount.
+      base_shipping_discount_tax_compensation_amnt:
+        type: number
+        description: Base shipping discount tax compensation amount.
+      base_shipping_incl_tax:
+        type: number
+        description: Base shipping including tax.
+      base_shipping_tax_amount:
+        type: number
+        description: Base shipping tax amount.
+      base_subtotal:
+        type: number
+        description: Base subtotal.
+      base_subtotal_incl_tax:
+        type: number
+        description: Base subtotal including tax.
+      base_tax_amount:
+        type: number
+        description: Base tax amount.
+      base_total_refunded:
+        type: number
+        description: Base total refunded.
+      base_to_global_rate:
+        type: number
+        description: Base-to-global rate.
+      base_to_order_rate:
+        type: number
+        description: Base-to-order rate.
+      billing_address_id:
+        type: integer
+        description: Billing address ID.
+      can_void_flag:
+        type: integer
+        description: Can void flag value.
+      created_at:
+        type: string
+        description: Created-at timestamp.
+      discount_amount:
+        type: number
+        description: Discount amount.
+      discount_description:
+        type: string
+        description: Discount description.
+      email_sent:
+        type: integer
+        description: Email-sent flag value.
+      entity_id:
+        type: integer
+        description: Invoice ID.
+      global_currency_code:
+        type: string
+        description: Global currency code.
+      grand_total:
+        type: number
+        description: Grand total.
+      discount_tax_compensation_amount:
+        type: number
+        description: Discount tax compensation amount.
+      increment_id:
+        type: string
+        description: Increment ID.
+      is_used_for_refund:
+        type: integer
+        description: Is-used-for-refund flag value.
+      order_currency_code:
+        type: string
+        description: Order currency code.
+      order_id:
+        type: integer
+        description: Order ID.
+      shipping_address_id:
+        type: integer
+        description: Shipping address ID.
+      shipping_amount:
+        type: number
+        description: Shipping amount.
+      shipping_discount_tax_compensation_amount:
+        type: number
+        description: Shipping discount tax compensation amount.
+      shipping_incl_tax:
+        type: number
+        description: Shipping including tax.
+      shipping_tax_amount:
+        type: number
+        description: Shipping tax amount.
+      state:
+        type: integer
+        description: State.
+      store_currency_code:
+        type: string
+        description: Store currency code.
+      store_id:
+        type: integer
+        description: Store ID.
+      store_to_base_rate:
+        type: number
+        description: Store-to-base rate.
+      store_to_order_rate:
+        type: number
+        description: Store-to-order rate.
+      subtotal:
+        type: number
+        description: Subtotal.
+      subtotal_incl_tax:
+        type: number
+        description: Subtotal including tax.
+      tax_amount:
+        type: number
+        description: Tax amount.
+      total_qty:
+        type: number
+        description: Total quantity.
+      transaction_id:
+        type: string
+        description: Transaction ID.
+      updated_at:
+        type: string
+        description: Updated-at timestamp.
+      items:
+        type: array
+        description: Array of invoice items.
+        items:
+          "$ref": "#/definitions/sales-data-invoice-item-interface"
+      comments:
+        type: array
+        description: Array of any invoice comments. Otherwise, null.
+        items:
+          "$ref": "#/definitions/sales-data-invoice-comment-interface"
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-invoice-extension-interface"
+    required:
+    - order_id
+    - total_qty
+    - items
+  sales-data-invoice-item-interface:
+    type: object
+    description: Invoice item interface. An invoice is a record of the receipt of
+      payment for an order. An invoice item is a purchased item in an invoice.
+    properties:
+      additional_data:
+        type: string
+        description: Additional data.
+      base_cost:
+        type: number
+        description: Base cost.
+      base_discount_amount:
+        type: number
+        description: Base discount amount.
+      base_discount_tax_compensation_amount:
+        type: number
+        description: Base discount tax compensation amount.
+      base_price:
+        type: number
+        description: Base price.
+      base_price_incl_tax:
+        type: number
+        description: Base price including tax.
+      base_row_total:
+        type: number
+        description: Base row total.
+      base_row_total_incl_tax:
+        type: number
+        description: Base row total including tax.
+      base_tax_amount:
+        type: number
+        description: Base tax amount.
+      description:
+        type: string
+        description: Description.
+      discount_amount:
+        type: number
+        description: Discount amount.
+      entity_id:
+        type: integer
+        description: Invoice item ID.
+      discount_tax_compensation_amount:
+        type: number
+        description: Discount tax compensation amount.
+      name:
+        type: string
+        description: Name.
+      parent_id:
+        type: integer
+        description: Parent ID.
+      price:
+        type: number
+        description: Price.
+      price_incl_tax:
+        type: number
+        description: Price including tax.
+      product_id:
+        type: integer
+        description: Product ID.
+      row_total:
+        type: number
+        description: Row total.
+      row_total_incl_tax:
+        type: number
+        description: Row total including tax.
+      sku:
+        type: string
+        description: SKU.
+      tax_amount:
+        type: number
+        description: Tax amount.
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-invoice-item-extension-interface"
+      order_item_id:
+        type: integer
+        description: Order item ID.
+      qty:
+        type: number
+        description: Quantity.
+    required:
+    - sku
+    - order_item_id
+    - qty
+  sales-data-invoice-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceItemInterface
+  sales-data-invoice-comment-interface:
+    type: object
+    description: Invoice comment interface. An invoice is a record of the receipt
+      of payment for an order. An invoice can include comments that detail the invoice
+      history.
+    properties:
+      is_customer_notified:
+        type: integer
+        description: Is-customer-notified flag value.
+      parent_id:
+        type: integer
+        description: Parent ID.
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-invoice-comment-extension-interface"
+      comment:
+        type: string
+        description: Comment.
+      is_visible_on_front:
+        type: integer
+        description: Is-visible-on-storefront flag value.
+      created_at:
+        type: string
+        description: Created-at timestamp.
+      entity_id:
+        type: integer
+        description: Invoice ID.
+    required:
+    - is_customer_notified
+    - parent_id
+    - comment
+    - is_visible_on_front
+  sales-data-invoice-comment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCommentInterface
+  sales-data-invoice-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceInterface
+    properties:
+      base_customer_balance_amount:
+        type: number
+      customer_balance_amount:
+        type: number
+      base_gift_cards_amount:
+        type: number
+      gift_cards_amount:
+        type: number
+      gw_base_price:
+        type: string
+      gw_price:
+        type: string
+      gw_items_base_price:
+        type: string
+      gw_items_price:
+        type: string
+      gw_card_base_price:
+        type: string
+      gw_card_price:
+        type: string
+      gw_base_tax_amount:
+        type: string
+      gw_tax_amount:
+        type: string
+      gw_items_base_tax_amount:
+        type: string
+      gw_items_tax_amount:
+        type: string
+      gw_card_base_tax_amount:
+        type: string
+      gw_card_tax_amount:
+        type: string
+  sales-data-invoice-search-result-interface:
+    type: object
+    description: Invoice search result interface. An invoice is a record of the receipt
+      of payment for an order.
+    properties:
+      items:
+        type: array
+        description: Array of collection items.
+        items:
+          "$ref": "#/definitions/sales-data-invoice-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  sales-data-invoice-comment-search-result-interface:
+    type: object
+    description: Invoice comment search result interface. An invoice is a record of
+      the receipt of payment for an order. An invoice can include comments that detail
+      the invoice history.
+    properties:
+      items:
+        type: array
+        description: Array of collection items.
+        items:
+          "$ref": "#/definitions/sales-data-invoice-comment-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  sales-data-creditmemo-item-creation-interface:
+    type: object
+    description: Interface CreditmemoItemCreationInterface
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-creditmemo-item-creation-extension-interface"
+      order_item_id:
+        type: integer
+        description: Order item ID.
+      qty:
+        type: number
+        description: Quantity.
+    required:
+    - order_item_id
+    - qty
+  sales-data-creditmemo-item-creation-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoItemCreationInterface
+  sales-data-creditmemo-comment-creation-interface:
+    type: object
+    description: Interface CreditmemoCommentCreationInterface
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-creditmemo-comment-creation-extension-interface"
+      comment:
+        type: string
+        description: Comment.
+      is_visible_on_front:
+        type: integer
+        description: Is-visible-on-storefront flag value.
+    required:
+    - comment
+    - is_visible_on_front
+  sales-data-creditmemo-comment-creation-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentCreationInterface
+  sales-data-creditmemo-creation-arguments-interface:
+    type: object
+    description: Interface CreditmemoCreationArgumentsInterface
+    properties:
+      shipping_amount:
+        type: number
+        description: Credit memo shipping amount.
+      adjustment_positive:
+        type: number
+        description: Credit memo positive adjustment.
+      adjustment_negative:
+        type: number
+        description: Credit memo negative adjustment.
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-creditmemo-creation-arguments-extension-interface"
+  sales-data-creditmemo-creation-arguments-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCreationArgumentsInterface
+    properties:
+      return_to_stock_items:
+        type: array
+        items:
+          type: integer
+  sales-data-creditmemo-comment-search-result-interface:
+    type: object
+    description: Credit memo comment search result interface. After a customer places
+      and pays for an order and an invoice has been issued, the merchant can create
+      a credit memo to refund all or part of the amount paid for any returned or undelivered
+      items. The memo restores funds to the customer account so that the customer
+      can make future purchases. A credit memo usually includes comments that detail
+      why the credit memo amount was credited to the customer.
+    properties:
+      items:
+        type: array
+        description: Array of collection items.
+        items:
+          "$ref": "#/definitions/sales-data-creditmemo-comment-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  sales-data-creditmemo-comment-interface:
+    type: object
+    description: Credit memo comment interface. After a customer places and pays for
+      an order and an invoice has been issued, the merchant can create a credit memo
+      to refund all or part of the amount paid for any returned or undelivered items.
+      The memo restores funds to the customer account so that the customer can make
+      future purchases. A credit memo usually includes comments that detail why the
+      credit memo amount was credited to the customer.
+    properties:
+      comment:
+        type: string
+        description: Comment.
+      created_at:
+        type: string
+        description: Created-at timestamp.
+      entity_id:
+        type: integer
+        description: Credit memo ID.
+      is_customer_notified:
+        type: integer
+        description: Is-customer-notified flag value.
+      is_visible_on_front:
+        type: integer
+        description: Is-visible-on-storefront flag value.
+      parent_id:
+        type: integer
+        description: Parent ID.
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-creditmemo-comment-extension-interface"
+    required:
+    - comment
+    - is_customer_notified
+    - is_visible_on_front
+    - parent_id
+  sales-data-creditmemo-comment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentInterface
+  sales-data-creditmemo-interface:
+    type: object
+    description: Credit memo interface. After a customer places and pays for an order
+      and an invoice has been issued, the merchant can create a credit memo to refund
+      all or part of the amount paid for any returned or undelivered items. The memo
+      restores funds to the customer account so that the customer can make future
+      purchases.
+    properties:
+      adjustment:
+        type: number
+        description: Credit memo adjustment.
+      adjustment_negative:
+        type: number
+        description: Credit memo negative adjustment.
+      adjustment_positive:
+        type: number
+        description: Credit memo positive adjustment.
+      base_adjustment:
+        type: number
+        description: Credit memo base adjustment.
+      base_adjustment_negative:
+        type: number
+        description: Credit memo negative base adjustment.
+      base_adjustment_positive:
+        type: number
+        description: Credit memo positive base adjustment.
+      base_currency_code:
+        type: string
+        description: Credit memo base currency code.
+      base_discount_amount:
+        type: number
+        description: Credit memo base discount amount.
+      base_grand_total:
+        type: number
+        description: Credit memo base grand total.
+      base_discount_tax_compensation_amount:
+        type: number
+        description: Credit memo base discount tax compensation amount.
+      base_shipping_amount:
+        type: number
+        description: Credit memo base shipping amount.
+      base_shipping_discount_tax_compensation_amnt:
+        type: number
+        description: Credit memo base shipping discount tax compensation amount.
+      base_shipping_incl_tax:
+        type: number
+        description: Credit memo base shipping including tax.
+      base_shipping_tax_amount:
+        type: number
+        description: Credit memo base shipping tax amount.
+      base_subtotal:
+        type: number
+        description: Credit memo base subtotal.
+      base_subtotal_incl_tax:
+        type: number
+        description: Credit memo base subtotal including tax.
+      base_tax_amount:
+        type: number
+        description: Credit memo base tax amount.
+      base_to_global_rate:
+        type: number
+        description: Credit memo base-to-global rate.
+      base_to_order_rate:
+        type: number
+        description: Credit memo base-to-order rate.
+      billing_address_id:
+        type: integer
+        description: Credit memo billing address ID.
+      created_at:
+        type: string
+        description: Credit memo created-at timestamp.
+      creditmemo_status:
+        type: integer
+        description: Credit memo status.
+      discount_amount:
+        type: number
+        description: Credit memo discount amount.
+      discount_description:
+        type: string
+        description: Credit memo discount description.
+      email_sent:
+        type: integer
+        description: Credit memo email sent flag value.
+      entity_id:
+        type: integer
+        description: Credit memo ID.
+      global_currency_code:
+        type: string
+        description: Credit memo global currency code.
+      grand_total:
+        type: number
+        description: Credit memo grand total.
+      discount_tax_compensation_amount:
+        type: number
+        description: Credit memo discount tax compensation amount.
+      increment_id:
+        type: string
+        description: Credit memo increment ID.
+      invoice_id:
+        type: integer
+        description: Credit memo invoice ID.
+      order_currency_code:
+        type: string
+        description: Credit memo order currency code.
+      order_id:
+        type: integer
+        description: Credit memo order ID.
+      shipping_address_id:
+        type: integer
+        description: Credit memo shipping address ID.
+      shipping_amount:
+        type: number
+        description: Credit memo shipping amount.
+      shipping_discount_tax_compensation_amount:
+        type: number
+        description: Credit memo shipping discount tax compensation amount.
+      shipping_incl_tax:
+        type: number
+        description: Credit memo shipping including tax.
+      shipping_tax_amount:
+        type: number
+        description: Credit memo shipping tax amount.
+      state:
+        type: integer
+        description: Credit memo state.
+      store_currency_code:
+        type: string
+        description: Credit memo store currency code.
+      store_id:
+        type: integer
+        description: Credit memo store ID.
+      store_to_base_rate:
+        type: number
+        description: Credit memo store-to-base rate.
+      store_to_order_rate:
+        type: number
+        description: Credit memo store-to-order rate.
+      subtotal:
+        type: number
+        description: Credit memo subtotal.
+      subtotal_incl_tax:
+        type: number
+        description: Credit memo subtotal including tax.
+      tax_amount:
+        type: number
+        description: Credit memo tax amount.
+      transaction_id:
+        type: string
+        description: Credit memo transaction ID.
+      updated_at:
+        type: string
+        description: Credit memo updated-at timestamp.
+      items:
+        type: array
+        description: Array of credit memo items.
+        items:
+          "$ref": "#/definitions/sales-data-creditmemo-item-interface"
+      comments:
+        type: array
+        description: Array of any credit memo comments. Otherwise, null.
+        items:
+          "$ref": "#/definitions/sales-data-creditmemo-comment-interface"
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-creditmemo-extension-interface"
+    required:
+    - order_id
+    - items
+  sales-data-creditmemo-item-interface:
+    type: object
+    description: Credit memo item interface. After a customer places and pays for
+      an order and an invoice has been issued, the merchant can create a credit memo
+      to refund all or part of the amount paid for any returned or undelivered items.
+      The memo restores funds to the customer account so that the customer can make
+      future purchases. A credit memo item is an invoiced item for which a merchant
+      creates a credit memo.
+    properties:
+      additional_data:
+        type: string
+        description: Additional data.
+      base_cost:
+        type: number
+        description: The base cost for a credit memo item.
+      base_discount_amount:
+        type: number
+        description: The base discount amount for a credit memo item.
+      base_discount_tax_compensation_amount:
+        type: number
+        description: The base discount tax compensation amount for a credit memo item.
+      base_price:
+        type: number
+        description: The base price for a credit memo item.
+      base_price_incl_tax:
+        type: number
+        description: Base price including tax.
+      base_row_total:
+        type: number
+        description: Base row total.
+      base_row_total_incl_tax:
+        type: number
+        description: Base row total including tax.
+      base_tax_amount:
+        type: number
+        description: Base tax amount.
+      base_weee_tax_applied_amount:
+        type: number
+        description: Base WEEE tax applied amount.
+      base_weee_tax_applied_row_amnt:
+        type: number
+        description: Base WEEE tax applied row amount.
+      base_weee_tax_disposition:
+        type: number
+        description: Base WEEE tax disposition.
+      base_weee_tax_row_disposition:
+        type: number
+        description: Base WEEE tax row disposition.
+      description:
+        type: string
+        description: Description.
+      discount_amount:
+        type: number
+        description: Discount amount.
+      entity_id:
+        type: integer
+        description: Credit memo item ID.
+      discount_tax_compensation_amount:
+        type: number
+        description: Discount tax compensation amount.
+      name:
+        type: string
+        description: Name.
+      order_item_id:
+        type: integer
+        description: Order item ID.
+      parent_id:
+        type: integer
+        description: Parent ID.
+      price:
+        type: number
+        description: Price.
+      price_incl_tax:
+        type: number
+        description: Price including tax.
+      product_id:
+        type: integer
+        description: Product ID.
+      qty:
+        type: number
+        description: Quantity.
+      row_total:
+        type: number
+        description: Row total.
+      row_total_incl_tax:
+        type: number
+        description: Row total including tax.
+      sku:
+        type: string
+        description: SKU.
+      tax_amount:
+        type: number
+        description: Tax amount.
+      weee_tax_applied:
+        type: string
+        description: WEEE tax applied.
+      weee_tax_applied_amount:
+        type: number
+        description: WEEE tax applied amount.
+      weee_tax_applied_row_amount:
+        type: number
+        description: WEEE tax applied row amount.
+      weee_tax_disposition:
+        type: number
+        description: WEEE tax disposition.
+      weee_tax_row_disposition:
+        type: number
+        description: WEEE tax row disposition.
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-creditmemo-item-extension-interface"
+    required:
+    - base_cost
+    - base_price
+    - entity_id
+    - order_item_id
+    - qty
+  sales-data-creditmemo-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoItemInterface
+  sales-data-creditmemo-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoInterface
+    properties:
+      base_customer_balance_amount:
+        type: number
+      customer_balance_amount:
+        type: number
+      base_gift_cards_amount:
+        type: number
+      gift_cards_amount:
+        type: number
+      gw_base_price:
+        type: string
+      gw_price:
+        type: string
+      gw_items_base_price:
+        type: string
+      gw_items_price:
+        type: string
+      gw_card_base_price:
+        type: string
+      gw_card_price:
+        type: string
+      gw_base_tax_amount:
+        type: string
+      gw_tax_amount:
+        type: string
+      gw_items_base_tax_amount:
+        type: string
+      gw_items_tax_amount:
+        type: string
+      gw_card_base_tax_amount:
+        type: string
+      gw_card_tax_amount:
+        type: string
+  sales-data-creditmemo-search-result-interface:
+    type: object
+    description: Credit memo search result interface. After a customer places and
+      pays for an order and an invoice has been issued, the merchant can create a
+      credit memo to refund all or part of the amount paid for any returned or undelivered
+      items. The memo restores funds to the customer account so that the customer
+      can make future purchases.
+    properties:
+      items:
+        type: array
+        description: Array of collection items.
+        items:
+          "$ref": "#/definitions/sales-data-creditmemo-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  sales-data-shipment-interface:
+    type: object
+    description: Shipment interface. A shipment is a delivery package that contains
+      products. A shipment document accompanies the shipment. This document lists
+      the products and their quantities in the delivery package. This interface creates
+      shipment record without items quantity (total_qty) validation. To validate total
+      shipped quantity for each item in the order you must use newer `POST /V1/order/:orderId/ship`
+      endpoint.
+    properties:
+      billing_address_id:
+        type: integer
+        description: Billing address ID.
+      created_at:
+        type: string
+        description: Created-at timestamp.
+      customer_id:
+        type: integer
+        description: Customer ID.
+      email_sent:
+        type: integer
+        description: Email-sent flag value.
+      entity_id:
+        type: integer
+        description: Shipment ID.
+      increment_id:
+        type: string
+        description: Increment ID.
+      order_id:
+        type: integer
+        description: Order ID.
+      packages:
+        type: array
+        description: Array of packages, if any. Otherwise, null.
+        items:
+          "$ref": "#/definitions/sales-data-shipment-package-interface"
+      shipment_status:
+        type: integer
+        description: Shipment status.
+      shipping_address_id:
+        type: integer
+        description: Shipping address ID.
+      shipping_label:
+        type: string
+        description: Shipping label.
+      store_id:
+        type: integer
+        description: Store ID.
+      total_qty:
+        type: number
+        description: Total quantity.
+      total_weight:
+        type: number
+        description: Total weight.
+      updated_at:
+        type: string
+        description: Updated-at timestamp.
+      items:
+        type: array
+        description: Array of items.
+        items:
+          "$ref": "#/definitions/sales-data-shipment-item-interface"
+      tracks:
+        type: array
+        description: Array of tracks.
+        items:
+          "$ref": "#/definitions/sales-data-shipment-track-interface"
+      comments:
+        type: array
+        description: Array of comments.
+        items:
+          "$ref": "#/definitions/sales-data-shipment-comment-interface"
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-shipment-extension-interface"
+    required:
+    - order_id
+    - items
+    - tracks
+    - comments
+  sales-data-shipment-package-interface:
+    type: object
+    description: Shipment package interface. A shipment is a delivery package that
+      contains products. A shipment document accompanies the shipment. This document
+      lists the products and their quantities in the delivery package.
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-shipment-package-extension-interface"
+  sales-data-shipment-package-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentPackageInterface
+  sales-data-shipment-item-interface:
+    type: object
+    description: Shipment item interface. A shipment is a delivery package that contains
+      products. A shipment document accompanies the shipment. This document lists
+      the products and their quantities in the delivery package. A product is an item
+      in a shipment.
+    properties:
+      additional_data:
+        type: string
+        description: Additional data.
+      description:
+        type: string
+        description: Description.
+      entity_id:
+        type: integer
+        description: Shipment item ID.
+      name:
+        type: string
+        description: Name.
+      parent_id:
+        type: integer
+        description: Parent ID.
+      price:
+        type: number
+        description: Price.
+      product_id:
+        type: integer
+        description: Product ID.
+      row_total:
+        type: number
+        description: Row total.
+      sku:
+        type: string
+        description: SKU.
+      weight:
+        type: number
+        description: Weight.
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-shipment-item-extension-interface"
+      order_item_id:
+        type: integer
+        description: Order item ID.
+      qty:
+        type: number
+        description: Quantity.
+    required:
+    - order_item_id
+    - qty
+  sales-data-shipment-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentItemInterface
+  sales-data-shipment-track-interface:
+    type: object
+    description: Shipment track interface. A shipment is a delivery package that contains
+      products. A shipment document accompanies the shipment. This document lists
+      the products and their quantities in the delivery package. Merchants and customers
+      can track shipments.
+    properties:
+      order_id:
+        type: integer
+        description: The order_id for the shipment package.
+      created_at:
+        type: string
+        description: Created-at timestamp.
+      entity_id:
+        type: integer
+        description: Shipment package ID.
+      parent_id:
+        type: integer
+        description: Parent ID.
+      updated_at:
+        type: string
+        description: Updated-at timestamp.
+      weight:
+        type: number
+        description: Weight.
+      qty:
+        type: number
+        description: Quantity.
+      description:
+        type: string
+        description: Description.
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-shipment-track-extension-interface"
+      track_number:
+        type: string
+        description: Track number.
+      title:
+        type: string
+        description: Title.
+      carrier_code:
+        type: string
+        description: Carrier code.
+    required:
+    - order_id
+    - parent_id
+    - weight
+    - qty
+    - description
+    - track_number
+    - title
+    - carrier_code
+  sales-data-shipment-track-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentTrackInterface
+  sales-data-shipment-comment-interface:
+    type: object
+    description: Shipment comment interface. A shipment is a delivery package that
+      contains products. A shipment document accompanies the shipment. This document
+      lists the products and their quantities in the delivery package. A shipment
+      document can contain comments.
+    properties:
+      is_customer_notified:
+        type: integer
+        description: Is-customer-notified flag value.
+      parent_id:
+        type: integer
+        description: Parent ID.
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-shipment-comment-extension-interface"
+      comment:
+        type: string
+        description: Comment.
+      is_visible_on_front:
+        type: integer
+        description: Is-visible-on-storefront flag value.
+      created_at:
+        type: string
+        description: Created-at timestamp.
+      entity_id:
+        type: integer
+        description: Invoice ID.
+    required:
+    - is_customer_notified
+    - parent_id
+    - comment
+    - is_visible_on_front
+  sales-data-shipment-comment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentCommentInterface
+  sales-data-shipment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentInterface
+    properties:
+      source_code:
+        type: string
+  sales-data-shipment-search-result-interface:
+    type: object
+    description: Shipment search result interface. A shipment is a delivery package
+      that contains products. A shipment document accompanies the shipment. This document
+      lists the products and their quantities in the delivery package.
+    properties:
+      items:
+        type: array
+        description: Array of collection items.
+        items:
+          "$ref": "#/definitions/sales-data-shipment-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  sales-data-shipment-comment-search-result-interface:
+    type: object
+    description: Shipment comment search result interface. A shipment is a delivery
+      package that contains products. A shipment document accompanies the shipment.
+      This document lists the products and their quantities in the delivery package.
+      A shipment document can contain comments.
+    properties:
+      items:
+        type: array
+        description: Array of collection items.
+        items:
+          "$ref": "#/definitions/sales-data-shipment-comment-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  sales-data-shipment-item-creation-interface:
+    type: object
+    description: Input argument for shipment item creation Interface ShipmentItemCreationInterface
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-shipment-item-creation-extension-interface"
+      order_item_id:
+        type: integer
+        description: Order item ID.
+      qty:
+        type: number
+        description: Quantity.
+    required:
+    - order_item_id
+    - qty
+  sales-data-shipment-item-creation-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentItemCreationInterface
+  sales-data-shipment-comment-creation-interface:
+    type: object
+    description: Interface ShipmentCommentCreationInterface
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-shipment-comment-creation-extension-interface"
+      comment:
+        type: string
+        description: Comment.
+      is_visible_on_front:
+        type: integer
+        description: Is-visible-on-storefront flag value.
+    required:
+    - comment
+    - is_visible_on_front
+  sales-data-shipment-comment-creation-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentCommentCreationInterface
+  sales-data-shipment-track-creation-interface:
+    type: object
+    description: Shipment Track Creation interface.
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-shipment-track-creation-extension-interface"
+      track_number:
+        type: string
+        description: Track number.
+      title:
+        type: string
+        description: Title.
+      carrier_code:
+        type: string
+        description: Carrier code.
+    required:
+    - track_number
+    - title
+    - carrier_code
+  sales-data-shipment-track-creation-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentTrackCreationInterface
+  sales-data-shipment-package-creation-interface:
+    type: object
+    description: Shipment package interface. A shipment is a delivery package that
+      contains products. A shipment document accompanies the shipment. This document
+      lists the products and their quantities in the delivery package.
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-shipment-package-creation-extension-interface"
+  sales-data-shipment-package-creation-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentPackageCreationInterface
+  sales-data-shipment-creation-arguments-interface:
+    type: object
+    description: Interface for creation arguments for Shipment.
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-shipment-creation-arguments-extension-interface"
+  sales-data-shipment-creation-arguments-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface
+    properties:
+      source_code:
+        type: string
+  sales-data-transaction-interface:
+    type: object
+    description: Transaction interface. A transaction is an interaction between a
+      merchant and a customer such as a purchase, a credit, a refund, and so on.
+    properties:
+      transaction_id:
+        type: integer
+        description: Transaction ID.
+      parent_id:
+        type: integer
+        description: The parent ID for the transaction. Otherwise, null.
+      order_id:
+        type: integer
+        description: Order ID.
+      payment_id:
+        type: integer
+        description: Payment ID.
+      txn_id:
+        type: string
+        description: Transaction business ID.
+      parent_txn_id:
+        type: string
+        description: Parent transaction business ID.
+      txn_type:
+        type: string
+        description: Transaction type.
+      is_closed:
+        type: integer
+        description: Is-closed flag value.
+      additional_information:
+        type: array
+        description: Array of additional information. Otherwise, null.
+        items:
+          type: string
+      created_at:
+        type: string
+        description: Created-at timestamp.
+      child_transactions:
+        type: array
+        description: Array of child transactions.
+        items:
+          "$ref": "#/definitions/sales-data-transaction-interface"
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-transaction-extension-interface"
+    required:
+    - transaction_id
+    - order_id
+    - payment_id
+    - txn_id
+    - parent_txn_id
+    - txn_type
+    - is_closed
+    - created_at
+    - child_transactions
+  sales-data-transaction-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\TransactionInterface
+  sales-data-transaction-search-result-interface:
+    type: object
+    description: Transaction search result interface. A transaction is an interaction
+      between a merchant and a customer such as a purchase, a credit, a refund, and
+      so on.
+    properties:
+      items:
+        type: array
+        description: Array of collection items.
+        items:
+          "$ref": "#/definitions/sales-data-transaction-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  sales-data-invoice-item-creation-interface:
+    type: object
+    description: Input argument for invoice creation Interface InvoiceItemCreationInterface
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-invoice-item-creation-extension-interface"
+      order_item_id:
+        type: integer
+        description: Order item ID.
+      qty:
+        type: number
+        description: Quantity.
+    required:
+    - order_item_id
+    - qty
+  sales-data-invoice-item-creation-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceItemCreationInterface
+  sales-data-invoice-comment-creation-interface:
+    type: object
+    description: Interface InvoiceCommentCreationInterface
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-invoice-comment-creation-extension-interface"
+      comment:
+        type: string
+        description: Comment.
+      is_visible_on_front:
+        type: integer
+        description: Is-visible-on-storefront flag value.
+    required:
+    - comment
+    - is_visible_on_front
+  sales-data-invoice-comment-creation-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCommentCreationInterface
+  sales-data-invoice-creation-arguments-interface:
+    type: object
+    description: Interface for creation arguments for Invoice.
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/sales-data-invoice-creation-arguments-extension-interface"
+  sales-data-invoice-creation-arguments-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCreationArgumentsInterface
+  sales-rule-data-rule-interface:
+    type: object
+    description: Interface RuleInterface
+    properties:
+      rule_id:
+        type: integer
+        description: Rule id
+      name:
+        type: string
+        description: Rule name
+      store_labels:
+        type: array
+        description: Display label
+        items:
+          "$ref": "#/definitions/sales-rule-data-rule-label-interface"
+      description:
+        type: string
+        description: Description
+      website_ids:
+        type: array
+        description: A list of websites the rule applies to
+        items:
+          type: integer
+      customer_group_ids:
+        type: array
+        description: Ids of customer groups that the rule applies to
+        items:
+          type: integer
+      from_date:
+        type: string
+        description: The start date when the coupon is active
+      to_date:
+        type: string
+        description: The end date when the coupon is active
+      uses_per_customer:
+        type: integer
+        description: Number of uses per customer
+      is_active:
+        type: boolean
+        description: The coupon is active
+      condition:
+        "$ref": "#/definitions/sales-rule-data-condition-interface"
+      action_condition:
+        "$ref": "#/definitions/sales-rule-data-condition-interface"
+      stop_rules_processing:
+        type: boolean
+        description: To stop rule processing
+      is_advanced:
+        type: boolean
+        description: Is this field needed
+      product_ids:
+        type: array
+        description: Product ids
+        items:
+          type: integer
+      sort_order:
+        type: integer
+        description: Sort order
+      simple_action:
+        type: string
+        description: Simple action of the rule
+      discount_amount:
+        type: number
+        description: Discount amount
+      discount_qty:
+        type: number
+        description: Maximum qty discount is applied
+      discount_step:
+        type: integer
+        description: Discount step
+      apply_to_shipping:
+        type: boolean
+        description: The rule applies to shipping
+      times_used:
+        type: integer
+        description: How many times the rule has been used
+      is_rss:
+        type: boolean
+        description: Whether the rule is in RSS
+      coupon_type:
+        type: string
+        description: Coupon type
+      use_auto_generation:
+        type: boolean
+        description: To auto generate coupon
+      uses_per_coupon:
+        type: integer
+        description: Limit of uses per coupon
+      simple_free_shipping:
+        type: string
+        description: To grant free shipping
+      extension_attributes:
+        "$ref": "#/definitions/sales-rule-data-rule-extension-interface"
+    required:
+    - website_ids
+    - customer_group_ids
+    - uses_per_customer
+    - is_active
+    - stop_rules_processing
+    - is_advanced
+    - sort_order
+    - discount_amount
+    - discount_step
+    - apply_to_shipping
+    - times_used
+    - is_rss
+    - coupon_type
+    - use_auto_generation
+    - uses_per_coupon
+  sales-rule-data-rule-label-interface:
+    type: object
+    description: Interface RuleLabelInterface
+    properties:
+      store_id:
+        type: integer
+        description: StoreId
+      store_label:
+        type: string
+        description: The label for the store
+      extension_attributes:
+        "$ref": "#/definitions/sales-rule-data-rule-label-extension-interface"
+    required:
+    - store_id
+    - store_label
+  sales-rule-data-rule-label-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\RuleLabelInterface
+  sales-rule-data-condition-interface:
+    type: object
+    description: Interface ConditionInterface
+    properties:
+      condition_type:
+        type: string
+        description: Condition type
+      conditions:
+        type: array
+        description: List of conditions
+        items:
+          "$ref": "#/definitions/sales-rule-data-condition-interface"
+      aggregator_type:
+        type: string
+        description: The aggregator type
+      operator:
+        type: string
+        description: The operator of the condition
+      attribute_name:
+        type: string
+        description: The attribute name of the condition
+      value:
+        type: string
+        description: The value of the condition
+      extension_attributes:
+        "$ref": "#/definitions/sales-rule-data-condition-extension-interface"
+    required:
+    - condition_type
+    - operator
+    - value
+  sales-rule-data-condition-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\ConditionInterface
+  sales-rule-data-rule-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\RuleInterface
+    properties:
+      reward_points_delta:
+        type: integer
+  sales-rule-data-rule-search-result-interface:
+    type: object
+    description: ''
+    properties:
+      items:
+        type: array
+        description: Rules.
+        items:
+          "$ref": "#/definitions/sales-rule-data-rule-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  sales-rule-data-coupon-interface:
+    type: object
+    description: Interface CouponInterface
+    properties:
+      coupon_id:
+        type: integer
+        description: Coupon id
+      rule_id:
+        type: integer
+        description: The id of the rule associated with the coupon
+      code:
+        type: string
+        description: Coupon code
+      usage_limit:
+        type: integer
+        description: Usage limit
+      usage_per_customer:
+        type: integer
+        description: Usage limit per customer
+      times_used:
+        type: integer
+        description: The number of times the coupon has been used
+      expiration_date:
+        type: string
+        description: Expiration date
+      is_primary:
+        type: boolean
+        description: The coupon is primary coupon for the rule that it's associated
+          with
+      created_at:
+        type: string
+        description: When the coupon is created
+      type:
+        type: integer
+        description: Of coupon
+      extension_attributes:
+        "$ref": "#/definitions/sales-rule-data-coupon-extension-interface"
+    required:
+    - rule_id
+    - times_used
+    - is_primary
+  sales-rule-data-coupon-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\CouponInterface
+  sales-rule-data-coupon-search-result-interface:
+    type: object
+    description: ''
+    properties:
+      items:
+        type: array
+        description: Rules.
+        items:
+          "$ref": "#/definitions/sales-rule-data-coupon-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  sales-rule-data-coupon-generation-spec-interface:
+    type: object
+    description: CouponGenerationSpecInterface
+    properties:
+      rule_id:
+        type: integer
+        description: The id of the rule associated with the coupon
+      format:
+        type: string
+        description: Format of generated coupon code
+      quantity:
+        type: integer
+        description: Of coupons to generate
+      length:
+        type: integer
+        description: Length of coupon code
+      prefix:
+        type: string
+        description: The prefix
+      suffix:
+        type: string
+        description: The suffix
+      delimiter_at_every:
+        type: integer
+        description: The spacing where the delimiter should exist
+      delimiter:
+        type: string
+        description: The delimiter
+      extension_attributes:
+        "$ref": "#/definitions/sales-rule-data-coupon-generation-spec-extension-interface"
+    required:
+    - rule_id
+    - format
+    - quantity
+    - length
+  sales-rule-data-coupon-generation-spec-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\CouponGenerationSpecInterface
+  sales-rule-data-coupon-mass-delete-result-interface:
+    type: object
+    description: Coupon mass delete results interface.
+    properties:
+      failed_items:
+        type: array
+        description: List of failed items.
+        items:
+          type: string
+      missing_items:
+        type: array
+        description: List of missing items.
+        items:
+          type: string
+    required:
+    - failed_items
+    - missing_items
+  bundle-data-option-type-interface:
+    type: object
+    description: Interface OptionTypeInterface
+    properties:
+      label:
+        type: string
+        description: Type label
+      code:
+        type: string
+        description: Type code
+      extension_attributes:
+        "$ref": "#/definitions/bundle-data-option-type-extension-interface"
+    required:
+    - label
+    - code
+  bundle-data-option-type-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\OptionTypeInterface
+  requisition-list-data-requisition-list-interface:
+    type: object
+    description: Interface RequisitionListInterface
+    properties:
+      id:
+        type: integer
+        description: Requisition List ID
+      customer_id:
+        type: integer
+        description: Customer ID
+      name:
+        type: string
+        description: Requisition List Name
+      updated_at:
+        type: string
+        description: Requisition List Update Time
+      description:
+        type: string
+        description: Requisition List Description
+      items:
+        type: array
+        description: Requisition List Items
+        items:
+          "$ref": "#/definitions/requisition-list-data-requisition-list-item-interface"
+      extension_attributes:
+        "$ref": "#/definitions/requisition-list-data-requisition-list-extension-interface"
+    required:
+    - id
+    - customer_id
+    - name
+    - updated_at
+    - description
+    - items
+  requisition-list-data-requisition-list-item-interface:
+    type: object
+    description: Interface RequisitionListItemInterface
+    properties:
+      id:
+        type: integer
+        description: Requisition List ID.
+      sku:
+        type: string
+        description: Product SKU.
+      requisition_list_id:
+        type: integer
+        description: Requisition List ID.
+      qty:
+        type: number
+        description: Product Qty.
+      options:
+        type: array
+        description: Requisition list item options.
+        items:
+          type: string
+      store_id:
+        type: integer
+        description: Store ID.
+      added_at:
+        type: string
+        description: Added_at value.
+      extension_attributes:
+        "$ref": "#/definitions/requisition-list-data-requisition-list-item-extension-interface"
+    required:
+    - id
+    - sku
+    - requisition_list_id
+    - qty
+    - options
+    - store_id
+    - added_at
+  requisition-list-data-requisition-list-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListItemInterface
+  requisition-list-data-requisition-list-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListInterface
+  checkout-data-shipping-information-interface:
+    type: object
+    description: Interface ShippingInformationInterface
+    properties:
+      shipping_address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      billing_address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      shipping_method_code:
+        type: string
+        description: Shipping method code
+      shipping_carrier_code:
+        type: string
+        description: Carrier code
+      extension_attributes:
+        "$ref": "#/definitions/checkout-data-shipping-information-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - shipping_address
+    - shipping_method_code
+    - shipping_carrier_code
+  checkout-data-shipping-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface
+  checkout-data-payment-details-interface:
+    type: object
+    description: Interface PaymentDetailsInterface
+    properties:
+      payment_methods:
+        type: array
+        items:
+          "$ref": "#/definitions/quote-data-payment-method-interface"
+      totals:
+        "$ref": "#/definitions/quote-data-totals-interface"
+      extension_attributes:
+        "$ref": "#/definitions/checkout-data-payment-details-extension-interface"
+    required:
+    - payment_methods
+    - totals
+  checkout-data-payment-details-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface
+  checkout-data-totals-information-interface:
+    type: object
+    description: Interface TotalsInformationInterface
+    properties:
+      address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      shipping_method_code:
+        type: string
+        description: Shipping method code
+      shipping_carrier_code:
+        type: string
+        description: Carrier code
+      extension_attributes:
+        "$ref": "#/definitions/checkout-data-totals-information-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - address
+  checkout-data-totals-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface
+  commerce-backend-uix-data-mass-action-failed-request-interface:
+    type: object
+    description: Defines the mass actions failed requests database model
+    properties:
+      id:
+        type: string
+        description: Internal id
+      request_id:
+        type: string
+        description: Request id
+      action_id:
+        type: string
+        description: Action id
+      grid_type:
+        type: string
+        description: Ui grid type
+      error_status:
+        type: string
+        description: Error status
+      error_message:
+        type: string
+        description: Error message
+      request_timestamp:
+        type: string
+        description: Request timestamp
+      selected_ids:
+        type: string
+        description: Selected ids
+    required:
+    - request_id
+    - action_id
+    - grid_type
+    - error_status
+    - error_message
+    - request_timestamp
+    - selected_ids
+  commerce-backend-uix-data-order-view-button-failed-request-interface:
+    type: object
+    description: Defines the order view button failed requests database model
+    properties:
+      id:
+        type: string
+        description: Internal id
+      request_id:
+        type: string
+        description: Request id
+      button_id:
+        type: string
+        description: Button id
+      order_id:
+        type: string
+        description: Order id
+      error_status:
+        type: string
+        description: Error status
+      error_message:
+        type: string
+        description: Error message
+      request_timestamp:
+        type: string
+        description: Request timestamp
+    required:
+    - request_id
+    - button_id
+    - order_id
+    - error_status
+    - error_message
+    - request_timestamp
+  commerce-backend-uix-data-app-management-validation-result-interface:
+    type: object
+    description: App Management User Validation Result Interface
+    properties:
+      authorized:
+        type: boolean
+        description: Authorization status
+    required:
+    - authorized
+  company-data-company-search-results-interface:
+    type: object
+    description: Interface for company search results
+    properties:
+      items:
+        type: array
+        description: Companies list
+        items:
+          "$ref": "#/definitions/company-data-company-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  company-data-company-interface:
+    type: object
+    description: Interface for Company entity.
+    properties:
+      id:
+        type: integer
+        description: Id.
+      status:
+        type: integer
+        description: Status.
+      company_name:
+        type: string
+        description: Company name.
+      legal_name:
+        type: string
+        description: Legal name.
+      company_email:
+        type: string
+        description: Company email.
+      vat_tax_id:
+        type: string
+        description: Vat tax id.
+      reseller_id:
+        type: string
+        description: Reseller Id.
+      comment:
+        type: string
+        description: Comment.
+      street:
+        type: array
+        description: Street.
+        items:
+          type: string
+      city:
+        type: string
+        description: City.
+      country_id:
+        type: string
+        description: Country.
+      region:
+        type: string
+        description: Region.
+      region_id:
+        type: string
+        description: Region Id.
+      postcode:
+        type: string
+        description: Postcode.
+      telephone:
+        type: string
+        description: Telephone.
+      customer_group_id:
+        type: integer
+        description: Customer Group Id.
+      sales_representative_id:
+        type: integer
+        description: Sales Representative Id.
+      reject_reason:
+        type: string
+        description: Reject Reason.
+      rejected_at:
+        type: string
+        description: Rejected at time.
+      super_user_id:
+        type: integer
+        description: Company admin customer id.
+      extension_attributes:
+        "$ref": "#/definitions/company-data-company-extension-interface"
+    required:
+    - street
+    - customer_group_id
+    - sales_representative_id
+    - reject_reason
+    - rejected_at
+    - super_user_id
+  company-data-company-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyInterface
+    properties:
+      applicable_payment_method:
+        type: integer
+      available_payment_methods:
+        type: string
+      use_config_settings:
+        type: integer
+      quote_config:
+        "$ref": "#/definitions/negotiable-quote-data-company-quote-config-interface"
+      is_purchase_order_enabled:
+        type: boolean
+      applicable_shipping_method:
+        type: integer
+      available_shipping_methods:
+        type: string
+      use_config_settings_shipping:
+        type: integer
+  negotiable-quote-data-company-quote-config-interface:
+    type: object
+    description: Interface CompanyQuoteConfigInterface
+    properties:
+      company_id:
+        type: string
+        description: Company id
+      is_quote_enabled:
+        type: boolean
+        description: Quote enabled for company
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-company-quote-config-extension-interface"
+    required:
+    - is_quote_enabled
+  negotiable-quote-data-company-quote-config-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CompanyQuoteConfigInterface
+  company-data-team-search-results-interface:
+    type: object
+    description: Interface for company team search results
+    properties:
+      items:
+        type: array
+        description: Teams list
+        items:
+          "$ref": "#/definitions/company-data-team-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  company-data-team-interface:
+    type: object
+    description: Team custom attributes management
+    properties:
+      id:
+        type: integer
+        description: ID
+      name:
+        type: string
+        description: Name
+      description:
+        type: string
+        description: Description
+      extension_attributes:
+        "$ref": "#/definitions/company-data-team-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+  company-data-team-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Company\Api\Data\TeamInterface
+  company-data-hierarchy-interface:
+    type: object
+    description: Company hierarchy DTO interface for WebAPI.
+    properties:
+      structure_id:
+        type: integer
+        description: Structure ID.
+      entity_id:
+        type: integer
+        description: Entity ID.
+      entity_type:
+        type: string
+        description: Entity type.
+      structure_parent_id:
+        type: integer
+        description: Structure parent ID.
+      extension_attributes:
+        "$ref": "#/definitions/company-data-hierarchy-extension-interface"
+  company-data-hierarchy-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Company\Api\Data\HierarchyInterface
+  company-data-role-search-results-interface:
+    type: object
+    description: Interface for role search results.
+    properties:
+      items:
+        type: array
+        description: Roles list.
+        items:
+          "$ref": "#/definitions/company-data-role-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  company-data-role-interface:
+    type: object
+    description: Role data transfer object interface.
+    properties:
+      id:
+        type: integer
+        description: Role id.
+      role_name:
+        type: string
+        description: Role name.
+      permissions:
+        type: array
+        description: Permissions.
+        items:
+          "$ref": "#/definitions/company-data-permission-interface"
+      company_id:
+        type: integer
+        description: Company id.
+      extension_attributes:
+        "$ref": "#/definitions/company-data-role-extension-interface"
+    required:
+    - permissions
+  company-data-permission-interface:
+    type: object
+    description: Permission management
+    properties:
+      id:
+        type: integer
+        description: Id.
+      role_id:
+        type: integer
+        description: Role id.
+      resource_id:
+        type: string
+        description: Resource id.
+      permission:
+        type: string
+        description: Permission.
+    required:
+    - resource_id
+    - permission
+  company-data-role-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Company\Api\Data\RoleInterface
+  company-data-company-customer-search-results-interface:
+    type: object
+    description: Interface for company customer attributes search results
+    properties:
+      items:
+        type: array
+        description: Company customer attributes list
+        items:
+          "$ref": "#/definitions/company-data-company-customer-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  checkout-agreements-data-agreement-interface:
+    type: object
+    description: Interface AgreementInterface
+    properties:
+      agreement_id:
+        type: integer
+        description: Agreement ID.
+      name:
+        type: string
+        description: Agreement name.
+      content:
+        type: string
+        description: Agreement content.
+      content_height:
+        type: string
+        description: Agreement content height. Otherwise, null.
+      checkbox_text:
+        type: string
+        description: Agreement checkbox text.
+      is_active:
+        type: boolean
+        description: Agreement status.
+      is_html:
+        type: boolean
+        description: "* true - HTML. * false - plain text."
+      mode:
+        type: integer
+        description: The agreement applied mode.
+      extension_attributes:
+        "$ref": "#/definitions/checkout-agreements-data-agreement-extension-interface"
+    required:
+    - agreement_id
+    - name
+    - content
+    - checkbox_text
+    - is_active
+    - is_html
+    - mode
+  checkout-agreements-data-agreement-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\CheckoutAgreements\Api\Data\AgreementInterface
+  tax-data-tax-rate-interface:
+    type: object
+    description: Tax rate interface.
+    properties:
+      id:
+        type: integer
+        description: Id
+      tax_country_id:
+        type: string
+        description: Country id
+      tax_region_id:
+        type: integer
+        description: Region id
+      region_name:
+        type: string
+        description: Region name
+      tax_postcode:
+        type: string
+        description: Postcode
+      zip_is_range:
+        type: integer
+        description: Zip is range
+      zip_from:
+        type: integer
+        description: Zip range from
+      zip_to:
+        type: integer
+        description: Zip range to
+      rate:
+        type: number
+        description: Tax rate in percentage
+      code:
+        type: string
+        description: Tax rate code
+      titles:
+        type: array
+        description: Tax rate titles
+        items:
+          "$ref": "#/definitions/tax-data-tax-rate-title-interface"
+      extension_attributes:
+        "$ref": "#/definitions/tax-data-tax-rate-extension-interface"
+    required:
+    - tax_country_id
+    - rate
+    - code
+  tax-data-tax-rate-title-interface:
+    type: object
+    description: Tax rate title interface.
+    properties:
+      store_id:
+        type: string
+        description: Store id
+      value:
+        type: string
+        description: Title value
+      extension_attributes:
+        "$ref": "#/definitions/tax-data-tax-rate-title-extension-interface"
+    required:
+    - store_id
+    - value
+  tax-data-tax-rate-title-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Tax\Api\Data\TaxRateTitleInterface
+  tax-data-tax-rate-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Tax\Api\Data\TaxRateInterface
+  tax-data-tax-rate-search-results-interface:
+    type: object
+    description: Interface for tax rate search results.
+    properties:
+      items:
+        type: array
+        description: Items
+        items:
+          "$ref": "#/definitions/tax-data-tax-rate-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  tax-data-tax-rule-interface:
+    type: object
+    description: Tax rule interface.
+    properties:
+      id:
+        type: integer
+        description: Id
+      code:
+        type: string
+        description: Tax rule code
+      priority:
+        type: integer
+        description: Priority
+      position:
+        type: integer
+        description: Sort order.
+      customer_tax_class_ids:
+        type: array
+        description: Customer tax class id
+        items:
+          type: integer
+      product_tax_class_ids:
+        type: array
+        description: Product tax class id
+        items:
+          type: integer
+      tax_rate_ids:
+        type: array
+        description: Tax rate ids
+        items:
+          type: integer
+      calculate_subtotal:
+        type: boolean
+        description: Calculate subtotal.
+      extension_attributes:
+        "$ref": "#/definitions/tax-data-tax-rule-extension-interface"
+    required:
+    - code
+    - priority
+    - position
+    - customer_tax_class_ids
+    - product_tax_class_ids
+    - tax_rate_ids
+  tax-data-tax-rule-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Tax\Api\Data\TaxRuleInterface
+  tax-data-tax-rule-search-results-interface:
+    type: object
+    description: Interface for tax rule search results.
+    properties:
+      items:
+        type: array
+        description: Items
+        items:
+          "$ref": "#/definitions/tax-data-tax-rule-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  tax-data-tax-class-interface:
+    type: object
+    description: Tax class interface.
+    properties:
+      class_id:
+        type: integer
+        description: Tax class ID.
+      class_name:
+        type: string
+        description: Tax class name.
+      class_type:
+        type: string
+        description: Tax class type.
+      extension_attributes:
+        "$ref": "#/definitions/tax-data-tax-class-extension-interface"
+    required:
+    - class_name
+    - class_type
+  tax-data-tax-class-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Tax\Api\Data\TaxClassInterface
+  tax-data-tax-class-search-results-interface:
+    type: object
+    description: Interface for tax class search results.
+    properties:
+      items:
+        type: array
+        description: Items
+        items:
+          "$ref": "#/definitions/tax-data-tax-class-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  company-credit-data-credit-limit-search-results-interface:
+    type: object
+    description: Interface for Credit Limit search results.
+    properties:
+      items:
+        type: array
+        description: Credit Limit list.
+        items:
+          "$ref": "#/definitions/company-credit-data-credit-data-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  company-credit-data-credit-data-interface:
+    type: object
+    description: Credit Data interface.
+    properties:
+      id:
+        type: integer
+        description: ID.
+      company_id:
+        type: integer
+        description: Company id.
+      credit_limit:
+        type: number
+        description: Credit Limit.
+      balance:
+        type: number
+        description: Balance.
+      currency_code:
+        type: string
+        description: Currency Code.
+      exceed_limit:
+        type: boolean
+        description: Exceed Limit.
+      available_limit:
+        type: number
+        description: Available Limit.
+    required:
+    - exceed_limit
+  company-credit-data-credit-limit-interface:
+    type: object
+    description: Credit Limit data transfer object interface.
+    properties:
+      id:
+        type: integer
+        description: ID.
+      company_id:
+        type: integer
+        description: Company id.
+      credit_limit:
+        type: number
+        description: Credit Limit.
+      balance:
+        type: number
+        description: Balance.
+      currency_code:
+        type: string
+        description: Currency Code.
+      exceed_limit:
+        type: boolean
+        description: Exceed Limit.
+      available_limit:
+        type: number
+        description: Available Limit.
+      credit_comment:
+        type: string
+        description: Credit comment for company credit history.
+      extension_attributes:
+        "$ref": "#/definitions/company-credit-data-credit-limit-extension-interface"
+    required:
+    - exceed_limit
+  company-credit-data-credit-limit-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\CompanyCredit\Api\Data\CreditLimitInterface
+  company-credit-data-credit-balance-options-interface:
+    type: object
+    description: Credit balance data transfer object interface.
+    properties:
+      purchase_order:
+        type: string
+        description: Purchase order number.
+      custom_reference_number:
+        type: string
+        description: Custom Reference number.
+      order_increment:
+        type: string
+        description: Order increment.
+      currency_display:
+        type: string
+        description: Currency display.
+      currency_base:
+        type: string
+        description: Currency base.
+    required:
+    - purchase_order
+    - order_increment
+    - currency_display
+    - currency_base
+  company-credit-data-history-search-results-interface:
+    type: object
+    description: Interface for History search results.
+    properties:
+      items:
+        type: array
+        description: History list.
+        items:
+          "$ref": "#/definitions/company-credit-data-history-data-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  company-credit-data-history-data-interface:
+    type: object
+    description: History data transfer object interface.
+    properties:
+      id:
+        type: integer
+        description: ID.
+      company_credit_id:
+        type: integer
+        description: Company credit id.
+      user_id:
+        type: integer
+        description: User Id.
+      user_type:
+        type: integer
+        description: 'User type: integration, admin, customer.'
+      currency_credit:
+        type: string
+        description: Currency code of credit.
+      currency_operation:
+        type: string
+        description: Currency code of operation.
+      rate:
+        type: number
+        description: Currency rate between credit and operation currencies.
+      rate_credit:
+        type: number
+        description: Rate between credit and base currencies.
+      amount:
+        type: number
+        description: Amount.
+      balance:
+        type: number
+        description: Outstanding balance.
+      credit_limit:
+        type: number
+        description: Credit limit.
+      available_limit:
+        type: number
+        description: Available limit.
+      type:
+        type: integer
+        description: Type of operation.
+      datetime:
+        type: string
+        description: Operation datetime.
+      purchase_order:
+        type: string
+        description: Purchase Order number.
+      custom_reference_number:
+        type: string
+        description: Custom Reference number.
+      comment:
+        type: string
+        description: Comment.
+    required:
+    - rate
+    - amount
+    - balance
+    - credit_limit
+  negotiable-quote-data-attachment-content-interface:
+    type: object
+    description: Attachment files content interface.
+    properties:
+      base64_encoded_data:
+        type: string
+        description: Media data (base64 encoded content).
+      type:
+        type: string
+        description: MIME type.
+      name:
+        type: string
+        description: File name.
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-attachment-content-extension-interface"
+    required:
+    - base64_encoded_data
+    - type
+    - name
+  negotiable-quote-data-attachment-content-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\AttachmentContentInterface
+  negotiable-quote-data-comment-interface:
+    type: object
+    description: Interface CommentInterface
+    properties:
+      entity_id:
+        type: integer
+        description: Comment ID.
+      parent_id:
+        type: integer
+        description: Negotiable quote ID, that this comment belongs to.
+      creator_type:
+        type: integer
+        description: The comment creator type.
+      is_decline:
+        type: integer
+        description: Is quote was declined by seller.
+      is_draft:
+        type: integer
+        description: Is quote draft flag.
+      creator_id:
+        type: integer
+        description: Comment creator ID.
+      comment:
+        type: string
+        description: Comment.
+      created_at:
+        type: string
+        description: Comment created at.
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-comment-extension-interface"
+      attachments:
+        type: array
+        description: Existing attachments.
+        items:
+          "$ref": "#/definitions/negotiable-quote-data-comment-attachment-interface"
+    required:
+    - entity_id
+    - parent_id
+    - creator_type
+    - is_decline
+    - is_draft
+    - creator_id
+    - comment
+    - created_at
+    - attachments
+  negotiable-quote-data-comment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CommentInterface
+  negotiable-quote-data-comment-attachment-interface:
+    type: object
+    description: Interface for quote comment attachment.
+    properties:
+      attachment_id:
+        type: integer
+        description: Attachment ID.
+      comment_id:
+        type: integer
+        description: Comment ID.
+      file_name:
+        type: string
+        description: File name.
+      file_path:
+        type: string
+        description: File path.
+      file_type:
+        type: string
+        description: File type.
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-comment-attachment-extension-interface"
+    required:
+    - attachment_id
+    - comment_id
+    - file_name
+    - file_path
+    - file_type
+  negotiable-quote-data-comment-attachment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CommentAttachmentInterface
+  gift-card-account-data-gift-card-account-interface:
+    type: object
+    description: Gift Card Account data
+    properties:
+      gift_cards:
+        type: array
+        description: Cards codes.
+        items:
+          type: string
+      gift_cards_amount:
+        type: number
+        description: Cards amount in quote currency.
+      base_gift_cards_amount:
+        type: number
+        description: Cards amount in base currency.
+      gift_cards_amount_used:
+        type: number
+        description: Cards amount used in quote currency.
+      base_gift_cards_amount_used:
+        type: number
+        description: Cards amount used in base currency.
+      extension_attributes:
+        "$ref": "#/definitions/gift-card-account-data-gift-card-account-extension-interface"
+    required:
+    - gift_cards_amount
+    - base_gift_cards_amount
+    - gift_cards_amount_used
+    - base_gift_cards_amount_used
+  gift-card-account-data-gift-card-account-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface
+  negotiable-quote-data-item-note-search-results-interface:
+    type: object
+    description: Interface for Negotiable Quote Item Notes search results.
+    properties:
+      items:
+        type: array
+        description: Negotiable Quote Item Notes list.
+        items:
+          "$ref": "#/definitions/negotiable-quote-data-item-note-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  negotiable-quote-template-data-template-interface:
+    type: object
+    description: Interface TemplateInterface
+    properties:
+      template_id:
+        type: integer
+        description: Negotiable quote ID.
+      parent_quote_id:
+        type: integer
+        description: Negotiable quote ID.
+      template_name:
+        type: string
+        description: Negotiable quote template name.
+      status:
+        type: string
+        description: Negotiable quote template status
+      expiration_date:
+        type: string
+        description: Expiration period.
+      creator_id:
+        type: integer
+        description: Quote template creator id.
+      creator_type:
+        type: integer
+        description: Quote creator type.
+      min_orders:
+        type: integer
+        description: Min orders for purchase
+      max_orders:
+        type: integer
+        description: Min orders for purchase
+      is_min_max_qty_used:
+        type: boolean
+        description: Is min/max qty used.
+      activated_at:
+        type: string
+        description: Activated at time
+      last_shared_at:
+        type: string
+        description: Last shared at
+      inactivated_at:
+        type: string
+        description: Inactivated at time
+      created_at:
+        type: string
+        description: Created at time
+      updated_at:
+        type: string
+        description: Updated at time
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-template-data-template-extension-interface"
+    required:
+    - template_id
+    - parent_quote_id
+    - template_name
+    - status
+    - expiration_date
+    - creator_id
+    - creator_type
+    - min_orders
+    - max_orders
+    - is_min_max_qty_used
+    - activated_at
+    - last_shared_at
+    - inactivated_at
+    - created_at
+    - updated_at
+    - extension_attributes
+  negotiable-quote-template-data-template-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuoteTemplate\Api\Data\TemplateInterface
+  framework-search-results-interface:
+    type: object
+    description: Search results interface.
+    properties:
+      items:
+        type: array
+        description: Items list.
+        items:
+          "$ref": "#/definitions/framework-extensible-data-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  framework-extensible-data-interface:
+    type: object
+    description: Interface for entities which can be extended with extension attributes.
+  negotiable-quote-template-data-reference-document-link-interface:
+    type: object
+    description: Interface ReferenceDocumentLinkInterface
+    properties:
+      link_id:
+        type: integer
+        description: Link ID.
+      template_id:
+        type: integer
+        description: Negotiable quote ID.
+      document_name:
+        type: string
+        description: Document name
+      document_identifier:
+        type: string
+        description: Document identifier
+      reference_document_url:
+        type: string
+        description: Reference document url
+      created_at:
+        type: string
+        description: Created at time
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-template-data-reference-document-link-extension-interface"
+    required:
+    - link_id
+    - template_id
+    - document_name
+    - document_identifier
+    - reference_document_url
+    - created_at
+    - extension_attributes
+  negotiable-quote-template-data-reference-document-link-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuoteTemplate\Api\Data\ReferenceDocumentLinkInterface
+  company-relation-data-relation-search-result-interface:
+    type: object
+    description: Interface for company relation search results
+    properties:
+      items:
+        type: array
+        description: Company relations
+        items:
+          "$ref": "#/definitions/company-relation-data-relation-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  company-relation-data-relation-interface:
+    type: object
+    description: Company relation data interface.
+    properties:
+      company_id:
+        type: integer
+        description: Company id.
+      parent_id:
+        type: integer
+        description: Parent company id.
+    required:
+    - company_id
+    - parent_id
+  two-factor-auth-provider-interface:
+    type: object
+    description: 2FA provider interface
+    properties:
+      enabled:
+        type: boolean
+        description: True if this provider has been enabled by admin
+      engine:
+        "$ref": "#/definitions/two-factor-auth-engine-interface"
+      code:
+        type: string
+        description: Provider code
+      name:
+        type: string
+        description: Provider name
+      icon:
+        type: string
+        description: Icon
+      reset_allowed:
+        type: boolean
+        description: True if this provider configuration can be reset
+      configure_action:
+        type: string
+        description: Configure action
+      auth_action:
+        type: string
+        description: Auth action
+      extra_actions:
+        type: array
+        description: Allowed extra actions
+        items:
+          type: string
+    required:
+    - enabled
+    - engine
+    - code
+    - name
+    - icon
+    - reset_allowed
+    - configure_action
+    - auth_action
+    - extra_actions
+  two-factor-auth-engine-interface:
+    type: object
+    description: 2FA engine interface
+    properties:
+      enabled:
+        type: boolean
+        description: True if this provider has been enabled by admin
+    required:
+    - enabled
+  two-factor-auth-data-google-configure-interface:
+    type: object
+    description: Google configuration data interface
+    properties:
+      qr_code_base64:
+        type: string
+        description: Value for QR code base 64
+      secret_code:
+        type: string
+        description: Value for secret code
+      extension_attributes:
+        "$ref": "#/definitions/two-factor-auth-data-google-configure-extension-interface"
+    required:
+    - qr_code_base64
+    - secret_code
+  two-factor-auth-data-google-configure-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface
+  two-factor-auth-data-authy-device-interface:
+    type: object
+    description: Authy device data interface
+    properties:
+      country:
+        type: string
+        description: The country
+      phone_number:
+        type: string
+        description: The phone number
+      method:
+        type: string
+        description: The method to authenticate with
+      extension_attributes:
+        "$ref": "#/definitions/two-factor-auth-data-authy-device-extension-interface"
+    required:
+    - country
+    - phone_number
+    - method
+  two-factor-auth-data-authy-device-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyDeviceInterface
+  two-factor-auth-data-authy-registration-prompt-response-interface:
+    type: object
+    description: Response for device registration prompt
+    properties:
+      message:
+        type: string
+        description: The message
+      expiration_seconds:
+        type: string
+        description: The seconds to expire
+      extension_attributes:
+        "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-extension-interface"
+    required:
+    - message
+    - expiration_seconds
+  two-factor-auth-data-authy-registration-prompt-response-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface
+  two-factor-auth-data-u2f-web-authn-request-interface:
+    type: object
+    description: Represents a WebAuthn dataset
+    properties:
+      credential_request_options_json:
+        type: string
+        description: The needed data to initiate a WebAuthn registration ceremony
+      extension_attributes:
+        "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-extension-interface"
+    required:
+    - credential_request_options_json
+  two-factor-auth-data-u2f-web-authn-request-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestInterface
+  shared-catalog-data-shared-catalog-interface:
+    type: object
+    description: SharedCatalogInterface interface.
+    properties:
+      id:
+        type: integer
+        description: ID.
+      name:
+        type: string
+        description: Shared Catalog name.
+      description:
+        type: string
+        description: Shared Catalog description.
+      customer_group_id:
+        type: integer
+        description: Customer Group Id.
+      type:
+        type: integer
+        description: Shared Catalog type.
+      created_at:
+        type: string
+        description: Created time for Shared Catalog.
+      created_by:
+        type: integer
+        description: Admin id for Shared Catalog.
+      store_id:
+        type: integer
+        description: Store group id for Shared Catalog.
+      tax_class_id:
+        type: integer
+        description: Tax class id.
+    required:
+    - name
+    - description
+    - customer_group_id
+    - type
+    - created_at
+    - created_by
+    - store_id
+    - tax_class_id
+  shared-catalog-data-search-results-interface:
+    type: object
+    description: Interface for Shared Catalog search results.
+    properties:
+      items:
+        type: array
+        description: Shared Catalog list.
+        items:
+          "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  adobe-commerce-webhooks-data-webhook-data-interface:
+    type: object
+    description: Interface for webhook data from webapi requests
+    properties:
+      webhook_method:
+        type: string
+        description: Webhook method name
+      webhook_type:
+        type: string
+        description: Webhook type
+      batch_name:
+        type: string
+        description: Webhook batch name
+      batch_order:
+        type: integer
+        description: Webhook batch order
+      hook_name:
+        type: string
+        description: Hook name
+      url:
+        type: string
+        description: Hook url
+      priority:
+        type: integer
+        description: Hook priority
+      required:
+        type: boolean
+        description: If hook is required
+      soft_timeout:
+        type: integer
+        description: Hook soft timeout
+      timeout:
+        type: integer
+        description: Hook timeout
+      method:
+        type: string
+        description: Hook method
+      fallback_error_message:
+        type: string
+        description: Hook fallback error message
+      ttl:
+        type: integer
+        description: Hook ttl
+      fields:
+        type: array
+        description: Webhook fields
+        items:
+          "$ref": "#/definitions/adobe-commerce-webhooks-data-hook-field-interface"
+      rules:
+        type: array
+        description: Webhook rules
+        items:
+          "$ref": "#/definitions/adobe-commerce-webhooks-data-hook-rule-interface"
+      headers:
+        type: array
+        description: Webhook headers
+        items:
+          "$ref": "#/definitions/adobe-commerce-webhooks-data-hook-header-interface"
+      developer_console_oauth:
+        "$ref": "#/definitions/adobe-commerce-webhooks-data-developer-console-oauth-interface"
+    required:
+    - webhook_method
+    - webhook_type
+    - batch_name
+    - batch_order
+    - hook_name
+    - url
+    - priority
+    - required
+    - soft_timeout
+    - timeout
+    - method
+    - fallback_error_message
+    - ttl
+    - fields
+    - rules
+    - headers
+  adobe-commerce-webhooks-data-hook-field-interface:
+    type: object
+    description: Interface for hook field data from webapi requests
+    properties:
+      name:
+        type: string
+        description: Field name.
+      source:
+        type: string
+        description: Field source.
+    required:
+    - name
+    - source
+  adobe-commerce-webhooks-data-hook-rule-interface:
+    type: object
+    description: Interface for hook rule data from webapi requests
+    properties:
+      field:
+        type: string
+        description: Field name.
+      operator:
+        type: string
+        description: Operator.
+      value:
+        type: string
+        description: Value.
+    required:
+    - field
+    - operator
+    - value
+  adobe-commerce-webhooks-data-hook-header-interface:
+    type: object
+    description: Interface for hook header data from webapi requests
+    properties:
+      name:
+        type: string
+        description: Header name.
+      value:
+        type: string
+        description: Header value.
+    required:
+    - name
+    - value
+  adobe-commerce-webhooks-data-developer-console-oauth-interface:
+    type: object
+    description: Interface for Developer Console OAuth data from webapi requests.
+    properties:
+      client_id:
+        type: string
+        description: The Developer Console OAuth client ID.
+      client_secret:
+        type: string
+        description: The Developer Console OAuth client secret.
+      org_id:
+        type: string
+        description: The Developer Console OAuth org ID.
+      environment:
+        type: string
+        description: The Developer Console OAuth environment.
+    required:
+    - client_id
+    - client_secret
+    - org_id
+    - environment
+  analytics-data-link-interface:
+    type: object
+    description: Represents link with collected data and initialized vector for decryption.
+    properties:
+      url:
+        type: string
+        description: Url
+      initialization_vector:
+        type: string
+        description: Initialization vector
+    required:
+    - url
+    - initialization_vector
+  gift-wrapping-data-wrapping-interface:
+    type: object
+    description: Interface WrappingInterface
+    properties:
+      wrapping_id:
+        type: integer
+        description: Wrapping ID
+      design:
+        type: string
+        description: Design
+      status:
+        type: integer
+        description: Status
+      base_price:
+        type: number
+        description: Base price
+      image_name:
+        type: string
+        description: Image name
+      image_base64_content:
+        type: string
+        description: Image base64 encode
+      base_currency_code:
+        type: string
+        description: Base currency code
+      website_ids:
+        type: array
+        description: Website ids
+        items:
+          type: integer
+      image_url:
+        type: string
+        description: Wrapping image URL.
+      extension_attributes:
+        "$ref": "#/definitions/gift-wrapping-data-wrapping-extension-interface"
+    required:
+    - wrapping_id
+    - design
+    - status
+    - base_price
+  gift-wrapping-data-wrapping-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\GiftWrapping\Api\Data\WrappingInterface
+  gift-wrapping-data-wrapping-search-results-interface:
+    type: object
+    description: Interface WrappingSearchResultsInterface
+    properties:
+      items:
+        type: array
+        description: Items
+        items:
+          "$ref": "#/definitions/gift-wrapping-data-wrapping-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  import-csv-api-data-localized-source-data-interface:
+    type: object
+    description: "{@inheritdoc} Adds locale field in source data"
+    properties:
+      locale:
+        type: string
+        description: Import content locale
+      entity:
+        type: string
+        description: Entity
+      behavior:
+        type: string
+        description: Behavior
+      validation_strategy:
+        type: string
+        description: Validation Strategy
+      allowed_error_count:
+        type: string
+        description: Allowed Error Count
+      csv_data:
+        type: string
+        description: CSV data as string
+      import_field_separator:
+        type: string
+        description: Import's Field Separator for CSV
+      import_multiple_value_separator:
+        type: string
+        description: Import's Multiple Value Field Separator for CSV
+      import_empty_attribute_value_constant:
+        type: string
+        description: Import's Empty Attribute Value Constant
+      import_images_file_dir:
+        type: string
+        description: Import's Images File Directory
+    required:
+    - entity
+    - behavior
+    - validation_strategy
+    - allowed_error_count
+    - csv_data
+  import-json-api-data-source-data-interface:
+    type: object
+    description: Import JSON source data interface.
+    properties:
+      entity:
+        type: string
+        description: Entity
+      behavior:
+        type: string
+        description: Behavior
+      validation_strategy:
+        type: string
+        description: Validation Strategy
+      allowed_error_count:
+        type: string
+        description: Allowed Error Count
+      items:
+        "$ref": "#/definitions/unstructured-array"
+      import_images_file_dir:
+        type: string
+        description: Import's Images File Directory
+      locale:
+        type: string
+        description: Import content locale
+    required:
+    - entity
+    - behavior
+    - validation_strategy
+    - allowed_error_count
+    - items
+  unstructured-array:
+    type: object
+    description: ''
+  inventory-api-data-source-search-results-interface:
+    type: object
+    description: Search results of Repository::getList method Used fully qualified
+      namespaces in annotations for proper work of WebApi request parser
+    properties:
+      items:
+        type: array
+        description: Sources list
+        items:
+          "$ref": "#/definitions/inventory-api-data-source-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  inventory-api-data-source-interface:
+    type: object
+    description: Represents physical storage, i.e. brick and mortar store or warehouse
+      Used fully qualified namespaces in annotations for proper work of WebApi request
+      parser
+    properties:
+      source_code:
+        type: string
+        description: Source code
+      name:
+        type: string
+        description: Source name
+      email:
+        type: string
+        description: Source email
+      contact_name:
+        type: string
+        description: Source contact name
+      enabled:
+        type: boolean
+        description: If source is enabled. For new entity can be null
+      description:
+        type: string
+        description: Source description
+      latitude:
+        type: number
+        description: Source latitude
+      longitude:
+        type: number
+        description: Source longitude
+      country_id:
+        type: string
+        description: Source country id
+      region_id:
+        type: integer
+        description: Region id if source has registered region.
+      region:
+        type: string
+        description: Region title if source has custom region
+      city:
+        type: string
+        description: Source city
+      street:
+        type: string
+        description: Source street name
+      postcode:
+        type: string
+        description: Source post code
+      phone:
+        type: string
+        description: Source phone number
+      fax:
+        type: string
+        description: Source fax
+      use_default_carrier_config:
+        type: boolean
+        description: Is need to use default config
+      carrier_links:
+        type: array
+        description: Carrier links for the source as an array of SourceCarrierLinkInterface
+          objects or null.
+        items:
+          "$ref": "#/definitions/inventory-api-data-source-carrier-link-interface"
+      extension_attributes:
+        "$ref": "#/definitions/inventory-api-data-source-extension-interface"
+  inventory-api-data-source-carrier-link-interface:
+    type: object
+    description: Represents relation between some physical storage and shipping method
+      Used fully qualified namespaces in annotations for proper work of WebApi request
+      parser
+    properties:
+      carrier_code:
+        type: string
+        description: Carrier code
+      position:
+        type: integer
+        description: Position
+      extension_attributes:
+        "$ref": "#/definitions/inventory-api-data-source-carrier-link-extension-interface"
+  inventory-api-data-source-carrier-link-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\SourceCarrierLinkInterface
+  inventory-api-data-source-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\SourceInterface
+    properties:
+      is_pickup_location_active:
+        type: boolean
+      frontend_name:
+        type: string
+      frontend_description:
+        type: string
+  inventory-api-data-stock-search-results-interface:
+    type: object
+    description: Search results of Repository::getList method Used fully qualified
+      namespaces in annotations for proper work of WebApi request parser
+    properties:
+      items:
+        type: array
+        description: Stocks list
+        items:
+          "$ref": "#/definitions/inventory-api-data-stock-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  inventory-api-data-stock-interface:
+    type: object
+    description: Represents product aggregation among some different physical storages
+      (in technical words, it is an index) Used fully qualified namespaces in annotations
+      for proper work of WebApi request parser
+    properties:
+      stock_id:
+        type: integer
+        description: Stock id
+      name:
+        type: string
+        description: Stock name
+      extension_attributes:
+        "$ref": "#/definitions/inventory-api-data-stock-extension-interface"
+  inventory-api-data-stock-extension-interface:
+    type: object
+    description: 'TODO: temporal fix of extension classes generation during installation
+      ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\StockInterface'
+    properties:
+      sales_channels:
+        type: array
+        description: Stock extension attributes like sales channels for a stock entity
+          as an array of SalesChannelInterface.
+        items:
+          "$ref": "#/definitions/inventory-sales-api-data-sales-channel-interface"
+  inventory-sales-api-data-sales-channel-interface:
+    type: object
+    description: Represents sales channels (which are a linkage between stocks and
+      websites, customer groups, etc.) Used fully qualified namespaces in annotations
+      for proper work of WebApi request parser
+    properties:
+      type:
+        type: string
+        description: Sales channel type
+      code:
+        type: string
+        description: Sales channel code
+      extension_attributes:
+        "$ref": "#/definitions/inventory-sales-api-data-sales-channel-extension-interface"
+  inventory-sales-api-data-sales-channel-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\SalesChannelInterface
+  inventory-api-data-stock-source-link-search-results-interface:
+    type: object
+    description: Search results of Repository::getList method Used fully qualified
+      namespaces in annotations for proper work of WebApi request parser
+    properties:
+      items:
+        type: array
+        description: StockSourceLink list
+        items:
+          "$ref": "#/definitions/inventory-api-data-stock-source-link-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  inventory-api-data-stock-source-link-interface:
+    type: object
+    description: Represents relation between Stock and Source entities. Used fully
+      qualified namespaces in annotations for proper work of WebApi request parser
+    properties:
+      stock_id:
+        type: integer
+        description: Stock id
+      source_code:
+        type: string
+        description: Source code of the link
+      priority:
+        type: integer
+        description: Priority of the link
+      extension_attributes:
+        "$ref": "#/definitions/inventory-api-data-stock-source-link-extension-interface"
+  inventory-api-data-stock-source-link-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\StockSourceLinkInterface
+    properties:
+      source_name:
+        type: string
+  inventory-api-data-source-item-search-results-interface:
+    type: object
+    description: Search results of Repository::getList method Used fully qualified
+      namespaces in annotations for proper work of WebApi request parser
+    properties:
+      items:
+        type: array
+        description: Source items list
+        items:
+          "$ref": "#/definitions/inventory-api-data-source-item-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  inventory-api-data-source-item-interface:
+    type: object
+    description: Represents amount of product on physical storage Entity id getter
+      is missed because entity identifies by compound identifier (sku and source_code)
+      Used fully qualified namespaces in annotations for proper work of WebApi request
+      parser
+    properties:
+      sku:
+        type: string
+        description: Source item sku
+      source_code:
+        type: string
+        description: Source code
+      quantity:
+        type: number
+        description: Source item quantity
+      status:
+        type: integer
+        description: Source item status (One of self::STATUS_*)
+      extension_attributes:
+        "$ref": "#/definitions/inventory-api-data-source-item-extension-interface"
+  inventory-api-data-source-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\SourceItemInterface
+  inventory-catalog-api-data-partial-inventory-transfer-item-interface:
+    type: object
+    description: Specifies item and quantity for partial inventory transfer.
+    properties:
+      sku:
+        type: string
+        description: The SKU of the partial inventory transfer item.
+      qty:
+        type: number
+        description: The quantity of the partial inventory transfer item.
+    required:
+    - sku
+    - qty
+  inventory-distance-based-source-selection-api-data-lat-lng-interface:
+    type: object
+    description: DTO for latitude and longitude request
+    properties:
+      lat:
+        type: number
+        description: Latitude
+      lng:
+        type: number
+        description: Longitude
+    required:
+    - lat
+    - lng
+  inventory-export-stock-api-data-export-stock-salable-qty-search-result-interface:
+    type: object
+    description: Interface for ExportStockSalableQtySearchResult
+    properties:
+      items:
+        type: array
+        items:
+          "$ref": "#/definitions/framework-extensible-data-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  inventory-export-stock-api-data-product-stock-index-data-interface:
+    type: object
+    description: Class ExportStockIndexDataResultInterface for result Inventory stock
+      index dump export
+    properties:
+      sku:
+        type: string
+        description: Product SKU
+      qty:
+        type: number
+        description: Product QTY
+      is_salable:
+        type: boolean
+        description: Product is salable flag
+    required:
+    - sku
+    - qty
+    - is_salable
+  inventory-sales-api-data-is-product-salable-result-interface:
+    type: object
+    description: Represents "is product salable" result interface.
+    properties:
+      sku:
+        type: string
+        description: Product sku from result.
+      stock_id:
+        type: integer
+        description: Stock id from result.
+      salable:
+        type: boolean
+        description: Is salable result.
+      extension_attributes:
+        "$ref": "#/definitions/inventory-sales-api-data-is-product-salable-result-extension-interface"
+    required:
+    - sku
+    - stock_id
+    - salable
+  inventory-sales-api-data-is-product-salable-result-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\IsProductSalableResultInterface
+  inventory-sales-api-data-product-salable-result-interface:
+    type: object
+    description: Represents result of service Magento\InventorySalesApi\Api\IsProductSalableForRequestedQtyInterface::execute
+    properties:
+      salable:
+        type: boolean
+        description: If the product is salable based on its availability and conditions.
+      errors:
+        type: array
+        description: A list of errors related to product salability.
+        items:
+          "$ref": "#/definitions/inventory-sales-api-data-product-salability-error-interface"
+      extension_attributes:
+        "$ref": "#/definitions/inventory-sales-api-data-product-salable-result-extension-interface"
+    required:
+    - salable
+    - errors
+  inventory-sales-api-data-product-salability-error-interface:
+    type: object
+    description: ''
+    properties:
+      code:
+        type: string
+        description: The error code related to product salability, returning it as
+          a string value.
+      message:
+        type: string
+        description: The error message related to product salability, returning it
+          as a string value.
+      extension_attributes:
+        "$ref": "#/definitions/inventory-sales-api-data-product-salability-error-extension-interface"
+    required:
+    - code
+    - message
+  inventory-sales-api-data-product-salability-error-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\ProductSalabilityErrorInterface
+  inventory-sales-api-data-product-salable-result-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\ProductSalableResultInterface
+  inventory-sales-api-data-is-product-salable-for-requested-qty-result-interface:
+    type: object
+    description: Represents "is product salable for requested quantity" result interface.
+    properties:
+      sku:
+        type: string
+        description: Product sku from result.
+      stock_id:
+        type: integer
+        description: Stock id from result.
+      salable:
+        type: boolean
+        description: Is salable result.
+      errors:
+        type: array
+        description: Errors from result.
+        items:
+          "$ref": "#/definitions/inventory-sales-api-data-product-salability-error-interface"
+      extension_attributes:
+        "$ref": "#/definitions/inventory-sales-api-data-is-product-salable-for-requested-qty-result-extension-interface"
+    required:
+    - sku
+    - stock_id
+    - salable
+    - errors
+  inventory-sales-api-data-is-product-salable-for-requested-qty-result-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\IsProductSalableForRequestedQtyResultInterface
+  inventory-in-store-pickup-api-data-search-result-interface:
+    type: object
+    description: Search results for providing pickup locations.
+    properties:
+      items:
+        type: array
+        description: Items list.
+        items:
+          "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-interface"
+      search_request:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_request
+    - total_count
+  inventory-in-store-pickup-api-data-pickup-location-interface:
+    type: object
+    description: Represents sources projection on In-Store Pickup context. Realisation
+      must follow immutable DTO concept. Partial immutability done according to restriction
+      of current Extension Attributes implementation.
+    properties:
+      pickup_location_code:
+        type: string
+        description: Source code of Pickup Location.
+      name:
+        type: string
+        description: Pickup Location name.
+      email:
+        type: string
+        description: Pickup Location contact email.
+      fax:
+        type: string
+        description: Fax contact info.
+      contact_name:
+        type: string
+        description: Pickup Location contact name.
+      description:
+        type: string
+        description: Pickup Location description.
+      latitude:
+        type: number
+        description: Pickup Location latitude.
+      longitude:
+        type: number
+        description: Pickup Location longitude.
+      country_id:
+        type: string
+        description: Pickup Location country ID.
+      region_id:
+        type: integer
+        description: Pickup Location region ID.
+      region:
+        type: string
+        description: Pickup Location region.
+      city:
+        type: string
+        description: Pickup Location city.
+      street:
+        type: string
+        description: Pickup Location street.
+      postcode:
+        type: string
+        description: Pickup Location postcode.
+      phone:
+        type: string
+        description: Pickup Location phone.
+      extension_attributes:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-extension-interface"
+    required:
+    - pickup_location_code
+  inventory-in-store-pickup-api-data-pickup-location-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface
+  inventory-in-store-pickup-api-data-search-request-interface:
+    type: object
+    description: 'Endpoint used to search Pickup Locations by different parameters:
+      - by attribute filters fields @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\FiltersInterface
+      - by distance to the address @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\AreaInterface
+      Also, endpoint supports paging and sort orders.'
+    properties:
+      area:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-area-interface"
+      filters:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filters-interface"
+      page_size:
+        type: integer
+        description: Page size.
+      current_page:
+        type: integer
+        description: Current page.
+      scope_type:
+        type: string
+        description: Sales Channel Type.
+      scope_code:
+        type: string
+        description: Sales Channel code.
+      sort:
+        type: array
+        description: Sort Order.
+        items:
+          "$ref": "#/definitions/framework-sort-order"
+      extension_attributes:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-extension-interface"
+    required:
+    - current_page
+    - scope_type
+    - scope_code
+  inventory-in-store-pickup-api-data-search-request-area-interface:
+    type: object
+    description: 'Filter by Distance to the Address. Pickup Locations will be filtered
+      by distance according to the geo-position of the entered address. Required fields
+      for the address are country and one of the field: region or city or postcode.'
+    properties:
+      radius:
+        type: integer
+        description: Search radius in KM.
+      search_term:
+        type: string
+        description: Search term string.
+    required:
+    - radius
+    - search_term
+  inventory-in-store-pickup-api-data-search-request-filters-interface:
+    type: object
+    description: Filter to filter by Fields. Each field may be filtered with different
+      condition type. Supported condition types restricted by @see \Magento\Framework\Api\SearchCriteriaInterface
+    properties:
+      country:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      postcode:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      region:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      region_id:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      city:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      street:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      name:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      pickup_location_code:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+  inventory-in-store-pickup-api-data-search-request-filter-interface:
+    type: object
+    description: Filter for Pickup Location search.
+    properties:
+      value:
+        type: string
+        description: Value.
+      condition_type:
+        type: string
+        description: Condition Type.
+    required:
+    - value
+    - condition_type
+  inventory-in-store-pickup-api-data-search-request-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequestInterface
+    properties:
+      products_info:
+        type: array
+        items:
+          "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-interface"
+  inventory-in-store-pickup-api-data-search-request-product-info-interface:
+    type: object
+    description: Product Info Data Transfer Object.
+    properties:
+      sku:
+        type: string
+        description: Product SKU.
+      extension_attributes:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-extension-interface"
+    required:
+    - sku
+  inventory-in-store-pickup-api-data-search-request-product-info-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\ProductInfoInterface
+  inventory-source-selection-api-data-source-selection-algorithm-interface:
+    type: object
+    description: Data Interface representing particular Source Selection Algorithm
+    properties:
+      code:
+        type: string
+        description: The code of the Source Selection Algorithm as a string.
+      title:
+        type: string
+        description: The title of the Source Selection Algorithm as a string.
+      description:
+        type: string
+        description: The description of the Source Selection Algorithm as a string.
+      extension_attributes:
+        "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-algorithm-extension-interface"
+    required:
+    - code
+    - title
+    - description
+  inventory-source-selection-api-data-source-selection-algorithm-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\SourceSelectionAlgorithmInterface
+  inventory-source-selection-api-data-inventory-request-interface:
+    type: object
+    description: Request products in a given Qty and StockId
+    properties:
+      stock_id:
+        type: integer
+        description: Stock Id
+      items:
+        type: array
+        description: Items
+        items:
+          "$ref": "#/definitions/inventory-source-selection-api-data-item-request-interface"
+      extension_attributes:
+        "$ref": "#/definitions/inventory-source-selection-api-data-inventory-request-extension-interface"
+    required:
+    - stock_id
+    - items
+  inventory-source-selection-api-data-item-request-interface:
+    type: object
+    description: Represents requested quantity for particular product
+    properties:
+      sku:
+        type: string
+        description: SKU
+      qty:
+        type: number
+        description: Product Quantity
+      extension_attributes:
+        "$ref": "#/definitions/inventory-source-selection-api-data-item-request-extension-interface"
+    required:
+    - sku
+    - qty
+  inventory-source-selection-api-data-item-request-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\ItemRequestInterface
+  inventory-source-selection-api-data-inventory-request-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\InventoryRequestInterface
+    properties:
+      destination_address:
+        "$ref": "#/definitions/inventory-source-selection-api-data-address-interface"
+  inventory-source-selection-api-data-address-interface:
+    type: object
+    description: Data interface for shipping source or shipping destination
+    properties:
+      country:
+        type: string
+        description: Shipping country
+      postcode:
+        type: string
+        description: Shipping postcode
+      street:
+        type: string
+        description: Shipping street address
+      region:
+        type: string
+        description: Shipping region
+      city:
+        type: string
+        description: Shipping city
+    required:
+    - country
+    - postcode
+    - street
+    - region
+    - city
+  inventory-source-selection-api-data-source-selection-result-interface:
+    type: object
+    description: Result of how we will deduct product qty from different Sources
+    properties:
+      source_selection_items:
+        type: array
+        description: The list of source selection items representing how product quantities
+          are deducted from sources.
+        items:
+          "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-item-interface"
+      shippable:
+        type: boolean
+        description: If the source selection result is eligible for shipping.
+      extension_attributes:
+        "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-result-extension-interface"
+    required:
+    - source_selection_items
+    - shippable
+  inventory-source-selection-api-data-source-selection-item-interface:
+    type: object
+    description: Represents source selection result for the specific source and SKU
+    properties:
+      source_code:
+        type: string
+        description: Source code
+      sku:
+        type: string
+        description: Item SKU
+      qty_to_deduct:
+        type: number
+        description: Quantity which will be deducted for this source
+      qty_available:
+        type: number
+        description: Available quantity for this source
+      extension_attributes:
+        "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-item-extension-interface"
+    required:
+    - source_code
+    - sku
+    - qty_to_deduct
+    - qty_available
+  inventory-source-selection-api-data-source-selection-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\SourceSelectionItemInterface
+  inventory-source-selection-api-data-source-selection-result-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\SourceSelectionResultInterface
+  inventory-in-store-pickup-sales-api-data-result-interface:
+    type: object
+    description: Operation result object that contains status of the operation.
+    properties:
+      successful:
+        type: boolean
+        description: Operation result successful.
+      errors:
+        type: array
+        description: Error information for failed operations.
+        items:
+          type: string
+      extension_attributes:
+        "$ref": "#/definitions/inventory-in-store-pickup-sales-api-data-result-extension-interface"
+    required:
+    - successful
+    - errors
+  inventory-in-store-pickup-sales-api-data-result-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryInStorePickupSalesApi\Api\Data\ResultInterface
+  inventory-low-quantity-notification-api-data-source-item-configuration-interface:
+    type: object
+    description: Represents a Source Item Configuration object Used fully qualified
+      namespaces in annotations for proper work of WebApi request parser phpcs:disable
+      Generic.Files.LineLength.TooLong
+    properties:
+      source_code:
+        type: string
+        description: Source code
+      notify_stock_qty:
+        type: number
+        description: Notify stock qty
+      sku:
+        type: string
+        description: SKU
+      extension_attributes:
+        "$ref": "#/definitions/inventory-low-quantity-notification-api-data-source-item-configuration-extension-interface"
+  inventory-low-quantity-notification-api-data-source-item-configuration-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryLowQuantityNotificationApi\Api\Data\SourceItemConfigurationInterface
+  adobe-stock-asset-api-data-asset-interface:
+    type: object
+    description: Adobe Stock Asset data class interface
+    properties:
+      id:
+        type: integer
+        description: ID
+      media_gallery_id:
+        type: integer
+        description: Media gallery asset id
+      category_id:
+        type: integer
+        description: Category
+      category:
+        "$ref": "#/definitions/adobe-stock-asset-api-data-category-interface"
+      creator_id:
+        type: integer
+        description: The creator
+      creator:
+        "$ref": "#/definitions/adobe-stock-asset-api-data-creator-interface"
+      is_licensed:
+        type: integer
+        description: Licensed
+      creation_date:
+        type: string
+        description: Creation date
+      extension_attributes:
+        "$ref": "#/definitions/adobe-stock-asset-api-data-asset-extension-interface"
+    required:
+    - media_gallery_id
+    - is_licensed
+    - creation_date
+  adobe-stock-asset-api-data-category-interface:
+    type: object
+    description: Adobe Stock asset Category data class
+    properties:
+      id:
+        type: integer
+        description: The id
+      name:
+        type: string
+        description: The category name
+      extension_attributes:
+        "$ref": "#/definitions/adobe-stock-asset-api-data-category-extension-interface"
+    required:
+    - name
+    - extension_attributes
+  adobe-stock-asset-api-data-category-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\AdobeStockAssetApi\Api\Data\CategoryInterface
+  adobe-stock-asset-api-data-creator-interface:
+    type: object
+    description: Adobe Stock creator data class
+    properties:
+      id:
+        type: integer
+        description: The id
+      name:
+        type: string
+        description: The creator name
+      extension_attributes:
+        "$ref": "#/definitions/adobe-stock-asset-api-data-creator-extension-interface"
+    required:
+    - extension_attributes
+  adobe-stock-asset-api-data-creator-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\AdobeStockAssetApi\Api\Data\CreatorInterface
+  adobe-stock-asset-api-data-asset-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\AdobeStockAssetApi\Api\Data\AssetInterface
+  adobe-stock-asset-api-data-asset-search-results-interface:
+    type: object
+    description: Interface AssetSearchResultsInterface
+    properties:
+      items:
+        type: array
+        description: Assets list.
+        items:
+          "$ref": "#/definitions/adobe-stock-asset-api-data-asset-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  asynchronous-operations-data-detailed-bulk-operations-status-interface:
+    type: object
+    description: Interface BulkStatusInterface Bulk summary data with list of operations
+      items full data.
+    properties:
+      operations_list:
+        type: array
+        description: Operations list.
+        items:
+          "$ref": "#/definitions/asynchronous-operations-data-operation-interface"
+      extension_attributes:
+        "$ref": "#/definitions/asynchronous-operations-data-bulk-summary-extension-interface"
+      user_type:
+        type: integer
+        description: User type
+      bulk_id:
+        type: string
+        description: Bulk uuid
+      description:
+        type: string
+        description: Bulk description
+      start_time:
+        type: string
+        description: Bulk scheduled time
+      user_id:
+        type: integer
+        description: User id
+      operation_count:
+        type: integer
+        description: Total number of operations scheduled in scope of this bulk
+    required:
+    - operations_list
+    - user_type
+    - bulk_id
+    - description
+    - start_time
+    - user_id
+    - operation_count
+  asynchronous-operations-data-operation-interface:
+    type: object
+    description: Class OperationInterface
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/asynchronous-operations-data-operation-extension-interface"
+      id:
+        type: integer
+        description: Id
+      bulk_uuid:
+        type: string
+        description: Bulk uuid
+      topic_name:
+        type: string
+        description: Queue Topic
+      serialized_data:
+        type: string
+        description: Data
+      result_serialized_data:
+        type: string
+        description: Serialized Data
+      status:
+        type: integer
+        description: Operation status
+      result_message:
+        type: string
+        description: Result message
+      error_code:
+        type: integer
+        description: Error code
+    required:
+    - id
+    - bulk_uuid
+    - topic_name
+    - serialized_data
+    - result_serialized_data
+    - status
+    - result_message
+    - error_code
+  asynchronous-operations-data-operation-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\AsynchronousOperations\Api\Data\OperationInterface
+    properties:
+      start_time:
+        type: string
+  asynchronous-operations-data-bulk-summary-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\AsynchronousOperations\Api\Data\BulkSummaryInterface
+  asynchronous-operations-data-bulk-operations-status-interface:
+    type: object
+    description: Interface BulkStatusInterface Bulk summary data with list of operations
+      items summary data.
+    properties:
+      operations_list:
+        type: array
+        description: List of operation with statuses (short data).
+        items:
+          "$ref": "#/definitions/asynchronous-operations-data-summary-operation-status-interface"
+      extension_attributes:
+        "$ref": "#/definitions/asynchronous-operations-data-bulk-summary-extension-interface"
+      user_type:
+        type: integer
+        description: User type
+      bulk_id:
+        type: string
+        description: Bulk uuid
+      description:
+        type: string
+        description: Bulk description
+      start_time:
+        type: string
+        description: Bulk scheduled time
+      user_id:
+        type: integer
+        description: User id
+      operation_count:
+        type: integer
+        description: Total number of operations scheduled in scope of this bulk
+    required:
+    - operations_list
+    - user_type
+    - bulk_id
+    - description
+    - start_time
+    - user_id
+    - operation_count
+  asynchronous-operations-data-summary-operation-status-interface:
+    type: object
+    description: Getter Class OperationsStatusInterface Instead of OperationInterface
+      this class don't provide all operation data and not responsive to set any data,
+      just to get operation data without serialized_data and result_serialized_data
+    properties:
+      id:
+        type: integer
+        description: Id
+      status:
+        type: integer
+        description: Operation status
+      result_message:
+        type: string
+        description: Result message
+      error_code:
+        type: integer
+        description: Error code
+    required:
+    - id
+    - status
+    - result_message
+    - error_code
+  asynchronous-operations-data-operation-search-results-interface:
+    type: object
+    description: Bulk operation search result interface. An bulk is a group of queue
+      messages. An bulk operation item is a queue message.
+    properties:
+      items:
+        type: array
+        description: List of operations.
+        items:
+          "$ref": "#/definitions/asynchronous-operations-data-operation-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  rma-data-track-interface:
+    type: object
+    description: Interface TrackInterface
+    properties:
+      entity_id:
+        type: integer
+        description: Entity id
+      rma_entity_id:
+        type: integer
+        description: Rma entity id
+      track_number:
+        type: string
+        description: Track number
+      carrier_title:
+        type: string
+        description: Carrier title
+      carrier_code:
+        type: string
+        description: Carrier code
+      extension_attributes:
+        "$ref": "#/definitions/rma-data-track-extension-interface"
+    required:
+    - entity_id
+    - rma_entity_id
+    - track_number
+    - carrier_title
+    - carrier_code
+  rma-data-track-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Rma\Api\Data\TrackInterface
+  rma-data-track-search-result-interface:
+    type: object
+    description: Interface TrackSearchResultInterface
+    properties:
+      items:
+        type: array
+        description: Rma list
+        items:
+          "$ref": "#/definitions/rma-data-track-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  rma-data-rma-interface:
+    type: object
+    description: Interface RmaInterface
+    properties:
+      increment_id:
+        type: string
+        description: Entity_id
+      entity_id:
+        type: integer
+        description: Entity_id
+      order_id:
+        type: integer
+        description: Order_id
+      order_increment_id:
+        type: string
+        description: Order_increment_id
+      store_id:
+        type: integer
+        description: Store_id
+      customer_id:
+        type: integer
+        description: Customer_id
+      date_requested:
+        type: string
+        description: Date_requested
+      customer_custom_email:
+        type: string
+        description: Customer_custom_email
+      items:
+        type: array
+        description: Items
+        items:
+          "$ref": "#/definitions/rma-data-item-interface"
+      status:
+        type: string
+        description: Status
+      comments:
+        type: array
+        description: Comments list
+        items:
+          "$ref": "#/definitions/rma-data-comment-interface"
+      tracks:
+        type: array
+        description: Tracks list
+        items:
+          "$ref": "#/definitions/rma-data-track-interface"
+      extension_attributes:
+        "$ref": "#/definitions/rma-data-rma-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - increment_id
+    - entity_id
+    - order_id
+    - order_increment_id
+    - store_id
+    - customer_id
+    - date_requested
+    - customer_custom_email
+    - items
+    - status
+    - comments
+    - tracks
+  rma-data-item-interface:
+    type: object
+    description: Interface CategoryInterface
+    properties:
+      entity_id:
+        type: integer
+        description: Id
+      rma_entity_id:
+        type: integer
+        description: RMA id
+      order_item_id:
+        type: integer
+        description: Order_item_id
+      qty_requested:
+        type: integer
+        description: Qty_requested
+      qty_authorized:
+        type: integer
+        description: Qty_authorized
+      qty_approved:
+        type: integer
+        description: Qty_approved
+      qty_returned:
+        type: integer
+        description: Qty_returned
+      reason:
+        type: string
+        description: Reason
+      condition:
+        type: string
+        description: Condition
+      resolution:
+        type: string
+        description: Resolution
+      status:
+        type: string
+        description: Status
+      extension_attributes:
+        "$ref": "#/definitions/rma-data-item-extension-interface"
+    required:
+    - entity_id
+    - rma_entity_id
+    - order_item_id
+    - qty_requested
+    - qty_authorized
+    - qty_approved
+    - qty_returned
+    - reason
+    - condition
+    - resolution
+    - status
+  rma-data-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Rma\Api\Data\ItemInterface
+  rma-data-comment-interface:
+    type: object
+    description: Interface CommentInterface
+    properties:
+      comment:
+        type: string
+        description: Comment
+      rma_entity_id:
+        type: integer
+        description: Rma Id
+      created_at:
+        type: string
+        description: Created_at
+      entity_id:
+        type: integer
+        description: Entity_id
+      customer_notified:
+        type: boolean
+        description: Is_customer_notified
+      visible_on_front:
+        type: boolean
+        description: Is_visible_on_front
+      status:
+        type: string
+        description: Status
+      admin:
+        type: boolean
+        description: Is_admin
+      extension_attributes:
+        "$ref": "#/definitions/rma-data-comment-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - comment
+    - rma_entity_id
+    - created_at
+    - entity_id
+    - customer_notified
+    - visible_on_front
+    - status
+    - admin
+  rma-data-comment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Rma\Api\Data\CommentInterface
+  rma-data-rma-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Rma\Api\Data\RmaInterface
+  rma-data-comment-search-result-interface:
+    type: object
+    description: Interface CommentSearchResultInterface
+    properties:
+      items:
+        type: array
+        description: Rma Status History list
+        items:
+          "$ref": "#/definitions/rma-data-comment-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  rma-data-rma-search-result-interface:
+    type: object
+    description: Interface RmaSearchResultInterface
+    properties:
+      items:
+        type: array
+        description: Rma list
+        items:
+          "$ref": "#/definitions/rma-data-rma-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_criteria
+    - total_count
+  framework-metadata-object-interface:
+    type: object
+    description: Provides metadata about an attribute.
+    properties:
+      attribute_code:
+        type: string
+        description: Code of the attribute.
+    required:
+    - attribute_code
+  payment-services-paypal-payment-config-response-interface:
+    type: object
+    description: ''
+    properties:
+      apple_pay:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface"
+      google_pay:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface"
+      hosted_fields:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface"
+      smart_buttons:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface"
+    required:
+    - apple_pay
+    - google_pay
+    - hosted_fields
+    - smart_buttons
+  payment-services-paypal-data-payment-config-apple-pay-interface:
+    type: object
+    description: ''
+    properties:
+      button_styles:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface"
+      payment_source:
+        type: string
+        description: PaymentSource
+      code:
+        type: string
+        description: Code
+      sdk_params:
+        type: array
+        description: SDK params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+      is_visible:
+        type: boolean
+        description: Visible
+      sort_order:
+        type: string
+        description: Sort Order
+      payment_intent:
+        type: string
+        description: Payment intent
+      title:
+        type: string
+        description: Title
+    required:
+    - button_styles
+    - payment_source
+    - code
+    - sdk_params
+    - is_visible
+    - sort_order
+    - payment_intent
+    - title
+  payment-services-paypal-data-payment-config-button-styles-interface:
+    type: object
+    description: ''
+    properties:
+      layout:
+        type: string
+        description: Layout
+      color:
+        type: string
+        description: Color
+      shape:
+        type: string
+        description: Shape
+      label:
+        type: string
+        description: Label
+      tagline:
+        type: boolean
+        description: ShowTagline
+      height:
+        type: integer
+        description: Height
+      use_default_height:
+        type: boolean
+        description: Height
+    required:
+    - layout
+    - color
+    - shape
+    - label
+    - tagline
+    - height
+    - use_default_height
+  payment-services-paypal-data-payment-config-sdk-params-interface:
+    type: object
+    description: ''
+    properties:
+      name:
+        type: string
+        description: Code
+      value:
+        type: string
+        description: Config
+    required:
+    - name
+    - value
+  payment-services-paypal-data-payment-config-google-pay-interface:
+    type: object
+    description: ''
+    properties:
+      button_styles:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-button-styles-interface"
+      payment_source:
+        type: string
+        description: PaymentSource
+      three_d_s:
+        type: string
+        description: ThreeDS
+      code:
+        type: string
+        description: Code
+      sdk_params:
+        type: array
+        description: SDK params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+      is_visible:
+        type: boolean
+        description: Visible
+      sort_order:
+        type: string
+        description: Sort Order
+      payment_intent:
+        type: string
+        description: Payment intent
+      title:
+        type: string
+        description: Title
+    required:
+    - button_styles
+    - payment_source
+    - three_d_s
+    - code
+    - sdk_params
+    - is_visible
+    - sort_order
+    - payment_intent
+    - title
+  payment-services-paypal-data-payment-config-google-pay-button-styles-interface:
+    type: object
+    description: ''
+    properties:
+      color:
+        type: string
+        description: Color
+      height:
+        type: integer
+        description: Height
+      type:
+        type: string
+        description: Type
+    required:
+    - color
+    - height
+    - type
+  payment-services-paypal-data-payment-config-hosted-fields-interface:
+    type: object
+    description: ''
+    properties:
+      payment_source:
+        type: string
+        description: Payment Source
+      three_d_s:
+        type: string
+        description: ThreeDS
+      is_vault_enabled:
+        type: boolean
+        description: HasIsVaultEnabled
+      cc_vault_code:
+        type: string
+        description: CcVaultCode
+      requires_card_details:
+        type: boolean
+        description: RequiresCardDetails
+      code:
+        type: string
+        description: Code
+      sdk_params:
+        type: array
+        description: SDK params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+      is_visible:
+        type: boolean
+        description: Visible
+      sort_order:
+        type: string
+        description: Sort Order
+      payment_intent:
+        type: string
+        description: Payment intent
+      title:
+        type: string
+        description: Title
+    required:
+    - payment_source
+    - three_d_s
+    - is_vault_enabled
+    - cc_vault_code
+    - requires_card_details
+    - code
+    - sdk_params
+    - is_visible
+    - sort_order
+    - payment_intent
+    - title
+  payment-services-paypal-data-payment-config-smart-buttons-interface:
+    type: object
+    description: ''
+    properties:
+      display_message:
+        type: boolean
+        description: CanDisplayMessage
+      display_venmo:
+        type: boolean
+        description: Venmo
+      message_styles:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface"
+      button_styles:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface"
+      app_switch_when_available:
+        type: boolean
+        description: AppSwitchWhenAvailable
+      code:
+        type: string
+        description: Code
+      sdk_params:
+        type: array
+        description: SDK params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+      is_visible:
+        type: boolean
+        description: Visible
+      sort_order:
+        type: string
+        description: Sort Order
+      payment_intent:
+        type: string
+        description: Payment intent
+      title:
+        type: string
+        description: Title
+    required:
+    - display_message
+    - display_venmo
+    - message_styles
+    - button_styles
+    - app_switch_when_available
+    - code
+    - sdk_params
+    - is_visible
+    - sort_order
+    - payment_intent
+    - title
+  payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface:
+    type: object
+    description: ''
+    properties:
+      layout:
+        type: string
+        description: CanDisplayMessage
+      logo:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-logo-interface"
+    required:
+    - layout
+    - logo
+  payment-services-paypal-data-payment-config-smart-buttons-logo-interface:
+    type: object
+    description: ''
+    properties:
+      type:
+        type: string
+        description: CanDisplayMessage
+    required:
+    - type
+  payment-services-paypal-data-payment-order-interface:
+    type: object
+    description: Interface PaymentOrderInterface
+    properties:
+      id:
+        type: string
+        description: Payment order id
+      mp_order_id:
+        type: string
+        description: Payment order mpOrderId
+      status:
+        type: string
+        description: Payment order status
+      amount:
+        type: number
+        description: Payment order amount
+      currency_code:
+        type: string
+        description: Payment order currency code
+    required:
+    - id
+    - mp_order_id
+    - status
+    - amount
+    - currency_code
+  payment-services-paypal-data-payment-order-details-interface:
+    type: object
+    description: Interface PaymentOrderDetailsInterface
+    properties:
+      payment_source_details:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-source-details-interface"
+      id:
+        type: string
+        description: Payment order id
+      mp_order_id:
+        type: string
+        description: Payment order mpOrderId
+      status:
+        type: string
+        description: Payment order status
+      amount:
+        type: number
+        description: Payment order amount
+      currency_code:
+        type: string
+        description: Payment order currency code
+    required:
+    - payment_source_details
+    - id
+    - mp_order_id
+    - status
+    - amount
+    - currency_code
+  payment-services-paypal-data-payment-source-details-interface:
+    type: object
+    description: ''
+    properties:
+      card:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-card-details-interface"
+    required:
+    - card
+  payment-services-paypal-data-payment-card-details-interface:
+    type: object
+    description: ''
+    properties:
+      name:
+        type: string
+        description: Name
+      last_digits:
+        type: string
+        description: Last digits
+      card_expiry_month:
+        type: string
+        description: Card expiry month
+      card_expiry_year:
+        type: string
+        description: Card expiry year
+      bin_details:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-card-bin-details-interface"
+    required:
+    - name
+    - last_digits
+    - card_expiry_month
+    - card_expiry_year
+    - bin_details
+  payment-services-paypal-data-payment-card-bin-details-interface:
+    type: object
+    description: ''
+    properties:
+      bin:
+        type: string
+        description: Bin
+    required:
+    - bin
+  payment-services-paypal-data-payment-sdk-params-interface:
+    type: object
+    description: ''
+    properties:
+      code:
+        type: string
+        description: The payments sdk code
+      params:
+        type: array
+        description: The payments sdk params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+    required:
+    - code
+    - params
+  pay-pal-braintree-data-auth-data-interface:
+    type: object
+    description: Interface AuthDataInterface
+    properties:
+      client_token:
+        type: string
+        description: Client token
+      display_name:
+        type: string
+        description: Display name
+      action_success:
+        type: string
+        description: To success page
+      logged_in:
+        type: boolean
+        description: Logged in
+      store_code:
+        type: string
+        description: Current store code
+    required:
+    - display_name
+    - action_success
+    - logged_in
+    - store_code
+  pay-pal-braintree-data-payment-interface:
+    type: object
+    description: ''
+    properties:
+      payment_method_code:
+        type: string
+        description: The payment method code.
+      payment_method_nonce:
+        type: string
+        description: The payment method nonce.
+      device_data:
+        type: string
+        description: The device data.
+x-tagGroups:
+- name: addresses
+  tags:
+  - addresses/{addressId}
+- name: adminuisdk
+  tags:
+  - adminuisdk/appmanagement/validate
+  - adminuisdk/massaction/{request_id}
+  - adminuisdk/orderviewbutton/{request_id}
+- name: adobe_io_events
+  tags:
+  - adobe_io_events/check_configuration
+- name: adobestock
+  tags:
+  - adobestock/asset/list
+  - adobestock/asset/search
+  - adobestock/asset/{id}
+  - adobestock/search
+- name: analytics
+  tags:
+  - analytics/link
+- name: applepay
+  tags:
+  - applepay/auth
+- name: attributeMetadata
+  tags:
+  - attributeMetadata/customer
+  - attributeMetadata/customer/attribute/{attributeCode}
+  - attributeMetadata/customer/custom
+  - attributeMetadata/customer/form/{formCode}
+  - attributeMetadata/customerAddress
+  - attributeMetadata/customerAddress/attribute/{attributeCode}
+  - attributeMetadata/customerAddress/custom
+  - attributeMetadata/customerAddress/form/{formCode}
+- name: braintree
+  tags:
+  - braintree/mine/payment/vault
+- name: bulk
+  tags:
+  - bulk
+  - bulk/{bulkUuid}/detailed-status
+  - bulk/{bulkUuid}/operation-status/{status}
+  - bulk/{bulkUuid}/status
+- name: bundle products
+  tags:
+  - bundle-products/options/add
+  - bundle-products/options/types
+  - bundle-products/options/{optionId}
+  - bundle-products/{productSku}/children
+  - bundle-products/{sku}/links/{id}
+  - bundle-products/{sku}/links/{optionId}
+  - bundle-products/{sku}/options/all
+  - bundle-products/{sku}/options/{optionId}
+  - bundle-products/{sku}/options/{optionId}/children/{childSku}
+- name: carts
+  tags:
+  - carts/
+  - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
+  - carts/guest-carts/{cartId}/giftCards
+  - carts/guest-carts/{cartId}/giftCards/{giftCardCode}
+  - carts/licence
+  - carts/licence/list
+  - carts/mine
+  - carts/mine/balance/apply
+  - carts/mine/billing-address
+  - carts/mine/checkGiftCard/{giftCardCode}
+  - carts/mine/collect-totals
+  - carts/mine/coupons
+  - carts/mine/coupons/deleteByCodes
+  - carts/mine/coupons/{couponCode}
+  - carts/mine/estimate-shipping-methods
+  - carts/mine/estimate-shipping-methods-by-address-id
+  - carts/mine/gift-message
+  - carts/mine/gift-message/{itemId}
+  - carts/mine/giftCards
+  - carts/mine/giftCards/{giftCardCode}
+  - carts/mine/items
+  - carts/mine/items/{itemId}
+  - carts/mine/order
+  - carts/mine/payment-information
+  - carts/mine/payment-methods
+  - carts/mine/payment-order
+  - carts/mine/payment-order/{id}
+  - carts/mine/po-payment-information
+  - carts/mine/selected-payment-method
+  - carts/mine/set-payment-information
+  - carts/mine/shipping-information
+  - carts/mine/shipping-methods
+  - carts/mine/totals
+  - carts/mine/totals-information
+  - carts/search
+  - carts/{cartId}
+  - carts/{cartId}/billing-address
+  - carts/{cartId}/coupons
+  - carts/{cartId}/coupons/deleteByCodes
+  - carts/{cartId}/coupons/{couponCode}
+  - carts/{cartId}/estimate-shipping-methods
+  - carts/{cartId}/estimate-shipping-methods-by-address-id
+  - carts/{cartId}/gift-message
+  - carts/{cartId}/gift-message/{itemId}
+  - carts/{cartId}/giftCards
+  - carts/{cartId}/giftCards/{giftCardCode}
+  - carts/{cartId}/items
+  - carts/{cartId}/items/{itemId}
+  - carts/{cartId}/order
+  - carts/{cartId}/payment-methods
+  - carts/{cartId}/selected-payment-method
+  - carts/{cartId}/shipping-information
+  - carts/{cartId}/shipping-methods
+  - carts/{cartId}/totals
+  - carts/{cartId}/totals-information
+  - carts/{quoteId}/giftCards
+  - carts/{quoteId}/items
+- name: categories
+  tags:
+  - categories
+  - categories/attributes
+  - categories/attributes/{attributeCode}
+  - categories/attributes/{attributeCode}/options
+  - categories/list
+  - categories/{categoryId}
+  - categories/{categoryId}/move
+  - categories/{categoryId}/products
+  - categories/{categoryId}/products/{sku}
+  - categories/{id}
+- name: cmsBlock
+  tags:
+  - cmsBlock
+  - cmsBlock/search
+  - cmsBlock/{blockId}
+  - cmsBlock/{id}
+- name: cmsPage
+  tags:
+  - cmsPage
+  - cmsPage/search
+  - cmsPage/{id}
+  - cmsPage/{pageId}
+- name: company
+  tags:
+  - company/
+  - company/assignRoles
+  - company/relations
+  - company/role/
+  - company/role/{id}
+  - company/role/{roleId}
+  - company/role/{roleId}/users
+  - company/{companyId}
+  - company/{parentId}/relations
+  - company/{parentId}/relations/{companyId}
+- name: companyCredits
+  tags:
+  - companyCredits/
+  - companyCredits/company/{companyId}
+  - companyCredits/history
+  - companyCredits/history/{historyId}
+  - companyCredits/{creditId}
+  - companyCredits/{creditId}/decreaseBalance
+  - companyCredits/{creditId}/increaseBalance
+  - companyCredits/{id}
+- name: configurable products
+  tags:
+  - configurable-products/variation
+  - configurable-products/{sku}/child
+  - configurable-products/{sku}/children
+  - configurable-products/{sku}/children/{childSku}
+  - configurable-products/{sku}/options
+  - configurable-products/{sku}/options/all
+  - configurable-products/{sku}/options/{id}
+- name: coupons
+  tags:
+  - coupons
+  - coupons/deleteByCodes
+  - coupons/deleteByIds
+  - coupons/generate
+  - coupons/search
+  - coupons/{couponId}
+- name: creditmemo
+  tags:
+  - creditmemo
+  - creditmemo/refund
+  - creditmemo/{id}
+  - creditmemo/{id}/comments
+  - creditmemo/{id}/emails
+- name: creditmemos
+  tags:
+  - creditmemos
+- name: customerGroups
+  tags:
+  - customerGroups
+  - customerGroups/default
+  - customerGroups/default/{id}
+  - customerGroups/default/{storeId}
+  - customerGroups/search
+  - customerGroups/{id}
+  - customerGroups/{id}/permissions
+- name: customers
+  tags:
+  - customers
+  - customers/activate
+  - customers/addresses/{addressId}
+  - customers/companies
+  - customers/confirm
+  - customers/isEmailAvailable
+  - customers/me
+  - customers/me/activate
+  - customers/me/billingAddress
+  - customers/me/password
+  - customers/me/shippingAddress
+  - customers/password
+  - customers/resetPassword
+  - customers/search
+  - customers/validate
+  - customers/{customerId}
+  - customers/{customerId}/billingAddress
+  - customers/{customerId}/carts
+  - customers/{customerId}/companies
+  - customers/{customerId}/companies/{companyId}
+  - customers/{customerId}/confirm
+  - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
+  - customers/{customerId}/permissions/readonly
+  - customers/{customerId}/shippingAddress
+  - customers/{customerId}/token
+  - customers/{email}/activate
+- name: directory
+  tags:
+  - directory/countries
+  - directory/countries/{countryId}
+  - directory/currency
+- name: eav
+  tags:
+  - eav/attribute-sets
+  - eav/attribute-sets/list
+  - eav/attribute-sets/{attributeSetId}
+- name: eventing
+  tags:
+  - eventing/eventProvider
+  - eventing/eventProvider/{providerId}
+  - eventing/eventSubscribe
+  - eventing/eventSubscribe/{name}
+  - eventing/eventUnsubscribe/{name}
+  - eventing/getEventProviders
+  - eventing/getEventSubscriptions
+  - eventing/updateConfiguration
+- name: gift wrappings
+  tags:
+  - gift-wrappings
+  - gift-wrappings/{id}
+  - gift-wrappings/{wrappingId}
+- name: giftregistry
+  tags:
+  - giftregistry/mine/estimate-shipping-methods
+- name: guest carts
+  tags:
+  - guest-carts
+  - guest-carts/{cartId}
+  - guest-carts/{cartId}/billing-address
+  - guest-carts/{cartId}/collect-totals
+  - guest-carts/{cartId}/coupons
+  - guest-carts/{cartId}/coupons/{couponCode}
+  - guest-carts/{cartId}/estimate-shipping-methods
+  - guest-carts/{cartId}/gift-message
+  - guest-carts/{cartId}/gift-message/{itemId}
+  - guest-carts/{cartId}/items
+  - guest-carts/{cartId}/items/{itemId}
+  - guest-carts/{cartId}/order
+  - guest-carts/{cartId}/payment-information
+  - guest-carts/{cartId}/payment-methods
+  - guest-carts/{cartId}/payment-order
+  - guest-carts/{cartId}/payment-order/{id}
+  - guest-carts/{cartId}/selected-payment-method
+  - guest-carts/{cartId}/set-payment-information
+  - guest-carts/{cartId}/shipping-information
+  - guest-carts/{cartId}/shipping-methods
+  - guest-carts/{cartId}/totals
+  - guest-carts/{cartId}/totals-information
+- name: guest giftregistry
+  tags:
+  - guest-giftregistry/{cartId}/estimate-shipping-methods
+- name: hierarchy
+  tags:
+  - hierarchy/move/{id}
+  - hierarchy/{id}
+- name: import
+  tags:
+  - import/csv
+  - import/json
+- name: integration
+  tags:
+  - integration/admin/token
+  - integration/customer/revoke-customer-token
+  - integration/customer/token
+- name: inventory
+  tags:
+  - inventory/are-product-salable-for-requested-qty/
+  - inventory/are-products-salable
+  - inventory/bulk-partial-source-transfer
+  - inventory/bulk-product-source-assign
+  - inventory/bulk-product-source-transfer
+  - inventory/bulk-product-source-unassign
+  - inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode}
+  - inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode}
+  - inventory/get-distance
+  - inventory/get-distance-provider-code
+  - inventory/get-latlng-from-address
+  - inventory/get-latslngs-from-address
+  - inventory/get-product-salable-quantity/{sku}/{stockId}
+  - inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId}
+  - inventory/in-store-pickup/pickup-locations/
+  - inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty}
+  - inventory/is-product-salable/{sku}/{stockId}
+  - inventory/low-quantity-notification
+  - inventory/low-quantity-notification/{sourceCode}/{sku}
+  - inventory/low-quantity-notifications-delete
+  - inventory/source-items
+  - inventory/source-items-delete
+  - inventory/source-selection-algorithm-list
+  - inventory/source-selection-algorithm-result
+  - inventory/sources
+  - inventory/sources/{sourceCode}
+  - inventory/stock-resolver/{type}/{code}
+  - inventory/stock-source-links
+  - inventory/stock-source-links-delete
+  - inventory/stocks
+  - inventory/stocks/{stockId}
+- name: invoice
+  tags:
+  - invoice/{invoiceId}/refund
+- name: invoices
+  tags:
+  - invoices
+  - invoices/
+  - invoices/comments
+  - invoices/{id}
+  - invoices/{id}/capture
+  - invoices/{id}/comments
+  - invoices/{id}/emails
+  - invoices/{id}/void
+- name: modules
+  tags:
+  - modules
+- name: negotiable cart item note
+  tags:
+  - negotiable-cart-item-note
+  - negotiable-cart-item-note/search
+  - negotiable-cart-item-note/{noteId}
+- name: negotiable carts
+  tags:
+  - negotiable-carts/{cartId}/billing-address
+  - negotiable-carts/{cartId}/coupons
+  - negotiable-carts/{cartId}/coupons/{couponCode}
+  - negotiable-carts/{cartId}/estimate-shipping-methods
+  - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
+  - negotiable-carts/{cartId}/giftCards
+  - negotiable-carts/{cartId}/giftCards/{giftCardCode}
+  - negotiable-carts/{cartId}/payment-information
+  - negotiable-carts/{cartId}/po-payment-information
+  - negotiable-carts/{cartId}/set-payment-information
+  - negotiable-carts/{cartId}/shipping-information
+  - negotiable-carts/{cartId}/totals
+- name: negotiableQuote
+  tags:
+  - negotiableQuote/attachmentContent
+  - negotiableQuote/decline
+  - negotiableQuote/draft
+  - negotiableQuote/pricesUpdated
+  - negotiableQuote/request
+  - negotiableQuote/submitToCustomer
+  - negotiableQuote/{negotiableQuoteId}/duplicate
+  - negotiableQuote/{quoteId}
+  - negotiableQuote/{quoteId}/comments
+  - negotiableQuote/{quoteId}/shippingMethod
+- name: negotiableQuoteTemplate
+  tags:
+  - negotiableQuoteTemplate
+  - negotiableQuoteTemplate/accept
+  - negotiableQuoteTemplate/cancel
+  - negotiableQuoteTemplate/cancel/me
+  - negotiableQuoteTemplate/decline
+  - negotiableQuoteTemplate/draft
+  - negotiableQuoteTemplate/generateQuote
+  - negotiableQuoteTemplate/me
+  - negotiableQuoteTemplate/me/{templateId}
+  - negotiableQuoteTemplate/open
+  - negotiableQuoteTemplate/open/me
+  - negotiableQuoteTemplate/referenceDocumentLink
+  - negotiableQuoteTemplate/referenceDocumentLink/{linkId}
+  - negotiableQuoteTemplate/request
+  - negotiableQuoteTemplate/request/me
+  - negotiableQuoteTemplate/submitToCustomer
+  - negotiableQuoteTemplate/submitToSeller
+  - negotiableQuoteTemplate/{templateId}
+- name: order
+  tags:
+  - order/notify-orders-are-ready-for-pickup
+  - order/{orderId}/invoice
+  - order/{orderId}/refund
+  - order/{orderId}/ship
+- name: orders
+  tags:
+  - orders
+  - orders/create
+  - orders/items
+  - orders/items/{id}
+  - orders/{id}
+  - orders/{id}/cancel
+  - orders/{id}/comments
+  - orders/{id}/emails
+  - orders/{id}/hold
+  - orders/{id}/statuses
+  - orders/{id}/unhold
+  - orders/{parent_id}
+- name: payment order
+  tags:
+  - payment-order/completeOrder
+- name: payments config
+  tags:
+  - payments-config/apple-pay/{location}
+  - payments-config/google-pay/{location}
+  - payments-config/hosted-fields/{location}
+  - payments-config/smart-buttons/{location}
+  - payments-config/{location}
+- name: payments sdk
+  tags:
+  - payments-sdk/{location}
+  - payments-sdk/{location}/{methodCode}
+- name: paypal
+  tags:
+  - paypal/lineItems
+  - paypal/oneClick
+  - paypal/validatePhoneNumber
+- name: products
+  tags:
+  - products
+  - products/attribute-sets
+  - products/attribute-sets/attributes
+  - products/attribute-sets/groups
+  - products/attribute-sets/groups/list
+  - products/attribute-sets/groups/{groupId}
+  - products/attribute-sets/sets/list
+  - products/attribute-sets/{attributeSetId}
+  - products/attribute-sets/{attributeSetId}/attributes
+  - products/attribute-sets/{attributeSetId}/attributes/{attributeCode}
+  - products/attribute-sets/{attributeSetId}/groups
+  - products/attributes
+  - products/attributes/types
+  - products/attributes/{attributeCode}
+  - products/attributes/{attributeCode}/is-filterable
+  - products/attributes/{attributeCode}/is-filterable/{isFilterable}
+  - products/attributes/{attributeCode}/options
+  - products/attributes/{attributeCode}/options/{optionId}
+  - products/base-prices
+  - products/base-prices-information
+  - products/cost
+  - products/cost-delete
+  - products/cost-information
+  - products/downloadable-links/samples/{id}
+  - products/downloadable-links/{id}
+  - products/links/types
+  - products/links/{type}/attributes
+  - products/media/types/{attributeSetName}
+  - products/options
+  - products/options/types
+  - products/options/{optionId}
+  - products/special-price
+  - products/special-price-delete
+  - products/special-price-information
+  - products/tier-prices
+  - products/tier-prices-delete
+  - products/tier-prices-information
+  - products/types
+  - products/{productSku}/stockItems/{itemId}
+  - products/{sku}
+  - products/{sku}/downloadable-links
+  - products/{sku}/downloadable-links/samples
+  - products/{sku}/downloadable-links/samples/{id}
+  - products/{sku}/downloadable-links/{id}
+  - products/{sku}/group-prices/{customerGroupId}/tiers
+  - products/{sku}/group-prices/{customerGroupId}/tiers/{qty}
+  - products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}
+  - products/{sku}/links
+  - products/{sku}/links/{type}
+  - products/{sku}/links/{type}/{linkedProductSku}
+  - products/{sku}/media
+  - products/{sku}/media/{entryId}
+  - products/{sku}/options
+  - products/{sku}/options/{optionId}
+  - products/{sku}/websites
+  - products/{sku}/websites/{websiteId}
+- name: products render info
+  tags:
+  - products-render-info
+- name: purchase order carts
+  tags:
+  - purchase-order-carts/{cartId}/billing-address
+  - purchase-order-carts/{cartId}/estimate-shipping-methods
+  - purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id
+  - purchase-order-carts/{cartId}/giftCards
+  - purchase-order-carts/{cartId}/giftCards/{giftCardCode}
+  - purchase-order-carts/{cartId}/payment-information
+  - purchase-order-carts/{cartId}/set-payment-information
+  - purchase-order-carts/{cartId}/totals
+- name: requisition_lists
+  tags:
+  - requisition_lists
+- name: returns
+  tags:
+  - returns
+  - returns/{id}
+  - returns/{id}/comments
+  - returns/{id}/labels
+  - returns/{id}/tracking-numbers
+  - returns/{id}/tracking-numbers/{trackId}
+- name: returnsAttributeMetadata
+  tags:
+  - returnsAttributeMetadata
+  - returnsAttributeMetadata/custom
+  - returnsAttributeMetadata/form/{formCode}
+  - returnsAttributeMetadata/{attributeCode}
+- name: reward
+  tags:
+  - reward/mine/use-reward
+- name: salesRules
+  tags:
+  - salesRules
+  - salesRules/search
+  - salesRules/{ruleId}
+- name: search
+  tags:
+  - search
+- name: sharedCatalog
+  tags:
+  - sharedCatalog
+  - sharedCatalog/
+  - sharedCatalog/{id}
+  - sharedCatalog/{id}/assignCategories
+  - sharedCatalog/{id}/assignProducts
+  - sharedCatalog/{id}/categories
+  - sharedCatalog/{id}/products
+  - sharedCatalog/{id}/unassignCategories
+  - sharedCatalog/{id}/unassignProducts
+  - sharedCatalog/{sharedCatalogId}
+  - sharedCatalog/{sharedCatalogId}/assignCompanies
+  - sharedCatalog/{sharedCatalogId}/assignTierPrices
+  - sharedCatalog/{sharedCatalogId}/companies
+  - sharedCatalog/{sharedCatalogId}/resetTierPrices
+  - sharedCatalog/{sharedCatalogId}/unassignCompanies
+- name: shipment
+  tags:
+  - shipment/
+  - shipment/track
+  - shipment/track/{id}
+  - shipment/{id}
+  - shipment/{id}/comments
+  - shipment/{id}/emails
+  - shipment/{id}/label
+- name: shipments
+  tags:
+  - shipments
+- name: stockItems
+  tags:
+  - stockItems/lowStock/
+  - stockItems/{productSku}
+- name: stockStatuses
+  tags:
+  - stockStatuses/{productSku}
+- name: store
+  tags:
+  - store/storeConfigs
+  - store/storeGroups
+  - store/storeViews
+  - store/websites
+- name: taxClasses
+  tags:
+  - taxClasses
+  - taxClasses/search
+  - taxClasses/{classId}
+  - taxClasses/{taxClassId}
+- name: taxRates
+  tags:
+  - taxRates
+  - taxRates/search
+  - taxRates/{rateId}
+- name: taxRules
+  tags:
+  - taxRules
+  - taxRules/search
+  - taxRules/{ruleId}
+- name: team
+  tags:
+  - team/
+  - team/{companyId}
+  - team/{teamId}
+- name: tfa
+  tags:
+  - tfa/default-provider-code/{userId}
+  - tfa/forced-providers
+  - tfa/installed-providers
+  - tfa/provider/authy/activate
+  - tfa/provider/authy/authenticate
+  - tfa/provider/authy/authenticate-onetouch
+  - tfa/provider/authy/configure
+  - tfa/provider/authy/send-token/{via}
+  - tfa/provider/duo_security/activate
+  - tfa/provider/duo_security/authenticate
+  - tfa/provider/duo_security/configure
+  - tfa/provider/google/activate
+  - tfa/provider/google/authenticate
+  - tfa/provider/google/configure
+  - tfa/provider/u2fkey/activate
+  - tfa/provider/u2fkey/authentication-challenge
+  - tfa/provider/u2fkey/configure
+  - tfa/provider/u2fkey/verify
+  - tfa/providers-to-activate/{userId}
+  - tfa/tfat-providers-to-activate
+  - tfa/tfat-user-providers
+  - tfa/user-providers/{userId}
+- name: transactions
+  tags:
+  - transactions
+  - transactions/{id}
+- name: webhooks
+  tags:
+  - webhooks/list
+  - webhooks/subscribe
+  - webhooks/unsubscribe
diff --git a/src/openapi/customer-schema-2.4.9-beta-1.yaml b/src/openapi/customer-schema-2.4.9-beta-1.yaml
new file mode 100644
index 000000000..898804cf2
--- /dev/null
+++ b/src/openapi/customer-schema-2.4.9-beta-1.yaml
@@ -0,0 +1,7870 @@
+---
+securityDefinitions:
+  api_key:
+    type: apiKey
+    name: api_key
+    in: header
+swagger: '2.0'
+info:
+  version: 2.4.9-beta-1
+  title: Commerce Customer REST endpoints - All inclusive
+  description:
+    "$ref": "../_includes/redocly-intro.md"
+host: example.com
+basePath: "/rest/default"
+schemes:
+- http
+tags:
+- name: applepay/auth
+- name: braintree/mine/payment/vault
+- name: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
+- name: carts/guest-carts/{cartId}/giftCards
+- name: carts/guest-carts/{cartId}/giftCards/{giftCardCode}
+- name: carts/mine
+- name: carts/mine/balance/apply
+- name: carts/mine/checkGiftCard/{giftCardCode}
+- name: carts/mine/collect-totals
+- name: carts/mine/payment-information
+- name: carts/mine/payment-order
+- name: carts/mine/payment-order/{id}
+- name: carts/mine/po-payment-information
+- name: carts/mine/set-payment-information
+- name: customers
+- name: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
+- name: customers/isEmailAvailable
+- name: customers/me/activate
+- name: customers/me/password
+- name: customers/password
+- name: customers/resetPassword
+- name: directory/countries
+- name: directory/countries/{countryId}
+- name: directory/currency
+- name: giftregistry/mine/estimate-shipping-methods
+- name: guest-carts
+- name: guest-carts/{cartId}
+- name: guest-carts/{cartId}/billing-address
+- name: guest-carts/{cartId}/collect-totals
+- name: guest-carts/{cartId}/coupons
+- name: guest-carts/{cartId}/coupons/{couponCode}
+- name: guest-carts/{cartId}/estimate-shipping-methods
+- name: guest-carts/{cartId}/gift-message
+- name: guest-carts/{cartId}/gift-message/{itemId}
+- name: guest-carts/{cartId}/items
+- name: guest-carts/{cartId}/items/{itemId}
+- name: guest-carts/{cartId}/order
+- name: guest-carts/{cartId}/payment-information
+- name: guest-carts/{cartId}/payment-methods
+- name: guest-carts/{cartId}/payment-order
+- name: guest-carts/{cartId}/payment-order/{id}
+- name: guest-carts/{cartId}/selected-payment-method
+- name: guest-carts/{cartId}/set-payment-information
+- name: guest-carts/{cartId}/shipping-information
+- name: guest-carts/{cartId}/shipping-methods
+- name: guest-carts/{cartId}/totals
+- name: guest-carts/{cartId}/totals-information
+- name: guest-giftregistry/{cartId}/estimate-shipping-methods
+- name: integration/admin/token
+- name: integration/customer/revoke-customer-token
+- name: integration/customer/token
+- name: inventory/in-store-pickup/pickup-locations/
+- name: negotiable-carts/{cartId}/billing-address
+- name: negotiable-carts/{cartId}/coupons
+- name: negotiable-carts/{cartId}/coupons/{couponCode}
+- name: negotiable-carts/{cartId}/estimate-shipping-methods
+- name: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
+- name: negotiable-carts/{cartId}/giftCards
+- name: negotiable-carts/{cartId}/giftCards/{giftCardCode}
+- name: negotiable-carts/{cartId}/payment-information
+- name: negotiable-carts/{cartId}/po-payment-information
+- name: negotiable-carts/{cartId}/set-payment-information
+- name: negotiable-carts/{cartId}/shipping-information
+- name: negotiable-carts/{cartId}/totals
+- name: negotiableQuoteTemplate/accept
+- name: negotiableQuoteTemplate/generateQuote
+- name: negotiableQuoteTemplate/submitToSeller
+- name: payment-order/completeOrder
+- name: payments-config/{location}
+- name: payments-config/apple-pay/{location}
+- name: payments-config/google-pay/{location}
+- name: payments-config/hosted-fields/{location}
+- name: payments-config/smart-buttons/{location}
+- name: payments-sdk/{location}
+- name: payments-sdk/{location}/{methodCode}
+- name: paypal/lineItems
+- name: paypal/oneClick
+- name: paypal/validatePhoneNumber
+- name: products-render-info
+- name: purchase-order-carts/{cartId}/payment-information
+- name: purchase-order-carts/{cartId}/set-payment-information
+- name: requisition_lists
+- name: reward/mine/use-reward
+- name: search
+- name: tfa/provider/authy/activate
+- name: tfa/provider/authy/authenticate
+- name: tfa/provider/authy/authenticate-onetouch
+- name: tfa/provider/authy/configure
+- name: tfa/provider/authy/send-token/{via}
+- name: tfa/provider/duo_security/activate
+- name: tfa/provider/duo_security/authenticate
+- name: tfa/provider/duo_security/configure
+- name: tfa/provider/google/activate
+- name: tfa/provider/google/authenticate
+- name: tfa/provider/google/configure
+- name: tfa/provider/u2fkey/activate
+- name: tfa/provider/u2fkey/authentication-challenge
+- name: tfa/provider/u2fkey/configure
+- name: tfa/provider/u2fkey/verify
+- name: tfa/tfat-providers-to-activate
+- name: tfa/tfat-user-providers
+paths:
+  "/V1/applepay/auth":
+    get:
+      tags:
+      - applepay/auth
+      description: Returns details required to be able to submit a payment with Apple
+        Pay
+      operationId: GetV1ApplepayAuth
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/pay-pal-braintree-data-auth-data-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: applepay/auth
+  "/V1/braintree/mine/payment/vault":
+    post:
+      tags:
+      - braintree/mine/payment/vault
+      description: Vault a Payment nonce for a customer. Billing address is optional
+        but advised for Card vaulting.
+      operationId: PostV1BraintreeMinePaymentVault
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1BraintreeMinePaymentVaultBody
+        in: body
+        schema:
+          required:
+          - payment
+          properties:
+            payment:
+              "$ref": "#/definitions/pay-pal-braintree-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/customer-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: braintree/mine/payment/vault
+  "/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}":
+    get:
+      tags:
+      - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
+      description: Check gift card balance if added to the cart.
+      operationId: GetV1CartsGuestcartsCartIdCheckGiftCardGiftCardCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: giftCardCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: number
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
+  "/V1/carts/guest-carts/{cartId}/giftCards":
+    post:
+      tags:
+      - carts/guest-carts/{cartId}/giftCards
+      description: Add gift card to the cart.
+      operationId: PostV1CartsGuestcartsCartIdGiftCards
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1CartsGuestcartsCartIdGiftCardsBody
+        in: body
+        schema:
+          required:
+          - giftCardAccountData
+          properties:
+            giftCardAccountData:
+              "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/guest-carts/{cartId}/giftCards
+  "/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}":
+    delete:
+      tags:
+      - carts/guest-carts/{cartId}/giftCards/{giftCardCode}
+      description: Remove GiftCard Account entity.
+      operationId: DeleteV1CartsGuestcartsCartIdGiftCardsGiftCardCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: giftCardCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/guest-carts/{cartId}/giftCards/{giftCardCode}
+  "/V1/carts/mine":
+    put:
+      tags:
+      - carts/mine
+      description: Save quote
+      operationId: PutV1CartsMine
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CartsMineBody
+        in: body
+        schema:
+          required:
+          - quote
+          properties:
+            quote:
+              "$ref": "#/definitions/quote-data-cart-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine
+    get:
+      tags:
+      - carts/mine
+      description: Returns information for the cart for a specified customer.
+      operationId: GetV1CartsMine
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine
+  "/V1/carts/mine/balance/apply":
+    post:
+      tags:
+      - carts/mine/balance/apply
+      description: Apply store credit
+      operationId: PostV1CartsMineBalanceApply
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/balance/apply
+  "/V1/carts/mine/checkGiftCard/{giftCardCode}":
+    get:
+      tags:
+      - carts/mine/checkGiftCard/{giftCardCode}
+      description: Check gift card balance if applied to given cart.
+      operationId: GetV1CartsMineCheckGiftCardGiftCardCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: giftCardCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: number
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/checkGiftCard/{giftCardCode}
+  "/V1/carts/mine/collect-totals":
+    put:
+      tags:
+      - carts/mine/collect-totals
+      description: Set shipping/billing methods and additional data for cart and collect
+        totals.
+      operationId: PutV1CartsMineCollecttotals
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CartsMineCollecttotalsBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            shippingCarrierCode:
+              type: string
+              description: The carrier code.
+            shippingMethodCode:
+              type: string
+              description: The shipping method code.
+            additionalData:
+              "$ref": "#/definitions/quote-data-totals-additional-data-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/collect-totals
+  "/V1/carts/mine/payment-information":
+    post:
+      tags:
+      - carts/mine/payment-information
+      description: Set payment information and place order for a specified cart.
+      operationId: PostV1CartsMinePaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMinePaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/payment-information
+    get:
+      tags:
+      - carts/mine/payment-information
+      description: Get payment information
+      operationId: GetV1CartsMinePaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/payment-information
+  "/V1/carts/mine/payment-order":
+    post:
+      tags:
+      - carts/mine/payment-order
+      description: Create a payment order for logged in customer
+      operationId: PostV1CartsMinePaymentorder
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMinePaymentorderBody
+        in: body
+        schema:
+          required:
+          - methodCode
+          - paymentSource
+          - location
+          properties:
+            methodCode:
+              type: string
+            paymentSource:
+              type: string
+            location:
+              type: string
+            vaultIntent:
+              type: boolean
+            threeDSMode:
+              type: string
+              description: "| null $threeDSMode"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/payment-order
+  "/V1/carts/mine/payment-order/{id}":
+    get:
+      tags:
+      - carts/mine/payment-order/{id}
+      description: Get payment order for logged in customer
+      operationId: GetV1CartsMinePaymentorderId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/payment-order/{id}
+    post:
+      tags:
+      - carts/mine/payment-order/{id}
+      description: Sync payment order for logged in customer
+      operationId: PostV1CartsMinePaymentorderId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: id
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/payment-order/{id}
+  "/V1/carts/mine/po-payment-information":
+    post:
+      tags:
+      - carts/mine/po-payment-information
+      description: Set payment information and place purchase order for a specified
+        cart.
+      operationId: PostV1CartsMinePopaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMinePopaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Purchase Order ID.
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/po-payment-information
+  "/V1/carts/mine/set-payment-information":
+    post:
+      tags:
+      - carts/mine/set-payment-information
+      description: Set payment information for a specified cart.
+      operationId: PostV1CartsMineSetpaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CartsMineSetpaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/mine/set-payment-information
+  "/V1/customers":
+    post:
+      tags:
+      - customers
+      description: Create customer account. Perform necessary business operations
+        like sending email.
+      operationId: PostV1Customers
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CustomersBody
+        in: body
+        schema:
+          required:
+          - customer
+          properties:
+            customer:
+              "$ref": "#/definitions/customer-data-customer-interface"
+            password:
+              type: string
+            redirectUrl:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-customer-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers
+  "/V1/customers/isEmailAvailable":
+    post:
+      tags:
+      - customers/isEmailAvailable
+      description: Check if given email is associated with a customer account in given
+        website.
+      operationId: PostV1CustomersIsEmailAvailable
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CustomersIsEmailAvailableBody
+        in: body
+        schema:
+          required:
+          - customerEmail
+          properties:
+            customerEmail:
+              type: string
+            websiteId:
+              type: integer
+              description: If not set, will use the current websiteId
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/isEmailAvailable
+  "/V1/customers/me/activate":
+    put:
+      tags:
+      - customers/me/activate
+      description: Activate a customer account using a key that was sent in a confirmation
+        email.
+      operationId: PutV1CustomersMeActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CustomersMeActivateBody
+        in: body
+        schema:
+          required:
+          - confirmationKey
+          properties:
+            confirmationKey:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-customer-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/me/activate
+  "/V1/customers/me/password":
+    put:
+      tags:
+      - customers/me/password
+      description: Change customer password.
+      operationId: PutV1CustomersMePassword
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CustomersMePasswordBody
+        in: body
+        schema:
+          required:
+          - currentPassword
+          - newPassword
+          properties:
+            currentPassword:
+              type: string
+            newPassword:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/me/password
+  "/V1/customers/password":
+    put:
+      tags:
+      - customers/password
+      description: Send an email to the customer with a password reset link.
+      operationId: PutV1CustomersPassword
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CustomersPasswordBody
+        in: body
+        schema:
+          required:
+          - email
+          - template
+          properties:
+            email:
+              type: string
+            template:
+              type: string
+            websiteId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/password
+  "/V1/customers/resetPassword":
+    post:
+      tags:
+      - customers/resetPassword
+      description: Reset customer password.
+      operationId: PostV1CustomersResetPassword
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CustomersResetPasswordBody
+        in: body
+        schema:
+          required:
+          - email
+          - resetToken
+          - newPassword
+          properties:
+            email:
+              type: string
+              description: If empty value given then the customer will be matched
+                by the RP token.
+            resetToken:
+              type: string
+            newPassword:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/resetPassword
+  "/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":
+    get:
+      tags:
+      - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
+      description: Check if password reset token is valid.
+      operationId: GetV1CustomersCustomerIdPasswordResetLinkTokenResetPasswordLinkToken
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+        description: If null is given then a customer will be matched by the RP token.
+      - name: resetPasswordLinkToken
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: True if the token is valid
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
+  "/V1/directory/countries":
+    get:
+      tags:
+      - directory/countries
+      description: Get all countries and regions information for the store.
+      operationId: GetV1DirectoryCountries
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/directory-data-country-information-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: directory/countries
+  "/V1/directory/countries/{countryId}":
+    get:
+      tags:
+      - directory/countries/{countryId}
+      description: Get country and region information for the store.
+      operationId: GetV1DirectoryCountriesCountryId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: countryId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/directory-data-country-information-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: directory/countries/{countryId}
+  "/V1/directory/currency":
+    get:
+      tags:
+      - directory/currency
+      description: Get currency information for the store.
+      operationId: GetV1DirectoryCurrency
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/directory-data-currency-information-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: directory/currency
+  "/V1/giftregistry/mine/estimate-shipping-methods":
+    post:
+      tags:
+      - giftregistry/mine/estimate-shipping-methods
+      description: Estimate shipping
+      operationId: PostV1GiftregistryMineEstimateshippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1GiftregistryMineEstimateshippingmethodsBody
+        in: body
+        schema:
+          required:
+          - registryId
+          properties:
+            registryId:
+              type: integer
+              description: The estimate registry id
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: giftregistry/mine/estimate-shipping-methods
+  "/V1/guest-carts":
+    post:
+      tags:
+      - guest-carts
+      description: Enable an customer or guest user to create an empty cart and quote
+        for an anonymous customer.
+      operationId: PostV1Guestcarts
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: Cart ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts
+  "/V1/guest-carts/{cartId}":
+    get:
+      tags:
+      - guest-carts/{cartId}
+      description: Enable a guest user to return information for a specified cart.
+      operationId: GetV1GuestcartsCartId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}
+    put:
+      tags:
+      - guest-carts/{cartId}
+      description: Assign a specified customer to a specified shopping cart.
+      operationId: PutV1GuestcartsCartId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PutV1GuestcartsCartIdBody
+        in: body
+        schema:
+          required:
+          - storeId
+          properties:
+            storeId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}
+  "/V1/guest-carts/{cartId}/billing-address":
+    get:
+      tags:
+      - guest-carts/{cartId}/billing-address
+      description: Return the billing address for a specified quote.
+      operationId: GetV1GuestcartsCartIdBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-address-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/billing-address
+    post:
+      tags:
+      - guest-carts/{cartId}/billing-address
+      description: Assign a specified billing address to a specified cart.
+      operationId: PostV1GuestcartsCartIdBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PostV1GuestcartsCartIdBillingaddressBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+            useForShipping:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Address ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/billing-address
+  "/V1/guest-carts/{cartId}/collect-totals":
+    put:
+      tags:
+      - guest-carts/{cartId}/collect-totals
+      description: Set shipping/billing methods and additional data for cart and collect
+        totals for guest.
+      operationId: PutV1GuestcartsCartIdCollecttotals
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PutV1GuestcartsCartIdCollecttotalsBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            shippingCarrierCode:
+              type: string
+              description: The carrier code.
+            shippingMethodCode:
+              type: string
+              description: The shipping method code.
+            additionalData:
+              "$ref": "#/definitions/quote-data-totals-additional-data-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/collect-totals
+  "/V1/guest-carts/{cartId}/coupons":
+    get:
+      tags:
+      - guest-carts/{cartId}/coupons
+      description: Return information for a coupon in a specified cart.
+      operationId: GetV1GuestcartsCartIdCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: The coupon code data.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/coupons
+    delete:
+      tags:
+      - guest-carts/{cartId}/coupons
+      description: Delete a coupon from a specified cart.
+      operationId: DeleteV1GuestcartsCartIdCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/coupons
+  "/V1/guest-carts/{cartId}/coupons/{couponCode}":
+    put:
+      tags:
+      - guest-carts/{cartId}/coupons/{couponCode}
+      description: Add a coupon by code to a specified cart.
+      operationId: PutV1GuestcartsCartIdCouponsCouponCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: couponCode
+        in: path
+        type: string
+        required: true
+        description: The coupon code data.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/coupons/{couponCode}
+  "/V1/guest-carts/{cartId}/estimate-shipping-methods":
+    post:
+      tags:
+      - guest-carts/{cartId}/estimate-shipping-methods
+      description: Estimate shipping by address and return list of available shipping
+        methods
+      operationId: PostV1GuestcartsCartIdEstimateshippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdEstimateshippingmethodsBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/estimate-shipping-methods
+  "/V1/guest-carts/{cartId}/gift-message":
+    get:
+      tags:
+      - guest-carts/{cartId}/gift-message
+      description: Return the gift message for a specified order.
+      operationId: GetV1GuestcartsCartIdGiftmessage
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The shopping cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-message-data-message-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/gift-message
+    post:
+      tags:
+      - guest-carts/{cartId}/gift-message
+      description: Set the gift message for an entire order.
+      operationId: PostV1GuestcartsCartIdGiftmessage
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PostV1GuestcartsCartIdGiftmessageBody
+        in: body
+        schema:
+          required:
+          - giftMessage
+          properties:
+            giftMessage:
+              "$ref": "#/definitions/gift-message-data-message-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/gift-message
+  "/V1/guest-carts/{cartId}/gift-message/{itemId}":
+    get:
+      tags:
+      - guest-carts/{cartId}/gift-message/{itemId}
+      description: Return the gift message for a specified item in a specified shopping
+        cart.
+      operationId: GetV1GuestcartsCartIdGiftmessageItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The shopping cart ID.
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-message-data-message-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/gift-message/{itemId}
+    post:
+      tags:
+      - guest-carts/{cartId}/gift-message/{itemId}
+      description: Set the gift message for a specified item in a specified shopping
+        cart.
+      operationId: PostV1GuestcartsCartIdGiftmessageItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID.
+      - name: PostV1GuestcartsCartIdGiftmessageItemIdBody
+        in: body
+        schema:
+          required:
+          - giftMessage
+          properties:
+            giftMessage:
+              "$ref": "#/definitions/gift-message-data-message-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/gift-message/{itemId}
+  "/V1/guest-carts/{cartId}/items":
+    get:
+      tags:
+      - guest-carts/{cartId}/items
+      description: List items that are assigned to a specified cart.
+      operationId: GetV1GuestcartsCartIdItems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: Array of items.
+            items:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/items
+    post:
+      tags:
+      - guest-carts/{cartId}/items
+      description: Add/update the specified cart item.
+      operationId: PostV1GuestcartsCartIdItems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdItemsBody
+        in: body
+        schema:
+          required:
+          - cartItem
+          properties:
+            cartItem:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/items
+  "/V1/guest-carts/{cartId}/items/{itemId}":
+    put:
+      tags:
+      - guest-carts/{cartId}/items/{itemId}
+      description: Add/update the specified cart item.
+      operationId: PutV1GuestcartsCartIdItemsItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: itemId
+        in: path
+        type: string
+        required: true
+      - name: PutV1GuestcartsCartIdItemsItemIdBody
+        in: body
+        schema:
+          required:
+          - cartItem
+          properties:
+            cartItem:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/items/{itemId}
+    delete:
+      tags:
+      - guest-carts/{cartId}/items/{itemId}
+      description: Remove the specified item from the specified cart.
+      operationId: DeleteV1GuestcartsCartIdItemsItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID of the item to be removed.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/items/{itemId}
+  "/V1/guest-carts/{cartId}/order":
+    put:
+      tags:
+      - guest-carts/{cartId}/order
+      description: Place an order for a specified cart.
+      operationId: PutV1GuestcartsCartIdOrder
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PutV1GuestcartsCartIdOrderBody
+        in: body
+        schema:
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/order
+  "/V1/guest-carts/{cartId}/payment-information":
+    post:
+      tags:
+      - guest-carts/{cartId}/payment-information
+      description: Set payment information and place order for a specified cart.
+      operationId: PostV1GuestcartsCartIdPaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdPaymentinformationBody
+        in: body
+        schema:
+          required:
+          - email
+          - paymentMethod
+          properties:
+            email:
+              type: string
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-information
+    get:
+      tags:
+      - guest-carts/{cartId}/payment-information
+      description: Get payment information
+      operationId: GetV1GuestcartsCartIdPaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-information
+  "/V1/guest-carts/{cartId}/payment-methods":
+    get:
+      tags:
+      - guest-carts/{cartId}/payment-methods
+      description: List available payment methods for a specified shopping cart. This
+        call returns an array of objects, but detailed information about each object’s
+        attributes might not be included.  See https://developer.adobe.com/commerce/webapi/rest/attributes#GuestPaymentMethodManagementInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1GuestcartsCartIdPaymentmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: Array of payment methods.
+            items:
+              "$ref": "#/definitions/quote-data-payment-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-methods
+  "/V1/guest-carts/{cartId}/payment-order":
+    post:
+      tags:
+      - guest-carts/{cartId}/payment-order
+      description: Create a payment order for guest customer
+      operationId: PostV1GuestcartsCartIdPaymentorder
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdPaymentorderBody
+        in: body
+        schema:
+          required:
+          - methodCode
+          - paymentSource
+          - location
+          properties:
+            methodCode:
+              type: string
+            paymentSource:
+              type: string
+            location:
+              type: string
+            vaultIntent:
+              type: boolean
+            threeDSMode:
+              type: string
+              description: "| null $threeDSMode"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-order
+  "/V1/guest-carts/{cartId}/payment-order/{id}":
+    get:
+      tags:
+      - guest-carts/{cartId}/payment-order/{id}
+      description: Get payment order for guest customer
+      operationId: GetV1GuestcartsCartIdPaymentorderId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: id
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-order/{id}
+    post:
+      tags:
+      - guest-carts/{cartId}/payment-order/{id}
+      description: Sync payment order for guest customer
+      operationId: PostV1GuestcartsCartIdPaymentorderId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: id
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-order/{id}
+  "/V1/guest-carts/{cartId}/selected-payment-method":
+    get:
+      tags:
+      - guest-carts/{cartId}/selected-payment-method
+      description: Return the payment method for a specified shopping cart.
+      operationId: GetV1GuestcartsCartIdSelectedpaymentmethod
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-payment-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/selected-payment-method
+    put:
+      tags:
+      - guest-carts/{cartId}/selected-payment-method
+      description: Add a specified payment method to a specified shopping cart.
+      operationId: PutV1GuestcartsCartIdSelectedpaymentmethod
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PutV1GuestcartsCartIdSelectedpaymentmethodBody
+        in: body
+        schema:
+          required:
+          - method
+          properties:
+            method:
+              "$ref": "#/definitions/quote-data-payment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Payment method ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/selected-payment-method
+  "/V1/guest-carts/{cartId}/set-payment-information":
+    post:
+      tags:
+      - guest-carts/{cartId}/set-payment-information
+      description: Set payment information for a specified cart.
+      operationId: PostV1GuestcartsCartIdSetpaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdSetpaymentinformationBody
+        in: body
+        schema:
+          required:
+          - email
+          - paymentMethod
+          properties:
+            email:
+              type: string
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/set-payment-information
+  "/V1/guest-carts/{cartId}/shipping-information":
+    post:
+      tags:
+      - guest-carts/{cartId}/shipping-information
+      description: ''
+      operationId: PostV1GuestcartsCartIdShippinginformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdShippinginformationBody
+        in: body
+        schema:
+          required:
+          - addressInformation
+          properties:
+            addressInformation:
+              "$ref": "#/definitions/checkout-data-shipping-information-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/shipping-information
+  "/V1/guest-carts/{cartId}/shipping-methods":
+    get:
+      tags:
+      - guest-carts/{cartId}/shipping-methods
+      description: List applicable shipping methods for a specified quote.
+      operationId: GetV1GuestcartsCartIdShippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The shopping cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/shipping-methods
+  "/V1/guest-carts/{cartId}/totals":
+    get:
+      tags:
+      - guest-carts/{cartId}/totals
+      description: Return quote totals data for a specified cart.
+      operationId: GetV1GuestcartsCartIdTotals
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/totals
+  "/V1/guest-carts/{cartId}/totals-information":
+    post:
+      tags:
+      - guest-carts/{cartId}/totals-information
+      description: Calculate quote totals based on address and shipping method.
+      operationId: PostV1GuestcartsCartIdTotalsinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdTotalsinformationBody
+        in: body
+        schema:
+          required:
+          - addressInformation
+          properties:
+            addressInformation:
+              "$ref": "#/definitions/checkout-data-totals-information-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/totals-information
+  "/V1/guest-giftregistry/{cartId}/estimate-shipping-methods":
+    post:
+      tags:
+      - guest-giftregistry/{cartId}/estimate-shipping-methods
+      description: Estimate shipping
+      operationId: PostV1GuestgiftregistryCartIdEstimateshippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The shopping cart ID.
+      - name: PostV1GuestgiftregistryCartIdEstimateshippingmethodsBody
+        in: body
+        schema:
+          required:
+          - registryId
+          properties:
+            registryId:
+              type: integer
+              description: The estimate registry id
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-giftregistry/{cartId}/estimate-shipping-methods
+  "/V1/integration/admin/token":
+    post:
+      tags:
+      - integration/admin/token
+      description: Create access token for admin given the admin credentials.
+      operationId: PostV1IntegrationAdminToken
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1IntegrationAdminTokenBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: Token created
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: integration/admin/token
+  "/V1/integration/customer/revoke-customer-token":
+    post:
+      tags:
+      - integration/customer/revoke-customer-token
+      description: Revoke token by customer id.
+      operationId: PostV1IntegrationCustomerRevokecustomertoken
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: integration/customer/revoke-customer-token
+  "/V1/integration/customer/token":
+    post:
+      tags:
+      - integration/customer/token
+      description: Create access token for admin given the customer credentials.
+      operationId: PostV1IntegrationCustomerToken
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1IntegrationCustomerTokenBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: Token created
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: integration/customer/token
+  "/V1/inventory/in-store-pickup/pickup-locations/":
+    get:
+      tags:
+      - inventory/in-store-pickup/pickup-locations/
+      description: Get Pickup Locations according to the results of filtration by
+        Search Request.
+      operationId: GetV1InventoryInstorepickupPickuplocations
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchRequest[area][radius]
+        in: query
+        type: integer
+        description: Search radius in KM.
+      - name: searchRequest[area][searchTerm]
+        in: query
+        type: string
+        description: Search term string.
+      - name: searchRequest[filters][country][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][country][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][postcode][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][postcode][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][region][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][region][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][regionId][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][regionId][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][city][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][city][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][street][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][street][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][name][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][name][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][pickupLocationCode][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][pickupLocationCode][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchRequest[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      - name: searchRequest[scopeType]
+        in: query
+        type: string
+        description: Sales Channel Type.
+      - name: searchRequest[scopeCode]
+        in: query
+        type: string
+        description: Sales Channel code.
+      - name: searchRequest[sort][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchRequest[sort][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchRequest[extensionAttributes][productsInfo][0][sku]
+        in: query
+        type: string
+        description: Product SKU.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/in-store-pickup/pickup-locations/
+    post:
+      tags:
+      - inventory/in-store-pickup/pickup-locations/
+      description: Get Pickup Locations according to the results of filtration by
+        Search Request.
+      operationId: PostV1InventoryInstorepickupPickuplocations
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventoryInstorepickupPickuplocationsBody
+        in: body
+        schema:
+          required:
+          - searchRequest
+          properties:
+            searchRequest:
+              "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/in-store-pickup/pickup-locations/
+  "/V1/negotiable-carts/{cartId}/billing-address":
+    get:
+      tags:
+      - negotiable-carts/{cartId}/billing-address
+      description: Returns the billing address for a specified quote.
+      operationId: GetV1NegotiablecartsCartIdBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-address-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/billing-address
+    post:
+      tags:
+      - negotiable-carts/{cartId}/billing-address
+      description: Assigns a specified billing address to a specified cart.
+      operationId: PostV1NegotiablecartsCartIdBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      - name: PostV1NegotiablecartsCartIdBillingaddressBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+            useForShipping:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Address ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/billing-address
+  "/V1/negotiable-carts/{cartId}/coupons":
+    delete:
+      tags:
+      - negotiable-carts/{cartId}/coupons
+      description: Deletes a coupon from a specified cart.
+      operationId: DeleteV1NegotiablecartsCartIdCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/coupons
+  "/V1/negotiable-carts/{cartId}/coupons/{couponCode}":
+    put:
+      tags:
+      - negotiable-carts/{cartId}/coupons/{couponCode}
+      description: Adds a coupon by code to a specified cart.
+      operationId: PutV1NegotiablecartsCartIdCouponsCouponCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      - name: couponCode
+        in: path
+        type: string
+        required: true
+        description: The coupon code data.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/coupons/{couponCode}
+  "/V1/negotiable-carts/{cartId}/estimate-shipping-methods":
+    post:
+      tags:
+      - negotiable-carts/{cartId}/estimate-shipping-methods
+      description: Estimate shipping by address and return list of available shipping
+        methods
+      operationId: PostV1NegotiablecartsCartIdEstimateshippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1NegotiablecartsCartIdEstimateshippingmethodsBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/estimate-shipping-methods
+  "/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id":
+    post:
+      tags:
+      - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
+      description: Estimate shipping
+      operationId: PostV1NegotiablecartsCartIdEstimateshippingmethodsbyaddressid
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The shopping cart ID.
+      - name: PostV1NegotiablecartsCartIdEstimateshippingmethodsbyaddressidBody
+        in: body
+        schema:
+          required:
+          - addressId
+          properties:
+            addressId:
+              type: integer
+              description: The estimate address id
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
+  "/V1/negotiable-carts/{cartId}/giftCards":
+    post:
+      tags:
+      - negotiable-carts/{cartId}/giftCards
+      description: ''
+      operationId: PostV1NegotiablecartsCartIdGiftCards
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1NegotiablecartsCartIdGiftCardsBody
+        in: body
+        schema:
+          required:
+          - giftCardAccountData
+          properties:
+            giftCardAccountData:
+              "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/giftCards
+  "/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}":
+    delete:
+      tags:
+      - negotiable-carts/{cartId}/giftCards/{giftCardCode}
+      description: Remove GiftCard Account entity
+      operationId: DeleteV1NegotiablecartsCartIdGiftCardsGiftCardCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: giftCardCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/giftCards/{giftCardCode}
+  "/V1/negotiable-carts/{cartId}/payment-information":
+    post:
+      tags:
+      - negotiable-carts/{cartId}/payment-information
+      description: Set payment information and place order for a specified cart.
+      operationId: PostV1NegotiablecartsCartIdPaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1NegotiablecartsCartIdPaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/payment-information
+    get:
+      tags:
+      - negotiable-carts/{cartId}/payment-information
+      description: Get payment information
+      operationId: GetV1NegotiablecartsCartIdPaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/payment-information
+  "/V1/negotiable-carts/{cartId}/po-payment-information":
+    post:
+      tags:
+      - negotiable-carts/{cartId}/po-payment-information
+      description: Set payment information and place purchase order for a specified
+        negotiable quote.
+      operationId: PostV1NegotiablecartsCartIdPopaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1NegotiablecartsCartIdPopaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Purchase Order ID.
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/po-payment-information
+  "/V1/negotiable-carts/{cartId}/set-payment-information":
+    post:
+      tags:
+      - negotiable-carts/{cartId}/set-payment-information
+      description: Set payment information for a specified cart.
+      operationId: PostV1NegotiablecartsCartIdSetpaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1NegotiablecartsCartIdSetpaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/set-payment-information
+  "/V1/negotiable-carts/{cartId}/shipping-information":
+    post:
+      tags:
+      - negotiable-carts/{cartId}/shipping-information
+      description: ''
+      operationId: PostV1NegotiablecartsCartIdShippinginformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1NegotiablecartsCartIdShippinginformationBody
+        in: body
+        schema:
+          required:
+          - addressInformation
+          properties:
+            addressInformation:
+              "$ref": "#/definitions/checkout-data-shipping-information-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/shipping-information
+  "/V1/negotiable-carts/{cartId}/totals":
+    get:
+      tags:
+      - negotiable-carts/{cartId}/totals
+      description: Returns quote totals data for a specified cart.
+      operationId: GetV1NegotiablecartsCartIdTotals
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiable-carts/{cartId}/totals
+  "/V1/negotiableQuoteTemplate/accept":
+    post:
+      tags:
+      - negotiableQuoteTemplate/accept
+      description: Create quote template from quote
+      operationId: PostV1NegotiableQuoteTemplateAccept
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateAcceptBody
+        in: body
+        schema:
+          required:
+          - templateId
+          properties:
+            templateId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/accept
+  "/V1/negotiableQuoteTemplate/generateQuote":
+    post:
+      tags:
+      - negotiableQuoteTemplate/generateQuote
+      description: Generate quote from template
+      operationId: PostV1NegotiableQuoteTemplateGenerateQuote
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateGenerateQuoteBody
+        in: body
+        schema:
+          required:
+          - templateId
+          properties:
+            templateId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/generateQuote
+  "/V1/negotiableQuoteTemplate/submitToSeller":
+    post:
+      tags:
+      - negotiableQuoteTemplate/submitToSeller
+      description: Send template to seller
+      operationId: PostV1NegotiableQuoteTemplateSubmitToSeller
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1NegotiableQuoteTemplateSubmitToSellerBody
+        in: body
+        schema:
+          required:
+          - templateId
+          properties:
+            templateId:
+              type: integer
+            commentText:
+              type: string
+            files:
+              type: array
+              items:
+                "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: negotiableQuoteTemplate/submitToSeller
+  "/V1/payment-order/completeOrder":
+    post:
+      tags:
+      - payment-order/completeOrder
+      description: Rest API endpoint to place an order
+      operationId: PostV1PaymentorderCompleteOrder
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1PaymentorderCompleteOrderBody
+        in: body
+        schema:
+          required:
+          - orderId
+          properties:
+            orderId:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payment-order/completeOrder
+  "/V1/payments-config/apple-pay/{location}":
+    get:
+      tags:
+      - payments-config/apple-pay/{location}
+      description: Get Apple Pay Config.
+      operationId: GetV1PaymentsconfigApplepayLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/apple-pay/{location}
+  "/V1/payments-config/google-pay/{location}":
+    get:
+      tags:
+      - payments-config/google-pay/{location}
+      description: Get Google Pay Config.
+      operationId: GetV1PaymentsconfigGooglepayLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/google-pay/{location}
+  "/V1/payments-config/hosted-fields/{location}":
+    get:
+      tags:
+      - payments-config/hosted-fields/{location}
+      description: Get Hosted Fields Config.
+      operationId: GetV1PaymentsconfigHostedfieldsLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/hosted-fields/{location}
+  "/V1/payments-config/smart-buttons/{location}":
+    get:
+      tags:
+      - payments-config/smart-buttons/{location}
+      description: Get Smart Buttons Config.
+      operationId: GetV1PaymentsconfigSmartbuttonsLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/smart-buttons/{location}
+  "/V1/payments-config/{location}":
+    get:
+      tags:
+      - payments-config/{location}
+      description: Get Config.
+      operationId: GetV1PaymentsconfigLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-payment-config-response-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/{location}
+  "/V1/payments-sdk/{location}":
+    get:
+      tags:
+      - payments-sdk/{location}
+      description: Get payment sdk url by location
+      operationId: GetV1PaymentssdkLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-sdk/{location}
+  "/V1/payments-sdk/{location}/{methodCode}":
+    get:
+      tags:
+      - payments-sdk/{location}/{methodCode}
+      description: Get payment sdk url by location and methodCode
+      operationId: GetV1PaymentssdkLocationMethodCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+      - name: methodCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-sdk/{location}/{methodCode}
+  "/V1/paypal/lineItems":
+    post:
+      tags:
+      - paypal/lineItems
+      description: Rest endpoint to calculate totals and line items
+      operationId: PostV1PaypalLineItems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1PaypalLineItemsBody
+        in: body
+        schema:
+          required:
+          - method
+          - cartId
+          properties:
+            method:
+              type: string
+            cartId:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: paypal/lineItems
+  "/V1/paypal/oneClick":
+    post:
+      tags:
+      - paypal/oneClick
+      description: Rest endpoint to add product to cart (mainly use for PayPal button
+        from PDP)
+      operationId: PostV1PaypalOneClick
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1PaypalOneClickBody
+        in: body
+        schema:
+          required:
+          - method
+          - productData
+          properties:
+            method:
+              type: string
+            productData:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: paypal/oneClick
+  "/V1/paypal/validatePhoneNumber":
+    post:
+      tags:
+      - paypal/validatePhoneNumber
+      description: Get & validate phone number and get shipping/billing email address
+      operationId: PostV1PaypalValidatePhoneNumber
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1PaypalValidatePhoneNumberBody
+        in: body
+        schema:
+          required:
+          - cartId
+          properties:
+            cartId:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: paypal/validatePhoneNumber
+  "/V1/products-render-info":
+    get:
+      tags:
+      - products-render-info
+      description: Collect and retrieve the list of product render info. This info
+        contains raw prices and formatted prices, product name, stock status, store_id,
+        etc.
+      operationId: GetV1Productsrenderinfo
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      - name: storeId
+        in: query
+        type: integer
+        required: true
+      - name: currencyCode
+        in: query
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-render-search-results-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products-render-info
+  "/V1/purchase-order-carts/{cartId}/payment-information":
+    post:
+      tags:
+      - purchase-order-carts/{cartId}/payment-information
+      description: Set payment information and place order for a specified cart.
+      operationId: PostV1PurchaseordercartsCartIdPaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1PurchaseordercartsCartIdPaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: purchase-order-carts/{cartId}/payment-information
+    get:
+      tags:
+      - purchase-order-carts/{cartId}/payment-information
+      description: Get payment information
+      operationId: GetV1PurchaseordercartsCartIdPaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: purchase-order-carts/{cartId}/payment-information
+  "/V1/purchase-order-carts/{cartId}/set-payment-information":
+    post:
+      tags:
+      - purchase-order-carts/{cartId}/set-payment-information
+      description: Set payment information for a specified cart.
+      operationId: PostV1PurchaseordercartsCartIdSetpaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: integer
+        required: true
+      - name: PostV1PurchaseordercartsCartIdSetpaymentinformationBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: purchase-order-carts/{cartId}/set-payment-information
+  "/V1/requisition_lists":
+    post:
+      tags:
+      - requisition_lists
+      description: Save Requisition List
+      operationId: PostV1Requisition_lists
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1Requisition_listsBody
+        in: body
+        schema:
+          required:
+          - requisitionList
+          properties:
+            requisitionList:
+              "$ref": "#/definitions/requisition-list-data-requisition-list-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/requisition-list-data-requisition-list-interface"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: requisition_lists
+  "/V1/reward/mine/use-reward":
+    post:
+      tags:
+      - reward/mine/use-reward
+      description: Set reward points to quote
+      operationId: PostV1RewardMineUsereward
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: reward/mine/use-reward
+  "/V1/search":
+    get:
+      tags:
+      - search
+      description: Make Full Text Search and return found Documents
+      operationId: GetV1Search
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[requestName]
+        in: query
+        type: string
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/framework-search-search-result-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: search
+  "/V1/tfa/provider/authy/activate":
+    post:
+      tags:
+      - tfa/provider/authy/activate
+      description: Activate the provider and get an admin token
+      operationId: PostV1TfaProviderAuthyActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderAuthyActivateBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          - otp
+          properties:
+            tfaToken:
+              type: string
+            otp:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/activate
+  "/V1/tfa/provider/authy/authenticate":
+    post:
+      tags:
+      - tfa/provider/authy/authenticate
+      description: Get an admin token using authy 2fa
+      operationId: PostV1TfaProviderAuthyAuthenticate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderAuthyAuthenticateBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          - otp
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+            otp:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: "$otp"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/authenticate
+  "/V1/tfa/provider/authy/authenticate-onetouch":
+    post:
+      tags:
+      - tfa/provider/authy/authenticate-onetouch
+      description: Authenticate using the present one touch response and get an admin
+        token
+      operationId: PostV1TfaProviderAuthyAuthenticateonetouch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderAuthyAuthenticateonetouchBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/authenticate-onetouch
+  "/V1/tfa/provider/authy/configure":
+    post:
+      tags:
+      - tfa/provider/authy/configure
+      description: Get the information required to configure google
+      operationId: PostV1TfaProviderAuthyConfigure
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderAuthyConfigureBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          - deviceData
+          properties:
+            tfaToken:
+              type: string
+            deviceData:
+              "$ref": "#/definitions/two-factor-auth-data-authy-device-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/configure
+  "/V1/tfa/provider/authy/send-token/{via}":
+    post:
+      tags:
+      - tfa/provider/authy/send-token/{via}
+      description: Send a one time password to a device using authy
+      operationId: PostV1TfaProviderAuthySendtokenVia
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: via
+        in: path
+        type: string
+        required: true
+      - name: PostV1TfaProviderAuthySendtokenViaBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/send-token/{via}
+  "/V1/tfa/provider/duo_security/activate":
+    post:
+      tags:
+      - tfa/provider/duo_security/activate
+      description: Activate the provider and get an admin token
+      operationId: PostV1TfaProviderDuo_securityActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderDuo_securityActivateBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          properties:
+            tfaToken:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/duo_security/activate
+  "/V1/tfa/provider/duo_security/authenticate":
+    post:
+      tags:
+      - tfa/provider/duo_security/authenticate
+      description: Authenticate and get an admin token with passcode
+      operationId: PostV1TfaProviderDuo_securityAuthenticate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderDuo_securityAuthenticateBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          - passcode
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+            passcode:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/duo_security/authenticate
+  "/V1/tfa/provider/duo_security/configure":
+    post:
+      tags:
+      - tfa/provider/duo_security/configure
+      description: Configure duo for first time user
+      operationId: PostV1TfaProviderDuo_securityConfigure
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderDuo_securityConfigureBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          properties:
+            tfaToken:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/duo_security/configure
+  "/V1/tfa/provider/google/activate":
+    post:
+      tags:
+      - tfa/provider/google/activate
+      description: Activate the provider and get an admin token
+      operationId: PostV1TfaProviderGoogleActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderGoogleActivateBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          - otp
+          properties:
+            tfaToken:
+              type: string
+            otp:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/google/activate
+  "/V1/tfa/provider/google/authenticate":
+    post:
+      tags:
+      - tfa/provider/google/authenticate
+      description: Get an admin token by authenticating using google
+      operationId: PostV1TfaProviderGoogleAuthenticate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderGoogleAuthenticateBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          - otp
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+            otp:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/google/authenticate
+  "/V1/tfa/provider/google/configure":
+    post:
+      tags:
+      - tfa/provider/google/configure
+      description: Get the information required to configure google
+      operationId: PostV1TfaProviderGoogleConfigure
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderGoogleConfigureBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          properties:
+            tfaToken:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/two-factor-auth-data-google-configure-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/google/configure
+  "/V1/tfa/provider/u2fkey/activate":
+    post:
+      tags:
+      - tfa/provider/u2fkey/activate
+      description: Activate the provider and get a token
+      operationId: PostV1TfaProviderU2fkeyActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderU2fkeyActivateBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          - publicKeyCredentialJson
+          properties:
+            tfaToken:
+              type: string
+            publicKeyCredentialJson:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/u2fkey/activate
+  "/V1/tfa/provider/u2fkey/authentication-challenge":
+    post:
+      tags:
+      - tfa/provider/u2fkey/authentication-challenge
+      description: Get the information to initiate a WebAuthn registration ceremony
+      operationId: PostV1TfaProviderU2fkeyAuthenticationchallenge
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderU2fkeyAuthenticationchallengeBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/u2fkey/authentication-challenge
+  "/V1/tfa/provider/u2fkey/configure":
+    post:
+      tags:
+      - tfa/provider/u2fkey/configure
+      description: Get the information to initiate a WebAuthn registration ceremony
+      operationId: PostV1TfaProviderU2fkeyConfigure
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderU2fkeyConfigureBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          properties:
+            tfaToken:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/u2fkey/configure
+  "/V1/tfa/provider/u2fkey/verify":
+    post:
+      tags:
+      - tfa/provider/u2fkey/verify
+      description: Authenticate with the provider and get a token
+      operationId: PostV1TfaProviderU2fkeyVerify
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderU2fkeyVerifyBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          - publicKeyCredentialJson
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+            publicKeyCredentialJson:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/u2fkey/verify
+  "/V1/tfa/tfat-providers-to-activate":
+    get:
+      tags:
+      - tfa/tfat-providers-to-activate
+      description: Get the providers that the user still needs to configure
+      operationId: GetV1TfaTfatproviderstoactivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: tfaToken
+        in: query
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/two-factor-auth-provider-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/tfat-providers-to-activate
+  "/V1/tfa/tfat-user-providers":
+    get:
+      tags:
+      - tfa/tfat-user-providers
+      description: Get the providers that the user is able to use for 2fa
+      operationId: GetV1TfaTfatuserproviders
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: tfaToken
+        in: query
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/two-factor-auth-provider-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/tfat-user-providers
+definitions:
+  error-response:
+    type: object
+    properties:
+      message:
+        type: string
+        description: Error message
+      errors:
+        "$ref": "#/definitions/error-errors"
+      code:
+        type: integer
+        description: Error code
+      parameters:
+        "$ref": "#/definitions/error-parameters"
+      trace:
+        type: string
+        description: Stack trace
+    required:
+    - message
+  error-errors:
+    type: array
+    description: Errors list
+    items:
+      "$ref": "#/definitions/error-errors-item"
+  error-errors-item:
+    type: object
+    description: Error details
+    properties:
+      message:
+        type: string
+        description: Error message
+      parameters:
+        "$ref": "#/definitions/error-parameters"
+  error-parameters:
+    type: array
+    description: Error parameters list
+    items:
+      "$ref": "#/definitions/error-parameters-item"
+  error-parameters-item:
+    type: object
+    description: Error parameters item
+    properties:
+      resources:
+        type: string
+        description: ACL resource
+      fieldName:
+        type: string
+        description: Missing or invalid field name
+      fieldValue:
+        type: string
+        description: Incorrect field value
+  directory-data-currency-information-interface:
+    type: object
+    description: Currency Information interface.
+    properties:
+      base_currency_code:
+        type: string
+        description: The base currency code for the store.
+      base_currency_symbol:
+        type: string
+        description: The currency symbol of the base currency for the store.
+      default_display_currency_code:
+        type: string
+        description: The default display currency code for the store.
+      default_display_currency_symbol:
+        type: string
+        description: The currency symbol of the default display currency for the store.
+      available_currency_codes:
+        type: array
+        description: The list of allowed currency codes for the store.
+        items:
+          type: string
+      exchange_rates:
+        type: array
+        description: The list of exchange rate information for the store.
+        items:
+          "$ref": "#/definitions/directory-data-exchange-rate-interface"
+      extension_attributes:
+        "$ref": "#/definitions/directory-data-currency-information-extension-interface"
+    required:
+    - base_currency_code
+    - base_currency_symbol
+    - default_display_currency_code
+    - default_display_currency_symbol
+    - available_currency_codes
+    - exchange_rates
+  directory-data-exchange-rate-interface:
+    type: object
+    description: Exchange Rate interface.
+    properties:
+      currency_to:
+        type: string
+        description: The currency code associated with the exchange rate.
+      rate:
+        type: number
+        description: The exchange rate for the associated currency and the store's
+          base currency.
+      extension_attributes:
+        "$ref": "#/definitions/directory-data-exchange-rate-extension-interface"
+    required:
+    - currency_to
+    - rate
+  directory-data-exchange-rate-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Directory\Api\Data\ExchangeRateInterface
+  directory-data-currency-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CurrencyInformationInterface
+  directory-data-country-information-interface:
+    type: object
+    description: Country Information interface.
+    properties:
+      id:
+        type: string
+        description: The country id for the store.
+      two_letter_abbreviation:
+        type: string
+        description: The country 2 letter abbreviation for the store.
+      three_letter_abbreviation:
+        type: string
+        description: The country 3 letter abbreviation for the store.
+      full_name_locale:
+        type: string
+        description: The country full name (in store locale) for the store.
+      full_name_english:
+        type: string
+        description: The country full name (in English) for the store.
+      available_regions:
+        type: array
+        description: The available regions for the store.
+        items:
+          "$ref": "#/definitions/directory-data-region-information-interface"
+      extension_attributes:
+        "$ref": "#/definitions/directory-data-country-information-extension-interface"
+    required:
+    - id
+    - two_letter_abbreviation
+    - three_letter_abbreviation
+    - full_name_locale
+    - full_name_english
+  directory-data-region-information-interface:
+    type: object
+    description: Region Information interface.
+    properties:
+      id:
+        type: string
+        description: Region id
+      code:
+        type: string
+        description: Region code
+      name:
+        type: string
+        description: Region name
+      extension_attributes:
+        "$ref": "#/definitions/directory-data-region-information-extension-interface"
+    required:
+    - id
+    - code
+    - name
+  directory-data-region-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Directory\Api\Data\RegionInformationInterface
+  directory-data-country-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CountryInformationInterface
+  customer-data-customer-interface:
+    type: object
+    description: Customer entity interface for API handling.
+    properties:
+      id:
+        type: integer
+        description: Customer id
+      group_id:
+        type: integer
+        description: Group id
+      default_billing:
+        type: string
+        description: Default billing address id
+      default_shipping:
+        type: string
+        description: Default shipping address id
+      confirmation:
+        type: string
+        description: Confirmation
+      created_at:
+        type: string
+        description: Created at time
+      updated_at:
+        type: string
+        description: Updated at time
+      created_in:
+        type: string
+        description: Created in area
+      dob:
+        type: string
+        description: In keeping with current security and privacy best practices,
+          be sure you are aware of any potential legal and security risks associated
+          with the storage of customers’ full date of birth (month, day, year) along
+          with other personal identifiers (e.g., full name) before collecting or processing
+          such data.
+      email:
+        type: string
+        description: Email address
+      firstname:
+        type: string
+        description: First name
+      lastname:
+        type: string
+        description: Last name
+      middlename:
+        type: string
+        description: Middle name
+      prefix:
+        type: string
+        description: Prefix
+      suffix:
+        type: string
+        description: Suffix
+      gender:
+        type: integer
+        description: Gender
+      store_id:
+        type: integer
+        description: Store id
+      taxvat:
+        type: string
+        description: Tax Vat
+      website_id:
+        type: integer
+        description: Website id
+      addresses:
+        type: array
+        description: Customer addresses.
+        items:
+          "$ref": "#/definitions/customer-data-address-interface"
+      disable_auto_group_change:
+        type: integer
+        description: Disable auto group change flag.
+      extension_attributes:
+        "$ref": "#/definitions/customer-data-customer-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - email
+    - firstname
+    - lastname
+  customer-data-address-interface:
+    type: object
+    description: Customer address interface.
+    properties:
+      id:
+        type: integer
+        description: ID
+      customer_id:
+        type: integer
+        description: Customer ID
+      region:
+        "$ref": "#/definitions/customer-data-region-interface"
+      region_id:
+        type: integer
+        description: Region ID
+      country_id:
+        type: string
+        description: Country code in ISO_3166-2 format
+      street:
+        type: array
+        description: Street
+        items:
+          type: string
+      company:
+        type: string
+        description: Company
+      telephone:
+        type: string
+        description: Telephone number
+      fax:
+        type: string
+        description: Fax number
+      postcode:
+        type: string
+        description: Postcode
+      city:
+        type: string
+        description: City name
+      firstname:
+        type: string
+        description: First name
+      lastname:
+        type: string
+        description: Last name
+      middlename:
+        type: string
+        description: Middle name
+      prefix:
+        type: string
+        description: Prefix
+      suffix:
+        type: string
+        description: Suffix
+      vat_id:
+        type: string
+        description: Vat id
+      default_shipping:
+        type: boolean
+        description: If this address is default shipping address.
+      default_billing:
+        type: boolean
+        description: If this address is default billing address
+      extension_attributes:
+        "$ref": "#/definitions/customer-data-address-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+  customer-data-region-interface:
+    type: object
+    description: Customer address region interface.
+    properties:
+      region_code:
+        type: string
+        description: Region code
+      region:
+        type: string
+        description: Region
+      region_id:
+        type: integer
+        description: Region id
+      extension_attributes:
+        "$ref": "#/definitions/customer-data-region-extension-interface"
+    required:
+    - region_code
+    - region
+    - region_id
+  customer-data-region-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface
+  customer-data-address-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface
+  framework-attribute-interface:
+    type: object
+    description: Interface for custom attribute value.
+    properties:
+      attribute_code:
+        type: string
+        description: Attribute code
+      value:
+        type: string
+        description: Attribute value
+    required:
+    - attribute_code
+    - value
+  customer-data-customer-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface
+    properties:
+      company_attributes:
+        "$ref": "#/definitions/company-data-company-customer-interface"
+      all_company_attributes:
+        type: array
+        items:
+          "$ref": "#/definitions/company-data-company-customer-interface"
+      is_subscribed:
+        type: boolean
+      assistance_allowed:
+        type: integer
+  company-data-company-customer-interface:
+    type: object
+    description: Extended customer custom attributes interface.
+    properties:
+      customer_id:
+        type: integer
+        description: Customer ID.
+      company_id:
+        type: integer
+        description: Company ID.
+      job_title:
+        type: string
+        description: Job title.
+      status:
+        type: integer
+        description: Customer status.
+      telephone:
+        type: string
+        description: Telephone.
+      is_default:
+        type: boolean
+        description: Is default
+      extension_attributes:
+        "$ref": "#/definitions/company-data-company-customer-extension-interface"
+  company-data-company-customer-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface
+  catalog-data-product-render-search-results-interface:
+    type: object
+    description: Dto that holds render information about products
+    properties:
+      items:
+        type: array
+        description: List of products rendered information
+        items:
+          "$ref": "#/definitions/catalog-data-product-render-interface"
+    required:
+    - items
+  catalog-data-product-render-interface:
+    type: object
+    description: Represents Data Object which holds enough information to render product
+      This information is put into part as Add To Cart or Add to Compare Data or Price
+      Data
+    properties:
+      add_to_cart_button:
+        "$ref": "#/definitions/catalog-data-product-render-button-interface"
+      add_to_compare_button:
+        "$ref": "#/definitions/catalog-data-product-render-button-interface"
+      price_info:
+        "$ref": "#/definitions/catalog-data-product-render-price-info-interface"
+      images:
+        type: array
+        description: Enough information, that needed to render image on front
+        items:
+          "$ref": "#/definitions/catalog-data-product-render-image-interface"
+      url:
+        type: string
+        description: Product url
+      id:
+        type: integer
+        description: Product identifier
+      name:
+        type: string
+        description: Product name
+      type:
+        type: string
+        description: Product type. Such as bundle, grouped, simple, etc...
+      is_salable:
+        type: string
+        description: Information about product saleability (In Stock)
+      store_id:
+        type: integer
+        description: Information about current store id or requested store id
+      currency_code:
+        type: string
+        description: Current or desired currency code to product
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-extension-interface"
+    required:
+    - add_to_cart_button
+    - add_to_compare_button
+    - price_info
+    - images
+    - url
+    - id
+    - name
+    - type
+    - is_salable
+    - store_id
+    - currency_code
+    - extension_attributes
+  catalog-data-product-render-button-interface:
+    type: object
+    description: 'Button interface. This interface represents all manner of product
+      buttons: add to cart, add to compare, etc... The buttons describes by this interface
+      should have interaction with backend'
+    properties:
+      post_data:
+        type: string
+        description: Post data
+      url:
+        type: string
+        description: Url, needed to add product to cart
+      required_options:
+        type: boolean
+        description: Flag whether a product has options or not
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-button-extension-interface"
+    required:
+    - post_data
+    - url
+    - required_options
+  catalog-data-product-render-button-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface
+  catalog-data-product-render-price-info-interface:
+    type: object
+    description: Price interface.
+    properties:
+      final_price:
+        type: number
+        description: Final price
+      max_price:
+        type: number
+        description: Max price of a product
+      max_regular_price:
+        type: number
+        description: Max regular price
+      minimal_regular_price:
+        type: number
+        description: Minimal regular price
+      special_price:
+        type: number
+        description: Special price
+      minimal_price:
+        type: number
+        description: Minimal price
+      regular_price:
+        type: number
+        description: Regular price
+      formatted_prices:
+        "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-interface"
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-price-info-extension-interface"
+    required:
+    - final_price
+    - max_price
+    - max_regular_price
+    - minimal_regular_price
+    - special_price
+    - minimal_price
+    - regular_price
+    - formatted_prices
+  catalog-data-product-render-formatted-price-info-interface:
+    type: object
+    description: 'Formatted Price interface. Aggregate formatted html with price representations.
+      E.g.: $9.00 Consider currency, rounding and html'
+    properties:
+      final_price:
+        type: string
+        description: Html with final price
+      max_price:
+        type: string
+        description: Max price of a product
+      minimal_price:
+        type: string
+        description: The minimal price of the product or variation
+      max_regular_price:
+        type: string
+        description: Max regular price
+      minimal_regular_price:
+        type: string
+        description: Minimal regular price
+      special_price:
+        type: string
+        description: Special price
+      regular_price:
+        type: string
+        description: Price - is price of product without discounts and special price
+          with taxes and fixed product tax
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-extension-interface"
+    required:
+    - final_price
+    - max_price
+    - minimal_price
+    - max_regular_price
+    - minimal_regular_price
+    - special_price
+    - regular_price
+  catalog-data-product-render-formatted-price-info-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\FormattedPriceInfoInterface
+  catalog-data-product-render-price-info-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface
+    properties:
+      msrp:
+        "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-interface"
+      tax_adjustments:
+        "$ref": "#/definitions/catalog-data-product-render-price-info-interface"
+      weee_attributes:
+        type: array
+        items:
+          "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-interface"
+      weee_adjustment:
+        type: string
+  msrp-data-product-render-msrp-price-info-interface:
+    type: object
+    description: Price interface.
+    properties:
+      msrp_price:
+        type: string
+      is_applicable:
+        type: string
+      is_shown_price_on_gesture:
+        type: string
+      msrp_message:
+        type: string
+      explanation_message:
+        type: string
+      extension_attributes:
+        "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-extension-interface"
+    required:
+    - msrp_price
+    - is_applicable
+    - is_shown_price_on_gesture
+    - msrp_message
+    - explanation_message
+  msrp-data-product-render-msrp-price-info-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface
+  weee-data-product-render-weee-adjustment-attribute-interface:
+    type: object
+    description: List of all weee attributes, their amounts, etc.., that product has
+    properties:
+      amount:
+        type: string
+        description: Weee attribute amount
+      tax_amount:
+        type: string
+        description: Tax which is calculated to fixed product tax attribute
+      tax_amount_incl_tax:
+        type: string
+        description: Tax amount of weee attribute
+      amount_excl_tax:
+        type: string
+        description: Product amount exclude tax
+      attribute_code:
+        type: string
+        description: Weee attribute code
+      extension_attributes:
+        "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface"
+    required:
+    - amount
+    - tax_amount
+    - tax_amount_incl_tax
+    - amount_excl_tax
+    - attribute_code
+    - extension_attributes
+  weee-data-product-render-weee-adjustment-attribute-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Weee\Api\Data\ProductRender\WeeeAdjustmentAttributeInterface
+  catalog-data-product-render-image-interface:
+    type: object
+    description: Product Render image interface. Represents physical characteristics
+      of image, that can be used in product listing or product view
+    properties:
+      url:
+        type: string
+        description: Image url
+      code:
+        type: string
+        description: Image code
+      height:
+        type: number
+        description: Image height
+      width:
+        type: number
+        description: Image width in px
+      label:
+        type: string
+        description: Image label
+      resized_width:
+        type: number
+        description: Resize width
+      resized_height:
+        type: number
+        description: Resize height
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-image-extension-interface"
+    required:
+    - url
+    - code
+    - height
+    - width
+    - label
+    - resized_width
+    - resized_height
+  catalog-data-product-render-image-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ImageInterface
+  catalog-data-product-render-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRenderInterface
+    properties:
+      wishlist_button:
+        "$ref": "#/definitions/catalog-data-product-render-button-interface"
+      review_html:
+        type: string
+  quote-data-cart-interface:
+    type: object
+    description: Interface CartInterface
+    properties:
+      id:
+        type: integer
+        description: Cart/quote ID.
+      created_at:
+        type: string
+        description: Cart creation date and time. Otherwise, null.
+      updated_at:
+        type: string
+        description: Cart last update date and time. Otherwise, null.
+      converted_at:
+        type: string
+        description: Cart conversion date and time. Otherwise, null.
+      is_active:
+        type: boolean
+        description: Active status flag value. Otherwise, null.
+      is_virtual:
+        type: boolean
+        description: Virtual flag value. Otherwise, null.
+      items:
+        type: array
+        description: Array of items. Otherwise, null.
+        items:
+          "$ref": "#/definitions/quote-data-cart-item-interface"
+      items_count:
+        type: integer
+        description: Number of different items or products in the cart. Otherwise,
+          null.
+      items_qty:
+        type: number
+        description: Total quantity of all cart items. Otherwise, null.
+      customer:
+        "$ref": "#/definitions/customer-data-customer-interface"
+      billing_address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      reserved_order_id:
+        type: string
+        description: Reserved order ID. Otherwise, null.
+      orig_order_id:
+        type: integer
+        description: Original order ID. Otherwise, null.
+      currency:
+        "$ref": "#/definitions/quote-data-currency-interface"
+      customer_is_guest:
+        type: boolean
+        description: For guest customers, false for logged in customers
+      customer_note:
+        type: string
+        description: Notice text
+      customer_note_notify:
+        type: boolean
+        description: Customer notification flag
+      customer_tax_class_id:
+        type: integer
+        description: Customer tax class ID.
+      store_id:
+        type: integer
+        description: Store identifier
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-cart-extension-interface"
+    required:
+    - id
+    - customer
+    - store_id
+  quote-data-cart-item-interface:
+    type: object
+    description: Interface CartItemInterface
+    properties:
+      item_id:
+        type: integer
+        description: Item ID. Otherwise, null.
+      sku:
+        type: string
+        description: Product SKU. Otherwise, null.
+      qty:
+        type: number
+        description: Product quantity.
+      name:
+        type: string
+        description: Product name. Otherwise, null.
+      price:
+        type: number
+        description: Product price. Otherwise, null.
+      product_type:
+        type: string
+        description: Product type. Otherwise, null.
+      quote_id:
+        type: string
+        description: Quote id.
+      product_option:
+        "$ref": "#/definitions/quote-data-product-option-interface"
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-cart-item-extension-interface"
+    required:
+    - qty
+    - quote_id
+  quote-data-product-option-interface:
+    type: object
+    description: Product option interface
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-product-option-extension-interface"
+  quote-data-product-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface
+    properties:
+      custom_options:
+        type: array
+        items:
+          "$ref": "#/definitions/catalog-data-custom-option-interface"
+      bundle_options:
+        type: array
+        items:
+          "$ref": "#/definitions/bundle-data-bundle-option-interface"
+      downloadable_option:
+        "$ref": "#/definitions/downloadable-data-downloadable-option-interface"
+      giftcard_item_option:
+        "$ref": "#/definitions/gift-card-data-gift-card-option-interface"
+      configurable_item_options:
+        type: array
+        items:
+          "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-interface"
+      grouped_options:
+        type: array
+        items:
+          "$ref": "#/definitions/grouped-product-data-grouped-options-interface"
+  catalog-data-custom-option-interface:
+    type: object
+    description: Interface CustomOptionInterface
+    properties:
+      option_id:
+        type: string
+        description: Option id
+      option_value:
+        type: string
+        description: Option value
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-custom-option-extension-interface"
+    required:
+    - option_id
+    - option_value
+  catalog-data-custom-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface
+    properties:
+      file_info:
+        "$ref": "#/definitions/framework-data-image-content-interface"
+  framework-data-image-content-interface:
+    type: object
+    description: Image Content data interface
+    properties:
+      base64_encoded_data:
+        type: string
+        description: Media data (base64 encoded content)
+      type:
+        type: string
+        description: MIME type
+      name:
+        type: string
+        description: Image name
+    required:
+    - base64_encoded_data
+    - type
+    - name
+  bundle-data-bundle-option-interface:
+    type: object
+    description: Interface BundleOptionInterface
+    properties:
+      option_id:
+        type: integer
+        description: Bundle option id.
+      option_qty:
+        type: integer
+        description: Bundle option quantity.
+      option_selections:
+        type: array
+        description: Bundle option selection ids.
+        items:
+          type: integer
+      extension_attributes:
+        "$ref": "#/definitions/bundle-data-bundle-option-extension-interface"
+    required:
+    - option_id
+    - option_qty
+    - option_selections
+  bundle-data-bundle-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface
+  downloadable-data-downloadable-option-interface:
+    type: object
+    description: Downloadable Option
+    properties:
+      downloadable_links:
+        type: array
+        description: The list of downloadable links
+        items:
+          type: integer
+    required:
+    - downloadable_links
+  gift-card-data-gift-card-option-interface:
+    type: object
+    description: Interface GiftCardOptionInterface
+    properties:
+      giftcard_amount:
+        type: string
+        description: Gift card amount.
+      custom_giftcard_amount:
+        type: number
+        description: Gift card open amount value.
+      giftcard_sender_name:
+        type: string
+        description: Gift card sender name.
+      giftcard_recipient_name:
+        type: string
+        description: Gift card recipient name.
+      giftcard_sender_email:
+        type: string
+        description: Gift card sender email.
+      giftcard_recipient_email:
+        type: string
+        description: Gift card recipient email.
+      giftcard_message:
+        type: string
+        description: Giftcard message.
+      extension_attributes:
+        "$ref": "#/definitions/gift-card-data-gift-card-option-extension-interface"
+    required:
+    - giftcard_amount
+    - giftcard_sender_name
+    - giftcard_recipient_name
+    - giftcard_sender_email
+    - giftcard_recipient_email
+  gift-card-data-gift-card-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface
+    properties:
+      giftcard_created_codes:
+        type: array
+        items:
+          type: string
+  configurable-product-data-configurable-item-option-value-interface:
+    type: object
+    description: Interface ConfigurableItemOptionValueInterface
+    properties:
+      option_id:
+        type: string
+        description: Option SKU
+      option_value:
+        type: integer
+        description: Item id
+      extension_attributes:
+        "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-extension-interface"
+    required:
+    - option_id
+  configurable-product-data-configurable-item-option-value-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface
+  grouped-product-data-grouped-options-interface:
+    type: object
+    description: Represents `product item id with qty` of a grouped product.
+    properties:
+      id:
+        type: integer
+        description: Associated product id
+      qty:
+        type: integer
+        description: Associated product qty
+      extension_attributes:
+        "$ref": "#/definitions/grouped-product-data-grouped-options-extension-interface"
+  grouped-product-data-grouped-options-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface
+  quote-data-cart-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface
+    properties:
+      discounts:
+        type: array
+        items:
+          "$ref": "#/definitions/sales-rule-data-rule-discount-interface"
+      negotiable_quote_item:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-interface"
+  sales-rule-data-rule-discount-interface:
+    type: object
+    description: Rule discount Interface
+    properties:
+      discount_data:
+        "$ref": "#/definitions/sales-rule-data-discount-data-interface"
+      rule_label:
+        type: string
+        description: Rule Label
+      rule_i_d:
+        type: integer
+        description: Rule ID
+    required:
+    - discount_data
+    - rule_label
+    - rule_i_d
+  sales-rule-data-discount-data-interface:
+    type: object
+    description: Discount Data Interface
+    properties:
+      amount:
+        type: number
+        description: Amount
+      base_amount:
+        type: number
+        description: Base Amount
+      original_amount:
+        type: number
+        description: Original Amount
+      base_original_amount:
+        type: number
+        description: Base Original Amount
+    required:
+    - amount
+    - base_amount
+    - original_amount
+    - base_original_amount
+  negotiable-quote-data-negotiable-quote-item-interface:
+    type: object
+    description: Interface CompanyQuoteConfigInterface
+    properties:
+      item_id:
+        type: integer
+        description: Quote item id
+      original_price:
+        type: number
+        description: Quote item original price
+      original_tax_amount:
+        type: number
+        description: Quote item original tax amount
+      original_discount_amount:
+        type: number
+        description: Quote item original discount amount
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-extension-interface"
+    required:
+    - item_id
+    - original_price
+    - original_tax_amount
+    - original_discount_amount
+  negotiable-quote-data-negotiable-quote-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface
+    properties:
+      negotiated_price_type:
+        type: integer
+      negotiated_price_value:
+        type: number
+      last_item_notes:
+        type: array
+        items:
+          "$ref": "#/definitions/negotiable-quote-data-item-note-interface"
+      is_discounting_locked:
+        type: boolean
+      min_qty:
+        type: number
+      max_qty:
+        type: number
+  negotiable-quote-data-item-note-interface:
+    type: object
+    description: Interface ItemNoteInterface
+    properties:
+      note_id:
+        type: integer
+        description: Note ID.
+      negotiable_quote_item_id:
+        type: integer
+        description: Negotiable quote item Id
+      creator_type:
+        type: integer
+        description: The note creator type.
+      creator_id:
+        type: integer
+        description: Note creator ID.
+      note:
+        type: string
+        description: Note.
+      created_at:
+        type: string
+        description: Comment created at.
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-item-note-extension-interface"
+    required:
+    - negotiable_quote_item_id
+    - creator_type
+    - creator_id
+    - note
+  negotiable-quote-data-item-note-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\ItemNoteInterface
+  quote-data-address-interface:
+    type: object
+    description: Interface AddressInterface
+    properties:
+      id:
+        type: integer
+        description: Id
+      region:
+        type: string
+        description: Region name
+      region_id:
+        type: integer
+        description: Region id
+      region_code:
+        type: string
+        description: Region code
+      country_id:
+        type: string
+        description: Country id
+      street:
+        type: array
+        description: Street
+        items:
+          type: string
+      company:
+        type: string
+        description: Company
+      telephone:
+        type: string
+        description: Telephone number
+      fax:
+        type: string
+        description: Fax number
+      postcode:
+        type: string
+        description: Postcode
+      city:
+        type: string
+        description: City name
+      firstname:
+        type: string
+        description: First name
+      lastname:
+        type: string
+        description: Last name
+      middlename:
+        type: string
+        description: Middle name
+      prefix:
+        type: string
+        description: Prefix
+      suffix:
+        type: string
+        description: Suffix
+      vat_id:
+        type: string
+        description: Vat id
+      customer_id:
+        type: integer
+        description: Customer id
+      email:
+        type: string
+        description: Billing/shipping email
+      same_as_billing:
+        type: integer
+        description: Same as billing flag
+      customer_address_id:
+        type: integer
+        description: Customer address id
+      save_in_address_book:
+        type: integer
+        description: Save in address book flag
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-address-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - region
+    - region_id
+    - region_code
+    - country_id
+    - street
+    - telephone
+    - postcode
+    - city
+    - firstname
+    - lastname
+    - email
+  quote-data-address-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface
+    properties:
+      discounts:
+        type: array
+        items:
+          "$ref": "#/definitions/sales-rule-data-rule-discount-interface"
+      gift_registry_id:
+        type: integer
+      pickup_location_code:
+        type: string
+  quote-data-currency-interface:
+    type: object
+    description: Interface CurrencyInterface
+    properties:
+      global_currency_code:
+        type: string
+        description: Global currency code
+      base_currency_code:
+        type: string
+        description: Base currency code
+      store_currency_code:
+        type: string
+        description: Store currency code
+      quote_currency_code:
+        type: string
+        description: Quote currency code
+      store_to_base_rate:
+        type: number
+        description: Store currency to base currency rate
+      store_to_quote_rate:
+        type: number
+        description: Store currency to quote currency rate
+      base_to_global_rate:
+        type: number
+        description: Base currency to global currency rate
+      base_to_quote_rate:
+        type: number
+        description: Base currency to quote currency rate
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-currency-extension-interface"
+  quote-data-currency-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface
+  quote-data-cart-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface
+    properties:
+      shipping_assignments:
+        type: array
+        items:
+          "$ref": "#/definitions/quote-data-shipping-assignment-interface"
+      negotiable_quote:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-interface"
+      company_id:
+        type: integer
+      coupon_codes:
+        type: array
+        items:
+          type: string
+  quote-data-shipping-assignment-interface:
+    type: object
+    description: Interface ShippingAssignmentInterface
+    properties:
+      shipping:
+        "$ref": "#/definitions/quote-data-shipping-interface"
+      items:
+        type: array
+        items:
+          "$ref": "#/definitions/quote-data-cart-item-interface"
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-shipping-assignment-extension-interface"
+    required:
+    - shipping
+    - items
+  quote-data-shipping-interface:
+    type: object
+    description: Interface ShippingInterface
+    properties:
+      address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      method:
+        type: string
+        description: Shipping method
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-shipping-extension-interface"
+    required:
+    - address
+    - method
+  quote-data-shipping-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface
+  quote-data-shipping-assignment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface
+  negotiable-quote-data-negotiable-quote-interface:
+    type: object
+    description: Interface NegotiableQuoteInterface
+    properties:
+      quote_id:
+        type: integer
+        description: Negotiable quote ID.
+      is_regular_quote:
+        type: boolean
+        description: Is regular quote.
+      status:
+        type: string
+        description: Negotiable quote status.
+      negotiated_price_type:
+        type: integer
+        description: Negotiated price type.
+      negotiated_price_value:
+        type: number
+        description: Negotiated price value.
+      shipping_price:
+        type: number
+        description: Proposed shipping price.
+      quote_name:
+        type: string
+        description: Negotiable quote name.
+      expiration_period:
+        type: string
+        description: Expiration period.
+      email_notification_status:
+        type: integer
+        description: Email notification status.
+      has_unconfirmed_changes:
+        type: boolean
+        description: Has unconfirmed changes.
+      is_shipping_tax_changed:
+        type: boolean
+        description: Shipping tax changes.
+      is_customer_price_changed:
+        type: boolean
+        description: Customer price changes.
+      notifications:
+        type: integer
+        description: Quote notifications.
+      applied_rule_ids:
+        type: string
+        description: Quote rules.
+      is_address_draft:
+        type: boolean
+        description: Is address draft.
+      deleted_sku:
+        type: string
+        description: Deleted products sku.
+      creator_id:
+        type: integer
+        description: Quote creator id.
+      creator_type:
+        type: integer
+        description: Quote creator type.
+      original_total_price:
+        type: number
+        description: Quote original total price.
+      base_original_total_price:
+        type: number
+        description: Quote original total price in base currency.
+      negotiated_total_price:
+        type: number
+        description: Quote negotiated total price.
+      base_negotiated_total_price:
+        type: number
+        description: Quote negotiated total price in base currency.
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-extension-interface"
+    required:
+    - quote_id
+    - is_regular_quote
+    - status
+    - negotiated_price_type
+    - negotiated_price_value
+    - shipping_price
+    - quote_name
+    - expiration_period
+    - email_notification_status
+    - has_unconfirmed_changes
+    - is_shipping_tax_changed
+    - is_customer_price_changed
+    - notifications
+    - applied_rule_ids
+    - is_address_draft
+    - deleted_sku
+    - creator_id
+    - creator_type
+  negotiable-quote-data-negotiable-quote-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface
+  quote-data-payment-interface:
+    type: object
+    description: Interface PaymentInterface
+    properties:
+      po_number:
+        type: string
+        description: Purchase order number
+      method:
+        type: string
+        description: Payment method code
+      additional_data:
+        type: array
+        description: Payment additional details
+        items:
+          type: string
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-payment-extension-interface"
+    required:
+    - method
+  quote-data-payment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface
+    properties:
+      agreement_ids:
+        type: array
+        items:
+          type: string
+  quote-data-shipping-method-interface:
+    type: object
+    description: Interface ShippingMethodInterface
+    properties:
+      carrier_code:
+        type: string
+        description: Shipping carrier code.
+      method_code:
+        type: string
+        description: Shipping method code.
+      carrier_title:
+        type: string
+        description: Shipping carrier title. Otherwise, null.
+      method_title:
+        type: string
+        description: Shipping method title. Otherwise, null.
+      amount:
+        type: number
+        description: Shipping amount in store currency.
+      base_amount:
+        type: number
+        description: Shipping amount in base currency.
+      available:
+        type: boolean
+        description: The value of the availability flag for the current shipping method.
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-shipping-method-extension-interface"
+      error_message:
+        type: string
+        description: Shipping Error message.
+      price_excl_tax:
+        type: number
+        description: Shipping price excl tax.
+      price_incl_tax:
+        type: number
+        description: Shipping price incl tax.
+    required:
+    - carrier_code
+    - method_code
+    - amount
+    - base_amount
+    - available
+    - error_message
+    - price_excl_tax
+    - price_incl_tax
+  quote-data-shipping-method-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface
+  quote-data-payment-method-interface:
+    type: object
+    description: Interface PaymentMethodInterface
+    properties:
+      code:
+        type: string
+        description: Payment method code
+      title:
+        type: string
+        description: Payment method title
+    required:
+    - code
+    - title
+  quote-data-totals-additional-data-interface:
+    type: object
+    description: Additional data for totals collection.
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-totals-additional-data-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+  quote-data-totals-additional-data-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface
+    properties:
+      gift_messages:
+        type: array
+        items:
+          "$ref": "#/definitions/gift-message-data-message-interface"
+  gift-message-data-message-interface:
+    type: object
+    description: Interface MessageInterface
+    properties:
+      gift_message_id:
+        type: integer
+        description: Gift message ID. Otherwise, null.
+      customer_id:
+        type: integer
+        description: Customer ID. Otherwise, null.
+      sender:
+        type: string
+        description: Sender name.
+      recipient:
+        type: string
+        description: Recipient name.
+      message:
+        type: string
+        description: Message text.
+      extension_attributes:
+        "$ref": "#/definitions/gift-message-data-message-extension-interface"
+    required:
+    - sender
+    - recipient
+    - message
+  gift-message-data-message-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface
+    properties:
+      entity_id:
+        type: string
+      entity_type:
+        type: string
+      wrapping_id:
+        type: integer
+      wrapping_allow_gift_receipt:
+        type: boolean
+      wrapping_add_printed_card:
+        type: boolean
+  quote-data-totals-interface:
+    type: object
+    description: Interface TotalsInterface
+    properties:
+      grand_total:
+        type: number
+        description: Grand total in quote currency
+      base_grand_total:
+        type: number
+        description: Grand total in base currency
+      subtotal:
+        type: number
+        description: Subtotal in quote currency
+      base_subtotal:
+        type: number
+        description: Subtotal in base currency
+      discount_amount:
+        type: number
+        description: Discount amount in quote currency
+      base_discount_amount:
+        type: number
+        description: Discount amount in base currency
+      subtotal_with_discount:
+        type: number
+        description: Subtotal in quote currency with applied discount
+      base_subtotal_with_discount:
+        type: number
+        description: Subtotal in base currency with applied discount
+      shipping_amount:
+        type: number
+        description: Shipping amount in quote currency
+      base_shipping_amount:
+        type: number
+        description: Shipping amount in base currency
+      shipping_discount_amount:
+        type: number
+        description: Shipping discount amount in quote currency
+      base_shipping_discount_amount:
+        type: number
+        description: Shipping discount amount in base currency
+      tax_amount:
+        type: number
+        description: Tax amount in quote currency
+      base_tax_amount:
+        type: number
+        description: Tax amount in base currency
+      weee_tax_applied_amount:
+        type: number
+        description: Item weee tax applied amount in quote currency.
+      shipping_tax_amount:
+        type: number
+        description: Shipping tax amount in quote currency
+      base_shipping_tax_amount:
+        type: number
+        description: Shipping tax amount in base currency
+      subtotal_incl_tax:
+        type: number
+        description: Subtotal including tax in quote currency
+      base_subtotal_incl_tax:
+        type: number
+        description: Subtotal including tax in base currency
+      shipping_incl_tax:
+        type: number
+        description: Shipping including tax in quote currency
+      base_shipping_incl_tax:
+        type: number
+        description: Shipping including tax in base currency
+      base_currency_code:
+        type: string
+        description: Base currency code
+      quote_currency_code:
+        type: string
+        description: Quote currency code
+      coupon_code:
+        type: string
+        description: Applied coupon code
+      items_qty:
+        type: integer
+        description: Items qty
+      items:
+        type: array
+        description: Totals by items
+        items:
+          "$ref": "#/definitions/quote-data-totals-item-interface"
+      total_segments:
+        type: array
+        description: Dynamically calculated totals
+        items:
+          "$ref": "#/definitions/quote-data-total-segment-interface"
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-totals-extension-interface"
+    required:
+    - weee_tax_applied_amount
+    - total_segments
+  quote-data-totals-item-interface:
+    type: object
+    description: Interface TotalsItemInterface
+    properties:
+      item_id:
+        type: integer
+        description: Item id
+      price:
+        type: number
+        description: Item price in quote currency.
+      base_price:
+        type: number
+        description: Item price in base currency.
+      qty:
+        type: number
+        description: Item quantity.
+      row_total:
+        type: number
+        description: Row total in quote currency.
+      base_row_total:
+        type: number
+        description: Row total in base currency.
+      row_total_with_discount:
+        type: number
+        description: Row total with discount in quote currency. Otherwise, null.
+      tax_amount:
+        type: number
+        description: Tax amount in quote currency. Otherwise, null.
+      base_tax_amount:
+        type: number
+        description: Tax amount in base currency. Otherwise, null.
+      tax_percent:
+        type: number
+        description: Tax percent. Otherwise, null.
+      discount_amount:
+        type: number
+        description: Discount amount in quote currency. Otherwise, null.
+      base_discount_amount:
+        type: number
+        description: Discount amount in base currency. Otherwise, null.
+      discount_percent:
+        type: number
+        description: Discount percent. Otherwise, null.
+      price_incl_tax:
+        type: number
+        description: Price including tax in quote currency. Otherwise, null.
+      base_price_incl_tax:
+        type: number
+        description: Price including tax in base currency. Otherwise, null.
+      row_total_incl_tax:
+        type: number
+        description: Row total including tax in quote currency. Otherwise, null.
+      base_row_total_incl_tax:
+        type: number
+        description: Row total including tax in base currency. Otherwise, null.
+      options:
+        type: string
+        description: Item price in quote currency.
+      weee_tax_applied_amount:
+        type: number
+        description: Item weee tax applied amount in quote currency.
+      weee_tax_applied:
+        type: string
+        description: Item weee tax applied in quote currency.
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-totals-item-extension-interface"
+      name:
+        type: string
+        description: Product name. Otherwise, null.
+    required:
+    - item_id
+    - price
+    - base_price
+    - qty
+    - row_total
+    - base_row_total
+    - options
+    - weee_tax_applied_amount
+    - weee_tax_applied
+  quote-data-totals-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface
+    properties:
+      negotiable_quote_item_totals:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface"
+  negotiable-quote-data-negotiable-quote-item-totals-interface:
+    type: object
+    description: Extension attribute for quote item totals model.
+    properties:
+      cost:
+        type: number
+        description: Cost for quote item.
+      catalog_price:
+        type: number
+        description: Catalog price for quote item.
+      base_catalog_price:
+        type: number
+        description: Catalog price for quote item in base currency.
+      catalog_price_incl_tax:
+        type: number
+        description: Catalog price with included tax for quote item.
+      base_catalog_price_incl_tax:
+        type: number
+        description: Catalog price with included tax for quote item in base currency.
+      cart_price:
+        type: number
+        description: Cart price for quote item.
+      base_cart_price:
+        type: number
+        description: Cart price for quote item in base currency.
+      cart_tax:
+        type: number
+        description: Tax from catalog price for quote item.
+      base_cart_tax:
+        type: number
+        description: Tax from catalog price for quote item in base currency.
+      cart_price_incl_tax:
+        type: number
+        description: Cart price with included tax for quote item.
+      base_cart_price_incl_tax:
+        type: number
+        description: Cart price with included tax for quote item in base currency.
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface"
+    required:
+    - cost
+    - catalog_price
+    - base_catalog_price
+    - catalog_price_incl_tax
+    - base_catalog_price_incl_tax
+    - cart_price
+    - base_cart_price
+    - cart_tax
+    - base_cart_tax
+    - cart_price_incl_tax
+    - base_cart_price_incl_tax
+  negotiable-quote-data-negotiable-quote-item-totals-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface
+  quote-data-total-segment-interface:
+    type: object
+    description: Interface TotalsInterface
+    properties:
+      code:
+        type: string
+        description: Code
+      title:
+        type: string
+        description: Total title
+      value:
+        type: number
+        description: Total value
+      area:
+        type: string
+        description: Display area code.
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-total-segment-extension-interface"
+    required:
+    - code
+    - value
+  quote-data-total-segment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface
+    properties:
+      tax_grandtotal_details:
+        type: array
+        items:
+          "$ref": "#/definitions/tax-data-grand-total-details-interface"
+      gift_cards:
+        type: string
+      gw_order_id:
+        type: string
+      gw_item_ids:
+        type: array
+        items:
+          type: string
+      gw_allow_gift_receipt:
+        type: string
+      gw_add_card:
+        type: string
+      gw_price:
+        type: string
+      gw_base_price:
+        type: string
+      gw_items_price:
+        type: string
+      gw_items_base_price:
+        type: string
+      gw_card_price:
+        type: string
+      gw_card_base_price:
+        type: string
+      gw_base_tax_amount:
+        type: string
+      gw_tax_amount:
+        type: string
+      gw_items_base_tax_amount:
+        type: string
+      gw_items_tax_amount:
+        type: string
+      gw_card_base_tax_amount:
+        type: string
+      gw_card_tax_amount:
+        type: string
+      gw_price_incl_tax:
+        type: string
+      gw_base_price_incl_tax:
+        type: string
+      gw_card_price_incl_tax:
+        type: string
+      gw_card_base_price_incl_tax:
+        type: string
+      gw_items_price_incl_tax:
+        type: string
+      gw_items_base_price_incl_tax:
+        type: string
+  tax-data-grand-total-details-interface:
+    type: object
+    description: Interface GrandTotalDetailsInterface
+    properties:
+      amount:
+        type: number
+        description: Tax amount value
+      rates:
+        type: array
+        description: Tax rates info
+        items:
+          "$ref": "#/definitions/tax-data-grand-total-rates-interface"
+      group_id:
+        type: integer
+        description: Group identifier
+    required:
+    - amount
+    - rates
+    - group_id
+  tax-data-grand-total-rates-interface:
+    type: object
+    description: Interface GrandTotalRatesInterface
+    properties:
+      percent:
+        type: string
+        description: Tax percentage value
+      title:
+        type: string
+        description: Rate title
+    required:
+    - percent
+    - title
+  quote-data-totals-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface
+    properties:
+      coupon_label:
+        type: string
+      negotiable_quote_totals:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-totals-interface"
+      base_customer_balance_amount:
+        type: number
+      customer_balance_amount:
+        type: number
+      coupon_codes:
+        type: array
+        items:
+          type: string
+      coupons_labels:
+        type: array
+        items:
+          type: string
+      reward_points_balance:
+        type: number
+      reward_currency_amount:
+        type: number
+      base_reward_currency_amount:
+        type: number
+  negotiable-quote-data-negotiable-quote-totals-interface:
+    type: object
+    description: Extension attribute for quote totals model.
+    properties:
+      items_count:
+        type: integer
+        description: The number of different items or products in the cart.
+      quote_status:
+        type: string
+        description: Negotiable quote status.
+      created_at:
+        type: string
+        description: The cart creation date and time.
+      updated_at:
+        type: string
+        description: The cart last update date and time.
+      customer_group:
+        type: integer
+        description: Customer group id.
+      base_to_quote_rate:
+        type: number
+        description: Base currency to quote currency rate.
+      cost_total:
+        type: number
+        description: Total cost for quote.
+      base_cost_total:
+        type: number
+        description: Total cost for quote in base currency.
+      original_total:
+        type: number
+        description: Original quote total.
+      base_original_total:
+        type: number
+        description: Original quote total in base currency.
+      original_tax:
+        type: number
+        description: Original tax amount for quote.
+      base_original_tax:
+        type: number
+        description: Original tax amount for quote in base currency.
+      original_price_incl_tax:
+        type: number
+        description: Original price with included tax for quote.
+      base_original_price_incl_tax:
+        type: number
+        description: Original price with included tax for quote in base currency.
+      negotiated_price_type:
+        type: integer
+        description: Negotiable quote type.
+      negotiated_price_value:
+        type: number
+        description: Negotiable price value for quote.
+    required:
+    - items_count
+    - quote_status
+    - created_at
+    - updated_at
+    - customer_group
+    - base_to_quote_rate
+    - cost_total
+    - base_cost_total
+    - original_total
+    - base_original_total
+    - original_tax
+    - base_original_tax
+    - original_price_incl_tax
+    - base_original_price_incl_tax
+    - negotiated_price_type
+    - negotiated_price_value
+  framework-search-search-result-interface:
+    type: object
+    description: Interface SearchResultInterface
+    properties:
+      items:
+        type: array
+        items:
+          "$ref": "#/definitions/framework-search-document-interface"
+      aggregations:
+        "$ref": "#/definitions/framework-search-aggregation-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - aggregations
+    - search_criteria
+    - total_count
+  framework-search-document-interface:
+    type: object
+    description: Interface Search Document
+    properties:
+      id:
+        type: integer
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - id
+  framework-search-aggregation-interface:
+    type: object
+    description: Interface Aggregation to get faceted data
+    properties:
+      buckets:
+        type: array
+        description: All Document fields
+        items:
+          "$ref": "#/definitions/framework-search-bucket-interface"
+      bucket_names:
+        type: array
+        description: Document field names
+        items:
+          type: string
+    required:
+    - buckets
+    - bucket_names
+  framework-search-bucket-interface:
+    type: object
+    description: Interface for facet Bucket
+    properties:
+      name:
+        type: string
+        description: Field name
+      values:
+        type: array
+        description: Field values
+        items:
+          "$ref": "#/definitions/framework-search-aggregation-value-interface"
+    required:
+    - name
+    - values
+  framework-search-aggregation-value-interface:
+    type: object
+    description: Interface Aggregation Value
+    properties:
+      value:
+        type: string
+        description: Aggregation
+      metrics:
+        type: array
+        description: Metrics
+        items:
+          type: string
+    required:
+    - value
+    - metrics
+  framework-search-search-criteria-interface:
+    type: object
+    description: Interface SearchCriteriaInterface
+    properties:
+      request_name:
+        type: string
+      filter_groups:
+        type: array
+        description: A list of filter groups.
+        items:
+          "$ref": "#/definitions/framework-search-filter-group"
+      sort_orders:
+        type: array
+        description: Sort order.
+        items:
+          "$ref": "#/definitions/framework-sort-order"
+      page_size:
+        type: integer
+        description: Page size.
+      current_page:
+        type: integer
+        description: Current page.
+    required:
+    - request_name
+    - filter_groups
+  framework-search-filter-group:
+    type: object
+    description: Groups two or more filters together using a logical OR
+    properties:
+      filters:
+        type: array
+        description: A list of filters in this group
+        items:
+          "$ref": "#/definitions/framework-filter"
+  framework-filter:
+    type: object
+    description: Filter which can be used by any methods from service layer.
+    properties:
+      field:
+        type: string
+        description: Field
+      value:
+        type: string
+        description: Value
+      condition_type:
+        type: string
+        description: Condition type
+    required:
+    - field
+    - value
+  framework-sort-order:
+    type: object
+    description: Data object for sort order.
+    properties:
+      field:
+        type: string
+        description: Sorting field.
+      direction:
+        type: string
+        description: Sorting direction.
+    required:
+    - field
+    - direction
+  requisition-list-data-requisition-list-interface:
+    type: object
+    description: Interface RequisitionListInterface
+    properties:
+      id:
+        type: integer
+        description: Requisition List ID
+      customer_id:
+        type: integer
+        description: Customer ID
+      name:
+        type: string
+        description: Requisition List Name
+      updated_at:
+        type: string
+        description: Requisition List Update Time
+      description:
+        type: string
+        description: Requisition List Description
+      items:
+        type: array
+        description: Requisition List Items
+        items:
+          "$ref": "#/definitions/requisition-list-data-requisition-list-item-interface"
+      extension_attributes:
+        "$ref": "#/definitions/requisition-list-data-requisition-list-extension-interface"
+    required:
+    - id
+    - customer_id
+    - name
+    - updated_at
+    - description
+    - items
+  requisition-list-data-requisition-list-item-interface:
+    type: object
+    description: Interface RequisitionListItemInterface
+    properties:
+      id:
+        type: integer
+        description: Requisition List ID.
+      sku:
+        type: string
+        description: Product SKU.
+      requisition_list_id:
+        type: integer
+        description: Requisition List ID.
+      qty:
+        type: number
+        description: Product Qty.
+      options:
+        type: array
+        description: Requisition list item options.
+        items:
+          type: string
+      store_id:
+        type: integer
+        description: Store ID.
+      added_at:
+        type: string
+        description: Added_at value.
+      extension_attributes:
+        "$ref": "#/definitions/requisition-list-data-requisition-list-item-extension-interface"
+    required:
+    - id
+    - sku
+    - requisition_list_id
+    - qty
+    - options
+    - store_id
+    - added_at
+  requisition-list-data-requisition-list-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListItemInterface
+  requisition-list-data-requisition-list-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListInterface
+  checkout-data-shipping-information-interface:
+    type: object
+    description: Interface ShippingInformationInterface
+    properties:
+      shipping_address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      billing_address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      shipping_method_code:
+        type: string
+        description: Shipping method code
+      shipping_carrier_code:
+        type: string
+        description: Carrier code
+      extension_attributes:
+        "$ref": "#/definitions/checkout-data-shipping-information-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - shipping_address
+    - shipping_method_code
+    - shipping_carrier_code
+  checkout-data-shipping-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface
+  checkout-data-payment-details-interface:
+    type: object
+    description: Interface PaymentDetailsInterface
+    properties:
+      payment_methods:
+        type: array
+        items:
+          "$ref": "#/definitions/quote-data-payment-method-interface"
+      totals:
+        "$ref": "#/definitions/quote-data-totals-interface"
+      extension_attributes:
+        "$ref": "#/definitions/checkout-data-payment-details-extension-interface"
+    required:
+    - payment_methods
+    - totals
+  checkout-data-payment-details-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface
+  checkout-data-totals-information-interface:
+    type: object
+    description: Interface TotalsInformationInterface
+    properties:
+      address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      shipping_method_code:
+        type: string
+        description: Shipping method code
+      shipping_carrier_code:
+        type: string
+        description: Carrier code
+      extension_attributes:
+        "$ref": "#/definitions/checkout-data-totals-information-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - address
+  checkout-data-totals-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface
+  gift-card-account-data-gift-card-account-interface:
+    type: object
+    description: Gift Card Account data
+    properties:
+      gift_cards:
+        type: array
+        description: Cards codes.
+        items:
+          type: string
+      gift_cards_amount:
+        type: number
+        description: Cards amount in quote currency.
+      base_gift_cards_amount:
+        type: number
+        description: Cards amount in base currency.
+      gift_cards_amount_used:
+        type: number
+        description: Cards amount used in quote currency.
+      base_gift_cards_amount_used:
+        type: number
+        description: Cards amount used in base currency.
+      extension_attributes:
+        "$ref": "#/definitions/gift-card-account-data-gift-card-account-extension-interface"
+    required:
+    - gift_cards_amount
+    - base_gift_cards_amount
+    - gift_cards_amount_used
+    - base_gift_cards_amount_used
+  gift-card-account-data-gift-card-account-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface
+  negotiable-quote-data-attachment-content-interface:
+    type: object
+    description: Attachment files content interface.
+    properties:
+      base64_encoded_data:
+        type: string
+        description: Media data (base64 encoded content).
+      type:
+        type: string
+        description: MIME type.
+      name:
+        type: string
+        description: File name.
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-attachment-content-extension-interface"
+    required:
+    - base64_encoded_data
+    - type
+    - name
+  negotiable-quote-data-attachment-content-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\AttachmentContentInterface
+  two-factor-auth-provider-interface:
+    type: object
+    description: 2FA provider interface
+    properties:
+      enabled:
+        type: boolean
+        description: True if this provider has been enabled by admin
+      engine:
+        "$ref": "#/definitions/two-factor-auth-engine-interface"
+      code:
+        type: string
+        description: Provider code
+      name:
+        type: string
+        description: Provider name
+      icon:
+        type: string
+        description: Icon
+      reset_allowed:
+        type: boolean
+        description: True if this provider configuration can be reset
+      configure_action:
+        type: string
+        description: Configure action
+      auth_action:
+        type: string
+        description: Auth action
+      extra_actions:
+        type: array
+        description: Allowed extra actions
+        items:
+          type: string
+    required:
+    - enabled
+    - engine
+    - code
+    - name
+    - icon
+    - reset_allowed
+    - configure_action
+    - auth_action
+    - extra_actions
+  two-factor-auth-engine-interface:
+    type: object
+    description: 2FA engine interface
+    properties:
+      enabled:
+        type: boolean
+        description: True if this provider has been enabled by admin
+    required:
+    - enabled
+  two-factor-auth-data-google-configure-interface:
+    type: object
+    description: Google configuration data interface
+    properties:
+      qr_code_base64:
+        type: string
+        description: Value for QR code base 64
+      secret_code:
+        type: string
+        description: Value for secret code
+      extension_attributes:
+        "$ref": "#/definitions/two-factor-auth-data-google-configure-extension-interface"
+    required:
+    - qr_code_base64
+    - secret_code
+  two-factor-auth-data-google-configure-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface
+  two-factor-auth-data-authy-device-interface:
+    type: object
+    description: Authy device data interface
+    properties:
+      country:
+        type: string
+        description: The country
+      phone_number:
+        type: string
+        description: The phone number
+      method:
+        type: string
+        description: The method to authenticate with
+      extension_attributes:
+        "$ref": "#/definitions/two-factor-auth-data-authy-device-extension-interface"
+    required:
+    - country
+    - phone_number
+    - method
+  two-factor-auth-data-authy-device-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyDeviceInterface
+  two-factor-auth-data-authy-registration-prompt-response-interface:
+    type: object
+    description: Response for device registration prompt
+    properties:
+      message:
+        type: string
+        description: The message
+      expiration_seconds:
+        type: string
+        description: The seconds to expire
+      extension_attributes:
+        "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-extension-interface"
+    required:
+    - message
+    - expiration_seconds
+  two-factor-auth-data-authy-registration-prompt-response-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface
+  two-factor-auth-data-u2f-web-authn-request-interface:
+    type: object
+    description: Represents a WebAuthn dataset
+    properties:
+      credential_request_options_json:
+        type: string
+        description: The needed data to initiate a WebAuthn registration ceremony
+      extension_attributes:
+        "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-extension-interface"
+    required:
+    - credential_request_options_json
+  two-factor-auth-data-u2f-web-authn-request-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestInterface
+  inventory-in-store-pickup-api-data-search-result-interface:
+    type: object
+    description: Search results for providing pickup locations.
+    properties:
+      items:
+        type: array
+        description: Items list.
+        items:
+          "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-interface"
+      search_request:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_request
+    - total_count
+  inventory-in-store-pickup-api-data-pickup-location-interface:
+    type: object
+    description: Represents sources projection on In-Store Pickup context. Realisation
+      must follow immutable DTO concept. Partial immutability done according to restriction
+      of current Extension Attributes implementation.
+    properties:
+      pickup_location_code:
+        type: string
+        description: Source code of Pickup Location.
+      name:
+        type: string
+        description: Pickup Location name.
+      email:
+        type: string
+        description: Pickup Location contact email.
+      fax:
+        type: string
+        description: Fax contact info.
+      contact_name:
+        type: string
+        description: Pickup Location contact name.
+      description:
+        type: string
+        description: Pickup Location description.
+      latitude:
+        type: number
+        description: Pickup Location latitude.
+      longitude:
+        type: number
+        description: Pickup Location longitude.
+      country_id:
+        type: string
+        description: Pickup Location country ID.
+      region_id:
+        type: integer
+        description: Pickup Location region ID.
+      region:
+        type: string
+        description: Pickup Location region.
+      city:
+        type: string
+        description: Pickup Location city.
+      street:
+        type: string
+        description: Pickup Location street.
+      postcode:
+        type: string
+        description: Pickup Location postcode.
+      phone:
+        type: string
+        description: Pickup Location phone.
+      extension_attributes:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-extension-interface"
+    required:
+    - pickup_location_code
+  inventory-in-store-pickup-api-data-pickup-location-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface
+  inventory-in-store-pickup-api-data-search-request-interface:
+    type: object
+    description: 'Endpoint used to search Pickup Locations by different parameters:
+      - by attribute filters fields @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\FiltersInterface
+      - by distance to the address @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\AreaInterface
+      Also, endpoint supports paging and sort orders.'
+    properties:
+      area:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-area-interface"
+      filters:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filters-interface"
+      page_size:
+        type: integer
+        description: Page size.
+      current_page:
+        type: integer
+        description: Current page.
+      scope_type:
+        type: string
+        description: Sales Channel Type.
+      scope_code:
+        type: string
+        description: Sales Channel code.
+      sort:
+        type: array
+        description: Sort Order.
+        items:
+          "$ref": "#/definitions/framework-sort-order"
+      extension_attributes:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-extension-interface"
+    required:
+    - current_page
+    - scope_type
+    - scope_code
+  inventory-in-store-pickup-api-data-search-request-area-interface:
+    type: object
+    description: 'Filter by Distance to the Address. Pickup Locations will be filtered
+      by distance according to the geo-position of the entered address. Required fields
+      for the address are country and one of the field: region or city or postcode.'
+    properties:
+      radius:
+        type: integer
+        description: Search radius in KM.
+      search_term:
+        type: string
+        description: Search term string.
+    required:
+    - radius
+    - search_term
+  inventory-in-store-pickup-api-data-search-request-filters-interface:
+    type: object
+    description: Filter to filter by Fields. Each field may be filtered with different
+      condition type. Supported condition types restricted by @see \Magento\Framework\Api\SearchCriteriaInterface
+    properties:
+      country:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      postcode:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      region:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      region_id:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      city:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      street:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      name:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      pickup_location_code:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+  inventory-in-store-pickup-api-data-search-request-filter-interface:
+    type: object
+    description: Filter for Pickup Location search.
+    properties:
+      value:
+        type: string
+        description: Value.
+      condition_type:
+        type: string
+        description: Condition Type.
+    required:
+    - value
+    - condition_type
+  inventory-in-store-pickup-api-data-search-request-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequestInterface
+    properties:
+      products_info:
+        type: array
+        items:
+          "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-interface"
+  inventory-in-store-pickup-api-data-search-request-product-info-interface:
+    type: object
+    description: Product Info Data Transfer Object.
+    properties:
+      sku:
+        type: string
+        description: Product SKU.
+      extension_attributes:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-extension-interface"
+    required:
+    - sku
+  inventory-in-store-pickup-api-data-search-request-product-info-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\ProductInfoInterface
+  payment-services-paypal-payment-config-response-interface:
+    type: object
+    description: ''
+    properties:
+      apple_pay:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface"
+      google_pay:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface"
+      hosted_fields:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface"
+      smart_buttons:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface"
+    required:
+    - apple_pay
+    - google_pay
+    - hosted_fields
+    - smart_buttons
+  payment-services-paypal-data-payment-config-apple-pay-interface:
+    type: object
+    description: ''
+    properties:
+      button_styles:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface"
+      payment_source:
+        type: string
+        description: PaymentSource
+      code:
+        type: string
+        description: Code
+      sdk_params:
+        type: array
+        description: SDK params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+      is_visible:
+        type: boolean
+        description: Visible
+      sort_order:
+        type: string
+        description: Sort Order
+      payment_intent:
+        type: string
+        description: Payment intent
+      title:
+        type: string
+        description: Title
+    required:
+    - button_styles
+    - payment_source
+    - code
+    - sdk_params
+    - is_visible
+    - sort_order
+    - payment_intent
+    - title
+  payment-services-paypal-data-payment-config-button-styles-interface:
+    type: object
+    description: ''
+    properties:
+      layout:
+        type: string
+        description: Layout
+      color:
+        type: string
+        description: Color
+      shape:
+        type: string
+        description: Shape
+      label:
+        type: string
+        description: Label
+      tagline:
+        type: boolean
+        description: ShowTagline
+      height:
+        type: integer
+        description: Height
+      use_default_height:
+        type: boolean
+        description: Height
+    required:
+    - layout
+    - color
+    - shape
+    - label
+    - tagline
+    - height
+    - use_default_height
+  payment-services-paypal-data-payment-config-sdk-params-interface:
+    type: object
+    description: ''
+    properties:
+      name:
+        type: string
+        description: Code
+      value:
+        type: string
+        description: Config
+    required:
+    - name
+    - value
+  payment-services-paypal-data-payment-config-google-pay-interface:
+    type: object
+    description: ''
+    properties:
+      button_styles:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-button-styles-interface"
+      payment_source:
+        type: string
+        description: PaymentSource
+      three_d_s:
+        type: string
+        description: ThreeDS
+      code:
+        type: string
+        description: Code
+      sdk_params:
+        type: array
+        description: SDK params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+      is_visible:
+        type: boolean
+        description: Visible
+      sort_order:
+        type: string
+        description: Sort Order
+      payment_intent:
+        type: string
+        description: Payment intent
+      title:
+        type: string
+        description: Title
+    required:
+    - button_styles
+    - payment_source
+    - three_d_s
+    - code
+    - sdk_params
+    - is_visible
+    - sort_order
+    - payment_intent
+    - title
+  payment-services-paypal-data-payment-config-google-pay-button-styles-interface:
+    type: object
+    description: ''
+    properties:
+      color:
+        type: string
+        description: Color
+      height:
+        type: integer
+        description: Height
+      type:
+        type: string
+        description: Type
+    required:
+    - color
+    - height
+    - type
+  payment-services-paypal-data-payment-config-hosted-fields-interface:
+    type: object
+    description: ''
+    properties:
+      payment_source:
+        type: string
+        description: Payment Source
+      three_d_s:
+        type: string
+        description: ThreeDS
+      is_vault_enabled:
+        type: boolean
+        description: HasIsVaultEnabled
+      cc_vault_code:
+        type: string
+        description: CcVaultCode
+      requires_card_details:
+        type: boolean
+        description: RequiresCardDetails
+      code:
+        type: string
+        description: Code
+      sdk_params:
+        type: array
+        description: SDK params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+      is_visible:
+        type: boolean
+        description: Visible
+      sort_order:
+        type: string
+        description: Sort Order
+      payment_intent:
+        type: string
+        description: Payment intent
+      title:
+        type: string
+        description: Title
+    required:
+    - payment_source
+    - three_d_s
+    - is_vault_enabled
+    - cc_vault_code
+    - requires_card_details
+    - code
+    - sdk_params
+    - is_visible
+    - sort_order
+    - payment_intent
+    - title
+  payment-services-paypal-data-payment-config-smart-buttons-interface:
+    type: object
+    description: ''
+    properties:
+      display_message:
+        type: boolean
+        description: CanDisplayMessage
+      display_venmo:
+        type: boolean
+        description: Venmo
+      message_styles:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface"
+      button_styles:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface"
+      app_switch_when_available:
+        type: boolean
+        description: AppSwitchWhenAvailable
+      code:
+        type: string
+        description: Code
+      sdk_params:
+        type: array
+        description: SDK params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+      is_visible:
+        type: boolean
+        description: Visible
+      sort_order:
+        type: string
+        description: Sort Order
+      payment_intent:
+        type: string
+        description: Payment intent
+      title:
+        type: string
+        description: Title
+    required:
+    - display_message
+    - display_venmo
+    - message_styles
+    - button_styles
+    - app_switch_when_available
+    - code
+    - sdk_params
+    - is_visible
+    - sort_order
+    - payment_intent
+    - title
+  payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface:
+    type: object
+    description: ''
+    properties:
+      layout:
+        type: string
+        description: CanDisplayMessage
+      logo:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-logo-interface"
+    required:
+    - layout
+    - logo
+  payment-services-paypal-data-payment-config-smart-buttons-logo-interface:
+    type: object
+    description: ''
+    properties:
+      type:
+        type: string
+        description: CanDisplayMessage
+    required:
+    - type
+  payment-services-paypal-data-payment-order-interface:
+    type: object
+    description: Interface PaymentOrderInterface
+    properties:
+      id:
+        type: string
+        description: Payment order id
+      mp_order_id:
+        type: string
+        description: Payment order mpOrderId
+      status:
+        type: string
+        description: Payment order status
+      amount:
+        type: number
+        description: Payment order amount
+      currency_code:
+        type: string
+        description: Payment order currency code
+    required:
+    - id
+    - mp_order_id
+    - status
+    - amount
+    - currency_code
+  payment-services-paypal-data-payment-order-details-interface:
+    type: object
+    description: Interface PaymentOrderDetailsInterface
+    properties:
+      payment_source_details:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-source-details-interface"
+      id:
+        type: string
+        description: Payment order id
+      mp_order_id:
+        type: string
+        description: Payment order mpOrderId
+      status:
+        type: string
+        description: Payment order status
+      amount:
+        type: number
+        description: Payment order amount
+      currency_code:
+        type: string
+        description: Payment order currency code
+    required:
+    - payment_source_details
+    - id
+    - mp_order_id
+    - status
+    - amount
+    - currency_code
+  payment-services-paypal-data-payment-source-details-interface:
+    type: object
+    description: ''
+    properties:
+      card:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-card-details-interface"
+    required:
+    - card
+  payment-services-paypal-data-payment-card-details-interface:
+    type: object
+    description: ''
+    properties:
+      name:
+        type: string
+        description: Name
+      last_digits:
+        type: string
+        description: Last digits
+      card_expiry_month:
+        type: string
+        description: Card expiry month
+      card_expiry_year:
+        type: string
+        description: Card expiry year
+      bin_details:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-card-bin-details-interface"
+    required:
+    - name
+    - last_digits
+    - card_expiry_month
+    - card_expiry_year
+    - bin_details
+  payment-services-paypal-data-payment-card-bin-details-interface:
+    type: object
+    description: ''
+    properties:
+      bin:
+        type: string
+        description: Bin
+    required:
+    - bin
+  payment-services-paypal-data-payment-sdk-params-interface:
+    type: object
+    description: ''
+    properties:
+      code:
+        type: string
+        description: The payments sdk code
+      params:
+        type: array
+        description: The payments sdk params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+    required:
+    - code
+    - params
+  pay-pal-braintree-data-auth-data-interface:
+    type: object
+    description: Interface AuthDataInterface
+    properties:
+      client_token:
+        type: string
+        description: Client token
+      display_name:
+        type: string
+        description: Display name
+      action_success:
+        type: string
+        description: To success page
+      logged_in:
+        type: boolean
+        description: Logged in
+      store_code:
+        type: string
+        description: Current store code
+    required:
+    - display_name
+    - action_success
+    - logged_in
+    - store_code
+  pay-pal-braintree-data-payment-interface:
+    type: object
+    description: ''
+    properties:
+      payment_method_code:
+        type: string
+        description: The payment method code.
+      payment_method_nonce:
+        type: string
+        description: The payment method nonce.
+      device_data:
+        type: string
+        description: The device data.
+x-tagGroups:
+- name: applepay
+  tags:
+  - applepay/auth
+- name: braintree
+  tags:
+  - braintree/mine/payment/vault
+- name: carts
+  tags:
+  - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
+  - carts/guest-carts/{cartId}/giftCards
+  - carts/guest-carts/{cartId}/giftCards/{giftCardCode}
+  - carts/mine
+  - carts/mine/balance/apply
+  - carts/mine/checkGiftCard/{giftCardCode}
+  - carts/mine/collect-totals
+  - carts/mine/payment-information
+  - carts/mine/payment-order
+  - carts/mine/payment-order/{id}
+  - carts/mine/po-payment-information
+  - carts/mine/set-payment-information
+- name: customers
+  tags:
+  - customers
+  - customers/isEmailAvailable
+  - customers/me/activate
+  - customers/me/password
+  - customers/password
+  - customers/resetPassword
+  - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
+- name: directory
+  tags:
+  - directory/countries
+  - directory/countries/{countryId}
+  - directory/currency
+- name: giftregistry
+  tags:
+  - giftregistry/mine/estimate-shipping-methods
+- name: guest carts
+  tags:
+  - guest-carts
+  - guest-carts/{cartId}
+  - guest-carts/{cartId}/billing-address
+  - guest-carts/{cartId}/collect-totals
+  - guest-carts/{cartId}/coupons
+  - guest-carts/{cartId}/coupons/{couponCode}
+  - guest-carts/{cartId}/estimate-shipping-methods
+  - guest-carts/{cartId}/gift-message
+  - guest-carts/{cartId}/gift-message/{itemId}
+  - guest-carts/{cartId}/items
+  - guest-carts/{cartId}/items/{itemId}
+  - guest-carts/{cartId}/order
+  - guest-carts/{cartId}/payment-information
+  - guest-carts/{cartId}/payment-methods
+  - guest-carts/{cartId}/payment-order
+  - guest-carts/{cartId}/payment-order/{id}
+  - guest-carts/{cartId}/selected-payment-method
+  - guest-carts/{cartId}/set-payment-information
+  - guest-carts/{cartId}/shipping-information
+  - guest-carts/{cartId}/shipping-methods
+  - guest-carts/{cartId}/totals
+  - guest-carts/{cartId}/totals-information
+- name: guest giftregistry
+  tags:
+  - guest-giftregistry/{cartId}/estimate-shipping-methods
+- name: integration
+  tags:
+  - integration/admin/token
+  - integration/customer/revoke-customer-token
+  - integration/customer/token
+- name: inventory
+  tags:
+  - inventory/in-store-pickup/pickup-locations/
+- name: negotiable carts
+  tags:
+  - negotiable-carts/{cartId}/billing-address
+  - negotiable-carts/{cartId}/coupons
+  - negotiable-carts/{cartId}/coupons/{couponCode}
+  - negotiable-carts/{cartId}/estimate-shipping-methods
+  - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
+  - negotiable-carts/{cartId}/giftCards
+  - negotiable-carts/{cartId}/giftCards/{giftCardCode}
+  - negotiable-carts/{cartId}/payment-information
+  - negotiable-carts/{cartId}/po-payment-information
+  - negotiable-carts/{cartId}/set-payment-information
+  - negotiable-carts/{cartId}/shipping-information
+  - negotiable-carts/{cartId}/totals
+- name: negotiableQuoteTemplate
+  tags:
+  - negotiableQuoteTemplate/accept
+  - negotiableQuoteTemplate/generateQuote
+  - negotiableQuoteTemplate/submitToSeller
+- name: payment order
+  tags:
+  - payment-order/completeOrder
+- name: payments config
+  tags:
+  - payments-config/apple-pay/{location}
+  - payments-config/google-pay/{location}
+  - payments-config/hosted-fields/{location}
+  - payments-config/smart-buttons/{location}
+  - payments-config/{location}
+- name: payments sdk
+  tags:
+  - payments-sdk/{location}
+  - payments-sdk/{location}/{methodCode}
+- name: paypal
+  tags:
+  - paypal/lineItems
+  - paypal/oneClick
+  - paypal/validatePhoneNumber
+- name: products render info
+  tags:
+  - products-render-info
+- name: purchase order carts
+  tags:
+  - purchase-order-carts/{cartId}/payment-information
+  - purchase-order-carts/{cartId}/set-payment-information
+- name: requisition_lists
+  tags:
+  - requisition_lists
+- name: reward
+  tags:
+  - reward/mine/use-reward
+- name: search
+  tags:
+  - search
+- name: tfa
+  tags:
+  - tfa/provider/authy/activate
+  - tfa/provider/authy/authenticate
+  - tfa/provider/authy/authenticate-onetouch
+  - tfa/provider/authy/configure
+  - tfa/provider/authy/send-token/{via}
+  - tfa/provider/duo_security/activate
+  - tfa/provider/duo_security/authenticate
+  - tfa/provider/duo_security/configure
+  - tfa/provider/google/activate
+  - tfa/provider/google/authenticate
+  - tfa/provider/google/configure
+  - tfa/provider/u2fkey/activate
+  - tfa/provider/u2fkey/authentication-challenge
+  - tfa/provider/u2fkey/configure
+  - tfa/provider/u2fkey/verify
+  - tfa/tfat-providers-to-activate
+  - tfa/tfat-user-providers
diff --git a/src/openapi/guest-schema-2.4.9-beta-1.yaml b/src/openapi/guest-schema-2.4.9-beta-1.yaml
new file mode 100644
index 000000000..dc1df7e0b
--- /dev/null
+++ b/src/openapi/guest-schema-2.4.9-beta-1.yaml
@@ -0,0 +1,6073 @@
+---
+securityDefinitions:
+  api_key:
+    type: apiKey
+    name: api_key
+    in: header
+swagger: '2.0'
+info:
+  version: 2.4.9-beta-1
+  title: Commerce Guest REST endpoints - All inclusive
+  description:
+    "$ref": "../_includes/redocly-intro.md"
+host: example.com
+basePath: "/rest/default"
+schemes:
+- http
+tags:
+- name: applepay/auth
+- name: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
+- name: carts/guest-carts/{cartId}/giftCards
+- name: carts/guest-carts/{cartId}/giftCards/{giftCardCode}
+- name: customers
+- name: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
+- name: customers/isEmailAvailable
+- name: customers/password
+- name: customers/resetPassword
+- name: directory/countries
+- name: directory/countries/{countryId}
+- name: directory/currency
+- name: guest-carts
+- name: guest-carts/{cartId}
+- name: guest-carts/{cartId}/billing-address
+- name: guest-carts/{cartId}/collect-totals
+- name: guest-carts/{cartId}/coupons
+- name: guest-carts/{cartId}/coupons/{couponCode}
+- name: guest-carts/{cartId}/estimate-shipping-methods
+- name: guest-carts/{cartId}/gift-message
+- name: guest-carts/{cartId}/gift-message/{itemId}
+- name: guest-carts/{cartId}/items
+- name: guest-carts/{cartId}/items/{itemId}
+- name: guest-carts/{cartId}/order
+- name: guest-carts/{cartId}/payment-information
+- name: guest-carts/{cartId}/payment-methods
+- name: guest-carts/{cartId}/payment-order
+- name: guest-carts/{cartId}/payment-order/{id}
+- name: guest-carts/{cartId}/selected-payment-method
+- name: guest-carts/{cartId}/set-payment-information
+- name: guest-carts/{cartId}/shipping-information
+- name: guest-carts/{cartId}/shipping-methods
+- name: guest-carts/{cartId}/totals
+- name: guest-carts/{cartId}/totals-information
+- name: guest-giftregistry/{cartId}/estimate-shipping-methods
+- name: integration/admin/token
+- name: integration/customer/token
+- name: inventory/in-store-pickup/pickup-locations/
+- name: payment-order/completeOrder
+- name: payments-config/{location}
+- name: payments-config/apple-pay/{location}
+- name: payments-config/google-pay/{location}
+- name: payments-config/hosted-fields/{location}
+- name: payments-config/smart-buttons/{location}
+- name: payments-sdk/{location}
+- name: payments-sdk/{location}/{methodCode}
+- name: paypal/lineItems
+- name: paypal/oneClick
+- name: paypal/validatePhoneNumber
+- name: products-render-info
+- name: search
+- name: tfa/provider/authy/activate
+- name: tfa/provider/authy/authenticate
+- name: tfa/provider/authy/authenticate-onetouch
+- name: tfa/provider/authy/configure
+- name: tfa/provider/authy/send-token/{via}
+- name: tfa/provider/duo_security/activate
+- name: tfa/provider/duo_security/authenticate
+- name: tfa/provider/duo_security/configure
+- name: tfa/provider/google/activate
+- name: tfa/provider/google/authenticate
+- name: tfa/provider/google/configure
+- name: tfa/provider/u2fkey/activate
+- name: tfa/provider/u2fkey/authentication-challenge
+- name: tfa/provider/u2fkey/configure
+- name: tfa/provider/u2fkey/verify
+- name: tfa/tfat-providers-to-activate
+- name: tfa/tfat-user-providers
+paths:
+  "/V1/applepay/auth":
+    get:
+      tags:
+      - applepay/auth
+      description: Returns details required to be able to submit a payment with Apple
+        Pay
+      operationId: GetV1ApplepayAuth
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/pay-pal-braintree-data-auth-data-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: applepay/auth
+  "/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}":
+    get:
+      tags:
+      - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
+      description: Check gift card balance if added to the cart.
+      operationId: GetV1CartsGuestcartsCartIdCheckGiftCardGiftCardCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: giftCardCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: number
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
+  "/V1/carts/guest-carts/{cartId}/giftCards":
+    post:
+      tags:
+      - carts/guest-carts/{cartId}/giftCards
+      description: Add gift card to the cart.
+      operationId: PostV1CartsGuestcartsCartIdGiftCards
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1CartsGuestcartsCartIdGiftCardsBody
+        in: body
+        schema:
+          required:
+          - giftCardAccountData
+          properties:
+            giftCardAccountData:
+              "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/guest-carts/{cartId}/giftCards
+  "/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}":
+    delete:
+      tags:
+      - carts/guest-carts/{cartId}/giftCards/{giftCardCode}
+      description: Remove GiftCard Account entity.
+      operationId: DeleteV1CartsGuestcartsCartIdGiftCardsGiftCardCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: giftCardCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: carts/guest-carts/{cartId}/giftCards/{giftCardCode}
+  "/V1/customers":
+    post:
+      tags:
+      - customers
+      description: Create customer account. Perform necessary business operations
+        like sending email.
+      operationId: PostV1Customers
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CustomersBody
+        in: body
+        schema:
+          required:
+          - customer
+          properties:
+            customer:
+              "$ref": "#/definitions/customer-data-customer-interface"
+            password:
+              type: string
+            redirectUrl:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/customer-data-customer-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers
+  "/V1/customers/isEmailAvailable":
+    post:
+      tags:
+      - customers/isEmailAvailable
+      description: Check if given email is associated with a customer account in given
+        website.
+      operationId: PostV1CustomersIsEmailAvailable
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CustomersIsEmailAvailableBody
+        in: body
+        schema:
+          required:
+          - customerEmail
+          properties:
+            customerEmail:
+              type: string
+            websiteId:
+              type: integer
+              description: If not set, will use the current websiteId
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/isEmailAvailable
+  "/V1/customers/password":
+    put:
+      tags:
+      - customers/password
+      description: Send an email to the customer with a password reset link.
+      operationId: PutV1CustomersPassword
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PutV1CustomersPasswordBody
+        in: body
+        schema:
+          required:
+          - email
+          - template
+          properties:
+            email:
+              type: string
+            template:
+              type: string
+            websiteId:
+              type: integer
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/password
+  "/V1/customers/resetPassword":
+    post:
+      tags:
+      - customers/resetPassword
+      description: Reset customer password.
+      operationId: PostV1CustomersResetPassword
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1CustomersResetPasswordBody
+        in: body
+        schema:
+          required:
+          - email
+          - resetToken
+          - newPassword
+          properties:
+            email:
+              type: string
+              description: If empty value given then the customer will be matched
+                by the RP token.
+            resetToken:
+              type: string
+            newPassword:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: true on success
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/resetPassword
+  "/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":
+    get:
+      tags:
+      - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
+      description: Check if password reset token is valid.
+      operationId: GetV1CustomersCustomerIdPasswordResetLinkTokenResetPasswordLinkToken
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: customerId
+        in: path
+        type: integer
+        required: true
+        description: If null is given then a customer will be matched by the RP token.
+      - name: resetPasswordLinkToken
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+            description: True if the token is valid
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
+  "/V1/directory/countries":
+    get:
+      tags:
+      - directory/countries
+      description: Get all countries and regions information for the store.
+      operationId: GetV1DirectoryCountries
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/directory-data-country-information-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: directory/countries
+  "/V1/directory/countries/{countryId}":
+    get:
+      tags:
+      - directory/countries/{countryId}
+      description: Get country and region information for the store.
+      operationId: GetV1DirectoryCountriesCountryId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: countryId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/directory-data-country-information-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: directory/countries/{countryId}
+  "/V1/directory/currency":
+    get:
+      tags:
+      - directory/currency
+      description: Get currency information for the store.
+      operationId: GetV1DirectoryCurrency
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/directory-data-currency-information-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: directory/currency
+  "/V1/guest-carts":
+    post:
+      tags:
+      - guest-carts
+      description: Enable an customer or guest user to create an empty cart and quote
+        for an anonymous customer.
+      operationId: PostV1Guestcarts
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: Cart ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts
+  "/V1/guest-carts/{cartId}":
+    get:
+      tags:
+      - guest-carts/{cartId}
+      description: Enable a guest user to return information for a specified cart.
+      operationId: GetV1GuestcartsCartId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}
+  "/V1/guest-carts/{cartId}/billing-address":
+    get:
+      tags:
+      - guest-carts/{cartId}/billing-address
+      description: Return the billing address for a specified quote.
+      operationId: GetV1GuestcartsCartIdBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-address-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/billing-address
+    post:
+      tags:
+      - guest-carts/{cartId}/billing-address
+      description: Assign a specified billing address to a specified cart.
+      operationId: PostV1GuestcartsCartIdBillingaddress
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PostV1GuestcartsCartIdBillingaddressBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+            useForShipping:
+              type: boolean
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Address ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/billing-address
+  "/V1/guest-carts/{cartId}/collect-totals":
+    put:
+      tags:
+      - guest-carts/{cartId}/collect-totals
+      description: Set shipping/billing methods and additional data for cart and collect
+        totals for guest.
+      operationId: PutV1GuestcartsCartIdCollecttotals
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PutV1GuestcartsCartIdCollecttotalsBody
+        in: body
+        schema:
+          required:
+          - paymentMethod
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            shippingCarrierCode:
+              type: string
+              description: The carrier code.
+            shippingMethodCode:
+              type: string
+              description: The shipping method code.
+            additionalData:
+              "$ref": "#/definitions/quote-data-totals-additional-data-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/collect-totals
+  "/V1/guest-carts/{cartId}/coupons":
+    get:
+      tags:
+      - guest-carts/{cartId}/coupons
+      description: Return information for a coupon in a specified cart.
+      operationId: GetV1GuestcartsCartIdCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: The coupon code data.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/coupons
+    delete:
+      tags:
+      - guest-carts/{cartId}/coupons
+      description: Delete a coupon from a specified cart.
+      operationId: DeleteV1GuestcartsCartIdCoupons
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/coupons
+  "/V1/guest-carts/{cartId}/coupons/{couponCode}":
+    put:
+      tags:
+      - guest-carts/{cartId}/coupons/{couponCode}
+      description: Add a coupon by code to a specified cart.
+      operationId: PutV1GuestcartsCartIdCouponsCouponCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: couponCode
+        in: path
+        type: string
+        required: true
+        description: The coupon code data.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/coupons/{couponCode}
+  "/V1/guest-carts/{cartId}/estimate-shipping-methods":
+    post:
+      tags:
+      - guest-carts/{cartId}/estimate-shipping-methods
+      description: Estimate shipping by address and return list of available shipping
+        methods
+      operationId: PostV1GuestcartsCartIdEstimateshippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdEstimateshippingmethodsBody
+        in: body
+        schema:
+          required:
+          - address
+          properties:
+            address:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/estimate-shipping-methods
+  "/V1/guest-carts/{cartId}/gift-message":
+    get:
+      tags:
+      - guest-carts/{cartId}/gift-message
+      description: Return the gift message for a specified order.
+      operationId: GetV1GuestcartsCartIdGiftmessage
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The shopping cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-message-data-message-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/gift-message
+    post:
+      tags:
+      - guest-carts/{cartId}/gift-message
+      description: Set the gift message for an entire order.
+      operationId: PostV1GuestcartsCartIdGiftmessage
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PostV1GuestcartsCartIdGiftmessageBody
+        in: body
+        schema:
+          required:
+          - giftMessage
+          properties:
+            giftMessage:
+              "$ref": "#/definitions/gift-message-data-message-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/gift-message
+  "/V1/guest-carts/{cartId}/gift-message/{itemId}":
+    get:
+      tags:
+      - guest-carts/{cartId}/gift-message/{itemId}
+      description: Return the gift message for a specified item in a specified shopping
+        cart.
+      operationId: GetV1GuestcartsCartIdGiftmessageItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The shopping cart ID.
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/gift-message-data-message-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/gift-message/{itemId}
+    post:
+      tags:
+      - guest-carts/{cartId}/gift-message/{itemId}
+      description: Set the gift message for a specified item in a specified shopping
+        cart.
+      operationId: PostV1GuestcartsCartIdGiftmessageItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID.
+      - name: PostV1GuestcartsCartIdGiftmessageItemIdBody
+        in: body
+        schema:
+          required:
+          - giftMessage
+          properties:
+            giftMessage:
+              "$ref": "#/definitions/gift-message-data-message-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/gift-message/{itemId}
+  "/V1/guest-carts/{cartId}/items":
+    get:
+      tags:
+      - guest-carts/{cartId}/items
+      description: List items that are assigned to a specified cart.
+      operationId: GetV1GuestcartsCartIdItems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: Array of items.
+            items:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/items
+    post:
+      tags:
+      - guest-carts/{cartId}/items
+      description: Add/update the specified cart item.
+      operationId: PostV1GuestcartsCartIdItems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdItemsBody
+        in: body
+        schema:
+          required:
+          - cartItem
+          properties:
+            cartItem:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/items
+  "/V1/guest-carts/{cartId}/items/{itemId}":
+    put:
+      tags:
+      - guest-carts/{cartId}/items/{itemId}
+      description: Add/update the specified cart item.
+      operationId: PutV1GuestcartsCartIdItemsItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: itemId
+        in: path
+        type: string
+        required: true
+      - name: PutV1GuestcartsCartIdItemsItemIdBody
+        in: body
+        schema:
+          required:
+          - cartItem
+          properties:
+            cartItem:
+              "$ref": "#/definitions/quote-data-cart-item-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-cart-item-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/items/{itemId}
+    delete:
+      tags:
+      - guest-carts/{cartId}/items/{itemId}
+      description: Remove the specified item from the specified cart.
+      operationId: DeleteV1GuestcartsCartIdItemsItemId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: itemId
+        in: path
+        type: integer
+        required: true
+        description: The item ID of the item to be removed.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/items/{itemId}
+  "/V1/guest-carts/{cartId}/order":
+    put:
+      tags:
+      - guest-carts/{cartId}/order
+      description: Place an order for a specified cart.
+      operationId: PutV1GuestcartsCartIdOrder
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PutV1GuestcartsCartIdOrderBody
+        in: body
+        schema:
+          properties:
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/order
+  "/V1/guest-carts/{cartId}/payment-information":
+    post:
+      tags:
+      - guest-carts/{cartId}/payment-information
+      description: Set payment information and place order for a specified cart.
+      operationId: PostV1GuestcartsCartIdPaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdPaymentinformationBody
+        in: body
+        schema:
+          required:
+          - email
+          - paymentMethod
+          properties:
+            email:
+              type: string
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-information
+    get:
+      tags:
+      - guest-carts/{cartId}/payment-information
+      description: Get payment information
+      operationId: GetV1GuestcartsCartIdPaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-information
+  "/V1/guest-carts/{cartId}/payment-methods":
+    get:
+      tags:
+      - guest-carts/{cartId}/payment-methods
+      description: List available payment methods for a specified shopping cart. This
+        call returns an array of objects, but detailed information about each object’s
+        attributes might not be included.  See https://developer.adobe.com/commerce/webapi/rest/attributes#GuestPaymentMethodManagementInterface
+        to determine which call to use to get detailed information about all attributes
+        for an object.
+      operationId: GetV1GuestcartsCartIdPaymentmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: Array of payment methods.
+            items:
+              "$ref": "#/definitions/quote-data-payment-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-methods
+  "/V1/guest-carts/{cartId}/payment-order":
+    post:
+      tags:
+      - guest-carts/{cartId}/payment-order
+      description: Create a payment order for guest customer
+      operationId: PostV1GuestcartsCartIdPaymentorder
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdPaymentorderBody
+        in: body
+        schema:
+          required:
+          - methodCode
+          - paymentSource
+          - location
+          properties:
+            methodCode:
+              type: string
+            paymentSource:
+              type: string
+            location:
+              type: string
+            vaultIntent:
+              type: boolean
+            threeDSMode:
+              type: string
+              description: "| null $threeDSMode"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-order
+  "/V1/guest-carts/{cartId}/payment-order/{id}":
+    get:
+      tags:
+      - guest-carts/{cartId}/payment-order/{id}
+      description: Get payment order for guest customer
+      operationId: GetV1GuestcartsCartIdPaymentorderId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: id
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-order/{id}
+    post:
+      tags:
+      - guest-carts/{cartId}/payment-order/{id}
+      description: Sync payment order for guest customer
+      operationId: PostV1GuestcartsCartIdPaymentorderId
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: id
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: boolean
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/payment-order/{id}
+  "/V1/guest-carts/{cartId}/selected-payment-method":
+    get:
+      tags:
+      - guest-carts/{cartId}/selected-payment-method
+      description: Return the payment method for a specified shopping cart.
+      operationId: GetV1GuestcartsCartIdSelectedpaymentmethod
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-payment-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/selected-payment-method
+    put:
+      tags:
+      - guest-carts/{cartId}/selected-payment-method
+      description: Add a specified payment method to a specified shopping cart.
+      operationId: PutV1GuestcartsCartIdSelectedpaymentmethod
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      - name: PutV1GuestcartsCartIdSelectedpaymentmethodBody
+        in: body
+        schema:
+          required:
+          - method
+          properties:
+            method:
+              "$ref": "#/definitions/quote-data-payment-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Payment method ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/selected-payment-method
+  "/V1/guest-carts/{cartId}/set-payment-information":
+    post:
+      tags:
+      - guest-carts/{cartId}/set-payment-information
+      description: Set payment information for a specified cart.
+      operationId: PostV1GuestcartsCartIdSetpaymentinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdSetpaymentinformationBody
+        in: body
+        schema:
+          required:
+          - email
+          - paymentMethod
+          properties:
+            email:
+              type: string
+            paymentMethod:
+              "$ref": "#/definitions/quote-data-payment-interface"
+            billingAddress:
+              "$ref": "#/definitions/quote-data-address-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: integer
+            description: Order ID.
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/set-payment-information
+  "/V1/guest-carts/{cartId}/shipping-information":
+    post:
+      tags:
+      - guest-carts/{cartId}/shipping-information
+      description: ''
+      operationId: PostV1GuestcartsCartIdShippinginformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdShippinginformationBody
+        in: body
+        schema:
+          required:
+          - addressInformation
+          properties:
+            addressInformation:
+              "$ref": "#/definitions/checkout-data-shipping-information-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/checkout-data-payment-details-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/shipping-information
+  "/V1/guest-carts/{cartId}/shipping-methods":
+    get:
+      tags:
+      - guest-carts/{cartId}/shipping-methods
+      description: List applicable shipping methods for a specified quote.
+      operationId: GetV1GuestcartsCartIdShippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The shopping cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/shipping-methods
+  "/V1/guest-carts/{cartId}/totals":
+    get:
+      tags:
+      - guest-carts/{cartId}/totals
+      description: Return quote totals data for a specified cart.
+      operationId: GetV1GuestcartsCartIdTotals
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The cart ID.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/totals
+  "/V1/guest-carts/{cartId}/totals-information":
+    post:
+      tags:
+      - guest-carts/{cartId}/totals-information
+      description: Calculate quote totals based on address and shipping method.
+      operationId: PostV1GuestcartsCartIdTotalsinformation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+      - name: PostV1GuestcartsCartIdTotalsinformationBody
+        in: body
+        schema:
+          required:
+          - addressInformation
+          properties:
+            addressInformation:
+              "$ref": "#/definitions/checkout-data-totals-information-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/quote-data-totals-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-carts/{cartId}/totals-information
+  "/V1/guest-giftregistry/{cartId}/estimate-shipping-methods":
+    post:
+      tags:
+      - guest-giftregistry/{cartId}/estimate-shipping-methods
+      description: Estimate shipping
+      operationId: PostV1GuestgiftregistryCartIdEstimateshippingmethods
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: cartId
+        in: path
+        type: string
+        required: true
+        description: The shopping cart ID.
+      - name: PostV1GuestgiftregistryCartIdEstimateshippingmethodsBody
+        in: body
+        schema:
+          required:
+          - registryId
+          properties:
+            registryId:
+              type: integer
+              description: The estimate registry id
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            description: An array of shipping methods.
+            items:
+              "$ref": "#/definitions/quote-data-shipping-method-interface"
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: guest-giftregistry/{cartId}/estimate-shipping-methods
+  "/V1/integration/admin/token":
+    post:
+      tags:
+      - integration/admin/token
+      description: Create access token for admin given the admin credentials.
+      operationId: PostV1IntegrationAdminToken
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1IntegrationAdminTokenBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: Token created
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: integration/admin/token
+  "/V1/integration/customer/token":
+    post:
+      tags:
+      - integration/customer/token
+      description: Create access token for admin given the customer credentials.
+      operationId: PostV1IntegrationCustomerToken
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1IntegrationCustomerTokenBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: Token created
+        '400':
+          description: 400 Bad Request
+          schema:
+            "$ref": "#/definitions/error-response"
+        '401':
+          description: 401 Unauthorized
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: integration/customer/token
+  "/V1/inventory/in-store-pickup/pickup-locations/":
+    get:
+      tags:
+      - inventory/in-store-pickup/pickup-locations/
+      description: Get Pickup Locations according to the results of filtration by
+        Search Request.
+      operationId: GetV1InventoryInstorepickupPickuplocations
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchRequest[area][radius]
+        in: query
+        type: integer
+        description: Search radius in KM.
+      - name: searchRequest[area][searchTerm]
+        in: query
+        type: string
+        description: Search term string.
+      - name: searchRequest[filters][country][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][country][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][postcode][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][postcode][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][region][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][region][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][regionId][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][regionId][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][city][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][city][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][street][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][street][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][name][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][name][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[filters][pickupLocationCode][value]
+        in: query
+        type: string
+        description: Value.
+      - name: searchRequest[filters][pickupLocationCode][conditionType]
+        in: query
+        type: string
+        description: Condition Type.
+      - name: searchRequest[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchRequest[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      - name: searchRequest[scopeType]
+        in: query
+        type: string
+        description: Sales Channel Type.
+      - name: searchRequest[scopeCode]
+        in: query
+        type: string
+        description: Sales Channel code.
+      - name: searchRequest[sort][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchRequest[sort][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchRequest[extensionAttributes][productsInfo][0][sku]
+        in: query
+        type: string
+        description: Product SKU.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/in-store-pickup/pickup-locations/
+    post:
+      tags:
+      - inventory/in-store-pickup/pickup-locations/
+      description: Get Pickup Locations according to the results of filtration by
+        Search Request.
+      operationId: PostV1InventoryInstorepickupPickuplocations
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1InventoryInstorepickupPickuplocationsBody
+        in: body
+        schema:
+          required:
+          - searchRequest
+          properties:
+            searchRequest:
+              "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: inventory/in-store-pickup/pickup-locations/
+  "/V1/payment-order/completeOrder":
+    post:
+      tags:
+      - payment-order/completeOrder
+      description: Rest API endpoint to place an order
+      operationId: PostV1PaymentorderCompleteOrder
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1PaymentorderCompleteOrderBody
+        in: body
+        schema:
+          required:
+          - orderId
+          properties:
+            orderId:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payment-order/completeOrder
+  "/V1/payments-config/apple-pay/{location}":
+    get:
+      tags:
+      - payments-config/apple-pay/{location}
+      description: Get Apple Pay Config.
+      operationId: GetV1PaymentsconfigApplepayLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/apple-pay/{location}
+  "/V1/payments-config/google-pay/{location}":
+    get:
+      tags:
+      - payments-config/google-pay/{location}
+      description: Get Google Pay Config.
+      operationId: GetV1PaymentsconfigGooglepayLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/google-pay/{location}
+  "/V1/payments-config/hosted-fields/{location}":
+    get:
+      tags:
+      - payments-config/hosted-fields/{location}
+      description: Get Hosted Fields Config.
+      operationId: GetV1PaymentsconfigHostedfieldsLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/hosted-fields/{location}
+  "/V1/payments-config/smart-buttons/{location}":
+    get:
+      tags:
+      - payments-config/smart-buttons/{location}
+      description: Get Smart Buttons Config.
+      operationId: GetV1PaymentsconfigSmartbuttonsLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/smart-buttons/{location}
+  "/V1/payments-config/{location}":
+    get:
+      tags:
+      - payments-config/{location}
+      description: Get Config.
+      operationId: GetV1PaymentsconfigLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+        description: sdk location.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-payment-config-response-interface"
+        '500':
+          description: Internal Server error
+          schema:
+            "$ref": "#/definitions/error-response"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-config/{location}
+  "/V1/payments-sdk/{location}":
+    get:
+      tags:
+      - payments-sdk/{location}
+      description: Get payment sdk url by location
+      operationId: GetV1PaymentssdkLocation
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-sdk/{location}
+  "/V1/payments-sdk/{location}/{methodCode}":
+    get:
+      tags:
+      - payments-sdk/{location}/{methodCode}
+      description: Get payment sdk url by location and methodCode
+      operationId: GetV1PaymentssdkLocationMethodCode
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: location
+        in: path
+        type: string
+        required: true
+      - name: methodCode
+        in: path
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: payments-sdk/{location}/{methodCode}
+  "/V1/paypal/lineItems":
+    post:
+      tags:
+      - paypal/lineItems
+      description: Rest endpoint to calculate totals and line items
+      operationId: PostV1PaypalLineItems
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1PaypalLineItemsBody
+        in: body
+        schema:
+          required:
+          - method
+          - cartId
+          properties:
+            method:
+              type: string
+            cartId:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: paypal/lineItems
+  "/V1/paypal/oneClick":
+    post:
+      tags:
+      - paypal/oneClick
+      description: Rest endpoint to add product to cart (mainly use for PayPal button
+        from PDP)
+      operationId: PostV1PaypalOneClick
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1PaypalOneClickBody
+        in: body
+        schema:
+          required:
+          - method
+          - productData
+          properties:
+            method:
+              type: string
+            productData:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: paypal/oneClick
+  "/V1/paypal/validatePhoneNumber":
+    post:
+      tags:
+      - paypal/validatePhoneNumber
+      description: Get & validate phone number and get shipping/billing email address
+      operationId: PostV1PaypalValidatePhoneNumber
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1PaypalValidatePhoneNumberBody
+        in: body
+        schema:
+          required:
+          - cartId
+          properties:
+            cartId:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: paypal/validatePhoneNumber
+  "/V1/products-render-info":
+    get:
+      tags:
+      - products-render-info
+      description: Collect and retrieve the list of product render info. This info
+        contains raw prices and formatted prices, product name, stock status, store_id,
+        etc.
+      operationId: GetV1Productsrenderinfo
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      - name: storeId
+        in: query
+        type: integer
+        required: true
+      - name: currencyCode
+        in: query
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/catalog-data-product-render-search-results-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: products-render-info
+  "/V1/search":
+    get:
+      tags:
+      - search
+      description: Make Full Text Search and return found Documents
+      operationId: GetV1Search
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: searchCriteria[requestName]
+        in: query
+        type: string
+      - name: searchCriteria[filterGroups][0][filters][0][field]
+        in: query
+        type: string
+        description: Field
+      - name: searchCriteria[filterGroups][0][filters][0][value]
+        in: query
+        type: string
+        description: Value
+      - name: searchCriteria[filterGroups][0][filters][0][conditionType]
+        in: query
+        type: string
+        description: Condition type
+      - name: searchCriteria[sortOrders][0][field]
+        in: query
+        type: string
+        description: Sorting field.
+      - name: searchCriteria[sortOrders][0][direction]
+        in: query
+        type: string
+        description: Sorting direction.
+      - name: searchCriteria[pageSize]
+        in: query
+        type: integer
+        description: Page size.
+      - name: searchCriteria[currentPage]
+        in: query
+        type: integer
+        description: Current page.
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/framework-search-search-result-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: search
+  "/V1/tfa/provider/authy/activate":
+    post:
+      tags:
+      - tfa/provider/authy/activate
+      description: Activate the provider and get an admin token
+      operationId: PostV1TfaProviderAuthyActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderAuthyActivateBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          - otp
+          properties:
+            tfaToken:
+              type: string
+            otp:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/activate
+  "/V1/tfa/provider/authy/authenticate":
+    post:
+      tags:
+      - tfa/provider/authy/authenticate
+      description: Get an admin token using authy 2fa
+      operationId: PostV1TfaProviderAuthyAuthenticate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderAuthyAuthenticateBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          - otp
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+            otp:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+            description: "$otp"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/authenticate
+  "/V1/tfa/provider/authy/authenticate-onetouch":
+    post:
+      tags:
+      - tfa/provider/authy/authenticate-onetouch
+      description: Authenticate using the present one touch response and get an admin
+        token
+      operationId: PostV1TfaProviderAuthyAuthenticateonetouch
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderAuthyAuthenticateonetouchBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/authenticate-onetouch
+  "/V1/tfa/provider/authy/configure":
+    post:
+      tags:
+      - tfa/provider/authy/configure
+      description: Get the information required to configure google
+      operationId: PostV1TfaProviderAuthyConfigure
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderAuthyConfigureBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          - deviceData
+          properties:
+            tfaToken:
+              type: string
+            deviceData:
+              "$ref": "#/definitions/two-factor-auth-data-authy-device-interface"
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/configure
+  "/V1/tfa/provider/authy/send-token/{via}":
+    post:
+      tags:
+      - tfa/provider/authy/send-token/{via}
+      description: Send a one time password to a device using authy
+      operationId: PostV1TfaProviderAuthySendtokenVia
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: via
+        in: path
+        type: string
+        required: true
+      - name: PostV1TfaProviderAuthySendtokenViaBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/authy/send-token/{via}
+  "/V1/tfa/provider/duo_security/activate":
+    post:
+      tags:
+      - tfa/provider/duo_security/activate
+      description: Activate the provider and get an admin token
+      operationId: PostV1TfaProviderDuo_securityActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderDuo_securityActivateBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          properties:
+            tfaToken:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/duo_security/activate
+  "/V1/tfa/provider/duo_security/authenticate":
+    post:
+      tags:
+      - tfa/provider/duo_security/authenticate
+      description: Authenticate and get an admin token with passcode
+      operationId: PostV1TfaProviderDuo_securityAuthenticate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderDuo_securityAuthenticateBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          - passcode
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+            passcode:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/duo_security/authenticate
+  "/V1/tfa/provider/duo_security/configure":
+    post:
+      tags:
+      - tfa/provider/duo_security/configure
+      description: Configure duo for first time user
+      operationId: PostV1TfaProviderDuo_securityConfigure
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderDuo_securityConfigureBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          properties:
+            tfaToken:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/duo_security/configure
+  "/V1/tfa/provider/google/activate":
+    post:
+      tags:
+      - tfa/provider/google/activate
+      description: Activate the provider and get an admin token
+      operationId: PostV1TfaProviderGoogleActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderGoogleActivateBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          - otp
+          properties:
+            tfaToken:
+              type: string
+            otp:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/google/activate
+  "/V1/tfa/provider/google/authenticate":
+    post:
+      tags:
+      - tfa/provider/google/authenticate
+      description: Get an admin token by authenticating using google
+      operationId: PostV1TfaProviderGoogleAuthenticate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderGoogleAuthenticateBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          - otp
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+            otp:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/google/authenticate
+  "/V1/tfa/provider/google/configure":
+    post:
+      tags:
+      - tfa/provider/google/configure
+      description: Get the information required to configure google
+      operationId: PostV1TfaProviderGoogleConfigure
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderGoogleConfigureBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          properties:
+            tfaToken:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/two-factor-auth-data-google-configure-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/google/configure
+  "/V1/tfa/provider/u2fkey/activate":
+    post:
+      tags:
+      - tfa/provider/u2fkey/activate
+      description: Activate the provider and get a token
+      operationId: PostV1TfaProviderU2fkeyActivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderU2fkeyActivateBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          - publicKeyCredentialJson
+          properties:
+            tfaToken:
+              type: string
+            publicKeyCredentialJson:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/u2fkey/activate
+  "/V1/tfa/provider/u2fkey/authentication-challenge":
+    post:
+      tags:
+      - tfa/provider/u2fkey/authentication-challenge
+      description: Get the information to initiate a WebAuthn registration ceremony
+      operationId: PostV1TfaProviderU2fkeyAuthenticationchallenge
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderU2fkeyAuthenticationchallengeBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/u2fkey/authentication-challenge
+  "/V1/tfa/provider/u2fkey/configure":
+    post:
+      tags:
+      - tfa/provider/u2fkey/configure
+      description: Get the information to initiate a WebAuthn registration ceremony
+      operationId: PostV1TfaProviderU2fkeyConfigure
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderU2fkeyConfigureBody
+        in: body
+        schema:
+          required:
+          - tfaToken
+          properties:
+            tfaToken:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/u2fkey/configure
+  "/V1/tfa/provider/u2fkey/verify":
+    post:
+      tags:
+      - tfa/provider/u2fkey/verify
+      description: Authenticate with the provider and get a token
+      operationId: PostV1TfaProviderU2fkeyVerify
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: PostV1TfaProviderU2fkeyVerifyBody
+        in: body
+        schema:
+          required:
+          - username
+          - password
+          - publicKeyCredentialJson
+          properties:
+            username:
+              type: string
+            password:
+              type: string
+            publicKeyCredentialJson:
+              type: string
+          type: object
+          xml:
+            name: request
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: string
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/provider/u2fkey/verify
+  "/V1/tfa/tfat-providers-to-activate":
+    get:
+      tags:
+      - tfa/tfat-providers-to-activate
+      description: Get the providers that the user still needs to configure
+      operationId: GetV1TfaTfatproviderstoactivate
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: tfaToken
+        in: query
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/two-factor-auth-provider-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/tfat-providers-to-activate
+  "/V1/tfa/tfat-user-providers":
+    get:
+      tags:
+      - tfa/tfat-user-providers
+      description: Get the providers that the user is able to use for 2fa
+      operationId: GetV1TfaTfatuserproviders
+      consumes:
+      - application/json
+      - application/xml
+      produces:
+      - application/json
+      - application/xml
+      parameters:
+      - name: tfaToken
+        in: query
+        type: string
+        required: true
+      responses:
+        '200':
+          description: 200 Success.
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/two-factor-auth-provider-interface"
+        default:
+          description: Unexpected error
+          schema:
+            "$ref": "#/definitions/error-response"
+      summary: tfa/tfat-user-providers
+definitions:
+  error-response:
+    type: object
+    properties:
+      message:
+        type: string
+        description: Error message
+      errors:
+        "$ref": "#/definitions/error-errors"
+      code:
+        type: integer
+        description: Error code
+      parameters:
+        "$ref": "#/definitions/error-parameters"
+      trace:
+        type: string
+        description: Stack trace
+    required:
+    - message
+  error-errors:
+    type: array
+    description: Errors list
+    items:
+      "$ref": "#/definitions/error-errors-item"
+  error-errors-item:
+    type: object
+    description: Error details
+    properties:
+      message:
+        type: string
+        description: Error message
+      parameters:
+        "$ref": "#/definitions/error-parameters"
+  error-parameters:
+    type: array
+    description: Error parameters list
+    items:
+      "$ref": "#/definitions/error-parameters-item"
+  error-parameters-item:
+    type: object
+    description: Error parameters item
+    properties:
+      resources:
+        type: string
+        description: ACL resource
+      fieldName:
+        type: string
+        description: Missing or invalid field name
+      fieldValue:
+        type: string
+        description: Incorrect field value
+  directory-data-currency-information-interface:
+    type: object
+    description: Currency Information interface.
+    properties:
+      base_currency_code:
+        type: string
+        description: The base currency code for the store.
+      base_currency_symbol:
+        type: string
+        description: The currency symbol of the base currency for the store.
+      default_display_currency_code:
+        type: string
+        description: The default display currency code for the store.
+      default_display_currency_symbol:
+        type: string
+        description: The currency symbol of the default display currency for the store.
+      available_currency_codes:
+        type: array
+        description: The list of allowed currency codes for the store.
+        items:
+          type: string
+      exchange_rates:
+        type: array
+        description: The list of exchange rate information for the store.
+        items:
+          "$ref": "#/definitions/directory-data-exchange-rate-interface"
+      extension_attributes:
+        "$ref": "#/definitions/directory-data-currency-information-extension-interface"
+    required:
+    - base_currency_code
+    - base_currency_symbol
+    - default_display_currency_code
+    - default_display_currency_symbol
+    - available_currency_codes
+    - exchange_rates
+  directory-data-exchange-rate-interface:
+    type: object
+    description: Exchange Rate interface.
+    properties:
+      currency_to:
+        type: string
+        description: The currency code associated with the exchange rate.
+      rate:
+        type: number
+        description: The exchange rate for the associated currency and the store's
+          base currency.
+      extension_attributes:
+        "$ref": "#/definitions/directory-data-exchange-rate-extension-interface"
+    required:
+    - currency_to
+    - rate
+  directory-data-exchange-rate-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Directory\Api\Data\ExchangeRateInterface
+  directory-data-currency-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CurrencyInformationInterface
+  directory-data-country-information-interface:
+    type: object
+    description: Country Information interface.
+    properties:
+      id:
+        type: string
+        description: The country id for the store.
+      two_letter_abbreviation:
+        type: string
+        description: The country 2 letter abbreviation for the store.
+      three_letter_abbreviation:
+        type: string
+        description: The country 3 letter abbreviation for the store.
+      full_name_locale:
+        type: string
+        description: The country full name (in store locale) for the store.
+      full_name_english:
+        type: string
+        description: The country full name (in English) for the store.
+      available_regions:
+        type: array
+        description: The available regions for the store.
+        items:
+          "$ref": "#/definitions/directory-data-region-information-interface"
+      extension_attributes:
+        "$ref": "#/definitions/directory-data-country-information-extension-interface"
+    required:
+    - id
+    - two_letter_abbreviation
+    - three_letter_abbreviation
+    - full_name_locale
+    - full_name_english
+  directory-data-region-information-interface:
+    type: object
+    description: Region Information interface.
+    properties:
+      id:
+        type: string
+        description: Region id
+      code:
+        type: string
+        description: Region code
+      name:
+        type: string
+        description: Region name
+      extension_attributes:
+        "$ref": "#/definitions/directory-data-region-information-extension-interface"
+    required:
+    - id
+    - code
+    - name
+  directory-data-region-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Directory\Api\Data\RegionInformationInterface
+  directory-data-country-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CountryInformationInterface
+  customer-data-customer-interface:
+    type: object
+    description: Customer entity interface for API handling.
+    properties:
+      id:
+        type: integer
+        description: Customer id
+      group_id:
+        type: integer
+        description: Group id
+      default_billing:
+        type: string
+        description: Default billing address id
+      default_shipping:
+        type: string
+        description: Default shipping address id
+      confirmation:
+        type: string
+        description: Confirmation
+      created_at:
+        type: string
+        description: Created at time
+      updated_at:
+        type: string
+        description: Updated at time
+      created_in:
+        type: string
+        description: Created in area
+      dob:
+        type: string
+        description: In keeping with current security and privacy best practices,
+          be sure you are aware of any potential legal and security risks associated
+          with the storage of customers’ full date of birth (month, day, year) along
+          with other personal identifiers (e.g., full name) before collecting or processing
+          such data.
+      email:
+        type: string
+        description: Email address
+      firstname:
+        type: string
+        description: First name
+      lastname:
+        type: string
+        description: Last name
+      middlename:
+        type: string
+        description: Middle name
+      prefix:
+        type: string
+        description: Prefix
+      suffix:
+        type: string
+        description: Suffix
+      gender:
+        type: integer
+        description: Gender
+      store_id:
+        type: integer
+        description: Store id
+      taxvat:
+        type: string
+        description: Tax Vat
+      website_id:
+        type: integer
+        description: Website id
+      addresses:
+        type: array
+        description: Customer addresses.
+        items:
+          "$ref": "#/definitions/customer-data-address-interface"
+      disable_auto_group_change:
+        type: integer
+        description: Disable auto group change flag.
+      extension_attributes:
+        "$ref": "#/definitions/customer-data-customer-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - email
+    - firstname
+    - lastname
+  customer-data-address-interface:
+    type: object
+    description: Customer address interface.
+    properties:
+      id:
+        type: integer
+        description: ID
+      customer_id:
+        type: integer
+        description: Customer ID
+      region:
+        "$ref": "#/definitions/customer-data-region-interface"
+      region_id:
+        type: integer
+        description: Region ID
+      country_id:
+        type: string
+        description: Country code in ISO_3166-2 format
+      street:
+        type: array
+        description: Street
+        items:
+          type: string
+      company:
+        type: string
+        description: Company
+      telephone:
+        type: string
+        description: Telephone number
+      fax:
+        type: string
+        description: Fax number
+      postcode:
+        type: string
+        description: Postcode
+      city:
+        type: string
+        description: City name
+      firstname:
+        type: string
+        description: First name
+      lastname:
+        type: string
+        description: Last name
+      middlename:
+        type: string
+        description: Middle name
+      prefix:
+        type: string
+        description: Prefix
+      suffix:
+        type: string
+        description: Suffix
+      vat_id:
+        type: string
+        description: Vat id
+      default_shipping:
+        type: boolean
+        description: If this address is default shipping address.
+      default_billing:
+        type: boolean
+        description: If this address is default billing address
+      extension_attributes:
+        "$ref": "#/definitions/customer-data-address-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+  customer-data-region-interface:
+    type: object
+    description: Customer address region interface.
+    properties:
+      region_code:
+        type: string
+        description: Region code
+      region:
+        type: string
+        description: Region
+      region_id:
+        type: integer
+        description: Region id
+      extension_attributes:
+        "$ref": "#/definitions/customer-data-region-extension-interface"
+    required:
+    - region_code
+    - region
+    - region_id
+  customer-data-region-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface
+  customer-data-address-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface
+  framework-attribute-interface:
+    type: object
+    description: Interface for custom attribute value.
+    properties:
+      attribute_code:
+        type: string
+        description: Attribute code
+      value:
+        type: string
+        description: Attribute value
+    required:
+    - attribute_code
+    - value
+  customer-data-customer-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface
+    properties:
+      company_attributes:
+        "$ref": "#/definitions/company-data-company-customer-interface"
+      all_company_attributes:
+        type: array
+        items:
+          "$ref": "#/definitions/company-data-company-customer-interface"
+      is_subscribed:
+        type: boolean
+      assistance_allowed:
+        type: integer
+  company-data-company-customer-interface:
+    type: object
+    description: Extended customer custom attributes interface.
+    properties:
+      customer_id:
+        type: integer
+        description: Customer ID.
+      company_id:
+        type: integer
+        description: Company ID.
+      job_title:
+        type: string
+        description: Job title.
+      status:
+        type: integer
+        description: Customer status.
+      telephone:
+        type: string
+        description: Telephone.
+      is_default:
+        type: boolean
+        description: Is default
+      extension_attributes:
+        "$ref": "#/definitions/company-data-company-customer-extension-interface"
+  company-data-company-customer-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface
+  catalog-data-product-render-search-results-interface:
+    type: object
+    description: Dto that holds render information about products
+    properties:
+      items:
+        type: array
+        description: List of products rendered information
+        items:
+          "$ref": "#/definitions/catalog-data-product-render-interface"
+    required:
+    - items
+  catalog-data-product-render-interface:
+    type: object
+    description: Represents Data Object which holds enough information to render product
+      This information is put into part as Add To Cart or Add to Compare Data or Price
+      Data
+    properties:
+      add_to_cart_button:
+        "$ref": "#/definitions/catalog-data-product-render-button-interface"
+      add_to_compare_button:
+        "$ref": "#/definitions/catalog-data-product-render-button-interface"
+      price_info:
+        "$ref": "#/definitions/catalog-data-product-render-price-info-interface"
+      images:
+        type: array
+        description: Enough information, that needed to render image on front
+        items:
+          "$ref": "#/definitions/catalog-data-product-render-image-interface"
+      url:
+        type: string
+        description: Product url
+      id:
+        type: integer
+        description: Product identifier
+      name:
+        type: string
+        description: Product name
+      type:
+        type: string
+        description: Product type. Such as bundle, grouped, simple, etc...
+      is_salable:
+        type: string
+        description: Information about product saleability (In Stock)
+      store_id:
+        type: integer
+        description: Information about current store id or requested store id
+      currency_code:
+        type: string
+        description: Current or desired currency code to product
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-extension-interface"
+    required:
+    - add_to_cart_button
+    - add_to_compare_button
+    - price_info
+    - images
+    - url
+    - id
+    - name
+    - type
+    - is_salable
+    - store_id
+    - currency_code
+    - extension_attributes
+  catalog-data-product-render-button-interface:
+    type: object
+    description: 'Button interface. This interface represents all manner of product
+      buttons: add to cart, add to compare, etc... The buttons describes by this interface
+      should have interaction with backend'
+    properties:
+      post_data:
+        type: string
+        description: Post data
+      url:
+        type: string
+        description: Url, needed to add product to cart
+      required_options:
+        type: boolean
+        description: Flag whether a product has options or not
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-button-extension-interface"
+    required:
+    - post_data
+    - url
+    - required_options
+  catalog-data-product-render-button-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface
+  catalog-data-product-render-price-info-interface:
+    type: object
+    description: Price interface.
+    properties:
+      final_price:
+        type: number
+        description: Final price
+      max_price:
+        type: number
+        description: Max price of a product
+      max_regular_price:
+        type: number
+        description: Max regular price
+      minimal_regular_price:
+        type: number
+        description: Minimal regular price
+      special_price:
+        type: number
+        description: Special price
+      minimal_price:
+        type: number
+        description: Minimal price
+      regular_price:
+        type: number
+        description: Regular price
+      formatted_prices:
+        "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-interface"
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-price-info-extension-interface"
+    required:
+    - final_price
+    - max_price
+    - max_regular_price
+    - minimal_regular_price
+    - special_price
+    - minimal_price
+    - regular_price
+    - formatted_prices
+  catalog-data-product-render-formatted-price-info-interface:
+    type: object
+    description: 'Formatted Price interface. Aggregate formatted html with price representations.
+      E.g.: $9.00 Consider currency, rounding and html'
+    properties:
+      final_price:
+        type: string
+        description: Html with final price
+      max_price:
+        type: string
+        description: Max price of a product
+      minimal_price:
+        type: string
+        description: The minimal price of the product or variation
+      max_regular_price:
+        type: string
+        description: Max regular price
+      minimal_regular_price:
+        type: string
+        description: Minimal regular price
+      special_price:
+        type: string
+        description: Special price
+      regular_price:
+        type: string
+        description: Price - is price of product without discounts and special price
+          with taxes and fixed product tax
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-extension-interface"
+    required:
+    - final_price
+    - max_price
+    - minimal_price
+    - max_regular_price
+    - minimal_regular_price
+    - special_price
+    - regular_price
+  catalog-data-product-render-formatted-price-info-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\FormattedPriceInfoInterface
+  catalog-data-product-render-price-info-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface
+    properties:
+      msrp:
+        "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-interface"
+      tax_adjustments:
+        "$ref": "#/definitions/catalog-data-product-render-price-info-interface"
+      weee_attributes:
+        type: array
+        items:
+          "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-interface"
+      weee_adjustment:
+        type: string
+  msrp-data-product-render-msrp-price-info-interface:
+    type: object
+    description: Price interface.
+    properties:
+      msrp_price:
+        type: string
+      is_applicable:
+        type: string
+      is_shown_price_on_gesture:
+        type: string
+      msrp_message:
+        type: string
+      explanation_message:
+        type: string
+      extension_attributes:
+        "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-extension-interface"
+    required:
+    - msrp_price
+    - is_applicable
+    - is_shown_price_on_gesture
+    - msrp_message
+    - explanation_message
+  msrp-data-product-render-msrp-price-info-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface
+  weee-data-product-render-weee-adjustment-attribute-interface:
+    type: object
+    description: List of all weee attributes, their amounts, etc.., that product has
+    properties:
+      amount:
+        type: string
+        description: Weee attribute amount
+      tax_amount:
+        type: string
+        description: Tax which is calculated to fixed product tax attribute
+      tax_amount_incl_tax:
+        type: string
+        description: Tax amount of weee attribute
+      amount_excl_tax:
+        type: string
+        description: Product amount exclude tax
+      attribute_code:
+        type: string
+        description: Weee attribute code
+      extension_attributes:
+        "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface"
+    required:
+    - amount
+    - tax_amount
+    - tax_amount_incl_tax
+    - amount_excl_tax
+    - attribute_code
+    - extension_attributes
+  weee-data-product-render-weee-adjustment-attribute-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Weee\Api\Data\ProductRender\WeeeAdjustmentAttributeInterface
+  catalog-data-product-render-image-interface:
+    type: object
+    description: Product Render image interface. Represents physical characteristics
+      of image, that can be used in product listing or product view
+    properties:
+      url:
+        type: string
+        description: Image url
+      code:
+        type: string
+        description: Image code
+      height:
+        type: number
+        description: Image height
+      width:
+        type: number
+        description: Image width in px
+      label:
+        type: string
+        description: Image label
+      resized_width:
+        type: number
+        description: Resize width
+      resized_height:
+        type: number
+        description: Resize height
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-product-render-image-extension-interface"
+    required:
+    - url
+    - code
+    - height
+    - width
+    - label
+    - resized_width
+    - resized_height
+  catalog-data-product-render-image-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ImageInterface
+  catalog-data-product-render-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRenderInterface
+    properties:
+      wishlist_button:
+        "$ref": "#/definitions/catalog-data-product-render-button-interface"
+      review_html:
+        type: string
+  quote-data-cart-interface:
+    type: object
+    description: Interface CartInterface
+    properties:
+      id:
+        type: integer
+        description: Cart/quote ID.
+      created_at:
+        type: string
+        description: Cart creation date and time. Otherwise, null.
+      updated_at:
+        type: string
+        description: Cart last update date and time. Otherwise, null.
+      converted_at:
+        type: string
+        description: Cart conversion date and time. Otherwise, null.
+      is_active:
+        type: boolean
+        description: Active status flag value. Otherwise, null.
+      is_virtual:
+        type: boolean
+        description: Virtual flag value. Otherwise, null.
+      items:
+        type: array
+        description: Array of items. Otherwise, null.
+        items:
+          "$ref": "#/definitions/quote-data-cart-item-interface"
+      items_count:
+        type: integer
+        description: Number of different items or products in the cart. Otherwise,
+          null.
+      items_qty:
+        type: number
+        description: Total quantity of all cart items. Otherwise, null.
+      customer:
+        "$ref": "#/definitions/customer-data-customer-interface"
+      billing_address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      reserved_order_id:
+        type: string
+        description: Reserved order ID. Otherwise, null.
+      orig_order_id:
+        type: integer
+        description: Original order ID. Otherwise, null.
+      currency:
+        "$ref": "#/definitions/quote-data-currency-interface"
+      customer_is_guest:
+        type: boolean
+        description: For guest customers, false for logged in customers
+      customer_note:
+        type: string
+        description: Notice text
+      customer_note_notify:
+        type: boolean
+        description: Customer notification flag
+      customer_tax_class_id:
+        type: integer
+        description: Customer tax class ID.
+      store_id:
+        type: integer
+        description: Store identifier
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-cart-extension-interface"
+    required:
+    - id
+    - customer
+    - store_id
+  quote-data-cart-item-interface:
+    type: object
+    description: Interface CartItemInterface
+    properties:
+      item_id:
+        type: integer
+        description: Item ID. Otherwise, null.
+      sku:
+        type: string
+        description: Product SKU. Otherwise, null.
+      qty:
+        type: number
+        description: Product quantity.
+      name:
+        type: string
+        description: Product name. Otherwise, null.
+      price:
+        type: number
+        description: Product price. Otherwise, null.
+      product_type:
+        type: string
+        description: Product type. Otherwise, null.
+      quote_id:
+        type: string
+        description: Quote id.
+      product_option:
+        "$ref": "#/definitions/quote-data-product-option-interface"
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-cart-item-extension-interface"
+    required:
+    - qty
+    - quote_id
+  quote-data-product-option-interface:
+    type: object
+    description: Product option interface
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-product-option-extension-interface"
+  quote-data-product-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface
+    properties:
+      custom_options:
+        type: array
+        items:
+          "$ref": "#/definitions/catalog-data-custom-option-interface"
+      bundle_options:
+        type: array
+        items:
+          "$ref": "#/definitions/bundle-data-bundle-option-interface"
+      downloadable_option:
+        "$ref": "#/definitions/downloadable-data-downloadable-option-interface"
+      giftcard_item_option:
+        "$ref": "#/definitions/gift-card-data-gift-card-option-interface"
+      configurable_item_options:
+        type: array
+        items:
+          "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-interface"
+      grouped_options:
+        type: array
+        items:
+          "$ref": "#/definitions/grouped-product-data-grouped-options-interface"
+  catalog-data-custom-option-interface:
+    type: object
+    description: Interface CustomOptionInterface
+    properties:
+      option_id:
+        type: string
+        description: Option id
+      option_value:
+        type: string
+        description: Option value
+      extension_attributes:
+        "$ref": "#/definitions/catalog-data-custom-option-extension-interface"
+    required:
+    - option_id
+    - option_value
+  catalog-data-custom-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface
+    properties:
+      file_info:
+        "$ref": "#/definitions/framework-data-image-content-interface"
+  framework-data-image-content-interface:
+    type: object
+    description: Image Content data interface
+    properties:
+      base64_encoded_data:
+        type: string
+        description: Media data (base64 encoded content)
+      type:
+        type: string
+        description: MIME type
+      name:
+        type: string
+        description: Image name
+    required:
+    - base64_encoded_data
+    - type
+    - name
+  bundle-data-bundle-option-interface:
+    type: object
+    description: Interface BundleOptionInterface
+    properties:
+      option_id:
+        type: integer
+        description: Bundle option id.
+      option_qty:
+        type: integer
+        description: Bundle option quantity.
+      option_selections:
+        type: array
+        description: Bundle option selection ids.
+        items:
+          type: integer
+      extension_attributes:
+        "$ref": "#/definitions/bundle-data-bundle-option-extension-interface"
+    required:
+    - option_id
+    - option_qty
+    - option_selections
+  bundle-data-bundle-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface
+  downloadable-data-downloadable-option-interface:
+    type: object
+    description: Downloadable Option
+    properties:
+      downloadable_links:
+        type: array
+        description: The list of downloadable links
+        items:
+          type: integer
+    required:
+    - downloadable_links
+  gift-card-data-gift-card-option-interface:
+    type: object
+    description: Interface GiftCardOptionInterface
+    properties:
+      giftcard_amount:
+        type: string
+        description: Gift card amount.
+      custom_giftcard_amount:
+        type: number
+        description: Gift card open amount value.
+      giftcard_sender_name:
+        type: string
+        description: Gift card sender name.
+      giftcard_recipient_name:
+        type: string
+        description: Gift card recipient name.
+      giftcard_sender_email:
+        type: string
+        description: Gift card sender email.
+      giftcard_recipient_email:
+        type: string
+        description: Gift card recipient email.
+      giftcard_message:
+        type: string
+        description: Giftcard message.
+      extension_attributes:
+        "$ref": "#/definitions/gift-card-data-gift-card-option-extension-interface"
+    required:
+    - giftcard_amount
+    - giftcard_sender_name
+    - giftcard_recipient_name
+    - giftcard_sender_email
+    - giftcard_recipient_email
+  gift-card-data-gift-card-option-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface
+    properties:
+      giftcard_created_codes:
+        type: array
+        items:
+          type: string
+  configurable-product-data-configurable-item-option-value-interface:
+    type: object
+    description: Interface ConfigurableItemOptionValueInterface
+    properties:
+      option_id:
+        type: string
+        description: Option SKU
+      option_value:
+        type: integer
+        description: Item id
+      extension_attributes:
+        "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-extension-interface"
+    required:
+    - option_id
+  configurable-product-data-configurable-item-option-value-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface
+  grouped-product-data-grouped-options-interface:
+    type: object
+    description: Represents `product item id with qty` of a grouped product.
+    properties:
+      id:
+        type: integer
+        description: Associated product id
+      qty:
+        type: integer
+        description: Associated product qty
+      extension_attributes:
+        "$ref": "#/definitions/grouped-product-data-grouped-options-extension-interface"
+  grouped-product-data-grouped-options-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface
+  quote-data-cart-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface
+    properties:
+      discounts:
+        type: array
+        items:
+          "$ref": "#/definitions/sales-rule-data-rule-discount-interface"
+      negotiable_quote_item:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-interface"
+  sales-rule-data-rule-discount-interface:
+    type: object
+    description: Rule discount Interface
+    properties:
+      discount_data:
+        "$ref": "#/definitions/sales-rule-data-discount-data-interface"
+      rule_label:
+        type: string
+        description: Rule Label
+      rule_i_d:
+        type: integer
+        description: Rule ID
+    required:
+    - discount_data
+    - rule_label
+    - rule_i_d
+  sales-rule-data-discount-data-interface:
+    type: object
+    description: Discount Data Interface
+    properties:
+      amount:
+        type: number
+        description: Amount
+      base_amount:
+        type: number
+        description: Base Amount
+      original_amount:
+        type: number
+        description: Original Amount
+      base_original_amount:
+        type: number
+        description: Base Original Amount
+    required:
+    - amount
+    - base_amount
+    - original_amount
+    - base_original_amount
+  negotiable-quote-data-negotiable-quote-item-interface:
+    type: object
+    description: Interface CompanyQuoteConfigInterface
+    properties:
+      item_id:
+        type: integer
+        description: Quote item id
+      original_price:
+        type: number
+        description: Quote item original price
+      original_tax_amount:
+        type: number
+        description: Quote item original tax amount
+      original_discount_amount:
+        type: number
+        description: Quote item original discount amount
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-extension-interface"
+    required:
+    - item_id
+    - original_price
+    - original_tax_amount
+    - original_discount_amount
+  negotiable-quote-data-negotiable-quote-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface
+    properties:
+      negotiated_price_type:
+        type: integer
+      negotiated_price_value:
+        type: number
+      last_item_notes:
+        type: array
+        items:
+          "$ref": "#/definitions/negotiable-quote-data-item-note-interface"
+      is_discounting_locked:
+        type: boolean
+      min_qty:
+        type: number
+      max_qty:
+        type: number
+  negotiable-quote-data-item-note-interface:
+    type: object
+    description: Interface ItemNoteInterface
+    properties:
+      note_id:
+        type: integer
+        description: Note ID.
+      negotiable_quote_item_id:
+        type: integer
+        description: Negotiable quote item Id
+      creator_type:
+        type: integer
+        description: The note creator type.
+      creator_id:
+        type: integer
+        description: Note creator ID.
+      note:
+        type: string
+        description: Note.
+      created_at:
+        type: string
+        description: Comment created at.
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-item-note-extension-interface"
+    required:
+    - negotiable_quote_item_id
+    - creator_type
+    - creator_id
+    - note
+  negotiable-quote-data-item-note-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\ItemNoteInterface
+  quote-data-address-interface:
+    type: object
+    description: Interface AddressInterface
+    properties:
+      id:
+        type: integer
+        description: Id
+      region:
+        type: string
+        description: Region name
+      region_id:
+        type: integer
+        description: Region id
+      region_code:
+        type: string
+        description: Region code
+      country_id:
+        type: string
+        description: Country id
+      street:
+        type: array
+        description: Street
+        items:
+          type: string
+      company:
+        type: string
+        description: Company
+      telephone:
+        type: string
+        description: Telephone number
+      fax:
+        type: string
+        description: Fax number
+      postcode:
+        type: string
+        description: Postcode
+      city:
+        type: string
+        description: City name
+      firstname:
+        type: string
+        description: First name
+      lastname:
+        type: string
+        description: Last name
+      middlename:
+        type: string
+        description: Middle name
+      prefix:
+        type: string
+        description: Prefix
+      suffix:
+        type: string
+        description: Suffix
+      vat_id:
+        type: string
+        description: Vat id
+      customer_id:
+        type: integer
+        description: Customer id
+      email:
+        type: string
+        description: Billing/shipping email
+      same_as_billing:
+        type: integer
+        description: Same as billing flag
+      customer_address_id:
+        type: integer
+        description: Customer address id
+      save_in_address_book:
+        type: integer
+        description: Save in address book flag
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-address-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - region
+    - region_id
+    - region_code
+    - country_id
+    - street
+    - telephone
+    - postcode
+    - city
+    - firstname
+    - lastname
+    - email
+  quote-data-address-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface
+    properties:
+      discounts:
+        type: array
+        items:
+          "$ref": "#/definitions/sales-rule-data-rule-discount-interface"
+      gift_registry_id:
+        type: integer
+      pickup_location_code:
+        type: string
+  quote-data-currency-interface:
+    type: object
+    description: Interface CurrencyInterface
+    properties:
+      global_currency_code:
+        type: string
+        description: Global currency code
+      base_currency_code:
+        type: string
+        description: Base currency code
+      store_currency_code:
+        type: string
+        description: Store currency code
+      quote_currency_code:
+        type: string
+        description: Quote currency code
+      store_to_base_rate:
+        type: number
+        description: Store currency to base currency rate
+      store_to_quote_rate:
+        type: number
+        description: Store currency to quote currency rate
+      base_to_global_rate:
+        type: number
+        description: Base currency to global currency rate
+      base_to_quote_rate:
+        type: number
+        description: Base currency to quote currency rate
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-currency-extension-interface"
+  quote-data-currency-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface
+  quote-data-cart-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface
+    properties:
+      shipping_assignments:
+        type: array
+        items:
+          "$ref": "#/definitions/quote-data-shipping-assignment-interface"
+      negotiable_quote:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-interface"
+      company_id:
+        type: integer
+      coupon_codes:
+        type: array
+        items:
+          type: string
+  quote-data-shipping-assignment-interface:
+    type: object
+    description: Interface ShippingAssignmentInterface
+    properties:
+      shipping:
+        "$ref": "#/definitions/quote-data-shipping-interface"
+      items:
+        type: array
+        items:
+          "$ref": "#/definitions/quote-data-cart-item-interface"
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-shipping-assignment-extension-interface"
+    required:
+    - shipping
+    - items
+  quote-data-shipping-interface:
+    type: object
+    description: Interface ShippingInterface
+    properties:
+      address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      method:
+        type: string
+        description: Shipping method
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-shipping-extension-interface"
+    required:
+    - address
+    - method
+  quote-data-shipping-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface
+  quote-data-shipping-assignment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface
+  negotiable-quote-data-negotiable-quote-interface:
+    type: object
+    description: Interface NegotiableQuoteInterface
+    properties:
+      quote_id:
+        type: integer
+        description: Negotiable quote ID.
+      is_regular_quote:
+        type: boolean
+        description: Is regular quote.
+      status:
+        type: string
+        description: Negotiable quote status.
+      negotiated_price_type:
+        type: integer
+        description: Negotiated price type.
+      negotiated_price_value:
+        type: number
+        description: Negotiated price value.
+      shipping_price:
+        type: number
+        description: Proposed shipping price.
+      quote_name:
+        type: string
+        description: Negotiable quote name.
+      expiration_period:
+        type: string
+        description: Expiration period.
+      email_notification_status:
+        type: integer
+        description: Email notification status.
+      has_unconfirmed_changes:
+        type: boolean
+        description: Has unconfirmed changes.
+      is_shipping_tax_changed:
+        type: boolean
+        description: Shipping tax changes.
+      is_customer_price_changed:
+        type: boolean
+        description: Customer price changes.
+      notifications:
+        type: integer
+        description: Quote notifications.
+      applied_rule_ids:
+        type: string
+        description: Quote rules.
+      is_address_draft:
+        type: boolean
+        description: Is address draft.
+      deleted_sku:
+        type: string
+        description: Deleted products sku.
+      creator_id:
+        type: integer
+        description: Quote creator id.
+      creator_type:
+        type: integer
+        description: Quote creator type.
+      original_total_price:
+        type: number
+        description: Quote original total price.
+      base_original_total_price:
+        type: number
+        description: Quote original total price in base currency.
+      negotiated_total_price:
+        type: number
+        description: Quote negotiated total price.
+      base_negotiated_total_price:
+        type: number
+        description: Quote negotiated total price in base currency.
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-extension-interface"
+    required:
+    - quote_id
+    - is_regular_quote
+    - status
+    - negotiated_price_type
+    - negotiated_price_value
+    - shipping_price
+    - quote_name
+    - expiration_period
+    - email_notification_status
+    - has_unconfirmed_changes
+    - is_shipping_tax_changed
+    - is_customer_price_changed
+    - notifications
+    - applied_rule_ids
+    - is_address_draft
+    - deleted_sku
+    - creator_id
+    - creator_type
+  negotiable-quote-data-negotiable-quote-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface
+  quote-data-payment-interface:
+    type: object
+    description: Interface PaymentInterface
+    properties:
+      po_number:
+        type: string
+        description: Purchase order number
+      method:
+        type: string
+        description: Payment method code
+      additional_data:
+        type: array
+        description: Payment additional details
+        items:
+          type: string
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-payment-extension-interface"
+    required:
+    - method
+  quote-data-payment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface
+    properties:
+      agreement_ids:
+        type: array
+        items:
+          type: string
+  quote-data-shipping-method-interface:
+    type: object
+    description: Interface ShippingMethodInterface
+    properties:
+      carrier_code:
+        type: string
+        description: Shipping carrier code.
+      method_code:
+        type: string
+        description: Shipping method code.
+      carrier_title:
+        type: string
+        description: Shipping carrier title. Otherwise, null.
+      method_title:
+        type: string
+        description: Shipping method title. Otherwise, null.
+      amount:
+        type: number
+        description: Shipping amount in store currency.
+      base_amount:
+        type: number
+        description: Shipping amount in base currency.
+      available:
+        type: boolean
+        description: The value of the availability flag for the current shipping method.
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-shipping-method-extension-interface"
+      error_message:
+        type: string
+        description: Shipping Error message.
+      price_excl_tax:
+        type: number
+        description: Shipping price excl tax.
+      price_incl_tax:
+        type: number
+        description: Shipping price incl tax.
+    required:
+    - carrier_code
+    - method_code
+    - amount
+    - base_amount
+    - available
+    - error_message
+    - price_excl_tax
+    - price_incl_tax
+  quote-data-shipping-method-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface
+  quote-data-payment-method-interface:
+    type: object
+    description: Interface PaymentMethodInterface
+    properties:
+      code:
+        type: string
+        description: Payment method code
+      title:
+        type: string
+        description: Payment method title
+    required:
+    - code
+    - title
+  quote-data-totals-additional-data-interface:
+    type: object
+    description: Additional data for totals collection.
+    properties:
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-totals-additional-data-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+  quote-data-totals-additional-data-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface
+    properties:
+      gift_messages:
+        type: array
+        items:
+          "$ref": "#/definitions/gift-message-data-message-interface"
+  gift-message-data-message-interface:
+    type: object
+    description: Interface MessageInterface
+    properties:
+      gift_message_id:
+        type: integer
+        description: Gift message ID. Otherwise, null.
+      customer_id:
+        type: integer
+        description: Customer ID. Otherwise, null.
+      sender:
+        type: string
+        description: Sender name.
+      recipient:
+        type: string
+        description: Recipient name.
+      message:
+        type: string
+        description: Message text.
+      extension_attributes:
+        "$ref": "#/definitions/gift-message-data-message-extension-interface"
+    required:
+    - sender
+    - recipient
+    - message
+  gift-message-data-message-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface
+    properties:
+      entity_id:
+        type: string
+      entity_type:
+        type: string
+      wrapping_id:
+        type: integer
+      wrapping_allow_gift_receipt:
+        type: boolean
+      wrapping_add_printed_card:
+        type: boolean
+  quote-data-totals-interface:
+    type: object
+    description: Interface TotalsInterface
+    properties:
+      grand_total:
+        type: number
+        description: Grand total in quote currency
+      base_grand_total:
+        type: number
+        description: Grand total in base currency
+      subtotal:
+        type: number
+        description: Subtotal in quote currency
+      base_subtotal:
+        type: number
+        description: Subtotal in base currency
+      discount_amount:
+        type: number
+        description: Discount amount in quote currency
+      base_discount_amount:
+        type: number
+        description: Discount amount in base currency
+      subtotal_with_discount:
+        type: number
+        description: Subtotal in quote currency with applied discount
+      base_subtotal_with_discount:
+        type: number
+        description: Subtotal in base currency with applied discount
+      shipping_amount:
+        type: number
+        description: Shipping amount in quote currency
+      base_shipping_amount:
+        type: number
+        description: Shipping amount in base currency
+      shipping_discount_amount:
+        type: number
+        description: Shipping discount amount in quote currency
+      base_shipping_discount_amount:
+        type: number
+        description: Shipping discount amount in base currency
+      tax_amount:
+        type: number
+        description: Tax amount in quote currency
+      base_tax_amount:
+        type: number
+        description: Tax amount in base currency
+      weee_tax_applied_amount:
+        type: number
+        description: Item weee tax applied amount in quote currency.
+      shipping_tax_amount:
+        type: number
+        description: Shipping tax amount in quote currency
+      base_shipping_tax_amount:
+        type: number
+        description: Shipping tax amount in base currency
+      subtotal_incl_tax:
+        type: number
+        description: Subtotal including tax in quote currency
+      base_subtotal_incl_tax:
+        type: number
+        description: Subtotal including tax in base currency
+      shipping_incl_tax:
+        type: number
+        description: Shipping including tax in quote currency
+      base_shipping_incl_tax:
+        type: number
+        description: Shipping including tax in base currency
+      base_currency_code:
+        type: string
+        description: Base currency code
+      quote_currency_code:
+        type: string
+        description: Quote currency code
+      coupon_code:
+        type: string
+        description: Applied coupon code
+      items_qty:
+        type: integer
+        description: Items qty
+      items:
+        type: array
+        description: Totals by items
+        items:
+          "$ref": "#/definitions/quote-data-totals-item-interface"
+      total_segments:
+        type: array
+        description: Dynamically calculated totals
+        items:
+          "$ref": "#/definitions/quote-data-total-segment-interface"
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-totals-extension-interface"
+    required:
+    - weee_tax_applied_amount
+    - total_segments
+  quote-data-totals-item-interface:
+    type: object
+    description: Interface TotalsItemInterface
+    properties:
+      item_id:
+        type: integer
+        description: Item id
+      price:
+        type: number
+        description: Item price in quote currency.
+      base_price:
+        type: number
+        description: Item price in base currency.
+      qty:
+        type: number
+        description: Item quantity.
+      row_total:
+        type: number
+        description: Row total in quote currency.
+      base_row_total:
+        type: number
+        description: Row total in base currency.
+      row_total_with_discount:
+        type: number
+        description: Row total with discount in quote currency. Otherwise, null.
+      tax_amount:
+        type: number
+        description: Tax amount in quote currency. Otherwise, null.
+      base_tax_amount:
+        type: number
+        description: Tax amount in base currency. Otherwise, null.
+      tax_percent:
+        type: number
+        description: Tax percent. Otherwise, null.
+      discount_amount:
+        type: number
+        description: Discount amount in quote currency. Otherwise, null.
+      base_discount_amount:
+        type: number
+        description: Discount amount in base currency. Otherwise, null.
+      discount_percent:
+        type: number
+        description: Discount percent. Otherwise, null.
+      price_incl_tax:
+        type: number
+        description: Price including tax in quote currency. Otherwise, null.
+      base_price_incl_tax:
+        type: number
+        description: Price including tax in base currency. Otherwise, null.
+      row_total_incl_tax:
+        type: number
+        description: Row total including tax in quote currency. Otherwise, null.
+      base_row_total_incl_tax:
+        type: number
+        description: Row total including tax in base currency. Otherwise, null.
+      options:
+        type: string
+        description: Item price in quote currency.
+      weee_tax_applied_amount:
+        type: number
+        description: Item weee tax applied amount in quote currency.
+      weee_tax_applied:
+        type: string
+        description: Item weee tax applied in quote currency.
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-totals-item-extension-interface"
+      name:
+        type: string
+        description: Product name. Otherwise, null.
+    required:
+    - item_id
+    - price
+    - base_price
+    - qty
+    - row_total
+    - base_row_total
+    - options
+    - weee_tax_applied_amount
+    - weee_tax_applied
+  quote-data-totals-item-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface
+    properties:
+      negotiable_quote_item_totals:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface"
+  negotiable-quote-data-negotiable-quote-item-totals-interface:
+    type: object
+    description: Extension attribute for quote item totals model.
+    properties:
+      cost:
+        type: number
+        description: Cost for quote item.
+      catalog_price:
+        type: number
+        description: Catalog price for quote item.
+      base_catalog_price:
+        type: number
+        description: Catalog price for quote item in base currency.
+      catalog_price_incl_tax:
+        type: number
+        description: Catalog price with included tax for quote item.
+      base_catalog_price_incl_tax:
+        type: number
+        description: Catalog price with included tax for quote item in base currency.
+      cart_price:
+        type: number
+        description: Cart price for quote item.
+      base_cart_price:
+        type: number
+        description: Cart price for quote item in base currency.
+      cart_tax:
+        type: number
+        description: Tax from catalog price for quote item.
+      base_cart_tax:
+        type: number
+        description: Tax from catalog price for quote item in base currency.
+      cart_price_incl_tax:
+        type: number
+        description: Cart price with included tax for quote item.
+      base_cart_price_incl_tax:
+        type: number
+        description: Cart price with included tax for quote item in base currency.
+      extension_attributes:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface"
+    required:
+    - cost
+    - catalog_price
+    - base_catalog_price
+    - catalog_price_incl_tax
+    - base_catalog_price_incl_tax
+    - cart_price
+    - base_cart_price
+    - cart_tax
+    - base_cart_tax
+    - cart_price_incl_tax
+    - base_cart_price_incl_tax
+  negotiable-quote-data-negotiable-quote-item-totals-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface
+  quote-data-total-segment-interface:
+    type: object
+    description: Interface TotalsInterface
+    properties:
+      code:
+        type: string
+        description: Code
+      title:
+        type: string
+        description: Total title
+      value:
+        type: number
+        description: Total value
+      area:
+        type: string
+        description: Display area code.
+      extension_attributes:
+        "$ref": "#/definitions/quote-data-total-segment-extension-interface"
+    required:
+    - code
+    - value
+  quote-data-total-segment-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface
+    properties:
+      tax_grandtotal_details:
+        type: array
+        items:
+          "$ref": "#/definitions/tax-data-grand-total-details-interface"
+      gift_cards:
+        type: string
+      gw_order_id:
+        type: string
+      gw_item_ids:
+        type: array
+        items:
+          type: string
+      gw_allow_gift_receipt:
+        type: string
+      gw_add_card:
+        type: string
+      gw_price:
+        type: string
+      gw_base_price:
+        type: string
+      gw_items_price:
+        type: string
+      gw_items_base_price:
+        type: string
+      gw_card_price:
+        type: string
+      gw_card_base_price:
+        type: string
+      gw_base_tax_amount:
+        type: string
+      gw_tax_amount:
+        type: string
+      gw_items_base_tax_amount:
+        type: string
+      gw_items_tax_amount:
+        type: string
+      gw_card_base_tax_amount:
+        type: string
+      gw_card_tax_amount:
+        type: string
+      gw_price_incl_tax:
+        type: string
+      gw_base_price_incl_tax:
+        type: string
+      gw_card_price_incl_tax:
+        type: string
+      gw_card_base_price_incl_tax:
+        type: string
+      gw_items_price_incl_tax:
+        type: string
+      gw_items_base_price_incl_tax:
+        type: string
+  tax-data-grand-total-details-interface:
+    type: object
+    description: Interface GrandTotalDetailsInterface
+    properties:
+      amount:
+        type: number
+        description: Tax amount value
+      rates:
+        type: array
+        description: Tax rates info
+        items:
+          "$ref": "#/definitions/tax-data-grand-total-rates-interface"
+      group_id:
+        type: integer
+        description: Group identifier
+    required:
+    - amount
+    - rates
+    - group_id
+  tax-data-grand-total-rates-interface:
+    type: object
+    description: Interface GrandTotalRatesInterface
+    properties:
+      percent:
+        type: string
+        description: Tax percentage value
+      title:
+        type: string
+        description: Rate title
+    required:
+    - percent
+    - title
+  quote-data-totals-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface
+    properties:
+      coupon_label:
+        type: string
+      negotiable_quote_totals:
+        "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-totals-interface"
+      base_customer_balance_amount:
+        type: number
+      customer_balance_amount:
+        type: number
+      coupon_codes:
+        type: array
+        items:
+          type: string
+      coupons_labels:
+        type: array
+        items:
+          type: string
+      reward_points_balance:
+        type: number
+      reward_currency_amount:
+        type: number
+      base_reward_currency_amount:
+        type: number
+  negotiable-quote-data-negotiable-quote-totals-interface:
+    type: object
+    description: Extension attribute for quote totals model.
+    properties:
+      items_count:
+        type: integer
+        description: The number of different items or products in the cart.
+      quote_status:
+        type: string
+        description: Negotiable quote status.
+      created_at:
+        type: string
+        description: The cart creation date and time.
+      updated_at:
+        type: string
+        description: The cart last update date and time.
+      customer_group:
+        type: integer
+        description: Customer group id.
+      base_to_quote_rate:
+        type: number
+        description: Base currency to quote currency rate.
+      cost_total:
+        type: number
+        description: Total cost for quote.
+      base_cost_total:
+        type: number
+        description: Total cost for quote in base currency.
+      original_total:
+        type: number
+        description: Original quote total.
+      base_original_total:
+        type: number
+        description: Original quote total in base currency.
+      original_tax:
+        type: number
+        description: Original tax amount for quote.
+      base_original_tax:
+        type: number
+        description: Original tax amount for quote in base currency.
+      original_price_incl_tax:
+        type: number
+        description: Original price with included tax for quote.
+      base_original_price_incl_tax:
+        type: number
+        description: Original price with included tax for quote in base currency.
+      negotiated_price_type:
+        type: integer
+        description: Negotiable quote type.
+      negotiated_price_value:
+        type: number
+        description: Negotiable price value for quote.
+    required:
+    - items_count
+    - quote_status
+    - created_at
+    - updated_at
+    - customer_group
+    - base_to_quote_rate
+    - cost_total
+    - base_cost_total
+    - original_total
+    - base_original_total
+    - original_tax
+    - base_original_tax
+    - original_price_incl_tax
+    - base_original_price_incl_tax
+    - negotiated_price_type
+    - negotiated_price_value
+  framework-search-search-result-interface:
+    type: object
+    description: Interface SearchResultInterface
+    properties:
+      items:
+        type: array
+        items:
+          "$ref": "#/definitions/framework-search-document-interface"
+      aggregations:
+        "$ref": "#/definitions/framework-search-aggregation-interface"
+      search_criteria:
+        "$ref": "#/definitions/framework-search-search-criteria-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - aggregations
+    - search_criteria
+    - total_count
+  framework-search-document-interface:
+    type: object
+    description: Interface Search Document
+    properties:
+      id:
+        type: integer
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - id
+  framework-search-aggregation-interface:
+    type: object
+    description: Interface Aggregation to get faceted data
+    properties:
+      buckets:
+        type: array
+        description: All Document fields
+        items:
+          "$ref": "#/definitions/framework-search-bucket-interface"
+      bucket_names:
+        type: array
+        description: Document field names
+        items:
+          type: string
+    required:
+    - buckets
+    - bucket_names
+  framework-search-bucket-interface:
+    type: object
+    description: Interface for facet Bucket
+    properties:
+      name:
+        type: string
+        description: Field name
+      values:
+        type: array
+        description: Field values
+        items:
+          "$ref": "#/definitions/framework-search-aggregation-value-interface"
+    required:
+    - name
+    - values
+  framework-search-aggregation-value-interface:
+    type: object
+    description: Interface Aggregation Value
+    properties:
+      value:
+        type: string
+        description: Aggregation
+      metrics:
+        type: array
+        description: Metrics
+        items:
+          type: string
+    required:
+    - value
+    - metrics
+  framework-search-search-criteria-interface:
+    type: object
+    description: Interface SearchCriteriaInterface
+    properties:
+      request_name:
+        type: string
+      filter_groups:
+        type: array
+        description: A list of filter groups.
+        items:
+          "$ref": "#/definitions/framework-search-filter-group"
+      sort_orders:
+        type: array
+        description: Sort order.
+        items:
+          "$ref": "#/definitions/framework-sort-order"
+      page_size:
+        type: integer
+        description: Page size.
+      current_page:
+        type: integer
+        description: Current page.
+    required:
+    - request_name
+    - filter_groups
+  framework-search-filter-group:
+    type: object
+    description: Groups two or more filters together using a logical OR
+    properties:
+      filters:
+        type: array
+        description: A list of filters in this group
+        items:
+          "$ref": "#/definitions/framework-filter"
+  framework-filter:
+    type: object
+    description: Filter which can be used by any methods from service layer.
+    properties:
+      field:
+        type: string
+        description: Field
+      value:
+        type: string
+        description: Value
+      condition_type:
+        type: string
+        description: Condition type
+    required:
+    - field
+    - value
+  framework-sort-order:
+    type: object
+    description: Data object for sort order.
+    properties:
+      field:
+        type: string
+        description: Sorting field.
+      direction:
+        type: string
+        description: Sorting direction.
+    required:
+    - field
+    - direction
+  checkout-data-shipping-information-interface:
+    type: object
+    description: Interface ShippingInformationInterface
+    properties:
+      shipping_address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      billing_address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      shipping_method_code:
+        type: string
+        description: Shipping method code
+      shipping_carrier_code:
+        type: string
+        description: Carrier code
+      extension_attributes:
+        "$ref": "#/definitions/checkout-data-shipping-information-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - shipping_address
+    - shipping_method_code
+    - shipping_carrier_code
+  checkout-data-shipping-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface
+  checkout-data-payment-details-interface:
+    type: object
+    description: Interface PaymentDetailsInterface
+    properties:
+      payment_methods:
+        type: array
+        items:
+          "$ref": "#/definitions/quote-data-payment-method-interface"
+      totals:
+        "$ref": "#/definitions/quote-data-totals-interface"
+      extension_attributes:
+        "$ref": "#/definitions/checkout-data-payment-details-extension-interface"
+    required:
+    - payment_methods
+    - totals
+  checkout-data-payment-details-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface
+  checkout-data-totals-information-interface:
+    type: object
+    description: Interface TotalsInformationInterface
+    properties:
+      address:
+        "$ref": "#/definitions/quote-data-address-interface"
+      shipping_method_code:
+        type: string
+        description: Shipping method code
+      shipping_carrier_code:
+        type: string
+        description: Carrier code
+      extension_attributes:
+        "$ref": "#/definitions/checkout-data-totals-information-extension-interface"
+      custom_attributes:
+        type: array
+        description: Custom attributes values.
+        items:
+          "$ref": "#/definitions/framework-attribute-interface"
+    required:
+    - address
+  checkout-data-totals-information-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface
+  two-factor-auth-provider-interface:
+    type: object
+    description: 2FA provider interface
+    properties:
+      enabled:
+        type: boolean
+        description: True if this provider has been enabled by admin
+      engine:
+        "$ref": "#/definitions/two-factor-auth-engine-interface"
+      code:
+        type: string
+        description: Provider code
+      name:
+        type: string
+        description: Provider name
+      icon:
+        type: string
+        description: Icon
+      reset_allowed:
+        type: boolean
+        description: True if this provider configuration can be reset
+      configure_action:
+        type: string
+        description: Configure action
+      auth_action:
+        type: string
+        description: Auth action
+      extra_actions:
+        type: array
+        description: Allowed extra actions
+        items:
+          type: string
+    required:
+    - enabled
+    - engine
+    - code
+    - name
+    - icon
+    - reset_allowed
+    - configure_action
+    - auth_action
+    - extra_actions
+  two-factor-auth-engine-interface:
+    type: object
+    description: 2FA engine interface
+    properties:
+      enabled:
+        type: boolean
+        description: True if this provider has been enabled by admin
+    required:
+    - enabled
+  two-factor-auth-data-google-configure-interface:
+    type: object
+    description: Google configuration data interface
+    properties:
+      qr_code_base64:
+        type: string
+        description: Value for QR code base 64
+      secret_code:
+        type: string
+        description: Value for secret code
+      extension_attributes:
+        "$ref": "#/definitions/two-factor-auth-data-google-configure-extension-interface"
+    required:
+    - qr_code_base64
+    - secret_code
+  two-factor-auth-data-google-configure-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface
+  two-factor-auth-data-authy-device-interface:
+    type: object
+    description: Authy device data interface
+    properties:
+      country:
+        type: string
+        description: The country
+      phone_number:
+        type: string
+        description: The phone number
+      method:
+        type: string
+        description: The method to authenticate with
+      extension_attributes:
+        "$ref": "#/definitions/two-factor-auth-data-authy-device-extension-interface"
+    required:
+    - country
+    - phone_number
+    - method
+  two-factor-auth-data-authy-device-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyDeviceInterface
+  two-factor-auth-data-authy-registration-prompt-response-interface:
+    type: object
+    description: Response for device registration prompt
+    properties:
+      message:
+        type: string
+        description: The message
+      expiration_seconds:
+        type: string
+        description: The seconds to expire
+      extension_attributes:
+        "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-extension-interface"
+    required:
+    - message
+    - expiration_seconds
+  two-factor-auth-data-authy-registration-prompt-response-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface
+  two-factor-auth-data-u2f-web-authn-request-interface:
+    type: object
+    description: Represents a WebAuthn dataset
+    properties:
+      credential_request_options_json:
+        type: string
+        description: The needed data to initiate a WebAuthn registration ceremony
+      extension_attributes:
+        "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-extension-interface"
+    required:
+    - credential_request_options_json
+  two-factor-auth-data-u2f-web-authn-request-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestInterface
+  gift-card-account-data-gift-card-account-interface:
+    type: object
+    description: Gift Card Account data
+    properties:
+      gift_cards:
+        type: array
+        description: Cards codes.
+        items:
+          type: string
+      gift_cards_amount:
+        type: number
+        description: Cards amount in quote currency.
+      base_gift_cards_amount:
+        type: number
+        description: Cards amount in base currency.
+      gift_cards_amount_used:
+        type: number
+        description: Cards amount used in quote currency.
+      base_gift_cards_amount_used:
+        type: number
+        description: Cards amount used in base currency.
+      extension_attributes:
+        "$ref": "#/definitions/gift-card-account-data-gift-card-account-extension-interface"
+    required:
+    - gift_cards_amount
+    - base_gift_cards_amount
+    - gift_cards_amount_used
+    - base_gift_cards_amount_used
+  gift-card-account-data-gift-card-account-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface
+  inventory-in-store-pickup-api-data-search-result-interface:
+    type: object
+    description: Search results for providing pickup locations.
+    properties:
+      items:
+        type: array
+        description: Items list.
+        items:
+          "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-interface"
+      search_request:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface"
+      total_count:
+        type: integer
+        description: Total count.
+    required:
+    - items
+    - search_request
+    - total_count
+  inventory-in-store-pickup-api-data-pickup-location-interface:
+    type: object
+    description: Represents sources projection on In-Store Pickup context. Realisation
+      must follow immutable DTO concept. Partial immutability done according to restriction
+      of current Extension Attributes implementation.
+    properties:
+      pickup_location_code:
+        type: string
+        description: Source code of Pickup Location.
+      name:
+        type: string
+        description: Pickup Location name.
+      email:
+        type: string
+        description: Pickup Location contact email.
+      fax:
+        type: string
+        description: Fax contact info.
+      contact_name:
+        type: string
+        description: Pickup Location contact name.
+      description:
+        type: string
+        description: Pickup Location description.
+      latitude:
+        type: number
+        description: Pickup Location latitude.
+      longitude:
+        type: number
+        description: Pickup Location longitude.
+      country_id:
+        type: string
+        description: Pickup Location country ID.
+      region_id:
+        type: integer
+        description: Pickup Location region ID.
+      region:
+        type: string
+        description: Pickup Location region.
+      city:
+        type: string
+        description: Pickup Location city.
+      street:
+        type: string
+        description: Pickup Location street.
+      postcode:
+        type: string
+        description: Pickup Location postcode.
+      phone:
+        type: string
+        description: Pickup Location phone.
+      extension_attributes:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-extension-interface"
+    required:
+    - pickup_location_code
+  inventory-in-store-pickup-api-data-pickup-location-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface
+  inventory-in-store-pickup-api-data-search-request-interface:
+    type: object
+    description: 'Endpoint used to search Pickup Locations by different parameters:
+      - by attribute filters fields @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\FiltersInterface
+      - by distance to the address @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\AreaInterface
+      Also, endpoint supports paging and sort orders.'
+    properties:
+      area:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-area-interface"
+      filters:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filters-interface"
+      page_size:
+        type: integer
+        description: Page size.
+      current_page:
+        type: integer
+        description: Current page.
+      scope_type:
+        type: string
+        description: Sales Channel Type.
+      scope_code:
+        type: string
+        description: Sales Channel code.
+      sort:
+        type: array
+        description: Sort Order.
+        items:
+          "$ref": "#/definitions/framework-sort-order"
+      extension_attributes:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-extension-interface"
+    required:
+    - current_page
+    - scope_type
+    - scope_code
+  inventory-in-store-pickup-api-data-search-request-area-interface:
+    type: object
+    description: 'Filter by Distance to the Address. Pickup Locations will be filtered
+      by distance according to the geo-position of the entered address. Required fields
+      for the address are country and one of the field: region or city or postcode.'
+    properties:
+      radius:
+        type: integer
+        description: Search radius in KM.
+      search_term:
+        type: string
+        description: Search term string.
+    required:
+    - radius
+    - search_term
+  inventory-in-store-pickup-api-data-search-request-filters-interface:
+    type: object
+    description: Filter to filter by Fields. Each field may be filtered with different
+      condition type. Supported condition types restricted by @see \Magento\Framework\Api\SearchCriteriaInterface
+    properties:
+      country:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      postcode:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      region:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      region_id:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      city:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      street:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      name:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+      pickup_location_code:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface"
+  inventory-in-store-pickup-api-data-search-request-filter-interface:
+    type: object
+    description: Filter for Pickup Location search.
+    properties:
+      value:
+        type: string
+        description: Value.
+      condition_type:
+        type: string
+        description: Condition Type.
+    required:
+    - value
+    - condition_type
+  inventory-in-store-pickup-api-data-search-request-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequestInterface
+    properties:
+      products_info:
+        type: array
+        items:
+          "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-interface"
+  inventory-in-store-pickup-api-data-search-request-product-info-interface:
+    type: object
+    description: Product Info Data Transfer Object.
+    properties:
+      sku:
+        type: string
+        description: Product SKU.
+      extension_attributes:
+        "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-extension-interface"
+    required:
+    - sku
+  inventory-in-store-pickup-api-data-search-request-product-info-extension-interface:
+    type: object
+    description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\ProductInfoInterface
+  payment-services-paypal-payment-config-response-interface:
+    type: object
+    description: ''
+    properties:
+      apple_pay:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface"
+      google_pay:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface"
+      hosted_fields:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface"
+      smart_buttons:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface"
+    required:
+    - apple_pay
+    - google_pay
+    - hosted_fields
+    - smart_buttons
+  payment-services-paypal-data-payment-config-apple-pay-interface:
+    type: object
+    description: ''
+    properties:
+      button_styles:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface"
+      payment_source:
+        type: string
+        description: PaymentSource
+      code:
+        type: string
+        description: Code
+      sdk_params:
+        type: array
+        description: SDK params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+      is_visible:
+        type: boolean
+        description: Visible
+      sort_order:
+        type: string
+        description: Sort Order
+      payment_intent:
+        type: string
+        description: Payment intent
+      title:
+        type: string
+        description: Title
+    required:
+    - button_styles
+    - payment_source
+    - code
+    - sdk_params
+    - is_visible
+    - sort_order
+    - payment_intent
+    - title
+  payment-services-paypal-data-payment-config-button-styles-interface:
+    type: object
+    description: ''
+    properties:
+      layout:
+        type: string
+        description: Layout
+      color:
+        type: string
+        description: Color
+      shape:
+        type: string
+        description: Shape
+      label:
+        type: string
+        description: Label
+      tagline:
+        type: boolean
+        description: ShowTagline
+      height:
+        type: integer
+        description: Height
+      use_default_height:
+        type: boolean
+        description: Height
+    required:
+    - layout
+    - color
+    - shape
+    - label
+    - tagline
+    - height
+    - use_default_height
+  payment-services-paypal-data-payment-config-sdk-params-interface:
+    type: object
+    description: ''
+    properties:
+      name:
+        type: string
+        description: Code
+      value:
+        type: string
+        description: Config
+    required:
+    - name
+    - value
+  payment-services-paypal-data-payment-config-google-pay-interface:
+    type: object
+    description: ''
+    properties:
+      button_styles:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-button-styles-interface"
+      payment_source:
+        type: string
+        description: PaymentSource
+      three_d_s:
+        type: string
+        description: ThreeDS
+      code:
+        type: string
+        description: Code
+      sdk_params:
+        type: array
+        description: SDK params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+      is_visible:
+        type: boolean
+        description: Visible
+      sort_order:
+        type: string
+        description: Sort Order
+      payment_intent:
+        type: string
+        description: Payment intent
+      title:
+        type: string
+        description: Title
+    required:
+    - button_styles
+    - payment_source
+    - three_d_s
+    - code
+    - sdk_params
+    - is_visible
+    - sort_order
+    - payment_intent
+    - title
+  payment-services-paypal-data-payment-config-google-pay-button-styles-interface:
+    type: object
+    description: ''
+    properties:
+      color:
+        type: string
+        description: Color
+      height:
+        type: integer
+        description: Height
+      type:
+        type: string
+        description: Type
+    required:
+    - color
+    - height
+    - type
+  payment-services-paypal-data-payment-config-hosted-fields-interface:
+    type: object
+    description: ''
+    properties:
+      payment_source:
+        type: string
+        description: Payment Source
+      three_d_s:
+        type: string
+        description: ThreeDS
+      is_vault_enabled:
+        type: boolean
+        description: HasIsVaultEnabled
+      cc_vault_code:
+        type: string
+        description: CcVaultCode
+      requires_card_details:
+        type: boolean
+        description: RequiresCardDetails
+      code:
+        type: string
+        description: Code
+      sdk_params:
+        type: array
+        description: SDK params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+      is_visible:
+        type: boolean
+        description: Visible
+      sort_order:
+        type: string
+        description: Sort Order
+      payment_intent:
+        type: string
+        description: Payment intent
+      title:
+        type: string
+        description: Title
+    required:
+    - payment_source
+    - three_d_s
+    - is_vault_enabled
+    - cc_vault_code
+    - requires_card_details
+    - code
+    - sdk_params
+    - is_visible
+    - sort_order
+    - payment_intent
+    - title
+  payment-services-paypal-data-payment-config-smart-buttons-interface:
+    type: object
+    description: ''
+    properties:
+      display_message:
+        type: boolean
+        description: CanDisplayMessage
+      display_venmo:
+        type: boolean
+        description: Venmo
+      message_styles:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface"
+      button_styles:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface"
+      app_switch_when_available:
+        type: boolean
+        description: AppSwitchWhenAvailable
+      code:
+        type: string
+        description: Code
+      sdk_params:
+        type: array
+        description: SDK params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+      is_visible:
+        type: boolean
+        description: Visible
+      sort_order:
+        type: string
+        description: Sort Order
+      payment_intent:
+        type: string
+        description: Payment intent
+      title:
+        type: string
+        description: Title
+    required:
+    - display_message
+    - display_venmo
+    - message_styles
+    - button_styles
+    - app_switch_when_available
+    - code
+    - sdk_params
+    - is_visible
+    - sort_order
+    - payment_intent
+    - title
+  payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface:
+    type: object
+    description: ''
+    properties:
+      layout:
+        type: string
+        description: CanDisplayMessage
+      logo:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-logo-interface"
+    required:
+    - layout
+    - logo
+  payment-services-paypal-data-payment-config-smart-buttons-logo-interface:
+    type: object
+    description: ''
+    properties:
+      type:
+        type: string
+        description: CanDisplayMessage
+    required:
+    - type
+  payment-services-paypal-data-payment-order-interface:
+    type: object
+    description: Interface PaymentOrderInterface
+    properties:
+      id:
+        type: string
+        description: Payment order id
+      mp_order_id:
+        type: string
+        description: Payment order mpOrderId
+      status:
+        type: string
+        description: Payment order status
+      amount:
+        type: number
+        description: Payment order amount
+      currency_code:
+        type: string
+        description: Payment order currency code
+    required:
+    - id
+    - mp_order_id
+    - status
+    - amount
+    - currency_code
+  payment-services-paypal-data-payment-order-details-interface:
+    type: object
+    description: Interface PaymentOrderDetailsInterface
+    properties:
+      payment_source_details:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-source-details-interface"
+      id:
+        type: string
+        description: Payment order id
+      mp_order_id:
+        type: string
+        description: Payment order mpOrderId
+      status:
+        type: string
+        description: Payment order status
+      amount:
+        type: number
+        description: Payment order amount
+      currency_code:
+        type: string
+        description: Payment order currency code
+    required:
+    - payment_source_details
+    - id
+    - mp_order_id
+    - status
+    - amount
+    - currency_code
+  payment-services-paypal-data-payment-source-details-interface:
+    type: object
+    description: ''
+    properties:
+      card:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-card-details-interface"
+    required:
+    - card
+  payment-services-paypal-data-payment-card-details-interface:
+    type: object
+    description: ''
+    properties:
+      name:
+        type: string
+        description: Name
+      last_digits:
+        type: string
+        description: Last digits
+      card_expiry_month:
+        type: string
+        description: Card expiry month
+      card_expiry_year:
+        type: string
+        description: Card expiry year
+      bin_details:
+        "$ref": "#/definitions/payment-services-paypal-data-payment-card-bin-details-interface"
+    required:
+    - name
+    - last_digits
+    - card_expiry_month
+    - card_expiry_year
+    - bin_details
+  payment-services-paypal-data-payment-card-bin-details-interface:
+    type: object
+    description: ''
+    properties:
+      bin:
+        type: string
+        description: Bin
+    required:
+    - bin
+  payment-services-paypal-data-payment-sdk-params-interface:
+    type: object
+    description: ''
+    properties:
+      code:
+        type: string
+        description: The payments sdk code
+      params:
+        type: array
+        description: The payments sdk params
+        items:
+          "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface"
+    required:
+    - code
+    - params
+  pay-pal-braintree-data-auth-data-interface:
+    type: object
+    description: Interface AuthDataInterface
+    properties:
+      client_token:
+        type: string
+        description: Client token
+      display_name:
+        type: string
+        description: Display name
+      action_success:
+        type: string
+        description: To success page
+      logged_in:
+        type: boolean
+        description: Logged in
+      store_code:
+        type: string
+        description: Current store code
+    required:
+    - display_name
+    - action_success
+    - logged_in
+    - store_code
+x-tagGroups:
+- name: applepay
+  tags:
+  - applepay/auth
+- name: carts
+  tags:
+  - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
+  - carts/guest-carts/{cartId}/giftCards
+  - carts/guest-carts/{cartId}/giftCards/{giftCardCode}
+- name: customers
+  tags:
+  - customers
+  - customers/isEmailAvailable
+  - customers/password
+  - customers/resetPassword
+  - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
+- name: directory
+  tags:
+  - directory/countries
+  - directory/countries/{countryId}
+  - directory/currency
+- name: guest carts
+  tags:
+  - guest-carts
+  - guest-carts/{cartId}
+  - guest-carts/{cartId}/billing-address
+  - guest-carts/{cartId}/collect-totals
+  - guest-carts/{cartId}/coupons
+  - guest-carts/{cartId}/coupons/{couponCode}
+  - guest-carts/{cartId}/estimate-shipping-methods
+  - guest-carts/{cartId}/gift-message
+  - guest-carts/{cartId}/gift-message/{itemId}
+  - guest-carts/{cartId}/items
+  - guest-carts/{cartId}/items/{itemId}
+  - guest-carts/{cartId}/order
+  - guest-carts/{cartId}/payment-information
+  - guest-carts/{cartId}/payment-methods
+  - guest-carts/{cartId}/payment-order
+  - guest-carts/{cartId}/payment-order/{id}
+  - guest-carts/{cartId}/selected-payment-method
+  - guest-carts/{cartId}/set-payment-information
+  - guest-carts/{cartId}/shipping-information
+  - guest-carts/{cartId}/shipping-methods
+  - guest-carts/{cartId}/totals
+  - guest-carts/{cartId}/totals-information
+- name: guest giftregistry
+  tags:
+  - guest-giftregistry/{cartId}/estimate-shipping-methods
+- name: integration
+  tags:
+  - integration/admin/token
+  - integration/customer/token
+- name: inventory
+  tags:
+  - inventory/in-store-pickup/pickup-locations/
+- name: payment order
+  tags:
+  - payment-order/completeOrder
+- name: payments config
+  tags:
+  - payments-config/apple-pay/{location}
+  - payments-config/google-pay/{location}
+  - payments-config/hosted-fields/{location}
+  - payments-config/smart-buttons/{location}
+  - payments-config/{location}
+- name: payments sdk
+  tags:
+  - payments-sdk/{location}
+  - payments-sdk/{location}/{methodCode}
+- name: paypal
+  tags:
+  - paypal/lineItems
+  - paypal/oneClick
+  - paypal/validatePhoneNumber
+- name: products render info
+  tags:
+  - products-render-info
+- name: search
+  tags:
+  - search
+- name: tfa
+  tags:
+  - tfa/provider/authy/activate
+  - tfa/provider/authy/authenticate
+  - tfa/provider/authy/authenticate-onetouch
+  - tfa/provider/authy/configure
+  - tfa/provider/authy/send-token/{via}
+  - tfa/provider/duo_security/activate
+  - tfa/provider/duo_security/authenticate
+  - tfa/provider/duo_security/configure
+  - tfa/provider/google/activate
+  - tfa/provider/google/authenticate
+  - tfa/provider/google/configure
+  - tfa/provider/u2fkey/activate
+  - tfa/provider/u2fkey/authentication-challenge
+  - tfa/provider/u2fkey/configure
+  - tfa/provider/u2fkey/verify
+  - tfa/tfat-providers-to-activate
+  - tfa/tfat-user-providers

From d3a93810e1f93d9e0465f5fcaab3ea065acc9964 Mon Sep 17 00:00:00 2001
From: Dima Shevtsov 
Date: Mon, 11 May 2026 20:51:20 -0500
Subject: [PATCH 3/3] fix: Update version to 2.4.9 in default config and index
 files for GraphQL reference

---
 spectaql/config.yml           |    2 +-
 static/graphql-api/index.html | 3578 ++++++++++++++++-----------------
 2 files changed, 1785 insertions(+), 1795 deletions(-)

diff --git a/spectaql/config.yml b/spectaql/config.yml
index ee951f20f..6c0195729 100644
--- a/spectaql/config.yml
+++ b/spectaql/config.yml
@@ -422,7 +422,7 @@ info:
   ##############################################
 
   description: The Adobe Commerce GraphQL API allows you to quickly and efficiently transfer information between your Commerce store and your storefront. The schema documented here is autogenerated from an instance of Adobe Commerce with B2B. You can find examples of each query and mutation in the main GraphQL documentation.
-  version: 2.4.8
+  version: 2.4.9
   title: Adobe Commerce GraphQL API
   # This is non-standard and optional. If omitted, will use "title". Also, only relevant
   # when building non-embedded.
diff --git a/static/graphql-api/index.html b/static/graphql-api/index.html
index 2fcbe2579..fd1f636b8 100644
--- a/static/graphql-api/index.html
+++ b/static/graphql-api/index.html
@@ -1136,7 +1136,7 @@ 
    Headers
    
                 
                 
    
                   
    Version
    
-                  
    2.4.8
    
+                  
    2.4.9
    
                 
    
               
             
@@ -1627,242 +1627,242 @@ 
    Response
    
         "allow_gift_wrapping_on_order": "abc123",
         "allow_gift_wrapping_on_order_items": "abc123",
         "allow_guests_to_write_product_reviews": "abc123",
-        "allow_items": "abc123",
-        "allow_order": "abc123",
+        "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": "xyz789",
+        "base_media_url": "abc123",
         "base_static_url": "abc123",
-        "base_url": "abc123",
+        "base_url": "xyz789",
         "braintree_3dsecure_allowspecific": true,
         "braintree_3dsecure_always_request_3ds": true,
         "braintree_3dsecure_specificcountry": "xyz789",
         "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_vault_active": true,
+        "braintree_applepay_merchant_name": "xyz789",
+        "braintree_applepay_vault_active": false,
         "braintree_cc_vault_active": "xyz789",
         "braintree_cc_vault_cvv": false,
         "braintree_environment": "abc123",
         "braintree_googlepay_btn_color": "xyz789",
         "braintree_googlepay_cctypes": "xyz789",
-        "braintree_googlepay_merchant_id": "abc123",
-        "braintree_googlepay_vault_active": true,
-        "braintree_local_payment_allowed_methods": "abc123",
+        "braintree_googlepay_merchant_id": "xyz789",
+        "braintree_googlepay_vault_active": false,
+        "braintree_local_payment_allowed_methods": "xyz789",
         "braintree_local_payment_fallback_button_text": "abc123",
         "braintree_local_payment_redirect_on_fail": "abc123",
-        "braintree_merchant_account_id": "xyz789",
-        "braintree_paypal_button_location_cart_type_credit_color": "xyz789",
-        "braintree_paypal_button_location_cart_type_credit_label": "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": "xyz789",
         "braintree_paypal_button_location_cart_type_credit_show": true,
         "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789",
-        "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789",
-        "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
+        "braintree_paypal_button_location_cart_type_messaging_logo": "abc123",
+        "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789",
         "braintree_paypal_button_location_cart_type_messaging_show": false,
         "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789",
-        "braintree_paypal_button_location_cart_type_paylater_color": "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_color": "abc123",
+        "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
+        "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
         "braintree_paypal_button_location_cart_type_paylater_show": false,
         "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
-        "braintree_paypal_button_location_cart_type_paypal_label": "abc123",
-        "braintree_paypal_button_location_cart_type_paypal_shape": "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": 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": "xyz789",
         "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
         "braintree_paypal_button_location_checkout_type_credit_show": false,
         "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
-        "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
+        "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
         "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123",
         "braintree_paypal_button_location_checkout_type_messaging_show": false,
         "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789",
-        "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
+        "braintree_paypal_button_location_checkout_type_paylater_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_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_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_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_messaging_logo_position": "abc123",
-        "braintree_paypal_button_location_productpage_type_messaging_show": false,
+        "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123",
+        "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
+        "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
+        "braintree_paypal_button_location_productpage_type_messaging_show": true,
         "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
         "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
         "braintree_paypal_button_location_productpage_type_paylater_label": "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": "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": "xyz789",
-        "braintree_paypal_display_on_shopping_cart": true,
-        "braintree_paypal_merchant_country": "abc123",
-        "braintree_paypal_merchant_name_override": "xyz789",
+        "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_vault_active": true,
-        "cart_expires_in_days": 987,
+        "braintree_paypal_vault_active": false,
+        "cart_expires_in_days": 123,
         "cart_gift_wrapping": "xyz789",
-        "cart_merge_preference": "xyz789",
-        "cart_printed_card": "xyz789",
+        "cart_merge_preference": "abc123",
+        "cart_printed_card": "abc123",
         "cart_summary_display_quantity": 123,
         "catalog_default_sort_by": "abc123",
         "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-        "category_url_suffix": "abc123",
+        "category_url_suffix": "xyz789",
         "check_money_order_enable_for_specific_countries": false,
-        "check_money_order_enabled": true,
+        "check_money_order_enabled": false,
         "check_money_order_make_check_payable_to": "abc123",
         "check_money_order_max_order_total": "xyz789",
         "check_money_order_min_order_total": "abc123",
         "check_money_order_new_order_status": "abc123",
         "check_money_order_payment_from_specific_countries": "abc123",
         "check_money_order_send_check_to": "abc123",
-        "check_money_order_sort_order": 987,
-        "check_money_order_title": "abc123",
+        "check_money_order_sort_order": 123,
+        "check_money_order_title": "xyz789",
         "cms_home_page": "abc123",
-        "cms_no_cookies": "abc123",
+        "cms_no_cookies": "xyz789",
         "cms_no_route": "xyz789",
-        "code": "xyz789",
+        "code": "abc123",
         "configurable_product_image": "ITSELF",
-        "configurable_thumbnail_source": "xyz789",
+        "configurable_thumbnail_source": "abc123",
         "contact_enabled": false,
         "copyright": "abc123",
         "countries_with_required_region": "abc123",
-        "create_account_confirmation": true,
+        "create_account_confirmation": false,
         "customer_access_token_lifetime": 123.45,
         "default_country": "abc123",
-        "default_description": "abc123",
-        "default_display_currency_code": "abc123",
-        "default_keywords": "abc123",
+        "default_description": "xyz789",
+        "default_display_currency_code": "xyz789",
+        "default_keywords": "xyz789",
         "default_title": "abc123",
         "demonotice": 123,
-        "display_product_prices_in_catalog": 987,
+        "display_product_prices_in_catalog": 123,
         "display_shipping_prices": 987,
-        "display_state_if_optional": true,
-        "enable_multiple_wishlists": "abc123",
+        "display_state_if_optional": false,
+        "enable_multiple_wishlists": "xyz789",
         "fixed_product_taxes_apply_tax_to_fpt": false,
         "fixed_product_taxes_display_prices_in_emails": 123,
         "fixed_product_taxes_display_prices_in_product_lists": 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": false,
-        "front": "abc123",
+        "fixed_product_taxes_include_fpt_in_subtotal": true,
+        "front": "xyz789",
         "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": "abc123",
-        "head_shortcut_icon": "xyz789",
+        "head_shortcut_icon": "abc123",
         "header_logo_src": "xyz789",
-        "id": 987,
+        "id": 123,
         "is_checkout_agreements_enabled": false,
-        "is_default_store": false,
+        "is_default_store": true,
         "is_default_store_group": false,
-        "is_guest_checkout_enabled": false,
+        "is_guest_checkout_enabled": true,
         "is_negotiable_quote_active": true,
-        "is_one_page_checkout_enabled": true,
+        "is_one_page_checkout_enabled": false,
         "is_requisition_list_active": "abc123",
         "list_mode": "xyz789",
         "list_per_page": 123,
-        "list_per_page_values": "xyz789",
+        "list_per_page_values": "abc123",
         "locale": "abc123",
-        "logo_alt": "xyz789",
-        "logo_height": 987,
-        "logo_width": 987,
-        "magento_reward_general_is_enabled": "xyz789",
+        "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_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_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": "xyz789",
-        "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": "xyz789",
-        "minicart_display": false,
-        "minicart_max_items": 987,
+        "minicart_display": true,
+        "minicart_max_items": 123,
         "minimum_password_length": "abc123",
-        "newsletter_enabled": false,
-        "no_route": "abc123",
-        "optional_zip_countries": "xyz789",
-        "order_cancellation_enabled": true,
+        "newsletter_enabled": true,
+        "no_route": "xyz789",
+        "optional_zip_countries": "abc123",
+        "order_cancellation_enabled": false,
         "order_cancellation_reasons": [
           CancellationReason
         ],
-        "orders_invoices_credit_memos_display_full_summary": false,
+        "orders_invoices_credit_memos_display_full_summary": true,
         "orders_invoices_credit_memos_display_grandtotal": false,
-        "orders_invoices_credit_memos_display_price": 123,
-        "orders_invoices_credit_memos_display_shipping_amount": 987,
-        "orders_invoices_credit_memos_display_subtotal": 987,
+        "orders_invoices_credit_memos_display_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,
         "payment_payflowpro_cc_vault_active": "abc123",
-        "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": "abc123",
+        "product_reviews_enabled": "xyz789",
         "product_url_suffix": "xyz789",
         "quickorder_active": false,
-        "required_character_classes_number": "abc123",
+        "required_character_classes_number": "xyz789",
         "returns_enabled": "xyz789",
-        "root_category_id": 123,
+        "root_category_id": 987,
         "root_category_uid": "4",
         "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
         "sales_gift_wrapping": "xyz789",
         "sales_printed_card": "abc123",
-        "secure_base_link_url": "abc123",
+        "secure_base_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,
-        "share_active_segments": false,
+        "share_active_segments": true,
         "share_applied_cart_rule": true,
         "shopping_cart_display_full_summary": true,
-        "shopping_cart_display_grand_total": true,
+        "shopping_cart_display_grand_total": false,
         "shopping_cart_display_price": 123,
-        "shopping_cart_display_shipping": 987,
+        "shopping_cart_display_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": 987,
+        "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_prefix": "xyz789",
         "title_separator": "abc123",
         "title_suffix": "abc123",
-        "use_store_in_url": true,
-        "website_code": "4",
-        "website_id": 123,
-        "website_name": "xyz789",
-        "weight_unit": "xyz789",
+        "use_store_in_url": false,
+        "website_code": 4,
+        "website_id": 987,
+        "website_name": "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_payment_action": "xyz789",
-        "zero_subtotal_payment_from_specific_countries": "abc123",
+        "zero_subtotal_enable_for_specific_countries": false,
+        "zero_subtotal_enabled": true,
+        "zero_subtotal_new_order_status": "xyz789",
+        "zero_subtotal_payment_action": "abc123",
+        "zero_subtotal_payment_from_specific_countries": "xyz789",
         "zero_subtotal_sort_order": 987,
         "zero_subtotal_title": "abc123"
       }
@@ -2001,11 +2001,11 @@ 
    Response
    
         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,
@@ -2014,7 +2014,7 @@ 
    Response
    
       "rules": [CartRuleStorefront],
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
-      "total_quantity": 987.65
+      "total_quantity": 123.45
     }
   }
 }
@@ -2243,43 +2243,43 @@ 
    Response
    
                   
    {
   "data": {
     "category": {
-      "automatic_sorting": "xyz789",
-      "available_sort_by": ["abc123"],
+      "automatic_sorting": "abc123",
+      "available_sort_by": ["xyz789"],
       "breadcrumbs": [Breadcrumb],
       "canonical_url": "abc123",
       "children": [CategoryTree],
-      "children_count": "xyz789",
+      "children_count": "abc123",
       "cms_block": CmsBlock,
       "created_at": "xyz789",
       "custom_layout_update_file": "xyz789",
-      "default_sort_by": "abc123",
-      "description": "abc123",
+      "default_sort_by": "xyz789",
+      "description": "xyz789",
       "display_mode": "xyz789",
-      "filter_price_range": 123.45,
+      "filter_price_range": 987.65,
       "id": 987,
       "image": "abc123",
       "include_in_menu": 987,
       "is_anchor": 987,
       "landing_page": 123,
-      "level": 123,
+      "level": 987,
       "meta_description": "xyz789",
       "meta_keywords": "xyz789",
       "meta_title": "xyz789",
-      "name": "abc123",
+      "name": "xyz789",
       "path": "xyz789",
       "path_in_store": "abc123",
       "position": 987,
       "product_count": 987,
       "products": CategoryProducts,
       "redirect_code": 987,
-      "relative_url": "abc123",
+      "relative_url": "xyz789",
       "staged": false,
       "type": "CMS_PAGE",
       "uid": 4,
       "updated_at": "abc123",
-      "url_key": "abc123",
-      "url_path": "abc123",
-      "url_suffix": "xyz789"
+      "url_key": "xyz789",
+      "url_path": "xyz789",
+      "url_suffix": "abc123"
     }
   }
 }
@@ -2429,41 +2429,41 @@ 
    Response
    
     "categoryList": [
       {
         "automatic_sorting": "abc123",
-        "available_sort_by": ["xyz789"],
+        "available_sort_by": ["abc123"],
         "breadcrumbs": [Breadcrumb],
         "canonical_url": "abc123",
         "children": [CategoryTree],
-        "children_count": "abc123",
+        "children_count": "xyz789",
         "cms_block": CmsBlock,
         "created_at": "xyz789",
         "custom_layout_update_file": "xyz789",
-        "default_sort_by": "abc123",
+        "default_sort_by": "xyz789",
         "description": "abc123",
-        "display_mode": "xyz789",
+        "display_mode": "abc123",
         "filter_price_range": 987.65,
         "id": 123,
         "image": "xyz789",
         "include_in_menu": 123,
-        "is_anchor": 123,
-        "landing_page": 987,
-        "level": 987,
-        "meta_description": "xyz789",
-        "meta_keywords": "xyz789",
-        "meta_title": "abc123",
-        "name": "xyz789",
-        "path": "abc123",
+        "is_anchor": 987,
+        "landing_page": 123,
+        "level": 123,
+        "meta_description": "abc123",
+        "meta_keywords": "abc123",
+        "meta_title": "xyz789",
+        "name": "abc123",
+        "path": "xyz789",
         "path_in_store": "xyz789",
         "position": 123,
         "product_count": 123,
         "products": CategoryProducts,
         "redirect_code": 987,
-        "relative_url": "abc123",
-        "staged": false,
+        "relative_url": "xyz789",
+        "staged": true,
         "type": "CMS_PAGE",
-        "uid": 4,
-        "updated_at": "xyz789",
-        "url_key": "xyz789",
-        "url_path": "xyz789",
+        "uid": "4",
+        "updated_at": "abc123",
+        "url_key": "abc123",
+        "url_path": "abc123",
         "url_suffix": "xyz789"
       }
     ]
@@ -2521,13 +2521,13 @@ 
    Response
    
   "data": {
     "checkoutAgreements": [
       {
-        "agreement_id": 987,
-        "checkbox_text": "abc123",
-        "content": "abc123",
+        "agreement_id": 123,
+        "checkbox_text": "xyz789",
+        "content": "xyz789",
         "content_height": "xyz789",
-        "is_html": true,
+        "is_html": false,
         "mode": "AUTO",
-        "name": "abc123"
+        "name": "xyz789"
       }
     ]
   }
@@ -2595,7 +2595,7 @@ 
    Query
    
                 
                 
    
                   
    Variables
    
-                  
    {"identifiers": ["xyz789"]}
+                  
    {"identifiers": ["abc123"]}
 
    
                 
    
                 
    
@@ -2685,7 +2685,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"id": 987, "identifier": "xyz789"}
+                  
    {"id": 123, "identifier": "abc123"}
 
    
                 
    
                 
    
@@ -2694,14 +2694,14 @@ 
    Response
    
   "data": {
     "cmsPage": {
       "content": "xyz789",
-      "content_heading": "xyz789",
+      "content_heading": "abc123",
       "identifier": "xyz789",
-      "meta_description": "xyz789",
-      "meta_keywords": "xyz789",
+      "meta_description": "abc123",
+      "meta_keywords": "abc123",
       "meta_title": "xyz789",
       "page_layout": "xyz789",
       "redirect_code": 987,
-      "relative_url": "xyz789",
+      "relative_url": "abc123",
       "title": "xyz789",
       "type": "CMS_PAGE",
       "url_key": "abc123"
@@ -2802,7 +2802,7 @@ 
    Response
    
       "email": "abc123",
       "id": "4",
       "legal_address": CompanyLegalAddress,
-      "legal_name": "abc123",
+      "legal_name": "xyz789",
       "name": "abc123",
       "payment_methods": ["abc123"],
       "reseller_id": "xyz789",
@@ -2813,7 +2813,7 @@ 
    Response
    
       "team": CompanyTeam,
       "user": Customer,
       "users": CompanyUsers,
-      "vat_tax_id": "abc123"
+      "vat_tax_id": "xyz789"
     }
   }
 }
@@ -2885,7 +2885,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"uid": 4}
+                  
    {"uid": "4"}
 
    
                 
    
                 
    
@@ -2954,11 +2954,11 @@ 
    Response
    
     "countries": [
       {
         "available_regions": [Region],
-        "full_name_english": "abc123",
-        "full_name_locale": "xyz789",
+        "full_name_english": "xyz789",
+        "full_name_locale": "abc123",
         "id": "abc123",
         "three_letter_abbreviation": "xyz789",
-        "two_letter_abbreviation": "abc123"
+        "two_letter_abbreviation": "xyz789"
       }
     ]
   }
@@ -3041,11 +3041,11 @@ 
    Response
    
   "data": {
     "country": {
       "available_regions": [Region],
-      "full_name_english": "abc123",
-      "full_name_locale": "abc123",
+      "full_name_english": "xyz789",
+      "full_name_locale": "xyz789",
       "id": "abc123",
       "three_letter_abbreviation": "xyz789",
-      "two_letter_abbreviation": "abc123"
+      "two_letter_abbreviation": "xyz789"
     }
   }
 }
@@ -3106,11 +3106,11 @@ 
    Response
    
       "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": "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": "abc123",
       "exchange_rates": [ExchangeRate]
     }
@@ -3423,7 +3423,7 @@ 
    Response
    
     "customer": {
       "addresses": [CustomerAddress],
       "addressesV2": CustomerAddresses,
-      "allow_remote_shopping_assistance": false,
+      "allow_remote_shopping_assistance": true,
       "companies": UserCompaniesOutput,
       "compare_list": CompareList,
       "confirmation_status": "ACCOUNT_CONFIRMED",
@@ -3431,22 +3431,22 @@ 
    Response
    
       "custom_attributes": [AttributeValueInterface],
       "date_of_birth": "abc123",
       "default_billing": "abc123",
-      "default_shipping": "xyz789",
+      "default_shipping": "abc123",
       "dob": "xyz789",
-      "email": "xyz789",
+      "email": "abc123",
       "firstname": "xyz789",
-      "gender": 987,
+      "gender": 123,
       "gift_registries": [GiftRegistry],
       "gift_registry": GiftRegistry,
       "group": CustomerGroupStorefront,
-      "group_id": 123,
-      "id": 4,
-      "is_subscribed": false,
-      "job_title": "abc123",
+      "group_id": 987,
+      "id": "4",
+      "is_subscribed": true,
+      "job_title": "xyz789",
       "lastname": "abc123",
       "middlename": "abc123",
       "orders": CustomerOrders,
-      "prefix": "abc123",
+      "prefix": "xyz789",
       "purchase_order": PurchaseOrder,
       "purchase_order_approval_rule": PurchaseOrderApprovalRule,
       "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
@@ -3462,11 +3462,11 @@ 
    Response
    
       "segments": [CustomerSegmentStorefront],
       "status": "ACTIVE",
       "store_credit": CustomerStoreCredit,
-      "structure_id": "4",
+      "structure_id": 4,
       "suffix": "abc123",
-      "taxvat": "xyz789",
+      "taxvat": "abc123",
       "team": CompanyTeam,
-      "telephone": "abc123",
+      "telephone": "xyz789",
       "wishlist": Wishlist,
       "wishlist_v2": Wishlist,
       "wishlists": [Wishlist]
@@ -3583,18 +3583,18 @@ 
    Response
    
       "billing_address": BillingCartAddress,
       "email": "abc123",
       "gift_message": GiftMessage,
-      "gift_receipt_included": false,
+      "gift_receipt_included": true,
       "gift_wrapping": GiftWrapping,
-      "id": 4,
-      "is_virtual": false,
+      "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": 987.65
+      "total_quantity": 123.45
     }
   }
 }
@@ -3746,7 +3746,7 @@ 
    Response
    
       "date_of_first_order": "xyz789",
       "items": [CustomerOrder],
       "page_info": SearchResultPageInfo,
-      "total_count": 123
+      "total_count": 987
     }
   }
 }
@@ -3860,12 +3860,16 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"cartId": "xyz789"}
+                  
    {"cartId": "abc123"}
 
    
                 
    
                 
    
                   
    Response
    
-                  
    {"data": {"customerSegments": [{"uid": 4}]}}
+                  
    {
+  "data": {
+    "customerSegments": [{"uid": "4"}]
+  }
+}
 
    
                 
    
               
@@ -3967,7 +3971,7 @@ 
    Response
    
     "dynamicBlocks": {
       "items": [DynamicBlock],
       "page_info": SearchResultPageInfo,
-      "total_count": 987
+      "total_count": 123
     }
   }
 }
@@ -4293,8 +4297,8 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "cartId": "abc123",
-  "id": "xyz789"
+  "cartId": "xyz789",
+  "id": "abc123"
 }
 
    
                 
    
@@ -4306,7 +4310,7 @@ 
    Response
    
       "id": "abc123",
       "mp_order_id": "abc123",
       "payment_source_details": PaymentSourceDetails,
-      "status": "xyz789"
+      "status": "abc123"
     }
   }
 }
@@ -4508,8 +4512,8 @@ 
    Response
    
   "data": {
     "giftCardAccount": {
       "balance": Money,
-      "code": "xyz789",
-      "expiration_date": "xyz789"
+      "code": "abc123",
+      "expiration_date": "abc123"
     }
   }
 }
@@ -4595,7 +4599,7 @@ 
    Query
    
                 
                 
    
                   
    Variables
    
-                  
    {"giftRegistryUid": "4"}
+                  
    {"giftRegistryUid": 4}
 
    
                 
    
                 
    
@@ -4607,16 +4611,16 @@ 
    Response
    
       "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"
     }
   }
 }
@@ -4696,7 +4700,7 @@ 
    Response
    
     "giftRegistryEmailSearch": [
       {
         "event_date": "xyz789",
-        "event_title": "abc123",
+        "event_title": "xyz789",
         "gift_registry_uid": 4,
         "location": "xyz789",
         "name": "abc123",
@@ -4771,7 +4775,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"giftRegistryUid": 4}
+                  
    {"giftRegistryUid": "4"}
 
    
                 
    
                 
    
@@ -4782,8 +4786,8 @@ 
    Response
    
       {
         "event_date": "abc123",
         "event_title": "abc123",
-        "gift_registry_uid": "4",
-        "location": "xyz789",
+        "gift_registry_uid": 4,
+        "location": "abc123",
         "name": "abc123",
         "type": "xyz789"
       }
@@ -4890,11 +4894,11 @@ 
    Response
    
     "giftRegistryTypeSearch": [
       {
         "event_date": "xyz789",
-        "event_title": "xyz789",
-        "gift_registry_uid": 4,
+        "event_title": "abc123",
+        "gift_registry_uid": "4",
         "location": "abc123",
-        "name": "abc123",
-        "type": "abc123"
+        "name": "xyz789",
+        "type": "xyz789"
       }
     ]
   }
@@ -4953,7 +4957,7 @@ 
    Response
    
           GiftRegistryDynamicAttributeMetadataInterface
         ],
         "label": "xyz789",
-        "uid": 4
+        "uid": "4"
       }
     ]
   }
@@ -5098,7 +5102,7 @@ 
    Response
    
       "billing_address": OrderAddress,
       "carrier": "abc123",
       "comments": [SalesCommentItem],
-      "created_at": "abc123",
+      "created_at": "xyz789",
       "credit_memos": [CreditMemo],
       "customer_info": OrderCustomerInfo,
       "email": "xyz789",
@@ -5112,18 +5116,18 @@ 
    Response
    
       "is_virtual": true,
       "items": [OrderItemInterface],
       "items_eligible_for_return": [OrderItemInterface],
-      "number": "abc123",
+      "number": "xyz789",
       "order_date": "xyz789",
       "order_number": "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": "abc123",
-      "status": "abc123",
-      "token": "xyz789",
+      "shipping_method": "xyz789",
+      "status": "xyz789",
+      "token": "abc123",
       "total": OrderTotal
     }
   }
@@ -5266,33 +5270,33 @@ 
    Response
    
       "applied_gift_cards": [ApplyGiftCardToOrder],
       "available_actions": ["REORDER"],
       "billing_address": OrderAddress,
-      "carrier": "abc123",
+      "carrier": "xyz789",
       "comments": [SalesCommentItem],
-      "created_at": "xyz789",
+      "created_at": "abc123",
       "credit_memos": [CreditMemo],
       "customer_info": OrderCustomerInfo,
-      "email": "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],
       "is_virtual": false,
       "items": [OrderItemInterface],
       "items_eligible_for_return": [OrderItemInterface],
       "number": "xyz789",
-      "order_date": "xyz789",
+      "order_date": "abc123",
       "order_number": "xyz789",
       "order_status_change_date": "xyz789",
       "payment_methods": [OrderPaymentMethod],
-      "printed_card_included": false,
+      "printed_card_included": true,
       "returns": Returns,
       "shipments": [OrderShipment],
       "shipping_address": OrderAddress,
-      "shipping_method": "abc123",
-      "status": "xyz789",
+      "shipping_method": "xyz789",
+      "status": "abc123",
       "token": "abc123",
       "total": OrderTotal
     }
@@ -5365,7 +5369,7 @@ 
    Variables
    
                 
    
                 
    
                   
    Response
    
-                  
    {"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}}
+                  
    {"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}}
 
    
                 
    
               
@@ -5501,7 +5505,7 @@ 
    Variables
    
                 
                 
    
                   
    Response
    
-                  
    {"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}}
+                  
    {"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}}
 
    
                 
    
               
@@ -5733,7 +5737,7 @@ 
    Query
    
                 
                 
    
                   
    Variables
    
-                  
    {"uid": "4"}
+                  
    {"uid": 4}
 
    
                 
    
                 
    
@@ -5748,7 +5752,7 @@ 
    Response
    
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
       "created_at": "abc123",
-      "email": "xyz789",
+      "email": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
       "is_virtual": true,
       "items": [CartItemInterface],
@@ -5759,9 +5763,9 @@ 
    Response
    
         NegotiableQuoteShippingAddress
       ],
       "status": "SUBMITTED",
-      "total_quantity": 123.45,
+      "total_quantity": 987.65,
       "uid": "4",
-      "updated_at": "abc123"
+      "updated_at": "xyz789"
     }
   }
 }
@@ -5859,7 +5863,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"templateId": "4"}
+                  
    {"templateId": 4}
 
    
                 
    
                 
    
@@ -5869,14 +5873,14 @@ 
    Response
    
     "negotiableQuoteTemplate": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "abc123",
+      "expiration_date": "xyz789",
       "history": [NegotiableQuoteHistoryEntry],
-      "is_min_max_qty_used": true,
+      "is_min_max_qty_used": false,
       "is_virtual": false,
       "items": [CartItemInterface],
-      "max_order_commitment": 987,
-      "min_order_commitment": 123,
-      "name": "abc123",
+      "max_order_commitment": 123,
+      "min_order_commitment": 987,
+      "name": "xyz789",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
@@ -5885,9 +5889,9 @@ 
    Response
    
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "xyz789",
+      "status": "abc123",
       "template_id": "4",
-      "total_quantity": 987.65
+      "total_quantity": 123.45
     }
   }
 }
@@ -6005,7 +6009,7 @@ 
    Response
    
       "items": [NegotiableQuoteTemplateGridItem],
       "page_info": SearchResultPageInfo,
       "sort_fields": SortFields,
-      "total_count": 987
+      "total_count": 123
     }
   }
 }
@@ -6123,7 +6127,7 @@ 
    Response
    
       "items": [NegotiableQuote],
       "page_info": SearchResultPageInfo,
       "sort_fields": SortFields,
-      "total_count": 123
+      "total_count": 987
     }
   }
 }
@@ -6255,7 +6259,7 @@ 
    Response
    
     "pickupLocations": {
       "items": [PickupLocation],
       "page_info": SearchResultPageInfo,
-      "total_count": 987
+      "total_count": 123
     }
   }
 }
@@ -6426,7 +6430,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "search": "abc123",
+  "search": "xyz789",
   "filter": ProductAttributeFilterInput,
   "pageSize": 20,
   "currentPage": 1,
@@ -6445,7 +6449,7 @@ 
    Response
    
       "page_info": SearchResultPageInfo,
       "sort_fields": SortFields,
       "suggestions": [SearchSuggestion],
-      "total_count": 123
+      "total_count": 987
     }
   }
 }
@@ -6572,13 +6576,13 @@ 
    Response
    
   "data": {
     "recaptchaV3Config": {
       "badge_position": "abc123",
-      "failure_message": "abc123",
+      "failure_message": "xyz789",
       "forms": ["PLACE_ORDER"],
       "is_enabled": false,
-      "language_code": "abc123",
-      "minimum_score": 123.45,
+      "language_code": "xyz789",
+      "minimum_score": 987.65,
       "theme": "xyz789",
-      "website_key": "xyz789"
+      "website_key": "abc123"
     }
   }
 }
@@ -6645,7 +6649,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"url": "abc123"}
+                  
    {"url": "xyz789"}
 
    
                 
    
                 
    
@@ -6653,8 +6657,8 @@ 
    Response
    
                   
    {
   "data": {
     "route": {
-      "redirect_code": 987,
-      "relative_url": "xyz789",
+      "redirect_code": 123,
+      "relative_url": "abc123",
       "type": "CMS_PAGE"
     }
   }
@@ -6952,103 +6956,103 @@ 
    Response
    
     "storeConfig": {
       "absolute_footer": "xyz789",
       "allow_gift_receipt": "xyz789",
-      "allow_gift_wrapping_on_order": "abc123",
-      "allow_gift_wrapping_on_order_items": "xyz789",
+      "allow_gift_wrapping_on_order": "xyz789",
+      "allow_gift_wrapping_on_order_items": "abc123",
       "allow_guests_to_write_product_reviews": "xyz789",
       "allow_items": "xyz789",
-      "allow_order": "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_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_verify_3dsecure": false,
-      "braintree_ach_direct_debit_vault_active": false,
-      "braintree_applepay_merchant_name": "abc123",
-      "braintree_applepay_vault_active": true,
-      "braintree_cc_vault_active": "abc123",
+      "braintree_ach_direct_debit_vault_active": true,
+      "braintree_applepay_merchant_name": "xyz789",
+      "braintree_applepay_vault_active": false,
+      "braintree_cc_vault_active": "xyz789",
       "braintree_cc_vault_cvv": false,
-      "braintree_environment": "xyz789",
+      "braintree_environment": "abc123",
       "braintree_googlepay_btn_color": "xyz789",
       "braintree_googlepay_cctypes": "abc123",
       "braintree_googlepay_merchant_id": "abc123",
-      "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": "abc123",
       "braintree_local_payment_redirect_on_fail": "abc123",
       "braintree_merchant_account_id": "abc123",
-      "braintree_paypal_button_location_cart_type_credit_color": "xyz789",
+      "braintree_paypal_button_location_cart_type_credit_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": "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": "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_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_shape": "abc123",
       "braintree_paypal_button_location_cart_type_paylater_show": false,
       "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
       "braintree_paypal_button_location_cart_type_paypal_label": "abc123",
-      "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
-      "braintree_paypal_button_location_cart_type_paypal_show": true,
+      "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789",
+      "braintree_paypal_button_location_cart_type_paypal_show": false,
       "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
-      "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
+      "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
       "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
-      "braintree_paypal_button_location_checkout_type_credit_show": false,
+      "braintree_paypal_button_location_checkout_type_credit_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": "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_messaging_text_color": "xyz789",
+      "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
       "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
       "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
       "braintree_paypal_button_location_checkout_type_paylater_show": true,
-      "braintree_paypal_button_location_checkout_type_paypal_color": "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_color": "xyz789",
+      "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
+      "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
       "braintree_paypal_button_location_checkout_type_paypal_show": true,
-      "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
-      "braintree_paypal_button_location_productpage_type_credit_label": "abc123",
-      "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789",
+      "braintree_paypal_button_location_productpage_type_credit_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_layout": "abc123",
       "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
-      "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123",
-      "braintree_paypal_button_location_productpage_type_messaging_show": true,
-      "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
+      "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
+      "braintree_paypal_button_location_productpage_type_messaging_show": false,
+      "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789",
       "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789",
-      "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": 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_paylater_show": true,
+      "braintree_paypal_button_location_productpage_type_paypal_color": "abc123",
+      "braintree_paypal_button_location_productpage_type_paypal_label": "abc123",
       "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789",
       "braintree_paypal_button_location_productpage_type_paypal_show": false,
-      "braintree_paypal_credit_uk_merchant_name": "abc123",
-      "braintree_paypal_display_on_shopping_cart": 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_merchant_name_override": "xyz789",
       "braintree_paypal_require_billing_address": false,
-      "braintree_paypal_send_cart_line_items": false,
-      "braintree_paypal_vault_active": false,
+      "braintree_paypal_send_cart_line_items": true,
+      "braintree_paypal_vault_active": true,
       "cart_expires_in_days": 123,
-      "cart_gift_wrapping": "xyz789",
+      "cart_gift_wrapping": "abc123",
       "cart_merge_preference": "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",
+      "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",
@@ -7056,64 +7060,64 @@ 
    Response
    
       "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": 987,
-      "check_money_order_title": "abc123",
+      "check_money_order_send_check_to": "abc123",
+      "check_money_order_sort_order": 123,
+      "check_money_order_title": "xyz789",
       "cms_home_page": "xyz789",
       "cms_no_cookies": "abc123",
       "cms_no_route": "abc123",
       "code": "xyz789",
       "configurable_product_image": "ITSELF",
       "configurable_thumbnail_source": "xyz789",
-      "contact_enabled": true,
-      "copyright": "abc123",
+      "contact_enabled": false,
+      "copyright": "xyz789",
       "countries_with_required_region": "xyz789",
-      "create_account_confirmation": true,
-      "customer_access_token_lifetime": 987.65,
+      "create_account_confirmation": false,
+      "customer_access_token_lifetime": 123.45,
       "default_country": "abc123",
       "default_description": "xyz789",
-      "default_display_currency_code": "xyz789",
-      "default_keywords": "abc123",
-      "default_title": "abc123",
-      "demonotice": 123,
+      "default_display_currency_code": "abc123",
+      "default_keywords": "xyz789",
+      "default_title": "xyz789",
+      "demonotice": 987,
       "display_product_prices_in_catalog": 123,
       "display_shipping_prices": 123,
       "display_state_if_optional": false,
-      "enable_multiple_wishlists": "xyz789",
+      "enable_multiple_wishlists": "abc123",
       "fixed_product_taxes_apply_tax_to_fpt": true,
-      "fixed_product_taxes_display_prices_in_emails": 123,
-      "fixed_product_taxes_display_prices_in_product_lists": 123,
-      "fixed_product_taxes_display_prices_in_sales_modules": 987,
+      "fixed_product_taxes_display_prices_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": false,
-      "fixed_product_taxes_include_fpt_in_subtotal": true,
-      "front": "abc123",
-      "graphql_share_customer_group": true,
-      "grid_per_page": 123,
-      "grid_per_page_values": "abc123",
+      "fixed_product_taxes_include_fpt_in_subtotal": false,
+      "front": "xyz789",
+      "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": "abc123",
+      "head_shortcut_icon": "abc123",
+      "header_logo_src": "xyz789",
       "id": 987,
-      "is_checkout_agreements_enabled": true,
-      "is_default_store": false,
-      "is_default_store_group": false,
+      "is_checkout_agreements_enabled": false,
+      "is_default_store": true,
+      "is_default_store_group": true,
       "is_guest_checkout_enabled": true,
       "is_negotiable_quote_active": true,
       "is_one_page_checkout_enabled": false,
       "is_requisition_list_active": "abc123",
-      "list_mode": "abc123",
-      "list_per_page": 123,
+      "list_mode": "xyz789",
+      "list_per_page": 987,
       "list_per_page_values": "xyz789",
       "locale": "xyz789",
       "logo_alt": "xyz789",
-      "logo_height": 123,
+      "logo_height": 987,
       "logo_width": 123,
       "magento_reward_general_is_enabled": "xyz789",
       "magento_reward_general_is_enabled_on_front": "xyz789",
-      "magento_reward_general_min_points_balance": "xyz789",
-      "magento_reward_general_publish_history": "xyz789",
+      "magento_reward_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": "abc123",
@@ -7121,76 +7125,76 @@ 
    Response
    
       "magento_reward_points_newsletter": "abc123",
       "magento_reward_points_order": "xyz789",
       "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": "abc123",
-      "max_items_in_order_summary": 123,
+      "max_items_in_order_summary": 987,
       "maximum_number_of_wishlists": "xyz789",
-      "minicart_display": false,
-      "minicart_max_items": 123,
+      "minicart_display": true,
+      "minicart_max_items": 987,
       "minimum_password_length": "abc123",
-      "newsletter_enabled": false,
+      "newsletter_enabled": true,
       "no_route": "abc123",
       "optional_zip_countries": "abc123",
-      "order_cancellation_enabled": true,
+      "order_cancellation_enabled": false,
       "order_cancellation_reasons": [CancellationReason],
-      "orders_invoices_credit_memos_display_full_summary": false,
+      "orders_invoices_credit_memos_display_full_summary": true,
       "orders_invoices_credit_memos_display_grandtotal": true,
-      "orders_invoices_credit_memos_display_price": 123,
+      "orders_invoices_credit_memos_display_price": 987,
       "orders_invoices_credit_memos_display_shipping_amount": 123,
-      "orders_invoices_credit_memos_display_subtotal": 987,
-      "orders_invoices_credit_memos_display_zero_tax": false,
+      "orders_invoices_credit_memos_display_subtotal": 123,
+      "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": "abc123",
-      "quickorder_active": false,
-      "required_character_classes_number": "xyz789",
+      "product_reviews_enabled": "abc123",
+      "product_url_suffix": "xyz789",
+      "quickorder_active": true,
+      "required_character_classes_number": "abc123",
       "returns_enabled": "xyz789",
-      "root_category_id": 123,
+      "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",
-      "secure_base_link_url": "xyz789",
+      "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_active_segments": false,
-      "share_applied_cart_rule": true,
-      "shopping_cart_display_full_summary": true,
+      "share_active_segments": true,
+      "share_applied_cart_rule": false,
+      "shopping_cart_display_full_summary": false,
       "shopping_cart_display_grand_total": true,
       "shopping_cart_display_price": 987,
-      "shopping_cart_display_shipping": 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": true,
       "show_cms_breadcrumbs": 987,
       "store_code": 4,
-      "store_group_code": 4,
-      "store_group_name": "xyz789",
+      "store_group_code": "4",
+      "store_group_name": "abc123",
       "store_name": "xyz789",
-      "store_sort_order": 987,
-      "timezone": "xyz789",
+      "store_sort_order": 123,
+      "timezone": "abc123",
       "title_prefix": "abc123",
       "title_separator": "xyz789",
-      "title_suffix": "xyz789",
+      "title_suffix": "abc123",
       "use_store_in_url": false,
       "website_code": "4",
-      "website_id": 123,
-      "website_name": "xyz789",
+      "website_id": 987,
+      "website_name": "abc123",
       "weight_unit": "abc123",
-      "welcome": "abc123",
-      "zero_subtotal_enable_for_specific_countries": true,
+      "welcome": "xyz789",
+      "zero_subtotal_enable_for_specific_countries": false,
       "zero_subtotal_enabled": false,
-      "zero_subtotal_new_order_status": "abc123",
+      "zero_subtotal_new_order_status": "xyz789",
       "zero_subtotal_payment_action": "xyz789",
-      "zero_subtotal_payment_from_specific_countries": "abc123",
+      "zero_subtotal_payment_from_specific_countries": "xyz789",
       "zero_subtotal_sort_order": 987,
-      "zero_subtotal_title": "abc123"
+      "zero_subtotal_title": "xyz789"
     }
   }
 }
@@ -7267,7 +7271,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"url": "abc123"}
+                  
    {"url": "xyz789"}
 
    
                 
    
                 
    
@@ -7277,7 +7281,7 @@ 
    Response
    
     "urlResolver": {
       "canonical_url": "abc123",
       "entity_uid": 4,
-      "id": 987,
+      "id": 123,
       "redirectCode": 123,
       "relative_url": "xyz789",
       "type": "CMS_PAGE"
@@ -7345,7 +7349,7 @@ 
    Response
    
       "items": [WishlistItem],
       "items_count": 123,
       "name": "xyz789",
-      "sharing_code": "abc123",
+      "sharing_code": "xyz789",
       "updated_at": "abc123"
     }
   }
@@ -7415,7 +7419,7 @@ 
    Variables
    
                 
    
                 
    
                   
    Response
    
-                  
    {"data": {"acceptCompanyInvitation": {"success": false}}}
+                  
    {"data": {"acceptCompanyInvitation": {"success": true}}}
 
    
                 
    
               
    
@@ -7521,12 +7525,12 @@ 
    Response
    
       "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": 987,
-      "min_order_commitment": 987,
-      "name": "xyz789",
+      "max_order_commitment": 123,
+      "min_order_commitment": 123,
+      "name": "abc123",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
@@ -7535,9 +7539,9 @@ 
    Response
    
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "xyz789",
-      "template_id": 4,
-      "total_quantity": 987.65
+      "status": "abc123",
+      "template_id": "4",
+      "total_quantity": 123.45
     }
   }
 }
@@ -7832,7 +7836,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "giftRegistryUid": "4",
+  "giftRegistryUid": 4,
   "registrants": [AddGiftRegistryRegistrantInput]
 }
 
    
@@ -7925,7 +7929,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "cartId": "xyz789",
+  "cartId": "abc123",
   "cartItems": [CartItemInput]
 }
 
    
@@ -8017,7 +8021,7 @@ 
    Response
    
   "data": {
     "addProductsToCompareList": {
       "attributes": [ComparableAttribute],
-      "item_count": 123,
+      "item_count": 987,
       "items": [ComparableItem],
       "uid": "4"
     }
@@ -8270,10 +8274,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {
-  "wishlistId": "4",
-  "wishlistItems": [WishlistItemInput]
-}
+                  
    {"wishlistId": 4, "wishlistItems": [WishlistItemInput]}
 
    
                 
    
                 
    
@@ -8533,7 +8534,7 @@ 
    Response
    
         AddRequisitionListItemToCartUserError
       ],
       "cart": Cart,
-      "status": false
+      "status": true
     }
   }
 }
@@ -8902,7 +8903,10 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"wishlistId": 4, "wishlistItemIds": [4]}
+                  
    {
+  "wishlistId": "4",
+  "wishlistItemIds": ["4"]
+}
 
    
                 
    
                 
    
@@ -9536,7 +9540,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
 
    
                 
    
                 
    
@@ -9556,14 +9560,14 @@ 
    Response
    
       "billing_address": BillingCartAddress,
       "email": "xyz789",
       "gift_message": GiftMessage,
-      "gift_receipt_included": false,
+      "gift_receipt_included": true,
       "gift_wrapping": GiftWrapping,
       "id": "4",
       "is_virtual": true,
       "items": [CartItemInterface],
       "itemsV2": CartItems,
       "prices": CartPrices,
-      "printed_card_included": true,
+      "printed_card_included": false,
       "rules": [CartRuleStorefront],
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
@@ -9674,14 +9678,14 @@ 
    Response
    
     "cancelNegotiableQuoteTemplate": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "abc123",
+      "expiration_date": "xyz789",
       "history": [NegotiableQuoteHistoryEntry],
       "is_min_max_qty_used": true,
       "is_virtual": true,
       "items": [CartItemInterface],
       "max_order_commitment": 987,
-      "min_order_commitment": 987,
-      "name": "abc123",
+      "min_order_commitment": 123,
+      "name": "xyz789",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
@@ -9692,7 +9696,7 @@ 
    Response
    
       ],
       "status": "xyz789",
       "template_id": 4,
-      "total_quantity": 987.65
+      "total_quantity": 123.45
     }
   }
 }
@@ -10032,8 +10036,8 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "currentPassword": "abc123",
-  "newPassword": "abc123"
+  "currentPassword": "xyz789",
+  "newPassword": "xyz789"
 }
 
    
                 
    
@@ -10050,30 +10054,30 @@ 
    Response
    
       "confirmation_status": "ACCOUNT_CONFIRMED",
       "created_at": "xyz789",
       "custom_attributes": [AttributeValueInterface],
-      "date_of_birth": "abc123",
-      "default_billing": "xyz789",
-      "default_shipping": "xyz789",
+      "date_of_birth": "xyz789",
+      "default_billing": "abc123",
+      "default_shipping": "abc123",
       "dob": "abc123",
-      "email": "xyz789",
-      "firstname": "xyz789",
-      "gender": 123,
+      "email": "abc123",
+      "firstname": "abc123",
+      "gender": 987,
       "gift_registries": [GiftRegistry],
       "gift_registry": GiftRegistry,
       "group": CustomerGroupStorefront,
-      "group_id": 987,
+      "group_id": 123,
       "id": "4",
-      "is_subscribed": true,
-      "job_title": "abc123",
+      "is_subscribed": false,
+      "job_title": "xyz789",
       "lastname": "abc123",
-      "middlename": "xyz789",
+      "middlename": "abc123",
       "orders": CustomerOrders,
-      "prefix": "abc123",
+      "prefix": "xyz789",
       "purchase_order": PurchaseOrder,
       "purchase_order_approval_rule": PurchaseOrderApprovalRule,
       "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
       "purchase_order_approval_rules": PurchaseOrderApprovalRules,
       "purchase_orders": PurchaseOrders,
-      "purchase_orders_enabled": true,
+      "purchase_orders_enabled": false,
       "requisition_lists": RequisitionLists,
       "return": Return,
       "returns": Returns,
@@ -10087,7 +10091,7 @@ 
    Response
    
       "suffix": "xyz789",
       "taxvat": "abc123",
       "team": CompanyTeam,
-      "telephone": "xyz789",
+      "telephone": "abc123",
       "wishlist": Wishlist,
       "wishlist_v2": Wishlist,
       "wishlists": [Wishlist]
@@ -10237,14 +10241,14 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"cartUid": "abc123"}
+                  
    {"cartUid": "xyz789"}
 
    
                 
    
                 
    
                   
    Response
    
                   
    {
   "data": {
-    "clearCustomerCart": {"cart": Cart, "status": true}
+    "clearCustomerCart": {"cart": Cart, "status": false}
   }
 }
 
    
@@ -10883,8 +10887,8 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "sourceRequisitionListUid": "4",
-  "destinationRequisitionListUid": "4",
+  "sourceRequisitionListUid": 4,
+  "destinationRequisitionListUid": 4,
   "requisitionListItem": CopyItemsBetweenRequisitionListsInput
 }
 
    
@@ -11047,7 +11051,7 @@ 
    Query
    
                   
    Response
    
                   
    {
   "data": {
-    "createBraintreeClientToken": "abc123"
+    "createBraintreeClientToken": "xyz789"
   }
 }
 
    
@@ -11092,7 +11096,7 @@ 
    Query
    
                   
    Response
    
                   
    {
   "data": {
-    "createBraintreePayPalClientToken": "abc123"
+    "createBraintreePayPalClientToken": "xyz789"
   }
 }
 
    
@@ -11525,7 +11529,7 @@ 
    Response
    
       "attributes": [ComparableAttribute],
       "item_count": 123,
       "items": [ComparableItem],
-      "uid": 4
+      "uid": "4"
     }
   }
 }
@@ -11701,27 +11705,27 @@ 
    Response
    
       "city": "xyz789",
       "company": "xyz789",
       "country_code": "AF",
-      "country_id": "abc123",
+      "country_id": "xyz789",
       "custom_attributes": [CustomerAddressAttribute],
       "custom_attributesV2": [AttributeValueInterface],
       "customer_id": 987,
       "default_billing": true,
-      "default_shipping": true,
+      "default_shipping": false,
       "extension_attributes": [CustomerAddressAttribute],
-      "fax": "xyz789",
-      "firstname": "abc123",
+      "fax": "abc123",
+      "firstname": "xyz789",
       "id": 987,
       "lastname": "abc123",
-      "middlename": "xyz789",
-      "postcode": "xyz789",
-      "prefix": "abc123",
+      "middlename": "abc123",
+      "postcode": "abc123",
+      "prefix": "xyz789",
       "region": CustomerAddressRegion,
       "region_id": 987,
       "street": ["xyz789"],
-      "suffix": "xyz789",
+      "suffix": "abc123",
       "telephone": "xyz789",
-      "uid": 4,
-      "vat_id": "xyz789"
+      "uid": "4",
+      "vat_id": "abc123"
     }
   }
 }
@@ -11865,7 +11869,7 @@ 
    Variables
    
                 
    
                 
    
                   
    Response
    
-                  
    {"data": {"createEmptyCart": "xyz789"}}
+                  
    {"data": {"createEmptyCart": "abc123"}}
 
    
                 
    
               
    
@@ -12083,7 +12087,7 @@ 
    Response
    
   "data": {
     "createPayflowProToken": {
       "response_message": "abc123",
-      "result": 987,
+      "result": 123,
       "result_code": 987,
       "secure_token": "abc123",
       "secure_token_id": "xyz789"
@@ -12166,8 +12170,8 @@ 
    Response
    
       "amount": 123.45,
       "currency_code": "xyz789",
       "id": "xyz789",
-      "mp_order_id": "xyz789",
-      "status": "abc123"
+      "mp_order_id": "abc123",
+      "status": "xyz789"
     }
   }
 }
@@ -12411,11 +12415,11 @@ 
    Response
    
       "condition": PurchaseOrderApprovalRuleConditionInterface,
       "created_at": "abc123",
       "created_by": "xyz789",
-      "description": "abc123",
+      "description": "xyz789",
       "name": "abc123",
       "status": "ENABLED",
       "uid": "4",
-      "updated_at": "xyz789"
+      "updated_at": "abc123"
     }
   }
 }
@@ -12568,7 +12572,7 @@ 
    Response
    
   "data": {
     "createVaultCardPaymentToken": {
       "payment_source": PaymentSourceOutput,
-      "vault_token_id": "abc123"
+      "vault_token_id": "xyz789"
     }
   }
 }
@@ -12776,12 +12780,12 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"id": 4}
+                  
    {"id": "4"}
 
    
                 
    
                 
    
                   
    Response
    
-                  
    {"data": {"deleteCompanyRole": {"success": true}}}
+                  
    {"data": {"deleteCompanyRole": {"success": false}}}
 
    
                 
    
               
@@ -12844,7 +12848,7 @@ 
    Query
    
                 
                 
    
                   
    Variables
    
-                  
    {"id": 4}
+                  
    {"id": "4"}
 
    
                 
    
                 
    
@@ -12924,7 +12928,7 @@ 
    Variables
    
                 
    
                 
    
                   
    Response
    
-                  
    {"data": {"deleteCompanyUser": {"success": false}}}
+                  
    {"data": {"deleteCompanyUser": {"success": true}}}
 
    
                 
    
               
@@ -12987,12 +12991,12 @@ 
    Query
    
                 
                 
    
                   
    Variables
    
-                  
    {"id": "4"}
+                  
    {"id": 4}
 
    
                 
    
                 
    
                   
    Response
    
-                  
    {"data": {"deleteCompanyUserV2": {"success": true}}}
+                  
    {"data": {"deleteCompanyUserV2": {"success": false}}}
 
    
                 
    
               
@@ -13054,7 +13058,7 @@ 
    Query
    
                 
                 
    
                   
    Variables
    
-                  
    {"uid": "4"}
+                  
    {"uid": 4}
 
    
                 
    
                 
    
@@ -13167,7 +13171,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"id": 123}
+                  
    {"id": 987}
 
    
                 
    
                 
    
@@ -13232,7 +13236,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"uid": "4"}
+                  
    {"uid": 4}
 
    
                 
    
                 
    
@@ -13302,7 +13306,7 @@ 
    Variables
    
                 
    
                 
    
                   
    Response
    
-                  
    {"data": {"deleteNegotiableQuoteTemplate": true}}
+                  
    {"data": {"deleteNegotiableQuoteTemplate": false}}
 
    
                 
    
               
@@ -13455,7 +13459,7 @@ 
    Query
    
                 
                 
    
                   
    Variables
    
-                  
    {"public_hash": "abc123"}
+                  
    {"public_hash": "xyz789"}
 
    
                 
    
                 
    
@@ -13696,10 +13700,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {
-  "requisitionListUid": "4",
-  "requisitionListItemUids": ["4"]
-}
+                  
    {"requisitionListUid": 4, "requisitionListItemUids": [4]}
 
    
                 
    
                 
    
@@ -13775,7 +13776,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"wishlistId": 4}
+                  
    {"wishlistId": "4"}
 
    
                 
    
                 
    
@@ -13949,13 +13950,13 @@ 
    Response
    
     "estimateShippingMethods": [
       {
         "amount": Money,
-        "available": false,
+        "available": true,
         "base_amount": Money,
         "carrier_code": "xyz789",
         "carrier_title": "xyz789",
-        "error_message": "xyz789",
-        "method_code": "abc123",
-        "method_title": "xyz789",
+        "error_message": "abc123",
+        "method_code": "xyz789",
+        "method_title": "abc123",
         "price_excl_tax": Money,
         "price_incl_tax": Money
       }
@@ -14104,7 +14105,7 @@ 
    Response
    
   "data": {
     "exchangeExternalCustomerToken": {
       "customer": Customer,
-      "token": "xyz789"
+      "token": "abc123"
     }
   }
 }
@@ -14182,7 +14183,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "email": "abc123",
+  "email": "xyz789",
   "password": "xyz789"
 }
 
    
@@ -14265,7 +14266,7 @@ 
    Response
    
                   
    {
   "data": {
     "generateCustomerTokenAsAdmin": {
-      "customer_token": "xyz789"
+      "customer_token": "abc123"
     }
   }
 }
@@ -14538,7 +14539,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "source_cart_id": "xyz789",
+  "source_cart_id": "abc123",
   "destination_cart_id": "abc123"
 }
 
    
@@ -14558,12 +14559,12 @@ 
    Response
    
         AvailablePaymentMethod
       ],
       "billing_address": BillingCartAddress,
-      "email": "xyz789",
+      "email": "abc123",
       "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,
@@ -14654,7 +14655,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"cartUid": 4, "giftRegistryUid": 4}
+                  
    {"cartUid": 4, "giftRegistryUid": "4"}
 
    
                 
    
                 
    
@@ -14936,7 +14937,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "sourceWishlistUid": 4,
+  "sourceWishlistUid": "4",
   "destinationWishlistUid": "4",
   "wishlistItems": [WishlistItemMoveInput]
 }
@@ -15056,10 +15057,10 @@ 
    Response
    
     "openNegotiableQuoteTemplate": {
       "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,
@@ -15073,8 +15074,8 @@ 
    Response
    
         NegotiableQuoteShippingAddress
       ],
       "status": "abc123",
-      "template_id": 4,
-      "total_quantity": 123.45
+      "template_id": "4",
+      "total_quantity": 987.65
     }
   }
 }
@@ -15455,7 +15456,7 @@ 
    Response
    
     "redeemGiftCardBalanceAsStoreCredit": {
       "balance": Money,
       "code": "abc123",
-      "expiration_date": "xyz789"
+      "expiration_date": "abc123"
     }
   }
 }
@@ -15888,7 +15889,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"giftRegistryUid": 4, "itemsUid": [4]}
+                  
    {"giftRegistryUid": 4, "itemsUid": ["4"]}
 
    
                 
    
                 
    
@@ -16237,14 +16238,14 @@ 
    Response
    
     "removeNegotiableQuoteTemplateItems": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "abc123",
+      "expiration_date": "xyz789",
       "history": [NegotiableQuoteHistoryEntry],
       "is_min_max_qty_used": false,
-      "is_virtual": 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": [
@@ -16253,9 +16254,9 @@ 
    Response
    
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "xyz789",
+      "status": "abc123",
       "template_id": 4,
-      "total_quantity": 123.45
+      "total_quantity": 987.65
     }
   }
 }
@@ -16336,9 +16337,9 @@ 
    Response
    
   "data": {
     "removeProductsFromCompareList": {
       "attributes": [ComparableAttribute],
-      "item_count": 123,
+      "item_count": 987,
       "items": [ComparableItem],
-      "uid": 4
+      "uid": "4"
     }
   }
 }
@@ -16420,7 +16421,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"wishlistId": 4, "wishlistItemsIds": ["4"]}
+                  
    {"wishlistId": "4", "wishlistItemsIds": [4]}
 
    
                 
    
                 
    
@@ -16781,7 +16782,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"orderNumber": "abc123"}
+                  
    {"orderNumber": "xyz789"}
 
    
                 
    
                 
    
@@ -16870,7 +16871,7 @@ 
    Response
    
                   
    {
   "data": {
     "requestGuestOrderCancel": {
-      "error": "abc123",
+      "error": "xyz789",
       "errorV2": CancelOrderError,
       "order": CustomerOrder
     }
@@ -17123,14 +17124,14 @@ 
    Response
    
     "requestNegotiableQuoteTemplateFromQuote": {
       "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,
+      "max_order_commitment": 123,
       "min_order_commitment": 987,
-      "name": "xyz789",
+      "name": "abc123",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
@@ -17140,7 +17141,7 @@ 
    Response
    
         NegotiableQuoteShippingAddress
       ],
       "status": "xyz789",
-      "template_id": 4,
+      "template_id": "4",
       "total_quantity": 987.65
     }
   }
@@ -17204,12 +17205,12 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"email": "abc123"}
+                  
    {"email": "xyz789"}
 
    
                 
    
                 
    
                   
    Response
    
-                  
    {"data": {"requestPasswordResetEmail": false}}
+                  
    {"data": {"requestPasswordResetEmail": true}}
 
    
                 
    
               
    
@@ -17353,7 +17354,7 @@ 
    Variables
    
                 
    
                 
    
                   
    Response
    
-                  
    {"data": {"resendConfirmationEmail": true}}
+                  
    {"data": {"resendConfirmationEmail": false}}
 
    
                 
    
               
    
@@ -17436,13 +17437,13 @@ 
    Variables
    
                   
    {
   "email": "xyz789",
   "resetPasswordToken": "xyz789",
-  "newPassword": "abc123"
+  "newPassword": "xyz789"
 }
 
    
                 
                 
    
                   
    Response
    
-                  
    {"data": {"resetPassword": true}}
+                  
    {"data": {"resetPassword": false}}
 
    
                 
    
               
@@ -17780,7 +17781,7 @@ 
    Response
    
   "data": {
     "setCartAsInactive": {
       "error": "xyz789",
-      "success": false
+      "success": true
     }
   }
 }
@@ -18394,14 +18395,14 @@ 
    Response
    
     "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": 987,
-      "name": "xyz789",
+      "max_order_commitment": 123,
+      "min_order_commitment": 123,
+      "name": "abc123",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
@@ -18410,7 +18411,7 @@ 
    Response
    
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "xyz789",
+      "status": "abc123",
       "template_id": 4,
       "total_quantity": 987.65
     }
@@ -18679,14 +18680,14 @@ 
    Response
    
     "setQuoteTemplateLineItemNote": {
       "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": 987,
+      "max_order_commitment": 123,
       "min_order_commitment": 987,
-      "name": "xyz789",
+      "name": "abc123",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
@@ -18695,8 +18696,8 @@ 
    Response
    
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "xyz789",
-      "template_id": 4,
+      "status": "abc123",
+      "template_id": "4",
       "total_quantity": 987.65
     }
   }
@@ -19033,13 +19034,13 @@ 
    Response
    
     "submitNegotiableQuoteTemplateForReview": {
       "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": 123,
-      "min_order_commitment": 123,
+      "min_order_commitment": 987,
       "name": "xyz789",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
@@ -19049,8 +19050,8 @@ 
    Response
    
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "xyz789",
-      "template_id": "4",
+      "status": "abc123",
+      "template_id": 4,
       "total_quantity": 987.65
     }
   }
@@ -19116,7 +19117,7 @@ 
    Query
    
                 
                 
    
                   
    Variables
    
-                  
    {"email": "abc123"}
+                  
    {"email": "xyz789"}
 
    
                 
    
                 
    
@@ -19186,7 +19187,7 @@ 
    Variables
    
                 
    
                 
    
                   
    Response
    
-                  
    {"data": {"syncPaymentOrder": true}}
+                  
    {"data": {"syncPaymentOrder": false}}
 
    
                 
    
               
@@ -19803,23 +19804,23 @@ 
    Response
    
                   
    {
   "data": {
     "updateCustomerAddress": {
-      "city": "xyz789",
-      "company": "abc123",
+      "city": "abc123",
+      "company": "xyz789",
       "country_code": "AF",
       "country_id": "xyz789",
       "custom_attributes": [CustomerAddressAttribute],
       "custom_attributesV2": [AttributeValueInterface],
-      "customer_id": 123,
+      "customer_id": 987,
       "default_billing": false,
-      "default_shipping": false,
+      "default_shipping": true,
       "extension_attributes": [CustomerAddressAttribute],
       "fax": "abc123",
       "firstname": "xyz789",
-      "id": 987,
+      "id": 123,
       "lastname": "xyz789",
       "middlename": "abc123",
-      "postcode": "abc123",
-      "prefix": "xyz789",
+      "postcode": "xyz789",
+      "prefix": "abc123",
       "region": CustomerAddressRegion,
       "region_id": 123,
       "street": ["abc123"],
@@ -19942,7 +19943,7 @@ 
    Response
    
                   
    {
   "data": {
     "updateCustomerAddressV2": {
-      "city": "xyz789",
+      "city": "abc123",
       "company": "abc123",
       "country_code": "AF",
       "country_id": "abc123",
@@ -19950,22 +19951,22 @@ 
    Response
    
       "custom_attributesV2": [AttributeValueInterface],
       "customer_id": 987,
       "default_billing": false,
-      "default_shipping": false,
+      "default_shipping": true,
       "extension_attributes": [CustomerAddressAttribute],
       "fax": "abc123",
-      "firstname": "abc123",
+      "firstname": "xyz789",
       "id": 123,
-      "lastname": "abc123",
-      "middlename": "xyz789",
+      "lastname": "xyz789",
+      "middlename": "abc123",
       "postcode": "xyz789",
       "prefix": "xyz789",
       "region": CustomerAddressRegion,
-      "region_id": 123,
+      "region_id": 987,
       "street": ["abc123"],
-      "suffix": "abc123",
+      "suffix": "xyz789",
       "telephone": "xyz789",
       "uid": "4",
-      "vat_id": "abc123"
+      "vat_id": "xyz789"
     }
   }
 }
@@ -20046,7 +20047,7 @@ 
    Query
    
                   
    Variables
    
                   
    {
   "email": "abc123",
-  "password": "abc123"
+  "password": "xyz789"
 }
 
    
                 
@@ -20198,7 +20199,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "giftRegistryUid": 4,
+  "giftRegistryUid": "4",
   "giftRegistry": UpdateGiftRegistryInput
 }
 
    
@@ -20286,7 +20287,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "giftRegistryUid": "4",
+  "giftRegistryUid": 4,
   "items": [UpdateGiftRegistryItemInput]
 }
 
    
@@ -20376,7 +20377,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "giftRegistryUid": "4",
+  "giftRegistryUid": 4,
   "registrants": [UpdateGiftRegistryRegistrantInput]
 }
 
    
@@ -20723,11 +20724,11 @@ 
    Response
    
       "approver_roles": [CompanyRole],
       "condition": PurchaseOrderApprovalRuleConditionInterface,
       "created_at": "xyz789",
-      "created_by": "abc123",
+      "created_by": "xyz789",
       "description": "xyz789",
-      "name": "abc123",
+      "name": "xyz789",
       "status": "ENABLED",
-      "uid": "4",
+      "uid": 4,
       "updated_at": "xyz789"
     }
   }
@@ -21000,7 +21001,7 @@ 
    Query
    
                   
    Variables
    
                   
    {
   "wishlistId": 4,
-  "name": "abc123",
+  "name": "xyz789",
   "visibility": "PUBLIC"
 }
 
    
@@ -21010,8 +21011,8 @@ 
    Response
    
                   
    {
   "data": {
     "updateWishlist": {
-      "name": "xyz789",
-      "uid": 4,
+      "name": "abc123",
+      "uid": "4",
       "visibility": "PUBLIC"
     }
   }
@@ -21182,7 +21183,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "cart_items": [BundleProductCartItemInput]
 }
 
    
@@ -21358,7 +21359,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "cart_items": [DownloadableProductCartItemInput]
 }
 
    
@@ -21465,7 +21466,7 @@ 
    Example
    
   ],
   "email": "abc123",
   "firstname": "abc123",
-  "lastname": "xyz789"
+  "lastname": "abc123"
 }
 
    
                 
    
@@ -21785,8 +21786,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "comment": "xyz789",
-  "purchase_order_uid": "4"
+  "comment": "abc123",
+  "purchase_order_uid": 4
 }
 
    
                 
    
@@ -21881,9 +21882,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "xyz789",
-  "purchase_order_uid": 4,
-  "replace_existing_cart_items": true
+  "cart_id": "abc123",
+  "purchase_order_uid": "4",
+  "replace_existing_cart_items": false
 }
 
    
                 
    
@@ -21930,7 +21931,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "message": "abc123",
+  "message": "xyz789",
   "type": "OUT_OF_STOCK"
 }
 
    
@@ -22094,7 +22095,10 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"comment_text": "xyz789", "return_uid": 4}
+                  
    {
+  "comment_text": "xyz789",
+  "return_uid": "4"
+}
 
    
                 
    
               
    
@@ -22189,8 +22193,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "carrier_uid": "4",
-  "return_uid": 4,
-  "tracking_number": "abc123"
+  "return_uid": "4",
+  "tracking_number": "xyz789"
 }
 
    
                 
    
@@ -22377,7 +22381,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "cart_items": [VirtualProductCartItemInput]
 }
 
    
@@ -22473,7 +22477,7 @@ 
    Example
    
   "add_wishlist_items_to_cart_user_errors": [
     WishlistCartUserInputError
   ],
-  "status": false,
+  "status": true,
   "wishlist": Wishlist
 }
 
    
@@ -22537,7 +22541,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "attribute_code": "xyz789",
-  "count": 123,
+  "count": 987,
   "label": "abc123",
   "options": [AggregationOption],
   "position": 987
@@ -22593,7 +22597,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "count": 987,
-  "label": "xyz789",
+  "label": "abc123",
   "value": "xyz789"
 }
 
    
@@ -22707,7 +22711,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"includeDirectChildrenOnly": false}
+                  
    {"includeDirectChildrenOnly": true}
 
    
                 
    
               
    
@@ -22821,10 +22825,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "button_styles": ButtonStyles,
-  "code": "xyz789",
+  "code": "abc123",
   "is_visible": true,
-  "payment_intent": "abc123",
-  "payment_source": "xyz789",
+  "payment_intent": "xyz789",
+  "payment_source": "abc123",
   "sdk_params": [SDKParams],
   "sort_order": "abc123",
   "title": "abc123"
@@ -22884,7 +22888,7 @@ 
    Example
    
                   
    {
   "payment_source": "xyz789",
   "payments_order_id": "xyz789",
-  "paypal_order_id": "abc123"
+  "paypal_order_id": "xyz789"
 }
 
    
                 
@@ -22982,9 +22986,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "applied_balance": Money,
-  "code": "abc123",
+  "code": "xyz789",
   "current_balance": Money,
-  "expiration_date": "abc123"
+  "expiration_date": "xyz789"
 }
 
    
                 
@@ -23088,7 +23092,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "cart_id": "abc123",
-  "coupon_code": "abc123"
+  "coupon_code": "xyz789"
 }
 
    
                 
@@ -23233,7 +23237,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "cart_id": "abc123",
-  "coupon_codes": ["abc123"],
+  "coupon_codes": ["xyz789"],
   "type": "APPEND"
 }
 
    
@@ -23284,7 +23288,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "cart_id": "xyz789",
-  "gift_card_code": "abc123"
+  "gift_card_code": "xyz789"
 }
 
    
                 
@@ -23586,7 +23590,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"compare_list": CompareList, "result": false}
+                  
    {"compare_list": CompareList, "result": true}
 
    
                 
    
               
    
@@ -23652,11 +23656,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "attribute_code": "abc123",
+  "attribute_code": "xyz789",
   "attribute_options": [AttributeOption],
   "attribute_type": "abc123",
   "entity_type": "xyz789",
-  "input_type": "xyz789",
+  "input_type": "abc123",
   "storefront_properties": StorefrontProperties
 }
 
    
@@ -23836,16 +23840,16 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "is_comparable": false,
+  "is_comparable": true,
   "is_filterable": true,
   "is_filterable_in_search": true,
   "is_html_allowed_on_front": true,
-  "is_searchable": true,
-  "is_used_for_customer_segment": false,
-  "is_used_for_price_rules": false,
+  "is_searchable": false,
+  "is_used_for_customer_segment": 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_visible_in_advanced_search": false,
+  "is_visible_on_front": true,
   "is_wysiwyg_enabled": false,
   "used_in_product_listing": false
 }
@@ -24043,7 +24047,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "attribute_code": "xyz789",
+  "attribute_code": "abc123",
   "entity_type": "abc123"
 }
 
    
@@ -24086,7 +24090,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"value": "xyz789"}
+                  
    {"value": "abc123"}
 
    
                 
    
               
    
@@ -24170,11 +24174,11 @@ 
    Example
    
   "code": 4,
   "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "xyz789",
+  "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
-  "is_required": false,
+  "is_required": true,
   "is_unique": true,
-  "label": "abc123",
+  "label": "xyz789",
   "options": [CustomAttributeOptionInterface]
 }
 
    
@@ -24222,7 +24226,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "message": "xyz789",
+  "message": "abc123",
   "type": "ENTITY_NOT_FOUND"
 }
 
    
@@ -24329,8 +24333,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "label": "abc123",
-  "value": "abc123"
+  "label": "xyz789",
+  "value": "xyz789"
 }
 
    
                 
    
@@ -24383,7 +24387,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "is_default": true,
-  "label": "abc123",
+  "label": "xyz789",
   "value": "xyz789"
 }
 
    
@@ -24428,7 +24432,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "label": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
    
                 
    
@@ -24488,8 +24492,8 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "label": "abc123",
-  "value": "xyz789"
+  "label": "xyz789",
+  "value": "abc123"
 }
 
    
                 
    
@@ -24699,7 +24703,7 @@ 
    Possible Types
    
               
    
                 
    
                   
    Example
    
-                  
    {"code": "4"}
+                  
    {"code": 4}
 
    
                 
    
               
    
@@ -24891,9 +24895,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "abc123",
+  "code": "xyz789",
   "is_deferred": false,
-  "title": "xyz789"
+  "title": "abc123"
 }
 
    
                 
    
@@ -24985,10 +24989,10 @@ 
    Example
    
   "amount": Money,
   "available": false,
   "base_amount": Money,
-  "carrier_code": "xyz789",
+  "carrier_code": "abc123",
   "carrier_title": "abc123",
-  "error_message": "abc123",
-  "method_code": "xyz789",
+  "error_message": "xyz789",
+  "method_code": "abc123",
   "method_title": "abc123",
   "price_excl_tax": Money,
   "price_incl_tax": Money
@@ -25111,10 +25115,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "address": CartAddressInput,
-  "customer_address_id": 987,
+  "customer_address_id": 123,
   "customer_address_uid": 4,
-  "same_as_shipping": false,
-  "use_for_shipping": false
+  "same_as_shipping": true,
+  "use_for_shipping": true
 }
 
    
                 
    
@@ -25189,9 +25193,9 @@ 
    Example
    
                   
    {
   "address_line_1": "abc123",
   "address_line_2": "abc123",
-  "city": "abc123",
-  "country_code": "xyz789",
-  "postal_code": "xyz789",
+  "city": "xyz789",
+  "country_code": "abc123",
+  "postal_code": "abc123",
   "region": "xyz789"
 }
 
    
@@ -25333,18 +25337,18 @@ 
    Example
    
   "custom_attributes": [AttributeValueInterface],
   "customer_address_uid": "4",
   "customer_notes": "abc123",
-  "fax": "xyz789",
-  "firstname": "xyz789",
-  "id": 987,
+  "fax": "abc123",
+  "firstname": "abc123",
+  "id": 123,
   "lastname": "abc123",
-  "middlename": "xyz789",
+  "middlename": "abc123",
   "postcode": "xyz789",
   "prefix": "xyz789",
   "region": CartAddressRegion,
   "street": ["xyz789"],
   "suffix": "xyz789",
   "telephone": "xyz789",
-  "uid": 4,
+  "uid": "4",
   "vat_id": "xyz789"
 }
 
    
@@ -25366,11 +25370,6 @@ 
    Description
    
                 
               
               
    
-                
    
-                  
    Example
    
-                  
    true
-
    
-                
    
               
    
               back to top
             
@@ -25414,8 +25413,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "device_data": "xyz789",
-  "public_hash": "abc123"
+  "device_data": "abc123",
+  "public_hash": "xyz789"
 }
 
    
                 
    
@@ -25516,7 +25515,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "device_data": "abc123",
-  "public_hash": "abc123"
+  "public_hash": "xyz789"
 }
 
    
                 
@@ -25587,8 +25586,8 @@ 
    Example
    
   "category_id": 987,
   "category_level": 987,
   "category_name": "xyz789",
-  "category_uid": "4",
-  "category_url_key": "xyz789",
+  "category_uid": 4,
+  "category_url_key": "abc123",
   "category_url_path": "abc123"
 }
 
    
@@ -25726,10 +25725,10 @@ 
    Example
    
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
   "id": "abc123",
-  "is_available": true,
+  "is_available": false,
   "max_qty": 987.65,
   "min_qty": 987.65,
-  "not_available_message": "abc123",
+  "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
@@ -25898,11 +25897,11 @@ 
    Example
    
                   
    {
   "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": 123.45
 }
 
    
@@ -25986,14 +25985,14 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "option_id": 987,
+  "option_id": 123,
   "options": [BundleItemOption],
   "position": 123,
   "price_range": PriceRange,
-  "required": true,
-  "sku": "xyz789",
-  "title": "abc123",
-  "type": "xyz789",
+  "required": false,
+  "sku": "abc123",
+  "title": "xyz789",
+  "type": "abc123",
   "uid": 4
 }
 
    
@@ -26088,17 +26087,17 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "can_change_quantity": false,
-  "id": 987,
-  "is_default": false,
+  "can_change_quantity": true,
+  "id": 123,
+  "is_default": true,
   "label": "abc123",
-  "position": 123,
+  "position": 987,
   "price": 123.45,
   "price_type": "FIXED",
   "product": ProductInterface,
   "qty": 987.65,
-  "quantity": 123.45,
-  "uid": "4"
+  "quantity": 987.65,
+  "uid": 4
 }
 
    
                 
    
@@ -26154,8 +26153,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "id": 123,
-  "quantity": 987.65,
-  "value": ["xyz789"]
+  "quantity": 123.45,
+  "value": ["abc123"]
 }
 
    
                 
    
@@ -26325,15 +26324,15 @@ 
    Example
    
   "product_name": "xyz789",
   "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_canceled": 123.45,
+  "quantity_invoiced": 987.65,
   "quantity_ordered": 987.65,
   "quantity_refunded": 123.45,
   "quantity_return_requested": 987.65,
   "quantity_returned": 123.45,
-  "quantity_shipped": 987.65,
+  "quantity_shipped": 123.45,
   "selected_options": [OrderItemOption],
   "status": "xyz789"
 }
@@ -26774,14 +26773,14 @@ 
    Example
    
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
   "color": 123,
-  "country_of_manufacture": "abc123",
-  "created_at": "abc123",
+  "country_of_manufacture": "xyz789",
+  "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "dynamic_price": false,
   "dynamic_sku": false,
-  "dynamic_weight": true,
+  "dynamic_weight": false,
   "gift_message_available": false,
   "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
@@ -26790,17 +26789,17 @@ 
    Example
    
   "is_returnable": "abc123",
   "items": [BundleItem],
   "manufacturer": 123,
-  "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_keyword": "abc123",
+  "meta_title": "abc123",
   "min_sale_qty": 987.65,
-  "name": "xyz789",
-  "new_from_date": "abc123",
-  "new_to_date": "abc123",
-  "only_x_left_in_stock": 123.45,
+  "name": "abc123",
+  "new_from_date": "xyz789",
+  "new_to_date": "xyz789",
+  "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
   "options_container": "xyz789",
   "price": ProductPrices,
@@ -26820,24 +26819,24 @@ 
    Example
    
   "short_description": ComplexTextValue,
   "sku": "xyz789",
   "small_image": ProductImage,
-  "special_from_date": "abc123",
+  "special_from_date": "xyz789",
   "special_price": 987.65,
-  "special_to_date": "abc123",
+  "special_to_date": "xyz789",
   "staged": true,
   "stock_status": "IN_STOCK",
-  "swatch_image": "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": "xyz789",
   "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "abc123",
+  "url_suffix": "xyz789",
   "websites": [Website],
   "weight": 123.45
 }
@@ -26961,7 +26960,7 @@ 
    Example
    
   "bundle_options": [SelectedBundleOption],
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": "4"
 }
 
    
@@ -27035,12 +27034,12 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "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
 }
 
    
                 
@@ -27112,13 +27111,13 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "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
 }
 
    
                 
    
@@ -27190,7 +27189,7 @@ 
    Example
    
   "height": 987,
   "label": "abc123",
   "layout": "xyz789",
-  "shape": "xyz789",
+  "shape": "abc123",
   "tagline": true,
   "use_default_height": true
 }
@@ -27241,7 +27240,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cancellation_comment": "xyz789",
+  "cancellation_comment": "abc123",
   "template_id": "4"
 }
 
    
@@ -27409,7 +27408,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "order_id": "4",
-  "reason": "abc123"
+  "reason": "xyz789"
 }
 
    
                 
    
@@ -27462,7 +27461,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "error": "xyz789",
+  "error": "abc123",
   "errorV2": CancelOrderError,
   "order": CustomerOrder
 }
@@ -27502,7 +27501,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"description": "abc123"}
+                  
    {"description": "xyz789"}
 
    
                 
    
               
    
@@ -27560,9 +27559,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "bin_details": CardBin,
-  "card_expiry_month": "xyz789",
-  "card_expiry_year": "abc123",
-  "last_digits": "xyz789",
+  "card_expiry_month": "abc123",
+  "card_expiry_year": "xyz789",
+  "last_digits": "abc123",
   "name": "abc123"
 }
 
    
@@ -27883,20 +27882,20 @@ 
    Example
    
   "available_gift_wrappings": [GiftWrapping],
   "available_payment_methods": [AvailablePaymentMethod],
   "billing_address": BillingCartAddress,
-  "email": "xyz789",
+  "email": "abc123",
   "gift_message": GiftMessage,
   "gift_receipt_included": false,
   "gift_wrapping": GiftWrapping,
   "id": 4,
-  "is_virtual": false,
+  "is_virtual": true,
   "items": [CartItemInterface],
   "itemsV2": CartItems,
   "prices": CartPrices,
-  "printed_card_included": true,
+  "printed_card_included": false,
   "rules": [CartRuleStorefront],
   "selected_payment_method": SelectedPaymentMethod,
   "shipping_addresses": [ShippingCartAddress],
-  "total_quantity": 987.65
+  "total_quantity": 123.45
 }
 
    
                 
    
@@ -28088,18 +28087,18 @@ 
    Example
    
   "country_code": "abc123",
   "custom_attributes": [AttributeValueInput],
   "fax": "xyz789",
-  "firstname": "abc123",
-  "lastname": "abc123",
-  "middlename": "xyz789",
-  "postcode": "abc123",
+  "firstname": "xyz789",
+  "lastname": "xyz789",
+  "middlename": "abc123",
+  "postcode": "xyz789",
   "prefix": "xyz789",
-  "region": "xyz789",
+  "region": "abc123",
   "region_id": 987,
   "save_in_address_book": false,
   "street": ["abc123"],
   "suffix": "xyz789",
-  "telephone": "abc123",
-  "vat_id": "abc123"
+  "telephone": "xyz789",
+  "vat_id": "xyz789"
 }
 
    
                 
@@ -28245,24 +28244,24 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "city": "abc123",
+  "city": "xyz789",
   "company": "abc123",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "customer_address_uid": "4",
+  "customer_address_uid": 4,
   "fax": "xyz789",
   "firstname": "xyz789",
   "id": 987,
   "lastname": "xyz789",
   "middlename": "xyz789",
   "postcode": "abc123",
-  "prefix": "abc123",
+  "prefix": "xyz789",
   "region": CartAddressRegion,
-  "street": ["abc123"],
-  "suffix": "abc123",
-  "telephone": "abc123",
-  "uid": "4",
-  "vat_id": "abc123"
+  "street": ["xyz789"],
+  "suffix": "xyz789",
+  "telephone": "xyz789",
+  "uid": 4,
+  "vat_id": "xyz789"
 }
 
    
                 
    
@@ -28316,7 +28315,7 @@ 
    Example
    
                   
    {
   "code": "abc123",
   "label": "abc123",
-  "region_id": 987
+  "region_id": 123
 }
 
    
                 
@@ -28451,7 +28450,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"code": "UNDEFINED", "message": "abc123"}
+                  
    {"code": "UNDEFINED", "message": "xyz789"}
 
    
                 
    
               
    
@@ -28571,9 +28570,9 @@ 
    Example
    
                   
    {
   "entered_options": [EnteredOptionInput],
   "parent_sku": "abc123",
-  "quantity": 987.65,
-  "selected_options": [4],
-  "sku": "xyz789"
+  "quantity": 123.45,
+  "selected_options": ["4"],
+  "sku": "abc123"
 }
 
    
                 
@@ -28721,17 +28720,17 @@ 
    Example
    
                   
    {
   "discount": [Discount],
   "errors": [CartItemError],
-  "id": "abc123",
+  "id": "xyz789",
   "is_available": false,
-  "max_qty": 987.65,
-  "min_qty": 123.45,
-  "not_available_message": "abc123",
+  "max_qty": 123.45,
+  "min_qty": 987.65,
+  "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": "4"
+  "quantity": 987.65,
+  "uid": 4
 }
 
    
                 
@@ -28883,7 +28882,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"cart_item_id": 123, "quantity": 987.65}
+                  
    {"cart_item_id": 987, "quantity": 987.65}
 
    
                 
    
               
    
@@ -28936,7 +28935,7 @@ 
    Example
    
                   
    {
   "type": "FIXED",
   "units": "xyz789",
-  "value": 987.65
+  "value": 123.45
 }
 
    
                 
@@ -29010,10 +29009,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "cart_item_id": 123,
-  "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
 }
 
    
@@ -29064,7 +29063,7 @@ 
    Example
    
                   
    {
   "items": [CartItemInterface],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
    
                 
@@ -29193,7 +29192,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"uid": "4"}
+                  
    {"uid": 4}
 
    
                 
    
               
    
@@ -29609,27 +29608,27 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "apply_to": ["SIMPLE"],
-  "code": 4,
-  "default_value": "abc123",
+  "code": "4",
+  "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
   "is_comparable": true,
-  "is_filterable": false,
+  "is_filterable": true,
   "is_filterable_in_search": false,
   "is_html_allowed_on_front": false,
-  "is_required": false,
+  "is_required": true,
   "is_searchable": false,
-  "is_unique": false,
-  "is_used_for_price_rules": true,
+  "is_unique": true,
+  "is_used_for_price_rules": false,
   "is_used_for_promo_rules": false,
-  "is_visible_in_advanced_search": false,
-  "is_visible_on_front": true,
+  "is_visible_in_advanced_search": true,
+  "is_visible_on_front": false,
   "is_wysiwyg_enabled": false,
-  "label": "abc123",
+  "label": "xyz789",
   "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": false
 }
@@ -29975,39 +29974,39 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "automatic_sorting": "abc123",
-  "available_sort_by": ["abc123"],
+  "automatic_sorting": "xyz789",
+  "available_sort_by": ["xyz789"],
   "breadcrumbs": [Breadcrumb],
   "canonical_url": "xyz789",
   "children_count": "abc123",
   "cms_block": CmsBlock,
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "custom_layout_update_file": "xyz789",
   "default_sort_by": "xyz789",
   "description": "abc123",
-  "display_mode": "abc123",
-  "filter_price_range": 987.65,
-  "id": 123,
+  "display_mode": "xyz789",
+  "filter_price_range": 123.45,
+  "id": 987,
   "image": "xyz789",
   "include_in_menu": 123,
-  "is_anchor": 123,
-  "landing_page": 123,
-  "level": 123,
+  "is_anchor": 987,
+  "landing_page": 987,
+  "level": 987,
   "meta_description": "abc123",
   "meta_keywords": "xyz789",
-  "meta_title": "abc123",
-  "name": "abc123",
-  "path": "abc123",
-  "path_in_store": "abc123",
+  "meta_title": "xyz789",
+  "name": "xyz789",
+  "path": "xyz789",
+  "path_in_store": "xyz789",
   "position": 987,
   "product_count": 987,
   "products": CategoryProducts,
-  "staged": false,
-  "uid": "4",
+  "staged": true,
+  "uid": 4,
   "updated_at": "abc123",
-  "url_key": "abc123",
-  "url_path": "abc123",
-  "url_suffix": "xyz789"
+  "url_key": "xyz789",
+  "url_path": "xyz789",
+  "url_suffix": "abc123"
 }
 
    
                 
    
@@ -30377,42 +30376,42 @@ 
    sort
                   
    Example
    
                   
    {
-  "automatic_sorting": "abc123",
-  "available_sort_by": ["xyz789"],
+  "automatic_sorting": "xyz789",
+  "available_sort_by": ["abc123"],
   "breadcrumbs": [Breadcrumb],
   "canonical_url": "abc123",
   "children": [CategoryTree],
   "children_count": "abc123",
   "cms_block": CmsBlock,
-  "created_at": "abc123",
-  "custom_layout_update_file": "xyz789",
+  "created_at": "xyz789",
+  "custom_layout_update_file": "abc123",
   "default_sort_by": "xyz789",
   "description": "xyz789",
   "display_mode": "abc123",
-  "filter_price_range": 123.45,
-  "id": 123,
-  "image": "xyz789",
+  "filter_price_range": 987.65,
+  "id": 987,
+  "image": "abc123",
   "include_in_menu": 123,
-  "is_anchor": 123,
-  "landing_page": 123,
+  "is_anchor": 987,
+  "landing_page": 987,
   "level": 987,
-  "meta_description": "xyz789",
+  "meta_description": "abc123",
   "meta_keywords": "xyz789",
   "meta_title": "abc123",
   "name": "xyz789",
   "path": "abc123",
   "path_in_store": "abc123",
-  "position": 123,
+  "position": 987,
   "product_count": 123,
   "products": CategoryProducts,
   "redirect_code": 987,
   "relative_url": "abc123",
-  "staged": false,
+  "staged": true,
   "type": "CMS_PAGE",
   "uid": 4,
   "updated_at": "xyz789",
   "url_key": "abc123",
-  "url_path": "abc123",
+  "url_path": "xyz789",
   "url_suffix": "xyz789"
 }
 
    
@@ -30485,11 +30484,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "agreement_id": 987,
+  "agreement_id": 123,
   "checkbox_text": "abc123",
   "content": "abc123",
-  "content_height": "xyz789",
-  "is_html": true,
+  "content_height": "abc123",
+  "is_html": false,
   "mode": "AUTO",
   "name": "abc123"
 }
@@ -30704,7 +30703,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"message": "xyz789", "type": "NOT_FOUND"}
+                  
    {"message": "abc123", "type": "NOT_FOUND"}
 
    
                 
    
               
    
@@ -30804,7 +30803,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"uid": 4}
+                  
    {"uid": "4"}
 
    
                 
    
               
    
@@ -30989,7 +30988,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "errors": [NegotiableQuoteInvalidStateError],
-  "quote_uid": "4"
+  "quote_uid": 4
 }
 
    
                 
    
@@ -31216,7 +31215,7 @@ 
    Example
    
                   
    {
   "content": "xyz789",
   "identifier": "xyz789",
-  "title": "abc123"
+  "title": "xyz789"
 }
 
    
                 
@@ -31356,9 +31355,9 @@ 
    Example
    
   "content": "abc123",
   "content_heading": "abc123",
   "identifier": "abc123",
-  "meta_description": "xyz789",
+  "meta_description": "abc123",
   "meta_keywords": "abc123",
-  "meta_title": "abc123",
+  "meta_title": "xyz789",
   "page_layout": "abc123",
   "redirect_code": 123,
   "relative_url": "abc123",
@@ -31746,10 +31745,10 @@ 
    Example
    
   "company_admin": Customer,
   "credit": CompanyCredit,
   "credit_history": CompanyCreditHistory,
-  "email": "abc123",
-  "id": "4",
+  "email": "xyz789",
+  "id": 4,
   "legal_address": CompanyLegalAddress,
-  "legal_name": "xyz789",
+  "legal_name": "abc123",
   "name": "abc123",
   "payment_methods": ["abc123"],
   "reseller_id": "abc123",
@@ -31900,12 +31899,12 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "custom_attributes": [AttributeValueInput],
-  "email": "xyz789",
+  "email": "abc123",
   "firstname": "xyz789",
   "gender": 123,
-  "job_title": "abc123",
+  "job_title": "xyz789",
   "lastname": "xyz789",
-  "telephone": "abc123"
+  "telephone": "xyz789"
 }
 
    
                 
@@ -31962,7 +31961,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": 4,
+  "id": "4",
   "legal_name": "xyz789",
   "name": "xyz789",
   "status": "PENDING"
@@ -32046,11 +32045,11 @@ 
    Example
    
                   
    {
   "company_admin": CompanyAdminInput,
   "company_email": "abc123",
-  "company_name": "abc123",
+  "company_name": "xyz789",
   "legal_address": CompanyLegalAddressCreateInput,
   "legal_name": "xyz789",
-  "reseller_id": "xyz789",
-  "vat_tax_id": "xyz789"
+  "reseller_id": "abc123",
+  "vat_tax_id": "abc123"
 }
 
    
                 
    
@@ -32213,9 +32212,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "custom_reference_number": "abc123",
+  "custom_reference_number": "xyz789",
   "operation_type": "ALLOCATION",
-  "updated_by": "xyz789"
+  "updated_by": "abc123"
 }
 
    
                 
    
@@ -32284,7 +32283,7 @@ 
    Example
    
                   
    {
   "amount": Money,
   "balance": CompanyCredit,
-  "custom_reference_number": "xyz789",
+  "custom_reference_number": "abc123",
   "date": "abc123",
   "type": "ALLOCATION",
   "updated_by": CompanyCreditOperationUser
@@ -32406,7 +32405,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"name": "xyz789", "type": "CUSTOMER"}
+                  
    {"name": "abc123", "type": "CUSTOMER"}
 
    
                 
    
               
    
@@ -32548,7 +32547,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"success": false}
+                  
    {"success": true}
 
    
                 
    
               
    
@@ -32614,7 +32613,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "company_id": "4",
+  "company_id": 4,
   "customer_id": 4,
   "job_title": "xyz789",
   "status": "ACTIVE",
@@ -32689,8 +32688,8 @@ 
    Example
    
   "country_code": "AF",
   "postcode": "xyz789",
   "region": CustomerAddressRegion,
-  "street": ["abc123"],
-  "telephone": "xyz789"
+  "street": ["xyz789"],
+  "telephone": "abc123"
 }
 
    
                 
    
@@ -32763,11 +32762,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "xyz789",
+  "city": "abc123",
   "country_id": "AF",
   "postcode": "xyz789",
   "region": CustomerAddressRegionInput,
-  "street": ["abc123"],
+  "street": ["xyz789"],
   "telephone": "abc123"
 }
 
    
@@ -32843,7 +32842,7 @@ 
    Example
    
                   
    {
   "city": "xyz789",
   "country_id": "AF",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "region": CustomerAddressRegionInput,
   "street": ["abc123"],
   "telephone": "abc123"
@@ -32903,8 +32902,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": 4,
-  "name": "abc123",
+  "id": "4",
+  "name": "xyz789",
   "permissions": [CompanyAclResource],
   "users_count": 987
 }
@@ -32955,7 +32954,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "name": "xyz789",
+  "name": "abc123",
   "permissions": ["xyz789"]
 }
 
    
@@ -33011,9 +33010,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": "4",
-  "name": "abc123",
-  "permissions": ["xyz789"]
+  "id": 4,
+  "name": "xyz789",
+  "permissions": ["abc123"]
 }
 
    
                 
    
@@ -33067,7 +33066,7 @@ 
    Example
    
                   
    {
   "items": [CompanyRole],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
    
                 
    
@@ -33119,9 +33118,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "abc123",
-  "firstname": "abc123",
-  "lastname": "abc123"
+  "email": "xyz789",
+  "firstname": "xyz789",
+  "lastname": "xyz789"
 }
 
    
                 
    
@@ -33311,11 +33310,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {
-  "entity": CompanyTeam,
-  "id": "4",
-  "parent_id": 4
-}
+                  
    {"entity": CompanyTeam, "id": 4, "parent_id": 4}
 
    
                 
    
               
    
@@ -33362,7 +33357,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"parent_tree_id": 4, "tree_id": 4}
+                  
    {"parent_tree_id": 4, "tree_id": "4"}
 
    
                 
    
               
    
@@ -33420,8 +33415,8 @@ 
    Example
    
                   
    {
   "description": "xyz789",
   "id": "4",
-  "name": "abc123",
-  "structure_id": "4"
+  "name": "xyz789",
+  "structure_id": 4
 }
 
    
                 
    
@@ -33476,7 +33471,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "description": "xyz789",
+  "description": "abc123",
   "name": "xyz789",
   "target_id": "4"
 }
@@ -33535,7 +33530,7 @@ 
    Example
    
                   
    {
   "description": "abc123",
   "id": 4,
-  "name": "abc123"
+  "name": "xyz789"
 }
 
    
                 
    
@@ -33611,8 +33606,8 @@ 
    Example
    
   "company_email": "xyz789",
   "company_name": "abc123",
   "legal_address": CompanyLegalAddressUpdateInput,
-  "legal_name": "abc123",
-  "reseller_id": "xyz789",
+  "legal_name": "xyz789",
+  "reseller_id": "abc123",
   "vat_tax_id": "abc123"
 }
 
    
@@ -33698,11 +33693,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "xyz789",
+  "email": "abc123",
   "firstname": "xyz789",
   "job_title": "xyz789",
   "lastname": "xyz789",
-  "role_id": 4,
+  "role_id": "4",
   "status": "ACTIVE",
   "target_id": "4",
   "telephone": "abc123"
@@ -33841,10 +33836,10 @@ 
    Example
    
   "firstname": "abc123",
   "id": 4,
   "job_title": "abc123",
-  "lastname": "abc123",
+  "lastname": "xyz789",
   "role_id": 4,
   "status": "ACTIVE",
-  "telephone": "xyz789"
+  "telephone": "abc123"
 }
 
    
                 
    
@@ -33898,7 +33893,7 @@ 
    Example
    
                   
    {
   "items": [Customer],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
    
                 
    
@@ -33987,7 +33982,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "xyz789",
-  "label": "abc123"
+  "label": "xyz789"
 }
 
    
                 
@@ -34041,7 +34036,7 @@ 
    Example
    
                   
    {
   "attributes": [ProductAttribute],
   "product": ProductInterface,
-  "uid": "4"
+  "uid": 4
 }
 
    
                 
@@ -34245,7 +34240,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "xyz789",
-  "label": "xyz789",
+  "label": "abc123",
   "uid": "4",
   "value_index": 123
 }
@@ -34389,17 +34384,17 @@ 
    Example
    
   "errors": [CartItemError],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "abc123",
+  "id": "xyz789",
   "is_available": true,
   "max_qty": 123.45,
-  "min_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"
+  "uid": 4
 }
 
    
                 
@@ -34446,8 +34441,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "attribute_code": "xyz789",
-  "option_value_uids": [4]
+  "attribute_code": "abc123",
+  "option_value_uids": ["4"]
 }
 
    
                 
    
@@ -34596,25 +34591,25 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "discounts": [Discount],
-  "eligible_for_return": false,
+  "eligible_for_return": true,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "4",
+  "id": 4,
   "parent_sku": "abc123",
   "prices": OrderItemPrices,
   "product": ProductInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "product_type": "abc123",
-  "product_url_key": "xyz789",
+  "product_type": "xyz789",
+  "product_url_key": "abc123",
   "quantity_canceled": 123.45,
   "quantity_invoiced": 987.65,
-  "quantity_ordered": 987.65,
+  "quantity_ordered": 123.45,
   "quantity_refunded": 987.65,
-  "quantity_return_requested": 987.65,
-  "quantity_returned": 123.45,
+  "quantity_return_requested": 123.45,
+  "quantity_returned": 987.65,
   "quantity_shipped": 123.45,
   "selected_options": [OrderItemOption],
   "status": "xyz789"
@@ -35052,7 +35047,7 @@ 
    Example
    
   "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,
@@ -35066,51 +35061,51 @@ 
    Example
    
   "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "xyz789",
-  "meta_keyword": "abc123",
-  "meta_title": "xyz789",
+  "meta_description": "abc123",
+  "meta_keyword": "xyz789",
+  "meta_title": "abc123",
   "min_sale_qty": 987.65,
   "name": "xyz789",
   "new_from_date": "abc123",
-  "new_to_date": "xyz789",
-  "only_x_left_in_stock": 123.45,
+  "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": 987,
+  "rating_summary": 123.45,
+  "redirect_code": 123,
   "related_products": [ProductInterface],
-  "relative_url": "xyz789",
-  "review_count": 987,
+  "relative_url": "abc123",
+  "review_count": 123,
   "reviews": ProductReviews,
   "short_description": ComplexTextValue,
   "sku": "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": 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",
+  "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",
   "variants": [ConfigurableVariant],
   "websites": [Website],
-  "weight": 123.45
+  "weight": 987.65
 }
 
    
                 
@@ -35170,7 +35165,7 @@ 
    Example
    
                   
    {
   "customizable_options": [CustomizableOptionInput],
   "data": CartItemInput,
-  "parent_sku": "xyz789",
+  "parent_sku": "abc123",
   "variant_sku": "xyz789"
 }
 
    
@@ -35228,8 +35223,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "attribute_code": "xyz789",
-  "label": "xyz789",
+  "attribute_code": "abc123",
+  "label": "abc123",
   "uid": "4",
   "values": [ConfigurableProductOptionValue]
 }
@@ -35294,7 +35289,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "is_available": false,
-  "is_use_default": true,
+  "is_use_default": false,
   "label": "xyz789",
   "swatch": SwatchDataInterface,
   "uid": 4
@@ -35394,15 +35389,15 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "attribute_code": "xyz789",
-  "attribute_id": "xyz789",
+  "attribute_id": "abc123",
   "attribute_id_v2": 123,
   "attribute_uid": "4",
   "id": 987,
-  "label": "xyz789",
-  "position": 123,
-  "product_id": 123,
-  "uid": 4,
-  "use_default": false,
+  "label": "abc123",
+  "position": 987,
+  "product_id": 987,
+  "uid": "4",
+  "use_default": true,
   "values": [ConfigurableProductOptionsValues]
 }
 
    
@@ -35538,13 +35533,13 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "default_label": "abc123",
-  "label": "abc123",
-  "store_label": "xyz789",
+  "default_label": "xyz789",
+  "label": "xyz789",
+  "store_label": "abc123",
   "swatch_data": SwatchDataInterface,
-  "uid": "4",
-  "use_default_value": false,
-  "value_index": 987
+  "uid": 4,
+  "use_default_value": true,
+  "value_index": 123
 }
 
    
                 
    
@@ -35609,8 +35604,8 @@ 
    Example
    
   "configurable_options": [SelectedConfigurableOption],
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": "4"
+  "quantity": 987.65,
+  "uid": 4
 }
 
    
                 
    
@@ -35741,13 +35736,13 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "added_at": "xyz789",
+  "added_at": "abc123",
   "child_sku": "abc123",
   "configurable_options": [SelectedConfigurableOption],
   "configured_variant": ProductInterface,
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
-  "id": "4",
+  "description": "abc123",
+  "id": 4,
   "product": ProductInterface,
   "quantity": 987.65
 }
@@ -35794,7 +35789,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "confirmation_key": "abc123",
+  "confirmation_key": "xyz789",
   "order_id": 4
 }
 
    
@@ -35844,8 +35839,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "confirmation_key": "abc123",
-  "email": "xyz789"
+  "confirmation_key": "xyz789",
+  "email": "abc123"
 }
 
    
                 
    
@@ -35996,9 +35991,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "comment": "abc123",
-  "email": "xyz789",
+  "email": "abc123",
   "name": "abc123",
-  "telephone": "abc123"
+  "telephone": "xyz789"
 }
 
    
                 
    
@@ -36039,7 +36034,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"status": false}
+                  
    {"status": true}
 
    
                 
    
               
    
@@ -36238,8 +36233,8 @@ 
    Example
    
                   
    {
   "available_regions": [Region],
   "full_name_english": "xyz789",
-  "full_name_locale": "xyz789",
-  "id": "xyz789",
+  "full_name_locale": "abc123",
+  "id": "abc123",
   "three_letter_abbreviation": "abc123",
   "two_letter_abbreviation": "abc123"
 }
@@ -38035,8 +38030,8 @@ 
    Example
    
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
-  "event_name": "xyz789",
-  "gift_registry_type_uid": 4,
+  "event_name": "abc123",
+  "gift_registry_type_uid": "4",
   "message": "xyz789",
   "privacy_settings": "PRIVATE",
   "registrants": [AddGiftRegistryRegistrantInput],
@@ -38216,9 +38211,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "response_message": "abc123",
-  "result": 987,
-  "result_code": 123,
+  "response_message": "xyz789",
+  "result": 123,
+  "result_code": 987,
   "secure_token": "abc123",
   "secure_token_id": "abc123"
 }
@@ -38289,8 +38284,8 @@ 
    Example
    
                   
    {
   "cartId": "xyz789",
   "location": "PRODUCT_DETAIL",
-  "methodCode": "xyz789",
-  "paymentSource": "abc123",
+  "methodCode": "abc123",
+  "paymentSource": "xyz789",
   "vaultIntent": false
 }
 
    
@@ -38353,11 +38348,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "amount": 123.45,
-  "currency_code": "xyz789",
-  "id": "xyz789",
-  "mp_order_id": "abc123",
-  "status": "abc123"
+  "amount": 987.65,
+  "currency_code": "abc123",
+  "id": "abc123",
+  "mp_order_id": "xyz789",
+  "status": "xyz789"
 }
 
    
                 
    
@@ -38426,9 +38421,9 @@ 
    Example
    
                   
    {
   "nickname": "abc123",
   "ratings": [ProductReviewRatingInput],
-  "sku": "abc123",
+  "sku": "xyz789",
   "summary": "abc123",
-  "text": "xyz789"
+  "text": "abc123"
 }
 
    
                 
    
@@ -38516,7 +38511,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"currency": "AFN", "value": 123.45}
+                  
    {"currency": "AFN", "value": 987.65}
 
    
                 
    
               
    
@@ -38579,7 +38574,7 @@ 
    Example
    
   "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput,
   "attribute": "GRAND_TOTAL",
   "operator": "MORE_THAN",
-  "quantity": 987
+  "quantity": 123
 }
 
    
                 
    
@@ -38629,7 +38624,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "description": "xyz789",
-  "name": "abc123"
+  "name": "xyz789"
 }
 
    
                 
@@ -38718,8 +38713,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "card_description": "xyz789",
-  "setup_token_id": "xyz789"
+  "card_description": "abc123",
+  "setup_token_id": "abc123"
 }
 
    
                 
    
@@ -38905,7 +38900,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"name": "xyz789", "visibility": "PUBLIC"}
+                  
    {"name": "abc123", "visibility": "PUBLIC"}
 
    
                 
    
               
    
@@ -39143,12 +39138,12 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "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
 }
 
    
                 
@@ -39253,12 +39248,12 @@ 
    Possible Types
    
                   
    Example
    
                   
    {
   "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
+  "quantity_refunded": 987.65
 }
 
    
                 
@@ -39425,10 +39420,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "available_currency_codes": ["xyz789"],
+  "available_currency_codes": ["abc123"],
   "base_currency_code": "abc123",
   "base_currency_symbol": "abc123",
-  "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",
@@ -40811,14 +40806,14 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "code": 4,
-  "default_value": "xyz789",
+  "code": "4",
+  "default_value": "abc123",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "xyz789",
+  "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
   "is_required": false,
-  "is_unique": false,
-  "label": "xyz789",
+  "is_unique": true,
+  "label": "abc123",
   "options": [CustomAttributeOptionInterface]
 }
 
    
@@ -40884,9 +40879,9 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "is_default": false,
-  "label": "abc123",
-  "value": "abc123"
+  "is_default": true,
+  "label": "xyz789",
+  "value": "xyz789"
 }
 
    
                 
    
@@ -41442,23 +41437,23 @@ 
    Example
    
   "companies": UserCompaniesOutput,
   "compare_list": CompareList,
   "confirmation_status": "ACCOUNT_CONFIRMED",
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "custom_attributes": [AttributeValueInterface],
-  "date_of_birth": "xyz789",
+  "date_of_birth": "abc123",
   "default_billing": "abc123",
   "default_shipping": "xyz789",
-  "dob": "xyz789",
+  "dob": "abc123",
   "email": "xyz789",
   "firstname": "abc123",
-  "gender": 987,
+  "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",
+  "lastname": "abc123",
   "middlename": "xyz789",
   "orders": CustomerOrders,
   "prefix": "xyz789",
@@ -41478,10 +41473,10 @@ 
    Example
    
   "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]
@@ -41660,17 +41655,17 @@ 
    attributeCodes
                   
    Example
    
                   
    {
   "city": "xyz789",
-  "company": "xyz789",
+  "company": "abc123",
   "country_code": "AF",
-  "country_id": "abc123",
+  "country_id": "xyz789",
   "custom_attributes": [CustomerAddressAttribute],
   "custom_attributesV2": [AttributeValueInterface],
   "customer_id": 987,
-  "default_billing": false,
+  "default_billing": true,
   "default_shipping": true,
   "extension_attributes": [CustomerAddressAttribute],
   "fax": "xyz789",
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "id": 987,
   "lastname": "xyz789",
   "middlename": "xyz789",
@@ -41678,10 +41673,10 @@ 
    Example
    
   "prefix": "xyz789",
   "region": CustomerAddressRegion,
   "region_id": 123,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "suffix": "abc123",
-  "telephone": "abc123",
-  "uid": 4,
+  "telephone": "xyz789",
+  "uid": "4",
   "vat_id": "xyz789"
 }
 
    
@@ -41730,7 +41725,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "attribute_code": "abc123",
-  "value": "xyz789"
+  "value": "abc123"
 }
 
    
                 
    
@@ -41779,8 +41774,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "attribute_code": "abc123",
-  "value": "abc123"
+  "attribute_code": "xyz789",
+  "value": "xyz789"
 }
 
    
                 
    
@@ -41933,17 +41928,17 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "abc123",
+  "city": "xyz789",
   "company": "xyz789",
   "country_code": "AF",
   "country_id": "AF",
   "custom_attributes": [CustomerAddressAttributeInput],
   "custom_attributesV2": [AttributeValueInput],
   "default_billing": true,
-  "default_shipping": true,
-  "fax": "xyz789",
+  "default_shipping": false,
+  "fax": "abc123",
   "firstname": "abc123",
-  "lastname": "xyz789",
+  "lastname": "abc123",
   "middlename": "abc123",
   "postcode": "xyz789",
   "prefix": "xyz789",
@@ -41951,7 +41946,7 @@ 
    Example
    
   "street": ["xyz789"],
   "suffix": "xyz789",
   "telephone": "xyz789",
-  "vat_id": "abc123"
+  "vat_id": "xyz789"
 }
 
    
                 
    
@@ -42003,9 +41998,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "region": "xyz789",
+  "region": "abc123",
   "region_code": "abc123",
-  "region_id": 123
+  "region_id": 987
 }
 
    
                 
    
@@ -42061,8 +42056,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "region": "abc123",
-  "region_code": "xyz789",
-  "region_id": 987
+  "region_code": "abc123",
+  "region_id": 123
 }
 
    
                 
    
@@ -42112,7 +42107,7 @@ 
    Example
    
                   
    {
   "items": [CustomerAddress],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
    
                 
@@ -42221,9 +42216,9 @@ 
    Example
    
   "frontend_input": "BOOLEAN",
   "input_filter": "NONE",
   "is_required": false,
-  "is_unique": false,
-  "label": "xyz789",
-  "multiline_count": 123,
+  "is_unique": true,
+  "label": "abc123",
+  "multiline_count": 987,
   "options": [CustomAttributeOptionInterface],
   "sort_order": 987,
   "validate_rules": [ValidationRule]
@@ -42348,18 +42343,18 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "allow_remote_shopping_assistance": false,
+  "allow_remote_shopping_assistance": true,
   "custom_attributes": [AttributeValueInput],
   "date_of_birth": "abc123",
-  "dob": "abc123",
-  "email": "abc123",
-  "firstname": "abc123",
-  "gender": 123,
-  "is_subscribed": false,
+  "dob": "xyz789",
+  "email": "xyz789",
+  "firstname": "xyz789",
+  "gender": 987,
+  "is_subscribed": true,
   "lastname": "abc123",
-  "middlename": "xyz789",
+  "middlename": "abc123",
   "password": "xyz789",
-  "prefix": "xyz789",
+  "prefix": "abc123",
   "suffix": "xyz789",
   "taxvat": "xyz789"
 }
@@ -42424,7 +42419,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "date": "abc123",
-  "download_url": "abc123",
+  "download_url": "xyz789",
   "order_increment_id": "xyz789",
   "remaining_downloads": "abc123",
   "status": "xyz789"
@@ -42621,14 +42616,14 @@ 
    Example
    
   "dob": "xyz789",
   "email": "xyz789",
   "firstname": "xyz789",
-  "gender": 987,
+  "gender": 123,
   "is_subscribed": true,
   "lastname": "xyz789",
-  "middlename": "abc123",
-  "password": "xyz789",
-  "prefix": "abc123",
-  "suffix": "xyz789",
-  "taxvat": "xyz789"
+  "middlename": "xyz789",
+  "password": "abc123",
+  "prefix": "xyz789",
+  "suffix": "abc123",
+  "taxvat": "abc123"
 }
 
    
                 
    
@@ -42863,20 +42858,20 @@ 
    Example
    
   "applied_gift_cards": [ApplyGiftCardToOrder],
   "available_actions": ["REORDER"],
   "billing_address": OrderAddress,
-  "carrier": "abc123",
+  "carrier": "xyz789",
   "comments": [SalesCommentItem],
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "credit_memos": [CreditMemo],
   "customer_info": OrderCustomerInfo,
-  "email": "xyz789",
+  "email": "abc123",
   "gift_message": GiftMessage,
-  "gift_receipt_included": true,
+  "gift_receipt_included": false,
   "gift_wrapping": GiftWrapping,
-  "grand_total": 987.65,
-  "id": 4,
-  "increment_id": "xyz789",
+  "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",
@@ -42884,13 +42879,13 @@ 
    Example
    
   "order_number": "xyz789",
   "order_status_change_date": "xyz789",
   "payment_methods": [OrderPaymentMethod],
-  "printed_card_included": true,
+  "printed_card_included": false,
   "returns": Returns,
   "shipments": [OrderShipment],
   "shipping_address": OrderAddress,
   "shipping_method": "abc123",
   "status": "abc123",
-  "token": "abc123",
+  "token": "xyz789",
   "total": OrderTotal
 }
 
    
@@ -43230,7 +43225,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"uid": "4"}
+                  
    {"uid": 4}
 
    
                 
    
               
    
@@ -43302,7 +43297,7 @@ 
    Example
    
                   
    {
   "balance_history": CustomerStoreCreditHistory,
   "current_balance": Money,
-  "enabled": true
+  "enabled": false
 }
 
    
                 
@@ -43413,10 +43408,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "action": "xyz789",
+  "action": "abc123",
   "actual_balance": Money,
   "balance_change": Money,
-  "date_time_changed": "abc123"
+  "date_time_changed": "xyz789"
 }
 
    
                 
    
@@ -43566,17 +43561,17 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "allow_remote_shopping_assistance": true,
+  "allow_remote_shopping_assistance": false,
   "custom_attributes": [AttributeValueInput],
   "date_of_birth": "xyz789",
   "dob": "xyz789",
   "firstname": "abc123",
   "gender": 123,
-  "is_subscribed": true,
+  "is_subscribed": false,
   "lastname": "xyz789",
   "middlename": "xyz789",
-  "prefix": "xyz789",
-  "suffix": "xyz789",
+  "prefix": "abc123",
+  "suffix": "abc123",
   "taxvat": "xyz789"
 }
 
    
@@ -43650,12 +43645,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "option_id": 987,
-  "product_sku": "xyz789",
+  "option_id": 123,
+  "product_sku": "abc123",
   "required": false,
   "sort_order": 123,
   "title": "abc123",
-  "uid": "4",
+  "uid": 4,
   "value": CustomizableAreaValue
 }
 
    
@@ -43718,10 +43713,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "max_characters": 123,
-  "price": 123.45,
+  "max_characters": 987,
+  "price": 987.65,
   "price_type": "FIXED",
-  "sku": "xyz789",
+  "sku": "abc123",
   "uid": 4
 }
 
    
@@ -43791,7 +43786,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "option_id": 123,
-  "required": false,
+  "required": true,
   "sort_order": 987,
   "title": "xyz789",
   "uid": 4,
@@ -43867,13 +43862,13 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "option_type_id": 123,
-  "price": 987.65,
+  "option_type_id": 987,
+  "price": 123.45,
   "price_type": "FIXED",
   "sku": "xyz789",
   "sort_order": 987,
   "title": "xyz789",
-  "uid": "4"
+  "uid": 4
 }
 
    
                 
    
@@ -43947,10 +43942,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "option_id": 987,
-  "product_sku": "abc123",
-  "required": false,
-  "sort_order": 987,
-  "title": "abc123",
+  "product_sku": "xyz789",
+  "required": true,
+  "sort_order": 123,
+  "title": "xyz789",
   "uid": 4,
   "value": CustomizableDateValue
 }
@@ -44070,11 +44065,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "price": 987.65,
+  "price": 123.45,
   "price_type": "FIXED",
-  "sku": "xyz789",
+  "sku": "abc123",
   "type": "DATE",
-  "uid": "4"
+  "uid": 4
 }
 
    
                 
    
@@ -44142,10 +44137,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "option_id": 123,
+  "option_id": 987,
   "required": true,
   "sort_order": 987,
-  "title": "xyz789",
+  "title": "abc123",
   "uid": "4",
   "value": [CustomizableDropDownValue]
 }
@@ -44219,10 +44214,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "option_type_id": 123,
-  "price": 987.65,
+  "option_type_id": 987,
+  "price": 123.45,
   "price_type": "FIXED",
-  "sku": "xyz789",
+  "sku": "abc123",
   "sort_order": 123,
   "title": "xyz789",
   "uid": 4
@@ -44299,11 +44294,11 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "option_id": 123,
-  "product_sku": "xyz789",
-  "required": false,
+  "product_sku": "abc123",
+  "required": true,
   "sort_order": 987,
   "title": "xyz789",
-  "uid": "4",
+  "uid": 4,
   "value": CustomizableFieldValue
 }
 
    
@@ -44367,7 +44362,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "max_characters": 123,
-  "price": 987.65,
+  "price": 123.45,
   "price_type": "FIXED",
   "sku": "abc123",
   "uid": "4"
@@ -44445,9 +44440,9 @@ 
    Example
    
                   
    {
   "option_id": 987,
   "product_sku": "abc123",
-  "required": false,
-  "sort_order": 123,
-  "title": "xyz789",
+  "required": true,
+  "sort_order": 987,
+  "title": "abc123",
   "uid": 4,
   "value": CustomizableFileValue
 }
@@ -44523,8 +44518,8 @@ 
    Example
    
                   
    {
   "file_extension": "xyz789",
   "image_size_x": 987,
-  "image_size_y": 987,
-  "price": 987.65,
+  "image_size_y": 123,
+  "price": 123.45,
   "price_type": "FIXED",
   "sku": "xyz789",
   "uid": 4
@@ -44596,8 +44591,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "option_id": 987,
-  "required": false,
-  "sort_order": 987,
+  "required": true,
+  "sort_order": 123,
   "title": "abc123",
   "uid": "4",
   "value": [CustomizableMultipleValue]
@@ -44673,12 +44668,12 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "option_type_id": 987,
-  "price": 123.45,
+  "price": 987.65,
   "price_type": "FIXED",
   "sku": "xyz789",
   "sort_order": 987,
   "title": "abc123",
-  "uid": "4"
+  "uid": 4
 }
 
    
                 
    
@@ -44733,9 +44728,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": 987,
-  "uid": 4,
-  "value_string": "abc123"
+  "id": 123,
+  "uid": "4",
+  "value_string": "xyz789"
 }
 
    
                 
    
@@ -44850,9 +44845,9 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "option_id": 123,
-  "required": true,
-  "sort_order": 123,
+  "option_id": 987,
+  "required": false,
+  "sort_order": 987,
   "title": "abc123",
   "uid": "4"
 }
@@ -45004,11 +44999,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "option_id": 123,
-  "required": true,
-  "sort_order": 123,
+  "option_id": 987,
+  "required": false,
+  "sort_order": 987,
   "title": "abc123",
-  "uid": 4,
+  "uid": "4",
   "value": [CustomizableRadioValue]
 }
 
    
@@ -45081,10 +45076,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "option_type_id": 123,
+  "option_type_id": 987,
   "price": 987.65,
   "price_type": "FIXED",
-  "sku": "abc123",
+  "sku": "xyz789",
   "sort_order": 987,
   "title": "xyz789",
   "uid": 4
@@ -45168,7 +45163,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"success": true}
+                  
    {"success": false}
 
    
                 
    
               
    
@@ -45423,7 +45418,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"template_id": 4}
+                  
    {"template_id": "4"}
 
    
                 
    
               
    
@@ -45592,7 +45587,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "customerPaymentTokens": CustomerPaymentTokens,
-  "result": true
+  "result": false
 }
 
    
                 
    
@@ -45638,7 +45633,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"message": "xyz789", "type": "UNDEFINED"}
+                  
    {"message": "abc123", "type": "UNDEFINED"}
 
    
                 
    
               
    
@@ -45849,7 +45844,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"requisition_lists": RequisitionLists, "status": true}
+                  
    {"requisition_lists": RequisitionLists, "status": false}
 
    
                 
    
               
    
@@ -45894,7 +45889,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"status": true, "wishlists": [Wishlist]}
+                  
    {"status": false, "wishlists": [Wishlist]}
 
    
                 
    
               
    
@@ -45969,7 +45964,7 @@ 
    Example
    
   "applied_to": "ITEM",
   "coupon": AppliedCoupon,
   "is_discounting_locked": false,
-  "label": "xyz789",
+  "label": "abc123",
   "type": "xyz789",
   "value": 987.65
 }
@@ -46093,19 +46088,19 @@ 
    Example
    
   "customizable_options": [SelectedCustomizableOption],
   "discount": [Discount],
   "errors": [CartItemError],
-  "id": "xyz789",
-  "is_available": false,
+  "id": "abc123",
+  "is_available": true,
   "links": [DownloadableProductLinks],
   "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,
+  "quantity": 123.45,
   "samples": [DownloadableProductSamples],
-  "uid": "4"
+  "uid": 4
 }
 
    
                 
    
@@ -46184,12 +46179,12 @@ 
    Example
    
                   
    {
   "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_refunded": 123.45
+  "product_sku": "abc123",
+  "quantity_refunded": 987.65
 }
 
    
                 
    
@@ -46317,10 +46312,10 @@ 
    Example
    
   "downloadable_links": [DownloadableItemsLinks],
   "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
 }
 
    
                 
    
@@ -46372,9 +46367,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "sort_order": 987,
+  "sort_order": 123,
   "title": "abc123",
-  "uid": 4
+  "uid": "4"
 }
 
    
                 
    
@@ -46535,20 +46530,20 @@ 
    Example
    
   "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,
-  "quantity_ordered": 123.45,
+  "quantity_canceled": 123.45,
+  "quantity_invoiced": 123.45,
+  "quantity_ordered": 987.65,
   "quantity_refunded": 987.65,
-  "quantity_return_requested": 987.65,
-  "quantity_returned": 987.65,
+  "quantity_return_requested": 123.45,
+  "quantity_returned": 123.45,
   "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "xyz789"
+  "status": "abc123"
 }
 
    
                 
@@ -46964,11 +46959,11 @@ 
    currentPageExample
    
                   
    {
   "attribute_set_id": 123,
-  "canonical_url": "abc123",
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
   "color": 987,
-  "country_of_manufacture": "abc123",
-  "created_at": "xyz789",
+  "country_of_manufacture": "xyz789",
+  "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
@@ -46979,25 +46974,25 @@ 
    Example
    
     DownloadableProductSamples
   ],
   "gift_message_available": false,
-  "gift_wrapping_available": true,
+  "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
   "id": 123,
   "image": ProductImage,
-  "is_returnable": "xyz789",
+  "is_returnable": "abc123",
   "links_purchased_separately": 123,
-  "links_title": "abc123",
-  "manufacturer": 123,
+  "links_title": "xyz789",
+  "manufacturer": 987,
   "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
-  "meta_keyword": "abc123",
+  "meta_description": "xyz789",
+  "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": "abc123",
-  "only_x_left_in_stock": 987.65,
+  "only_x_left_in_stock": 123.45,
   "options": [CustomizableOptionInterface],
   "options_container": "xyz789",
   "price": ProductPrices,
@@ -47008,18 +47003,18 @@ 
    Example
    
   "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",
+  "sku": "abc123",
   "small_image": ProductImage,
-  "special_from_date": "xyz789",
-  "special_price": 123.45,
-  "special_to_date": "abc123",
+  "special_from_date": "abc123",
+  "special_price": 987.65,
+  "special_to_date": "xyz789",
   "staged": true,
   "stock_status": "IN_STOCK",
-  "swatch_image": "xyz789",
+  "swatch_image": "abc123",
   "thumbnail": ProductImage,
   "tier_price": 987.65,
   "tier_prices": [ProductTierPrices],
@@ -47031,7 +47026,7 @@ 
    Example
    
   "url_key": "abc123",
   "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "abc123",
+  "url_suffix": "xyz789",
   "websites": [Website]
 }
 
    
@@ -47195,12 +47190,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": 123,
-  "is_shareable": false,
+  "id": 987,
+  "is_shareable": true,
   "link_type": "FILE",
-  "number_of_downloads": 987,
+  "number_of_downloads": 123,
   "price": 987.65,
-  "sample_file": "xyz789",
+  "sample_file": "abc123",
   "sample_type": "FILE",
   "sample_url": "abc123",
   "sort_order": 987,
@@ -47247,7 +47242,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"link_id": 987}
+                  
    {"link_id": 123}
 
    
                 
    
               
    
@@ -47320,9 +47315,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "id": 987,
-  "sample_file": "abc123",
+  "sample_file": "xyz789",
   "sample_type": "FILE",
-  "sample_url": "xyz789",
+  "sample_url": "abc123",
   "sort_order": 987,
   "title": "xyz789"
 }
@@ -47530,7 +47525,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "duplicated_quote_uid": "4",
-  "quote_uid": 4
+  "quote_uid": "4"
 }
 
    
                 
    
@@ -47904,7 +47899,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "attribute_code": "xyz789",
+  "attribute_code": "abc123",
   "value": "xyz789"
 }
 
    
@@ -47953,7 +47948,10 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"uid": 4, "value": "xyz789"}
+                  
    {
+  "uid": "4",
+  "value": "xyz789"
+}
 
    
                 
    
               
    
@@ -48023,10 +48021,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "canonical_url": "xyz789",
-  "entity_uid": 4,
+  "entity_uid": "4",
   "id": 123,
-  "redirectCode": 987,
-  "relative_url": "abc123",
+  "redirectCode": 123,
+  "relative_url": "xyz789",
   "type": "CMS_PAGE"
 }
 
    
@@ -48216,7 +48214,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "country_code": "AF",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "region": CustomerAddressRegionInput
 }
 
    
@@ -48399,7 +48397,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "customer": Customer,
-  "token": "abc123"
+  "token": "xyz789"
 }
 
    
                 
    
@@ -48518,13 +48516,13 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "abc123",
-  "is_visible": false,
-  "payment_intent": "xyz789",
-  "payment_source": "xyz789",
+  "is_visible": true,
+  "payment_intent": "abc123",
+  "payment_source": "abc123",
   "sdk_params": [SDKParams],
   "sort_order": "abc123",
   "three_ds_mode": "OFF",
-  "title": "abc123"
+  "title": "xyz789"
 }
 
    
                 
@@ -48573,7 +48571,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "payment_source": "xyz789",
+  "payment_source": "abc123",
   "paypal_fastlane_token": "xyz789"
 }
 
    
@@ -48766,7 +48764,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "from": "abc123",
-  "to": "xyz789"
+  "to": "abc123"
 }
 
    
                 
    
@@ -48822,8 +48820,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "eq": "xyz789",
-  "in": ["abc123"],
-  "match": "abc123"
+  "in": ["xyz789"],
+  "match": "xyz789"
 }
 
    
                 
@@ -48951,21 +48949,21 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "eq": "abc123",
+  "eq": "xyz789",
   "finset": ["xyz789"],
   "from": "xyz789",
   "gt": "abc123",
   "gteq": "abc123",
   "in": ["abc123"],
-  "like": "xyz789",
+  "like": "abc123",
   "lt": "abc123",
   "lteq": "abc123",
   "moreq": "xyz789",
-  "neq": "abc123",
-  "nin": ["abc123"],
+  "neq": "xyz789",
+  "nin": ["xyz789"],
   "notnull": "xyz789",
-  "null": "xyz789",
-  "to": "abc123"
+  "null": "abc123",
+  "to": "xyz789"
 }
 
    
                 
    
@@ -49013,7 +49011,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "amount": Money,
-  "label": "xyz789"
+  "label": "abc123"
 }
 
    
                 
@@ -49142,7 +49140,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"customer_email": "abc123"}
+                  
    {"customer_email": "xyz789"}
 
    
                 
    
               
    
@@ -49182,7 +49180,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"customer_token": "abc123"}
+                  
    {"customer_token": "xyz789"}
 
    
                 
    
               
    
@@ -49223,7 +49221,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"template_id": "4"}
+                  
    {"template_id": 4}
 
    
                 
    
               
    
@@ -49356,7 +49354,7 @@ 
    Example
    
                   
    {
   "balance": Money,
   "code": "xyz789",
-  "expiration_date": "xyz789"
+  "expiration_date": "abc123"
 }
 
    
                 
@@ -49466,10 +49464,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "attribute_id": 123,
-  "uid": "4",
+  "uid": 4,
   "value": 987.65,
   "value_id": 123,
-  "website_id": 987,
+  "website_id": 123,
   "website_value": 987.65
 }
 
    
@@ -49631,22 +49629,22 @@ 
    Example
    
   "errors": [CartItemError],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "abc123",
-  "is_available": true,
+  "id": "xyz789",
+  "is_available": false,
   "max_qty": 123.45,
-  "message": "abc123",
-  "min_qty": 987.65,
-  "not_available_message": "xyz789",
+  "message": "xyz789",
+  "min_qty": 123.45,
+  "not_available_message": "abc123",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "recipient_email": "abc123",
   "recipient_name": "abc123",
-  "sender_email": "xyz789",
+  "sender_email": "abc123",
   "sender_name": "abc123",
-  "uid": 4
+  "uid": "4"
 }
    @@ -49725,8 +49723,8 @@
    Example
    "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 987.65 + "product_sku": "abc123", + "quantity_refunded": 123.45 }     @@ -49803,10 +49801,10 @@
    Example
    "gift_card": GiftCardItem, "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 }     @@ -49868,11 +49866,11 @@
    Fields
    Example
    {
-  "message": "abc123",
-  "recipient_email": "abc123",
-  "recipient_name": "xyz789",
-  "sender_email": "abc123",
-  "sender_name": "xyz789"
+  "message": "xyz789",
+  "recipient_email": "xyz789",
+  "recipient_name": "abc123",
+  "sender_email": "xyz789",
+  "sender_name": "abc123"
 }
    @@ -49947,10 +49945,10 @@
    Example
    "amount": Money, "custom_giftcard_amount": Money, "message": "xyz789", - "recipient_email": "xyz789", - "recipient_name": "xyz789", + "recipient_email": "abc123", + "recipient_name": "abc123", "sender_email": "xyz789", - "sender_name": "abc123" + "sender_name": "xyz789" }     @@ -50104,18 +50102,18 @@
    Example
    "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": "xyz789", + "product_sku": "abc123", "product_type": "abc123", "product_url_key": "abc123", - "quantity_canceled": 987.65, + "quantity_canceled": 123.45, "quantity_invoiced": 123.45, "quantity_ordered": 123.45, - "quantity_refunded": 123.45, + "quantity_refunded": 987.65, "quantity_return_requested": 123.45, "quantity_returned": 123.45, "quantity_shipped": 987.65, @@ -50571,7 +50569,7 @@
    currentPageExample
    {
   "allow_message": false,
-  "allow_open_amount": false,
+  "allow_open_amount": true,
   "attribute_set_id": 987,
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
@@ -50582,30 +50580,30 @@ 
    Example
    
   "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,
   "image": ProductImage,
-  "is_redeemable": false,
-  "is_returnable": "xyz789",
-  "lifetime": 123,
-  "manufacturer": 123,
+  "is_redeemable": true,
+  "is_returnable": "abc123",
+  "lifetime": 987,
+  "manufacturer": 987,
   "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
   "message_max_length": 987,
   "meta_description": "abc123",
-  "meta_keyword": "xyz789",
-  "meta_title": "abc123",
-  "min_sale_qty": 123.45,
-  "name": "xyz789",
-  "new_from_date": "abc123",
+  "meta_keyword": "abc123",
+  "meta_title": "xyz789",
+  "min_sale_qty": 987.65,
+  "name": "abc123",
+  "new_from_date": "xyz789",
   "new_to_date": "xyz789",
-  "only_x_left_in_stock": 987.65,
-  "open_amount_max": 987.65,
+  "only_x_left_in_stock": 123.45,
+  "open_amount_max": 123.45,
   "open_amount_min": 987.65,
   "options": [CustomizableOptionInterface],
   "options_container": "abc123",
@@ -50613,36 +50611,36 @@ 
    Example
    
   "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": "abc123",
-  "review_count": 987,
+  "relative_url": "xyz789",
+  "review_count": 123,
   "reviews": ProductReviews,
   "short_description": ComplexTextValue,
-  "sku": "xyz789",
+  "sku": "abc123",
   "small_image": ProductImage,
   "special_from_date": "abc123",
-  "special_price": 123.45,
+  "special_price": 987.65,
   "special_to_date": "abc123",
-  "staged": true,
+  "staged": false,
   "stock_status": "IN_STOCK",
   "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": "xyz789",
+  "uid": 4,
+  "updated_at": "abc123",
   "upsell_products": [ProductInterface],
-  "url_key": "xyz789",
-  "url_path": "abc123",
+  "url_key": "abc123",
+  "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
   "url_suffix": "abc123",
   "websites": [Website],
-  "weight": 987.65
+  "weight": 123.45
 }
    @@ -50707,8 +50705,8 @@
    Example
    "customizable_options": [SelectedCustomizableOption], "gift_card_options": GiftCardOptions, "product": ProductInterface, - "quantity": 123.45, - "uid": "4" + "quantity": 987.65, + "uid": 4 }     @@ -50777,7 +50775,7 @@
    Fields
    Example
    {
   "gift_card": GiftCardItem,
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
@@ -50910,9 +50908,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "added_at": "abc123",
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
+  "description": "abc123",
   "gift_card_options": GiftCardOptions,
   "id": "4",
   "product": ProductInterface,
@@ -50962,10 +50960,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {
-  "code": "4",
-  "options": ["xyz789"]
-}
+                  
    {"code": 4, "options": ["xyz789"]}
 
    
                 
    
               
    
@@ -51016,8 +51011,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "from": "xyz789",
-  "message": "abc123",
+  "from": "abc123",
+  "message": "xyz789",
   "to": "abc123"
 }
 
    
@@ -51073,9 +51068,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "from": "xyz789",
+  "from": "abc123",
   "message": "abc123",
-  "to": "xyz789"
+  "to": "abc123"
 }
 
    
                 
    
@@ -51248,14 +51243,14 @@ 
    Example
    
   "dynamic_attributes": [GiftRegistryDynamicAttribute],
   "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"
 }
 
    
                 
    
@@ -51438,7 +51433,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "4",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
    
                 
@@ -51508,7 +51503,7 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "code": 4,
+  "code": "4",
   "label": "xyz789",
   "value": "abc123"
 }
@@ -51573,9 +51568,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "attribute_group": "abc123",
+  "attribute_group": "xyz789",
   "code": 4,
-  "input_type": "xyz789",
+  "input_type": "abc123",
   "is_required": false,
   "label": "xyz789",
   "sort_order": 987
@@ -51659,11 +51654,11 @@ 
    Possible Types
    
                   
    Example
    
                   
    {
   "attribute_group": "xyz789",
-  "code": 4,
+  "code": "4",
   "input_type": "abc123",
-  "is_required": true,
+  "is_required": false,
   "label": "abc123",
-  "sort_order": 987
+  "sort_order": 123
 }
 
    
                 
    
@@ -51730,7 +51725,7 @@ 
    Example
    
   "note": "xyz789",
   "product": ProductInterface,
   "quantity": 987.65,
-  "quantity_fulfilled": 987.65,
+  "quantity_fulfilled": 123.45,
   "uid": 4
 }
 
    
@@ -51815,8 +51810,8 @@ 
    Example
    
   "note": "xyz789",
   "product": ProductInterface,
   "quantity": 987.65,
-  "quantity_fulfilled": 123.45,
-  "uid": 4
+  "quantity_fulfilled": 987.65,
+  "uid": "4"
 }
    @@ -51945,9 +51940,9 @@
    Example
    {
   "code": "OUT_OF_STOCK",
   "gift_registry_item_uid": "4",
-  "gift_registry_uid": 4,
+  "gift_registry_uid": "4",
   "message": "xyz789",
-  "product_uid": "4"
+  "product_uid": 4
 }
    @@ -52173,8 +52168,8 @@
    Example
    ], "email": "xyz789", "firstname": "xyz789", - "lastname": "abc123", - "uid": "4" + "lastname": "xyz789", + "uid": 4 }     @@ -52222,7 +52217,7 @@
    Fields
    Example
    {
-  "code": 4,
+  "code": "4",
   "label": "abc123",
   "value": "xyz789"
 }
@@ -52292,11 +52287,11 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "event_date": "xyz789",
-  "event_title": "xyz789",
-  "gift_registry_uid": 4,
-  "location": "abc123",
-  "name": "xyz789",
-  "type": "xyz789"
+  "event_title": "abc123",
+  "gift_registry_uid": "4",
+  "location": "xyz789",
+  "name": "abc123",
+  "type": "abc123"
 }
    @@ -52458,7 +52453,7 @@
    Example
    GiftRegistryDynamicAttributeMetadataInterface ], "label": "abc123", - "uid": "4" + "uid": 4 }     @@ -52521,7 +52516,7 @@
    Fields
    Example
    {
-  "design": "abc123",
+  "design": "xyz789",
   "id": 4,
   "image": GiftWrappingImage,
   "price": Money,
@@ -52573,7 +52568,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "label": "abc123",
-  "url": "abc123"
+  "url": "xyz789"
 }
    @@ -52702,12 +52697,12 @@
    Fields
    Example
    {
   "button_styles": GooglePayButtonStyles,
-  "code": "abc123",
-  "is_visible": true,
-  "payment_intent": "xyz789",
-  "payment_source": "xyz789",
+  "code": "xyz789",
+  "is_visible": false,
+  "payment_intent": "abc123",
+  "payment_source": "abc123",
   "sdk_params": [SDKParams],
-  "sort_order": "abc123",
+  "sort_order": "xyz789",
   "three_ds_mode": "OFF",
   "title": "abc123"
 }
@@ -52764,8 +52759,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "payment_source": "abc123",
-  "payments_order_id": "abc123",
+  "payment_source": "xyz789",
+  "payments_order_id": "xyz789",
   "paypal_order_id": "abc123"
 }
 
    
@@ -53166,53 +53161,53 @@ 
    currentPage
                   
    Example
    
                   
    {
-  "attribute_set_id": 987,
+  "attribute_set_id": 123,
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
   "color": 987,
-  "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": true,
-  "gift_wrapping_available": false,
+  "gift_message_available": false,
+  "gift_wrapping_available": true,
   "gift_wrapping_price": Money,
   "id": 123,
   "image": ProductImage,
   "is_returnable": "abc123",
   "items": [GroupedProductItem],
-  "manufacturer": 987,
+  "manufacturer": 123,
   "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": "xyz789",
+  "name": "abc123",
   "new_from_date": "xyz789",
   "new_to_date": "xyz789",
   "only_x_left_in_stock": 987.65,
-  "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",
-  "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": 123.45,
+  "special_price": 987.65,
   "special_to_date": "abc123",
-  "staged": true,
+  "staged": false,
   "stock_status": "IN_STOCK",
   "swatch_image": "abc123",
   "thumbnail": ProductImage,
@@ -53223,7 +53218,7 @@ 
    Example
    
   "uid": "4",
   "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
-  "url_key": "abc123",
+  "url_key": "xyz789",
   "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
   "url_suffix": "xyz789",
@@ -53282,7 +53277,7 @@ 
    Example
    
                   
    {
   "position": 987,
   "product": ProductInterface,
-  "qty": 123.45
+  "qty": 987.65
 }
 
    
                 
    
@@ -53349,7 +53344,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "added_at": "xyz789",
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
   "id": 4,
@@ -53403,7 +53398,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "reason": "abc123",
+  "reason": "xyz789",
   "token": "abc123"
 }
 
    
@@ -53459,7 +53454,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "abc123",
+  "email": "xyz789",
   "lastname": "xyz789",
   "number": "xyz789"
 }
@@ -53556,11 +53551,11 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "cc_vault_code": "abc123",
-  "code": "xyz789",
-  "is_vault_enabled": true,
+  "code": "abc123",
+  "is_vault_enabled": false,
   "is_visible": false,
-  "payment_intent": "abc123",
-  "payment_source": "xyz789",
+  "payment_intent": "xyz789",
+  "payment_source": "abc123",
   "requires_card_details": true,
   "sdk_params": [SDKParams],
   "sort_order": "xyz789",
@@ -53659,13 +53654,13 @@ 
    Example
    
                   
    {
   "cardBin": "xyz789",
   "cardExpiryMonth": "abc123",
-  "cardExpiryYear": "xyz789",
+  "cardExpiryYear": "abc123",
   "cardLast4": "xyz789",
-  "holderName": "abc123",
-  "is_active_payment_token_enabler": false,
+  "holderName": "xyz789",
+  "is_active_payment_token_enabler": true,
   "payment_source": "xyz789",
   "payments_order_id": "abc123",
-  "paypal_order_id": "abc123"
+  "paypal_order_id": "xyz789"
 }
 
    
                 
    
@@ -53756,7 +53751,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"secure_form_url": "abc123"}
+                  
    {"secure_form_url": "xyz789"}
 
    
                 
    
               
    
@@ -53843,8 +53838,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "name": "abc123",
-  "value": "xyz789"
+  "name": "xyz789",
+  "value": "abc123"
 }
 
    
                 
    
@@ -53909,7 +53904,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "thumbnail": "xyz789",
+  "thumbnail": "abc123",
   "value": "abc123"
 }
 
    
@@ -54024,7 +54019,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "PRODUCT_NOT_FOUND",
-  "message": "abc123",
+  "message": "xyz789",
   "quantity": 123.45
 }
 
    
@@ -54088,7 +54083,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"message": "abc123"}
+                  
    {"message": "xyz789"}
 
    
                 
    
               
    
@@ -54150,9 +54145,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "comments": [SalesCommentItem],
-  "id": 4,
+  "id": "4",
   "items": [InvoiceItemInterface],
-  "number": "abc123",
+  "number": "xyz789",
   "total": InvoiceTotal
 }
 
    
@@ -54224,9 +54219,9 @@ 
    Example
    
   "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": 123.45
 }
 
    
@@ -54332,7 +54327,7 @@ 
    Possible Types
    
                   
    Example
    
                   
    {
   "discounts": [Discount],
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
@@ -54542,7 +54537,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"is_role_name_available": true}
+                  
    {"is_role_name_available": false}
 
    
                 
    
               
    
@@ -54622,7 +54617,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"is_email_available": false}
+                  
    {"is_email_available": true}
 
    
                 
    
               
    
@@ -54688,12 +54683,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "creator_id": 987,
-  "creator_type": 987,
-  "negotiable_quote_item_uid": 4,
-  "note": "xyz789",
-  "note_uid": 4
+  "creator_type": 123,
+  "negotiable_quote_item_uid": "4",
+  "note": "abc123",
+  "note_uid": "4"
 }
 
    
                 
    
@@ -54753,7 +54748,7 @@ 
    Example
    
                   
    {
   "id": 4,
   "label": "abc123",
-  "uid": "4",
+  "uid": 4,
   "values": [ItemSelectedBundleOptionValue]
 }
 
    
@@ -54822,12 +54817,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": 4,
+  "id": "4",
   "price": Money,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sku": "abc123",
-  "quantity": 123.45,
-  "uid": "4"
+  "quantity": 987.65,
+  "uid": 4
 }
 
    
                 
    
@@ -54874,7 +54869,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "name": "xyz789",
+  "name": "abc123",
   "value": "xyz789"
 }
 
    
@@ -54937,9 +54932,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "filter_items": [LayerFilterItemInterface],
-  "filter_items_count": 987,
-  "name": "xyz789",
-  "request_var": "abc123"
+  "filter_items_count": 123,
+  "name": "abc123",
+  "request_var": "xyz789"
 }
 
    
                 
    
@@ -54990,9 +54985,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "items_count": 987,
-  "label": "xyz789",
-  "value_string": "xyz789"
+  "items_count": 123,
+  "label": "abc123",
+  "value_string": "abc123"
 }
 
    
                 
    
@@ -55065,8 +55060,8 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "items_count": 987,
-  "label": "abc123",
+  "items_count": 123,
+  "label": "xyz789",
   "value_string": "xyz789"
 }
 
    
@@ -55122,8 +55117,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "note": "abc123",
-  "quote_item_uid": "4",
+  "note": "xyz789",
+  "quote_item_uid": 4,
   "quote_uid": 4
 }
 
    
@@ -55213,10 +55208,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "content": ProductMediaGalleryEntriesContent,
-  "disabled": true,
+  "disabled": false,
   "file": "xyz789",
-  "id": 123,
-  "label": "xyz789",
+  "id": 987,
+  "label": "abc123",
   "media_type": "xyz789",
   "position": 123,
   "types": ["abc123"],
@@ -55435,7 +55430,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"currency": "AFN", "value": 987.65}
+                  
    {"currency": "AFN", "value": 123.45}
 
    
                 
    
               
    
@@ -55530,7 +55525,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"requisitionListItemUids": [4]}
+                  
    {"requisitionListItemUids": ["4"]}
 
    
                 
    
               
    
@@ -55632,7 +55627,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "quote_item_uid": 4,
+  "quote_item_uid": "4",
   "quote_uid": 4,
   "requisition_list_uid": "4"
 }
@@ -55857,16 +55852,16 @@ 
    Example
    
   "created_at": "abc123",
   "email": "abc123",
   "history": [NegotiableQuoteHistoryEntry],
-  "is_virtual": true,
+  "is_virtual": false,
   "items": [CartItemInterface],
   "name": "abc123",
   "prices": CartPrices,
   "selected_payment_method": SelectedPaymentMethod,
   "shipping_addresses": [NegotiableQuoteShippingAddress],
   "status": "SUBMITTED",
-  "total_quantity": 123.45,
-  "uid": "4",
-  "updated_at": "xyz789"
+  "total_quantity": 987.65,
+  "uid": 4,
+  "updated_at": "abc123"
 }
 
    
                 
    
@@ -55914,7 +55909,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "xyz789",
-  "label": "abc123"
+  "label": "xyz789"
 }
 
    
                 
    
@@ -56018,16 +56013,16 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "city": "xyz789",
-  "company": "xyz789",
-  "country_code": "xyz789",
-  "firstname": "abc123",
-  "lastname": "abc123",
+  "company": "abc123",
+  "country_code": "abc123",
+  "firstname": "xyz789",
+  "lastname": "xyz789",
   "postcode": "xyz789",
-  "region": "abc123",
+  "region": "xyz789",
   "region_id": 987,
-  "save_in_address_book": true,
-  "street": ["abc123"],
-  "telephone": "xyz789"
+  "save_in_address_book": false,
+  "street": ["xyz789"],
+  "telephone": "abc123"
 }
 
    
                 
    
@@ -56128,14 +56123,14 @@ 
    Possible Types
    
                   
    Example
    
                   
    {
   "city": "abc123",
-  "company": "xyz789",
+  "company": "abc123",
   "country": NegotiableQuoteAddressCountry,
   "firstname": "abc123",
   "lastname": "abc123",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "region": NegotiableQuoteAddressRegion,
   "street": ["xyz789"],
-  "telephone": "abc123"
+  "telephone": "xyz789"
 }
 
    
                 
    
@@ -56187,9 +56182,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "xyz789",
+  "code": "abc123",
   "label": "xyz789",
-  "region_id": 123
+  "region_id": 987
 }
 
    
                 
    
@@ -56267,14 +56262,14 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "abc123",
-  "company": "abc123",
+  "city": "xyz789",
+  "company": "xyz789",
   "country": NegotiableQuoteAddressCountry,
-  "firstname": "xyz789",
-  "lastname": "abc123",
-  "postcode": "xyz789",
+  "firstname": "abc123",
+  "lastname": "xyz789",
+  "postcode": "abc123",
   "region": NegotiableQuoteAddressRegion,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "telephone": "xyz789"
 }
 
    
@@ -56338,8 +56333,8 @@ 
    Example
    
                   
    {
   "address": NegotiableQuoteAddressInput,
   "customer_address_uid": 4,
-  "same_as_shipping": true,
-  "use_for_shipping": true
+  "same_as_shipping": false,
+  "use_for_shipping": false
 }
 
    
                 
    
@@ -56492,7 +56487,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"comment": "xyz789"}
+                  
    {"comment": "abc123"}
 
    
                 
    
               
    
@@ -56543,8 +56538,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "new_value": "abc123",
-  "old_value": "xyz789",
+  "new_value": "xyz789",
+  "old_value": "abc123",
   "title": "abc123"
 }
 
    
@@ -56772,7 +56767,7 @@ 
    Example
    
   "author": NegotiableQuoteUser,
   "change_type": "CREATED",
   "changes": NegotiableQuoteHistoryChanges,
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "uid": "4"
 }
    @@ -56880,7 +56875,7 @@
    Fields
    Example
    {
   "new_expiration": "abc123",
-  "old_expiration": "xyz789"
+  "old_expiration": "abc123"
 }
    @@ -57149,7 +57144,7 @@
    Fields
    Example
    - 
    {"quantity": 987.65, "quote_item_uid": "4"}
+                  
    {"quantity": 123.45, "quote_item_uid": "4"}
    @@ -57198,7 +57193,7 @@
    Fields
    Example
    {
   "code": "xyz789",
-  "purchase_order_number": "xyz789"
+  "purchase_order_number": "abc123"
 }
    @@ -57256,7 +57251,7 @@
    Fields
    Example
    {
   "document_identifier": "xyz789",
-  "document_name": "abc123",
+  "document_name": "xyz789",
   "link_id": 4,
   "reference_document_url": "abc123"
 }
@@ -57347,16 +57342,16 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "available_shipping_methods": [AvailableShippingMethod],
-  "city": "xyz789",
+  "city": "abc123",
   "company": "xyz789",
   "country": NegotiableQuoteAddressCountry,
   "firstname": "abc123",
   "lastname": "xyz789",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "region": NegotiableQuoteAddressRegion,
   "selected_shipping_method": SelectedShippingMethod,
-  "street": ["xyz789"],
-  "telephone": "xyz789"
+  "street": ["abc123"],
+  "telephone": "abc123"
 }
 
    
                 
@@ -57412,8 +57407,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "address": NegotiableQuoteAddressInput,
-  "customer_address_uid": "4",
-  "customer_notes": "abc123"
+  "customer_address_uid": 4,
+  "customer_notes": "xyz789"
 }
 
    
                 
@@ -57729,12 +57724,12 @@ 
    Example
    
   "comments": [NegotiableQuoteComment],
   "expiration_date": "xyz789",
   "history": [NegotiableQuoteHistoryEntry],
-  "is_min_max_qty_used": false,
+  "is_min_max_qty_used": true,
   "is_virtual": true,
   "items": [CartItemInterface],
-  "max_order_commitment": 123,
-  "min_order_commitment": 987,
-  "name": "xyz789",
+  "max_order_commitment": 987,
+  "min_order_commitment": 123,
+  "name": "abc123",
   "notifications": [QuoteTemplateNotificationMessage],
   "prices": CartPrices,
   "reference_document_links": [
@@ -57743,7 +57738,7 @@ 
    Example
    
   "shipping_addresses": [NegotiableQuoteShippingAddress],
   "status": "xyz789",
   "template_id": 4,
-  "total_quantity": 987.65
+  "total_quantity": 123.45
 }
    @@ -57908,18 +57903,18 @@
    Example
    "activated_at": "xyz789", "company_name": "abc123", "expiration_date": "abc123", - "is_min_max_qty_used": false, - "last_shared_at": "xyz789", + "is_min_max_qty_used": true, + "last_shared_at": "abc123", "max_order_commitment": 987, "min_negotiated_grand_total": 987.65, - "min_order_commitment": 123, + "min_order_commitment": 987, "name": "abc123", - "orders_placed": 987, - "sales_rep_name": "xyz789", - "state": "xyz789", + "orders_placed": 123, + "sales_rep_name": "abc123", + "state": "abc123", "status": "xyz789", "submitted_by": "abc123", - "template_id": 4 + "template_id": "4" }     @@ -57979,12 +57974,7 @@
    Fields
    Example
    - 
    {
-  "item_id": "4",
-  "max_qty": 987.65,
-  "min_qty": 987.65,
-  "quantity": 123.45
-}
+                  
    {"item_id": 4, "max_qty": 123.45, "min_qty": 123.45, "quantity": 123.45}
    @@ -58044,9 +58034,9 @@
    Fields
    Example
    {
-  "document_identifier": "xyz789",
+  "document_identifier": "abc123",
   "document_name": "xyz789",
-  "link_id": "4",
+  "link_id": 4,
   "reference_document_url": "xyz789"
 }
    @@ -58103,8 +58093,8 @@
    Fields
    Example
    {
   "address": NegotiableQuoteAddressInput,
-  "customer_address_uid": 4,
-  "customer_notes": "abc123"
+  "customer_address_uid": "4",
+  "customer_notes": "xyz789"
 }
    @@ -58455,7 +58445,7 @@
    Example
    "items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 }     @@ -58502,7 +58492,7 @@
    Fields
    Example
    {
-  "message": "abc123",
+  "message": "xyz789",
   "uid": "4"
 }
    @@ -58545,7 +58535,7 @@
    Fields
    Example
    - 
    {"template_id": 4}
+                  
    {"template_id": "4"}
    @@ -58593,7 +58583,7 @@
    Fields
    Example
    {
-  "order_id": "xyz789",
+  "order_id": "abc123",
   "order_number": "abc123"
 }
    @@ -58780,22 +58770,22 @@
    attributeCodes
    Example
    {
-  "city": "xyz789",
+  "city": "abc123",
   "company": "abc123",
   "country_code": "AF",
   "custom_attributesV2": [AttributeValueInterface],
-  "fax": "xyz789",
+  "fax": "abc123",
   "firstname": "abc123",
   "lastname": "abc123",
-  "middlename": "xyz789",
+  "middlename": "abc123",
   "postcode": "abc123",
-  "prefix": "xyz789",
+  "prefix": "abc123",
   "region": "abc123",
   "region_id": 4,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "suffix": "abc123",
   "telephone": "abc123",
-  "vat_id": "abc123"
+  "vat_id": "xyz789"
 }
    @@ -58853,10 +58843,10 @@
    Fields
    Example
    {
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "lastname": "xyz789",
   "middlename": "xyz789",
-  "prefix": "xyz789",
+  "prefix": "abc123",
   "suffix": "xyz789"
 }
    @@ -59001,7 +58991,7 @@
    Fields
    Example
    {
   "discounts": [Discount],
-  "eligible_for_return": true,
+  "eligible_for_return": false,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
@@ -59012,12 +59002,12 @@ 
    Example
    
   "product_sale_price": Money,
   "product_sku": "abc123",
   "product_type": "abc123",
-  "product_url_key": "xyz789",
+  "product_url_key": "abc123",
   "quantity_canceled": 987.65,
-  "quantity_invoiced": 987.65,
-  "quantity_ordered": 987.65,
-  "quantity_refunded": 987.65,
-  "quantity_return_requested": 987.65,
+  "quantity_invoiced": 123.45,
+  "quantity_ordered": 123.45,
+  "quantity_refunded": 123.45,
+  "quantity_return_requested": 123.45,
   "quantity_returned": 987.65,
   "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
@@ -59206,27 +59196,27 @@ 
    Possible Types
    
                   
    Example
    
                   
    {
   "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_type": "xyz789",
-  "product_url_key": "xyz789",
+  "product_type": "abc123",
+  "product_url_key": "abc123",
   "quantity_canceled": 123.45,
-  "quantity_invoiced": 987.65,
-  "quantity_ordered": 987.65,
-  "quantity_refunded": 987.65,
+  "quantity_invoiced": 123.45,
+  "quantity_ordered": 123.45,
+  "quantity_refunded": 123.45,
   "quantity_return_requested": 123.45,
-  "quantity_returned": 987.65,
-  "quantity_shipped": 123.45,
+  "quantity_returned": 123.45,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "xyz789"
+  "status": "abc123"
 }
    @@ -59274,7 +59264,7 @@
    Fields
    Example
    {
   "label": "xyz789",
-  "value": "xyz789"
+  "value": "abc123"
 }
    @@ -59712,7 +59702,7 @@
    Fields
    Example
    {
   "payer_id": "xyz789",
-  "token": "abc123"
+  "token": "xyz789"
 }
    @@ -59767,7 +59757,7 @@
    Fields
    Example
    {
-  "cancel_url": "abc123",
+  "cancel_url": "xyz789",
   "error_url": "xyz789",
   "return_url": "xyz789"
 }
@@ -59877,7 +59867,7 @@ 
    Example
    
                   
    {
   "mode": "TEST",
   "paypal_url": "abc123",
-  "secure_token": "abc123",
+  "secure_token": "xyz789",
   "secure_token_id": "abc123"
 }
 
    
@@ -59920,7 +59910,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
 
    
                 
    
               
    
@@ -59969,7 +59959,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "cc_details": CreditCardDetailsInput,
-  "is_active_payment_token_enabler": false
+  "is_active_payment_token_enabler": true
 }
    @@ -60018,7 +60008,7 @@
    Fields
    Example
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "paypal_payload": "xyz789"
 }
    @@ -60104,7 +60094,7 @@
    Fields
    Example
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "urls": PayflowProUrlInput
 }
    @@ -60160,9 +60150,9 @@
    Fields
    Example
    {
-  "cancel_url": "xyz789",
+  "cancel_url": "abc123",
   "error_url": "abc123",
-  "return_url": "xyz789"
+  "return_url": "abc123"
 }
    @@ -60599,7 +60589,7 @@
    Example
    "braintree_googlepay_vault": BraintreeVaultInput, "braintree_paypal": BraintreeInput, "braintree_paypal_vault": BraintreeVaultInput, - "code": "xyz789", + "code": "abc123", "hosted_pro": HostedProInput, "payflow_express": PayflowExpressInput, "payflow_link": PayflowLinkInput, @@ -60670,9 +60660,9 @@
    Fields
    Example
    {
   "id": "xyz789",
-  "mp_order_id": "xyz789",
+  "mp_order_id": "abc123",
   "payment_source_details": PaymentSourceDetails,
-  "status": "abc123"
+  "status": "xyz789"
 }
    @@ -60890,9 +60880,9 @@
    Fields
    Example
    {
-  "details": "xyz789",
+  "details": "abc123",
   "payment_method_code": "abc123",
-  "public_hash": "xyz789",
+  "public_hash": "abc123",
   "type": "card"
 }
    @@ -60990,7 +60980,7 @@
    Fields
    Example
    {
   "payer_id": "xyz789",
-  "token": "xyz789"
+  "token": "abc123"
 }
    @@ -61057,11 +61047,11 @@
    Fields
    Example
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "code": "xyz789",
   "express_button": false,
   "urls": PaypalExpressUrlsInput,
-  "use_paypal_credit": false
+  "use_paypal_credit": true
 }
    @@ -61156,8 +61146,8 @@
    Fields
    Example
    {
-  "edit": "abc123",
-  "start": "xyz789"
+  "edit": "xyz789",
+  "start": "abc123"
 }
    @@ -61218,8 +61208,8 @@
    Fields
    Example
    {
-  "cancel_url": "xyz789",
-  "pending_url": "xyz789",
+  "cancel_url": "abc123",
+  "pending_url": "abc123",
   "return_url": "abc123",
   "success_url": "xyz789"
 }
@@ -61425,20 +61415,20 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "xyz789",
+  "city": "abc123",
   "contact_name": "abc123",
   "country_id": "abc123",
   "description": "xyz789",
   "email": "xyz789",
-  "fax": "xyz789",
+  "fax": "abc123",
   "latitude": 123.45,
-  "longitude": 987.65,
+  "longitude": 123.45,
   "name": "abc123",
-  "phone": "abc123",
+  "phone": "xyz789",
   "pickup_location_code": "abc123",
-  "postcode": "xyz789",
-  "region": "xyz789",
-  "region_id": 123,
+  "postcode": "abc123",
+  "region": "abc123",
+  "region_id": 987,
   "street": "xyz789"
 }
 
    
@@ -61733,7 +61723,7 @@ 
    Example
    
                   
    {
   "items": [PickupLocation],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
    
                 
    
@@ -61970,7 +61960,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"purchase_order_uid": "4"}
+                  
    {"purchase_order_uid": 4}
 
    
                 
    
               
    
@@ -62147,7 +62137,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
 
    
                 
    
               
    
@@ -62452,9 +62442,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "discount_percentage": 123.45,
-  "main_final_price": 987.65,
-  "main_price": 123.45
+  "discount_percentage": 987.65,
+  "main_final_price": 123.45,
+  "main_price": 987.65
 }
 
    
                 
    
@@ -62655,7 +62645,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "xyz789",
-  "value": "xyz789"
+  "value": "abc123"
 }
    @@ -62907,7 +62897,7 @@
    Fields
    Example
    - 
    {"amount_off": 987.65, "percent_off": 123.45}
+                  
    {"amount_off": 123.45, "percent_off": 987.65}
    @@ -63280,7 +63270,7 @@
    Example
    {
   "disabled": true,
   "label": "abc123",
-  "position": 987,
+  "position": 123,
   "types": ["xyz789"],
   "url": "abc123"
 }
@@ -63788,7 +63778,7 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "attribute_set_id": 987,
+  "attribute_set_id": 123,
   "canonical_url": "xyz789",
   "categories": [CategoryInterface],
   "color": 123,
@@ -63797,33 +63787,33 @@ 
    Example
    
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "gift_message_available": false,
-  "gift_wrapping_available": true,
+  "gift_message_available": true,
+  "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
   "id": 987,
   "image": ProductImage,
   "is_returnable": "xyz789",
-  "manufacturer": 987,
-  "max_sale_qty": 987.65,
+  "manufacturer": 123,
+  "max_sale_qty": 123.45,
   "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,
-  "name": "xyz789",
-  "new_from_date": "xyz789",
-  "new_to_date": "abc123",
+  "name": "abc123",
+  "new_from_date": "abc123",
+  "new_to_date": "xyz789",
   "only_x_left_in_stock": 123.45,
-  "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": 987.65,
   "related_products": [ProductInterface],
-  "review_count": 987,
+  "review_count": 123,
   "reviews": ProductReviews,
   "short_description": ComplexTextValue,
   "sku": "abc123",
@@ -63831,7 +63821,7 @@ 
    Example
    
   "special_from_date": "xyz789",
   "special_price": 987.65,
   "special_to_date": "xyz789",
-  "staged": true,
+  "staged": false,
   "stock_status": "IN_STOCK",
   "swatch_image": "xyz789",
   "thumbnail": ProductImage,
@@ -63842,9 +63832,9 @@ 
    Example
    
   "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]
 }
 
    
@@ -63909,9 +63899,9 @@ 
    Example
    
                   
    {
   "link_type": "xyz789",
   "linked_product_sku": "abc123",
-  "linked_product_type": "xyz789",
+  "linked_product_type": "abc123",
   "position": 987,
-  "sku": "xyz789"
+  "sku": "abc123"
 }
 
    
                 
    
@@ -63991,10 +63981,10 @@ 
    Possible Types
    
                   
    Example
    
                   
    {
   "link_type": "abc123",
-  "linked_product_sku": "abc123",
+  "linked_product_sku": "xyz789",
   "linked_product_type": "abc123",
-  "position": 123,
-  "sku": "abc123"
+  "position": 987,
+  "sku": "xyz789"
 }
    @@ -64046,9 +64036,9 @@
    Fields
    Example
    {
-  "base64_encoded_data": "xyz789",
+  "base64_encoded_data": "abc123",
   "name": "abc123",
-  "type": "abc123"
+  "type": "xyz789"
 }
    @@ -64116,11 +64106,11 @@
    Fields
    Example
    {
   "media_type": "abc123",
-  "video_description": "abc123",
+  "video_description": "xyz789",
   "video_metadata": "abc123",
   "video_provider": "abc123",
   "video_title": "xyz789",
-  "video_url": "xyz789"
+  "video_url": "abc123"
 }
    @@ -64309,8 +64299,8 @@
    Fields
    Example
    {
-  "average_rating": 123.45,
-  "created_at": "abc123",
+  "average_rating": 987.65,
+  "created_at": "xyz789",
   "nickname": "abc123",
   "product": ProductInterface,
   "ratings_breakdown": [ProductReviewRating],
@@ -64362,7 +64352,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "name": "xyz789",
+  "name": "abc123",
   "value": "xyz789"
 }
 
    
@@ -64465,8 +64455,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": "xyz789",
-  "name": "xyz789",
+  "id": "abc123",
+  "name": "abc123",
   "values": [ProductReviewRatingValueMetadata]
 }
 
    
@@ -64514,7 +64504,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "value": "abc123",
+  "value": "xyz789",
   "value_id": "xyz789"
 }
 
    
@@ -64719,11 +64709,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "customer_group_id": "xyz789",
+  "customer_group_id": "abc123",
   "percentage_value": 123.45,
-  "qty": 987.65,
-  "value": 987.65,
-  "website_id": 987.65
+  "qty": 123.45,
+  "value": 123.45,
+  "website_id": 123.45
 }
 
    
                 
    
@@ -64791,10 +64781,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "disabled": true,
-  "label": "xyz789",
-  "position": 123,
+  "label": "abc123",
+  "position": 987,
   "types": ["xyz789"],
-  "url": "xyz789",
+  "url": "abc123",
   "video_content": ProductMediaGalleryEntriesVideoContent
 }
 
    
@@ -64987,15 +64977,15 @@ 
    Example
    
   "approval_flow": [PurchaseOrderRuleApprovalFlow],
   "available_actions": ["REJECT"],
   "comments": [PurchaseOrderComment],
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "created_by": Customer,
   "history_log": [PurchaseOrderHistoryItem],
   "number": "xyz789",
   "order": CustomerOrder,
   "quote": Cart,
   "status": "PENDING",
-  "uid": 4,
-  "updated_at": "xyz789"
+  "uid": "4",
+  "updated_at": "abc123"
 }
    @@ -65107,7 +65097,7 @@
    Fields
    Example
    - 
    {"message": "xyz789", "type": "NOT_FOUND"}
+                  
    {"message": "abc123", "type": "NOT_FOUND"}
    @@ -65168,9 +65158,9 @@
    Fields
    Example
    {
-  "message": "abc123",
+  "message": "xyz789",
   "name": "abc123",
-  "role": "abc123",
+  "role": "xyz789",
   "status": "PENDING",
   "updated_at": "xyz789"
 }
@@ -65315,8 +65305,8 @@ 
    Example
    
   "approver_roles": [CompanyRole],
   "condition": PurchaseOrderApprovalRuleConditionInterface,
   "created_at": "abc123",
-  "created_by": "xyz789",
-  "description": "abc123",
+  "created_by": "abc123",
+  "description": "xyz789",
   "name": "xyz789",
   "status": "ENABLED",
   "uid": "4",
@@ -65623,10 +65613,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "applies_to": ["4"],
+  "applies_to": [4],
   "approvers": [4],
   "condition": CreatePurchaseOrderApprovalRuleConditionInput,
-  "description": "abc123",
+  "description": "xyz789",
   "name": "abc123",
   "status": "ENABLED"
 }
@@ -65833,7 +65823,7 @@ 
    Example
    
                   
    {
   "items": [PurchaseOrderApprovalRule],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
    
                 
    
@@ -66017,7 +66007,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "activity": "abc123",
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "message": "xyz789",
   "uid": "4"
 }
@@ -66470,8 +66460,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "item_id": 4,
-  "note": "abc123",
+  "item_id": "4",
+  "note": "xyz789",
   "templateId": 4
 }
 
    
@@ -66519,7 +66509,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "message": "abc123",
+  "message": "xyz789",
   "type": "abc123"
 }
 
    
@@ -66642,13 +66632,13 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "badge_position": "abc123",
+  "badge_position": "xyz789",
   "language_code": "abc123",
   "minimum_score": 987.65,
   "re_captcha_type": "INVISIBLE",
   "technical_failure_message": "xyz789",
   "theme": "abc123",
-  "validation_failure_message": "abc123",
+  "validation_failure_message": "xyz789",
   "website_key": "abc123"
 }
 
    
@@ -66726,11 +66716,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "badge_position": "xyz789",
-  "failure_message": "xyz789",
+  "badge_position": "abc123",
+  "failure_message": "abc123",
   "forms": ["PLACE_ORDER"],
-  "is_enabled": true,
-  "language_code": "xyz789",
+  "is_enabled": false,
+  "language_code": "abc123",
   "minimum_score": 987.65,
   "theme": "xyz789",
   "website_key": "abc123"
@@ -66941,8 +66931,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "xyz789",
-  "id": 987,
+  "code": "abc123",
+  "id": 123,
   "name": "abc123"
 }
 
    
@@ -66985,7 +66975,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
 
    
                 
    
               
    
@@ -67073,8 +67063,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "abc123",
-  "coupon_codes": ["xyz789"]
+  "cart_id": "xyz789",
+  "coupon_codes": ["abc123"]
 }
 
    
                 
    
@@ -67123,8 +67113,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "abc123",
-  "gift_card_code": "abc123"
+  "cart_id": "xyz789",
+  "gift_card_code": "xyz789"
 }
 
    
                 
    
@@ -67245,7 +67235,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"success": true}
+                  
    {"success": false}
 
    
                 
    
               
    
@@ -67339,9 +67329,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "cart_item_id": 987,
-  "cart_item_uid": "4"
+  "cart_item_uid": 4
 }
 
    
                 
    
@@ -67429,7 +67419,10 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"quote_item_uids": ["4"], "quote_uid": 4}
+                  
    {
+  "quote_item_uids": ["4"],
+  "quote_uid": "4"
+}
 
    
                 
    
               
    
@@ -67516,7 +67509,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"item_uids": [4], "template_id": 4}
+                  
    {"item_uids": [4], "template_id": "4"}
 
    
                 
    
               
    
@@ -67563,10 +67556,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {
-  "products": ["4"],
-  "uid": "4"
-}
+                  
    {"products": [4], "uid": 4}
 
    
                 
    
               
    
@@ -67776,7 +67766,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}
 
    
                 
    
               
    
@@ -68021,10 +68011,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "comment_text": "xyz789",
-  "contact_email": "xyz789",
+  "comment_text": "abc123",
+  "contact_email": "abc123",
   "items": [RequestReturnItemInput],
-  "token": "abc123"
+  "token": "xyz789"
 }
 
    
                 
    
@@ -68085,9 +68075,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "4",
+  "cart_id": 4,
   "comment": NegotiableQuoteCommentInput,
-  "is_draft": false,
+  "is_draft": true,
   "quote_name": "abc123"
 }
 
    
@@ -68170,7 +68160,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"cart_id": 4}
+                  
    {"cart_id": "4"}
 
    
                 
    
               
    
@@ -68230,8 +68220,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "comment_text": "abc123",
-  "contact_email": "abc123",
+  "comment_text": "xyz789",
+  "contact_email": "xyz789",
   "items": [RequestReturnItemInput],
   "order_uid": "4"
 }
@@ -68297,8 +68287,8 @@ 
    Example
    
   "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
   ]
@@ -68479,13 +68469,13 @@ 
    pageSize
                   
    Example
    
                   
    {
-  "description": "xyz789",
+  "description": "abc123",
   "items": RequistionListItems,
-  "items_count": 123,
+  "items_count": 987,
   "name": "abc123",
   "requisition_list_items": RequisitionListItems,
   "uid": "4",
-  "updated_at": "xyz789"
+  "updated_at": "abc123"
 }
 
    
                 
    
@@ -68636,8 +68626,8 @@ 
    Example
    
                   
    {
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": "4"
+  "quantity": 987.65,
+  "uid": 4
 }
 
    
                 
    
@@ -68760,8 +68750,8 @@ 
    Example
    
                   
    {
   "entered_options": [EnteredOptionInput],
   "parent_sku": "xyz789",
-  "quantity": 123.45,
-  "selected_options": ["xyz789"],
+  "quantity": 987.65,
+  "selected_options": ["abc123"],
   "sku": "xyz789"
 }
 
    
@@ -68816,7 +68806,7 @@ 
    Example
    
                   
    {
   "items": [RequisitionList],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
    
                 
    
@@ -68870,7 +68860,7 @@ 
    Example
    
                   
    {
   "items": [RequisitionListItemInterface],
   "page_info": SearchResultPageInfo,
-  "total_pages": 987
+  "total_pages": 123
 }
 
    
                 
    
@@ -68959,14 +68949,14 @@ 
    Example
    
                   
    {
   "available_shipping_carriers": [ReturnShippingCarrier],
   "comments": [ReturnComment],
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "customer": ReturnCustomer,
   "items": [ReturnItem],
   "number": "xyz789",
   "order": CustomerOrder,
   "shipping": ReturnShipping,
   "status": "PENDING",
-  "uid": "4"
+  "uid": 4
 }
 
    
                 
    
@@ -69023,10 +69013,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "author_name": "xyz789",
+  "author_name": "abc123",
   "created_at": "xyz789",
-  "text": "abc123",
-  "uid": "4"
+  "text": "xyz789",
+  "uid": 4
 }
 
    
                 
    
@@ -69078,7 +69068,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "label": "xyz789",
+  "label": "abc123",
   "uid": "4",
   "value": "abc123"
 }
@@ -69132,8 +69122,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "abc123",
-  "firstname": "xyz789",
+  "email": "xyz789",
+  "firstname": "abc123",
   "lastname": "abc123"
 }
 
    
@@ -69210,7 +69200,7 @@ 
    Example
    
   "custom_attributes": [ReturnCustomAttribute],
   "custom_attributesV2": [AttributeValueInterface],
   "order_item": OrderItemInterface,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "request_quantity": 987.65,
   "status": "PENDING",
   "uid": "4"
@@ -69316,17 +69306,17 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "4",
-  "default_value": "xyz789",
+  "default_value": "abc123",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
   "input_filter": "NONE",
-  "is_required": 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]
 }
 
    
@@ -69533,13 +69523,13 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "abc123",
-  "contact_name": "xyz789",
+  "city": "xyz789",
+  "contact_name": "abc123",
   "country": Country,
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": Region,
   "street": ["xyz789"],
-  "telephone": "xyz789"
+  "telephone": "abc123"
 }
 
    
                 
    
@@ -69646,7 +69636,7 @@ 
    Example
    
                   
    {
   "carrier": ReturnShippingCarrier,
   "status": ReturnShippingTrackingStatus,
-  "tracking_number": "abc123",
+  "tracking_number": "xyz789",
   "uid": "4"
 }
 
    
@@ -69913,7 +69903,7 @@ 
    Example
    
                   
    {
   "items": [Return],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
    
                 
    
@@ -70113,7 +70103,7 @@ 
    Example
    
                   
    {
   "balance": RewardPointsAmount,
   "change_reason": "xyz789",
-  "date": "xyz789",
+  "date": "abc123",
   "points_change": 123.45
 }
 
    
@@ -70415,7 +70405,7 @@ 
    Possible Types
    
                   
    Example
    
                   
    {
   "redirect_code": 123,
-  "relative_url": "xyz789",
+  "relative_url": "abc123",
   "type": "CMS_PAGE"
 }
 
    
@@ -70469,7 +70459,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "redirect_code": 123,
-  "relative_url": "xyz789",
+  "relative_url": "abc123",
   "type": "CMS_PAGE"
 }
 
    
@@ -70565,8 +70555,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "message": "abc123",
-  "timestamp": "abc123"
+  "message": "xyz789",
+  "timestamp": "xyz789"
 }
 
    
                 
    
@@ -70673,7 +70663,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"current_page": 123, "page_size": 123, "total_pages": 987}
+                  
    {"current_page": 987, "page_size": 987, "total_pages": 123}
 
    
                 
    
               
    
@@ -70777,7 +70767,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "id": 123,
-  "label": "abc123",
+  "label": "xyz789",
   "type": "abc123",
   "uid": 4,
   "values": [SelectedBundleOptionValue]
@@ -70854,12 +70844,12 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "id": 123,
-  "label": "xyz789",
+  "label": "abc123",
   "original_price": Money,
-  "price": 987.65,
+  "price": 123.45,
   "priceV2": Money,
-  "quantity": 987.65,
-  "uid": "4"
+  "quantity": 123.45,
+  "uid": 4
 }
 
    
                 
    
@@ -70934,7 +70924,7 @@ 
    Example
    
   "configurable_product_option_value_uid": "4",
   "id": 987,
   "option_label": "abc123",
-  "value_id": 987,
+  "value_id": 123,
   "value_label": "xyz789"
 }
 
    
@@ -70984,7 +70974,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "attribute_code": "xyz789",
+  "attribute_code": "abc123",
   "value": "xyz789"
 }
 
    
@@ -71059,12 +71049,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "customizable_option_uid": 4,
+  "customizable_option_uid": "4",
   "id": 123,
-  "is_required": true,
+  "is_required": false,
   "label": "abc123",
-  "sort_order": 987,
-  "type": "abc123",
+  "sort_order": 123,
+  "type": "xyz789",
   "values": [SelectedCustomizableOptionValue]
 }
 
    
@@ -71131,9 +71121,9 @@ 
    Example
    
                   
    {
   "customizable_option_value_uid": "4",
   "id": 123,
-  "label": "xyz789",
+  "label": "abc123",
   "price": CartItemSelectedOptionValuePrice,
-  "value": "abc123"
+  "value": "xyz789"
 }
 
    
                 
    
@@ -71185,7 +71175,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "abc123",
+  "code": "xyz789",
   "purchase_order_number": "abc123",
   "title": "abc123"
 }
@@ -71269,9 +71259,9 @@ 
    Example
    
   "amount": Money,
   "base_amount": Money,
   "carrier_code": "abc123",
-  "carrier_title": "abc123",
+  "carrier_title": "xyz789",
   "method_code": "xyz789",
-  "method_title": "xyz789",
+  "method_title": "abc123",
   "price_excl_tax": Money,
   "price_incl_tax": Money
 }
@@ -71328,7 +71318,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "product_id": 123,
+  "product_id": 987,
   "recipients": [SendEmailToFriendRecipientInput],
   "sender": SendEmailToFriendSenderInput
 }
@@ -71426,7 +71416,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "email": "abc123",
-  "name": "xyz789"
+  "name": "abc123"
 }
 
    
                 
    
@@ -71528,8 +71518,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "xyz789",
-  "message": "xyz789",
+  "email": "abc123",
+  "message": "abc123",
   "name": "abc123"
 }
 
    
@@ -71585,9 +71575,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "xyz789",
-  "message": "abc123",
-  "name": "abc123"
+  "email": "abc123",
+  "message": "xyz789",
+  "name": "xyz789"
 }
 
    
                 
    
@@ -71633,7 +71623,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"enabled_for_customers": false, "enabled_for_guests": true}
+                  
    {"enabled_for_customers": true, "enabled_for_guests": false}
 
    
                 
    
               
    
@@ -71680,10 +71670,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {
-  "comment": NegotiableQuoteCommentInput,
-  "quote_uid": "4"
-}
+                  
    {"comment": NegotiableQuoteCommentInput, "quote_uid": 4}
 
    
                 
    
               
    
@@ -71772,7 +71759,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "billing_address": BillingAddressInput,
-  "cart_id": "abc123"
+  "cart_id": "xyz789"
 }
 
    
                 
    
@@ -71858,7 +71845,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"error": "abc123", "success": false}
+                  
    {"error": "xyz789", "success": true}
 
    
                 
    
               
    
@@ -71924,10 +71911,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "gift_message": GiftMessageInput,
   "gift_receipt_included": true,
-  "gift_wrapping_id": "4",
+  "gift_wrapping_id": 4,
   "printed_card_included": false
 }
 
    
@@ -72018,7 +72005,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "cart_id": "xyz789",
-  "email": "xyz789"
+  "email": "abc123"
 }
 
    
                 
    
@@ -72333,7 +72320,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "customer_address_id": "4",
+  "customer_address_id": 4,
   "quote_uid": "4",
   "shipping_addresses": [
     NegotiableQuoteShippingAddressInput
@@ -72426,7 +72413,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "quote_uid": "4",
+  "quote_uid": 4,
   "shipping_methods": [ShippingMethodInput]
 }
 
    
@@ -72517,7 +72504,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "shipping_address": NegotiableQuoteTemplateShippingAddressInput,
-  "template_id": 4
+  "template_id": "4"
 }
 
    
                 
    
@@ -72566,7 +72553,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "payment_method": PaymentMethodInput
 }
 
    
@@ -72887,7 +72874,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "email": "abc123",
-  "name": "abc123"
+  "name": "xyz789"
 }
 
    
                 
    
@@ -72977,7 +72964,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "message": "xyz789",
-  "name": "abc123"
+  "name": "xyz789"
 }
 
    
                 
    
@@ -73091,7 +73078,7 @@ 
    Example
    
                   
    {
   "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "abc123",
   "quantity_shipped": 987.65
@@ -73188,12 +73175,12 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "quantity_shipped": 123.45
+  "quantity_shipped": 987.65
 }
 
    
                 
    
@@ -73246,7 +73233,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "carrier": "xyz789",
-  "number": "abc123",
+  "number": "xyz789",
   "title": "abc123"
 }
 
    
@@ -73316,9 +73303,9 @@ 
    Example
    
                   
    {
   "address": CartAddressInput,
   "customer_address_id": 987,
-  "customer_address_uid": "4",
-  "customer_notes": "xyz789",
-  "pickup_location_code": "xyz789"
+  "customer_address_uid": 4,
+  "customer_notes": "abc123",
+  "pickup_location_code": "abc123"
 }
 
    
                 
    
@@ -73494,29 +73481,29 @@ 
    Example
    
   "available_shipping_methods": [AvailableShippingMethod],
   "cart_items": [CartItemQuantity],
   "cart_items_v2": [CartItemInterface],
-  "city": "abc123",
+  "city": "xyz789",
   "company": "abc123",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "customer_address_uid": "4",
-  "customer_notes": "abc123",
-  "fax": "xyz789",
-  "firstname": "abc123",
-  "id": 987,
-  "items_weight": 123.45,
+  "customer_address_uid": 4,
+  "customer_notes": "xyz789",
+  "fax": "abc123",
+  "firstname": "xyz789",
+  "id": 123,
+  "items_weight": 987.65,
   "lastname": "abc123",
   "middlename": "abc123",
-  "pickup_location_code": "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": "abc123",
+  "suffix": "xyz789",
+  "telephone": "xyz789",
   "uid": 4,
-  "vat_id": "xyz789"
+  "vat_id": "abc123"
 }
    @@ -73671,8 +73658,8 @@
    Fields
    Example
    {
-  "carrier_code": "xyz789",
-  "method_code": "abc123"
+  "carrier_code": "abc123",
+  "method_code": "xyz789"
 }
    @@ -73802,9 +73789,9 @@
    Example
    "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": 987.65, "not_available_message": "xyz789", "note_from_buyer": [ItemNote], @@ -74212,51 +74199,51 @@
    currentPage
    Example
    {
-  "attribute_set_id": 987,
+  "attribute_set_id": 123,
   "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "color": 123,
+  "color": 987,
   "country_of_manufacture": "abc123",
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "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": 123,
+  "id": 987,
   "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": "xyz789",
-  "meta_title": "abc123",
-  "min_sale_qty": 123.45,
-  "name": "abc123",
-  "new_from_date": "abc123",
-  "new_to_date": "xyz789",
+  "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": 987.65,
   "options": [CustomizableOptionInterface],
-  "options_container": "abc123",
+  "options_container": "xyz789",
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "quantity": 987.65,
-  "rating_summary": 123.45,
-  "redirect_code": 123,
+  "quantity": 123.45,
+  "rating_summary": 987.65,
+  "redirect_code": 987,
   "related_products": [ProductInterface],
   "relative_url": "abc123",
   "review_count": 123,
   "reviews": ProductReviews,
   "short_description": ComplexTextValue,
-  "sku": "xyz789",
+  "sku": "abc123",
   "small_image": ProductImage,
   "special_from_date": "xyz789",
-  "special_price": 987.65,
+  "special_price": 123.45,
   "special_to_date": "xyz789",
   "staged": false,
   "stock_status": "IN_STOCK",
@@ -74267,12 +74254,12 @@ 
    Example
    
   "type": "CMS_PAGE",
   "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": "xyz789",
+  "url_suffix": "abc123",
   "websites": [Website],
   "weight": 123.45
 }
@@ -74451,10 +74438,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "added_at": "xyz789",
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
-  "id": "4",
+  "description": "abc123",
+  "id": 4,
   "product": ProductInterface,
   "quantity": 123.45
 }
@@ -74511,7 +74498,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "payment_source": "xyz789",
+  "payment_source": "abc123",
   "payments_order_id": "abc123",
   "paypal_order_id": "abc123"
 }
@@ -74601,14 +74588,14 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "app_switch_when_available": true,
+  "app_switch_when_available": false,
   "button_styles": ButtonStyles,
   "code": "xyz789",
-  "display_message": true,
-  "display_venmo": false,
-  "is_visible": false,
+  "display_message": false,
+  "display_venmo": true,
+  "is_visible": true,
   "message_styles": MessageStyles,
-  "payment_intent": "abc123",
+  "payment_intent": "xyz789",
   "sdk_params": [SDKParams],
   "sort_order": "xyz789",
   "title": "xyz789"
@@ -74708,7 +74695,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "label": "abc123",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
    
                 
    
@@ -74755,7 +74742,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "default": "xyz789",
+  "default": "abc123",
   "options": [SortField]
 }
 
    
@@ -76269,123 +76256,123 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "absolute_footer": "xyz789",
-  "allow_gift_receipt": "xyz789",
+  "absolute_footer": "abc123",
+  "allow_gift_receipt": "abc123",
   "allow_gift_wrapping_on_order": "abc123",
-  "allow_gift_wrapping_on_order_items": "xyz789",
+  "allow_gift_wrapping_on_order_items": "abc123",
   "allow_guests_to_write_product_reviews": "abc123",
   "allow_items": "xyz789",
   "allow_order": "xyz789",
   "allow_printed_card": "abc123",
-  "autocomplete_on_storefront": false,
+  "autocomplete_on_storefront": true,
   "base_currency_code": "xyz789",
-  "base_link_url": "xyz789",
+  "base_link_url": "abc123",
   "base_media_url": "xyz789",
-  "base_static_url": "xyz789",
+  "base_static_url": "abc123",
   "base_url": "abc123",
-  "braintree_3dsecure_allowspecific": true,
+  "braintree_3dsecure_allowspecific": false,
   "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": true,
   "braintree_ach_direct_debit_vault_active": true,
   "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": "xyz789",
+  "braintree_applepay_vault_active": false,
+  "braintree_cc_vault_active": "abc123",
+  "braintree_cc_vault_cvv": false,
+  "braintree_environment": "abc123",
+  "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_googlepay_vault_active": false,
+  "braintree_local_payment_allowed_methods": "xyz789",
   "braintree_local_payment_fallback_button_text": "abc123",
   "braintree_local_payment_redirect_on_fail": "xyz789",
-  "braintree_merchant_account_id": "abc123",
-  "braintree_paypal_button_location_cart_type_credit_color": "xyz789",
-  "braintree_paypal_button_location_cart_type_credit_label": "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_merchant_account_id": "xyz789",
+  "braintree_paypal_button_location_cart_type_credit_color": "abc123",
+  "braintree_paypal_button_location_cart_type_credit_label": "abc123",
+  "braintree_paypal_button_location_cart_type_credit_shape": "xyz789",
+  "braintree_paypal_button_location_cart_type_credit_show": 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": "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": "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_paylater_show": true,
+  "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
   "braintree_paypal_button_location_cart_type_paypal_label": "abc123",
   "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
-  "braintree_paypal_button_location_cart_type_paypal_show": false,
-  "braintree_paypal_button_location_checkout_type_credit_color": "xyz789",
-  "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
-  "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
+  "braintree_paypal_button_location_cart_type_paypal_show": true,
+  "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
+  "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
+  "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
   "braintree_paypal_button_location_checkout_type_credit_show": false,
-  "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
-  "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
+  "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
+  "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
   "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
   "braintree_paypal_button_location_checkout_type_messaging_show": true,
-  "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
+  "braintree_paypal_button_location_checkout_type_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": false,
+  "braintree_paypal_button_location_checkout_type_paypal_label": "abc123",
+  "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789",
+  "braintree_paypal_button_location_checkout_type_paypal_show": true,
   "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
   "braintree_paypal_button_location_productpage_type_credit_label": "xyz789",
-  "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": false,
   "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123",
   "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789",
-  "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
+  "braintree_paypal_button_location_productpage_type_messaging_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": "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_label": "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_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": "xyz789",
   "braintree_paypal_require_billing_address": false,
   "braintree_paypal_send_cart_line_items": true,
-  "braintree_paypal_vault_active": true,
+  "braintree_paypal_vault_active": false,
   "cart_expires_in_days": 123,
-  "cart_gift_wrapping": "abc123",
+  "cart_gift_wrapping": "xyz789",
   "cart_merge_preference": "abc123",
-  "cart_printed_card": "xyz789",
-  "cart_summary_display_quantity": 987,
+  "cart_printed_card": "abc123",
+  "cart_summary_display_quantity": 123,
   "catalog_default_sort_by": "xyz789",
   "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
   "category_url_suffix": "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": "abc123",
   "check_money_order_min_order_total": "abc123",
   "check_money_order_new_order_status": "xyz789",
-  "check_money_order_payment_from_specific_countries": "xyz789",
+  "check_money_order_payment_from_specific_countries": "abc123",
   "check_money_order_send_check_to": "abc123",
   "check_money_order_sort_order": 987,
-  "check_money_order_title": "abc123",
-  "cms_home_page": "xyz789",
+  "check_money_order_title": "xyz789",
+  "cms_home_page": "abc123",
   "cms_no_cookies": "xyz789",
-  "cms_no_route": "xyz789",
-  "code": "xyz789",
+  "cms_no_route": "abc123",
+  "code": "abc123",
   "configurable_product_image": "ITSELF",
   "configurable_thumbnail_source": "xyz789",
-  "contact_enabled": false,
-  "copyright": "abc123",
+  "contact_enabled": true,
+  "copyright": "xyz789",
   "countries_with_required_region": "abc123",
   "create_account_confirmation": true,
   "customer_access_token_lifetime": 123.45,
@@ -76393,48 +76380,48 @@ 
    Example
    
   "default_description": "xyz789",
   "default_display_currency_code": "abc123",
   "default_keywords": "xyz789",
-  "default_title": "xyz789",
+  "default_title": "abc123",
   "demonotice": 123,
-  "display_product_prices_in_catalog": 123,
+  "display_product_prices_in_catalog": 987,
   "display_shipping_prices": 123,
-  "display_state_if_optional": false,
-  "enable_multiple_wishlists": "xyz789",
-  "fixed_product_taxes_apply_tax_to_fpt": true,
+  "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": 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_include_fpt_in_subtotal": false,
   "front": "xyz789",
-  "graphql_share_customer_group": false,
-  "grid_per_page": 987,
-  "grid_per_page_values": "abc123",
+  "graphql_share_customer_group": true,
+  "grid_per_page": 123,
+  "grid_per_page_values": "xyz789",
   "grouped_product_image": "ITSELF",
-  "head_includes": "xyz789",
+  "head_includes": "abc123",
   "head_shortcut_icon": "abc123",
   "header_logo_src": "abc123",
-  "id": 123,
+  "id": 987,
   "is_checkout_agreements_enabled": false,
   "is_default_store": true,
-  "is_default_store_group": false,
-  "is_guest_checkout_enabled": true,
+  "is_default_store_group": true,
+  "is_guest_checkout_enabled": false,
   "is_negotiable_quote_active": false,
-  "is_one_page_checkout_enabled": false,
-  "is_requisition_list_active": "xyz789",
+  "is_one_page_checkout_enabled": true,
+  "is_requisition_list_active": "abc123",
   "list_mode": "xyz789",
-  "list_per_page": 123,
-  "list_per_page_values": "xyz789",
-  "locale": "abc123",
+  "list_per_page": 987,
+  "list_per_page_values": "abc123",
+  "locale": "xyz789",
   "logo_alt": "xyz789",
-  "logo_height": 123,
-  "logo_width": 123,
+  "logo_height": 987,
+  "logo_width": 987,
   "magento_reward_general_is_enabled": "abc123",
   "magento_reward_general_is_enabled_on_front": "abc123",
-  "magento_reward_general_min_points_balance": "xyz789",
+  "magento_reward_general_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_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",
@@ -76443,9 +76430,9 @@ 
    Example
    
   "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": "abc123",
-  "minicart_display": false,
+  "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,
@@ -76454,62 +76441,62 @@ 
    Example
    
   "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_grandtotal": false,
+  "orders_invoices_credit_memos_display_price": 987,
+  "orders_invoices_credit_memos_display_shipping_amount": 123,
   "orders_invoices_credit_memos_display_subtotal": 987,
   "orders_invoices_credit_memos_display_zero_tax": true,
-  "payment_payflowpro_cc_vault_active": "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_url_suffix": "abc123",
-  "quickorder_active": false,
+  "quickorder_active": true,
   "required_character_classes_number": "xyz789",
-  "returns_enabled": "xyz789",
+  "returns_enabled": "abc123",
   "root_category_id": 987,
   "root_category_uid": 4,
   "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
   "sales_gift_wrapping": "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_link_url": "xyz789",
+  "secure_base_media_url": "abc123",
+  "secure_base_static_url": "abc123",
+  "secure_base_url": "abc123",
   "send_friend": SendFriendConfiguration,
-  "share_active_segments": true,
-  "share_applied_cart_rule": true,
-  "shopping_cart_display_full_summary": false,
+  "share_active_segments": false,
+  "share_applied_cart_rule": false,
+  "shopping_cart_display_full_summary": true,
   "shopping_cart_display_grand_total": true,
-  "shopping_cart_display_price": 987,
+  "shopping_cart_display_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,
   "store_code": 4,
   "store_group_code": 4,
-  "store_group_name": "xyz789",
+  "store_group_name": "abc123",
   "store_name": "xyz789",
-  "store_sort_order": 123,
+  "store_sort_order": 987,
   "timezone": "xyz789",
   "title_prefix": "xyz789",
-  "title_separator": "xyz789",
-  "title_suffix": "abc123",
-  "use_store_in_url": true,
+  "title_separator": "abc123",
+  "title_suffix": "xyz789",
+  "use_store_in_url": false,
   "website_code": "4",
-  "website_id": 123,
+  "website_id": 987,
   "website_name": "xyz789",
   "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": "abc123",
-  "zero_subtotal_payment_action": "xyz789",
-  "zero_subtotal_payment_from_specific_countries": "xyz789",
-  "zero_subtotal_sort_order": 123,
-  "zero_subtotal_title": "xyz789"
+  "zero_subtotal_payment_action": "abc123",
+  "zero_subtotal_payment_from_specific_countries": "abc123",
+  "zero_subtotal_sort_order": 987,
+  "zero_subtotal_title": "abc123"
 }
 
    
                 
    
@@ -76571,7 +76558,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "position": 987,
+  "position": 123,
   "use_in_layered_navigation": "NO",
   "use_in_product_listing": false,
   "use_in_search_results_layered_navigation": false,
@@ -76598,7 +76585,7 @@ 
    Description
    
               
    
                 
    
                   
    Example
    
-                  
    "abc123"
+                  
    "xyz789"
 
    
                 
    
               
    
@@ -76673,7 +76660,7 @@ 
    Example
    
   "comment": "abc123",
   "max_order_commitment": 123,
   "min_order_commitment": 987,
-  "name": "abc123",
+  "name": "xyz789",
   "reference_document_links": [
     NegotiableQuoteTemplateReferenceDocumentLinkInput
   ],
@@ -76828,7 +76815,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "type": "xyz789",
-  "value": "xyz789"
+  "value": "abc123"
 }
 
    
                 
    
@@ -76892,7 +76879,7 @@ 
    Possible Types
    
               
    
                 
    
                   
    Example
    
-                  
    {"value": "xyz789"}
+                  
    {"value": "abc123"}
 
    
                 
    
               
    
@@ -77108,10 +77095,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "items_count": 987,
+  "items_count": 123,
   "label": "xyz789",
   "swatch_data": SwatchData,
-  "value_string": "xyz789"
+  "value_string": "abc123"
 }
 
    
                 
    
@@ -77214,7 +77201,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "cartId": "xyz789",
-  "id": "xyz789"
+  "id": "abc123"
 }
 
    
                 
    
@@ -77466,7 +77453,7 @@ 
    Example
    
                   
    {
   "discount": ProductDiscount,
   "final_price": Money,
-  "quantity": 123.45
+  "quantity": 987.65
 }
 
    
                 
    
@@ -77515,7 +77502,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "cart_items": [CartItemUpdateInput]
 }
 
    
@@ -77841,7 +77828,7 @@ 
    Example
    
     GiftRegistryDynamicAttributeInput
   ],
   "event_name": "abc123",
-  "message": "xyz789",
+  "message": "abc123",
   "privacy_settings": "PRIVATE",
   "shipping_address": GiftRegistryShippingAddressInput,
   "status": "ACTIVE"
@@ -77899,9 +77886,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "gift_registry_item_uid": 4,
-  "note": "xyz789",
-  "quantity": 987.65
+  "gift_registry_item_uid": "4",
+  "note": "abc123",
+  "quantity": 123.45
 }
 
    
                 
    
@@ -78051,8 +78038,8 @@ 
    Example
    
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
-  "email": "abc123",
-  "firstname": "abc123",
+  "email": "xyz789",
+  "firstname": "xyz789",
   "gift_registry_registrant_uid": 4,
   "lastname": "xyz789"
 }
@@ -78184,7 +78171,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "items": [NegotiableQuoteItemQuantityInput],
-  "quote_uid": 4
+  "quote_uid": "4"
 }
 
    
                 
    
@@ -78402,12 +78389,12 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "applies_to": ["4"],
-  "approvers": [4],
+  "approvers": ["4"],
   "condition": CreatePurchaseOrderApprovalRuleConditionInput,
   "description": "xyz789",
   "name": "abc123",
   "status": "ENABLED",
-  "uid": "4"
+  "uid": 4
 }
 
    
                 
    
@@ -78456,7 +78443,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "description": "xyz789",
+  "description": "abc123",
   "name": "abc123"
 }
 
    
@@ -78519,9 +78506,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "entered_options": [EnteredOptionInput],
-  "item_id": "4",
+  "item_id": 4,
   "quantity": 987.65,
-  "selected_options": ["abc123"]
+  "selected_options": ["xyz789"]
 }
 
    
                 
    
@@ -78870,7 +78857,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "currentPage": 123,
+  "currentPage": 987,
   "pageSize": 987,
   "sort": [CompaniesSortInput]
 }
@@ -78966,7 +78953,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"message": "xyz789", "type": "NOT_FOUND"}
+                  
    {"message": "abc123", "type": "NOT_FOUND"}
 
    
                 
    
               
    
@@ -79168,7 +79155,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "name": "DATE_RANGE_MAX",
-  "value": "xyz789"
+  "value": "abc123"
 }
 
    
                 
    
@@ -79354,7 +79341,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "is_vault_enabled": false,
+  "is_vault_enabled": true,
   "sdk_params": [SDKParams],
   "three_ds_mode": "OFF"
 }
@@ -79417,10 +79404,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "payment_source": "abc123",
+  "payment_source": "xyz789",
   "payments_order_id": "abc123",
-  "paypal_order_id": "xyz789",
-  "public_hash": "xyz789"
+  "paypal_order_id": "abc123",
+  "public_hash": "abc123"
 }
 
    
                 
    
@@ -79503,7 +79490,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"public_hash": "abc123"}
+                  
    {"public_hash": "xyz789"}
 
    
                 
    
               
    
@@ -79615,16 +79602,16 @@ 
    Example
    
   "discount": [Discount],
   "errors": [CartItemError],
   "id": "abc123",
-  "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": 987.65,
-  "uid": 4
+  "quantity": 123.45,
+  "uid": "4"
 }
 
    
                 
    
@@ -80022,61 +80009,61 @@ 
    Example
    
   "attribute_set_id": 987,
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "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,
   "gift_message_available": true,
   "gift_wrapping_available": true,
   "gift_wrapping_price": Money,
-  "id": 987,
+  "id": 123,
   "image": ProductImage,
-  "is_returnable": "xyz789",
-  "manufacturer": 987,
-  "max_sale_qty": 987.65,
+  "is_returnable": "abc123",
+  "manufacturer": 123,
+  "max_sale_qty": 123.45,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
+  "meta_description": "xyz789",
   "meta_keyword": "xyz789",
   "meta_title": "abc123",
-  "min_sale_qty": 123.45,
+  "min_sale_qty": 987.65,
   "name": "abc123",
-  "new_from_date": "xyz789",
-  "new_to_date": "xyz789",
-  "only_x_left_in_stock": 987.65,
+  "new_from_date": "abc123",
+  "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],
-  "quantity": 987.65,
-  "rating_summary": 123.45,
+  "quantity": 123.45,
+  "rating_summary": 987.65,
   "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": 123.45,
-  "special_to_date": "abc123",
-  "staged": false,
+  "special_price": 987.65,
+  "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": "abc123",
-  "uid": 4,
-  "updated_at": "xyz789",
+  "uid": "4",
+  "updated_at": "abc123",
   "upsell_products": [ProductInterface],
-  "url_key": "abc123",
+  "url_key": "xyz789",
   "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
   "url_suffix": "abc123",
@@ -80189,7 +80176,7 @@ 
    Example
    
                   
    {
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": "4"
 }
 
    
@@ -80259,10 +80246,10 @@ 
    Example
    
                   
    {
   "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
+  "description": "abc123",
   "id": 4,
   "product": ProductInterface,
-  "quantity": 123.45
+  "quantity": 987.65
 }
 
    
                 
@@ -80335,12 +80322,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "xyz789",
+  "code": "abc123",
   "default_group_id": "xyz789",
-  "id": 123,
-  "is_default": true,
-  "name": "abc123",
-  "sort_order": 987
+  "id": 987,
+  "is_default": false,
+  "name": "xyz789",
+  "sort_order": 123
 }
 
    
                 
    
@@ -80388,7 +80375,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "PRODUCT_NOT_FOUND",
-  "message": "xyz789"
+  "message": "abc123"
 }
 
    
                 
@@ -80533,13 +80520,13 @@ 
    pageSize
                   
    Example
    
                   
    {
-  "id": 4,
+  "id": "4",
   "items": [WishlistItem],
   "items_count": 123,
   "items_v2": WishlistItems,
-  "name": "abc123",
-  "sharing_code": "abc123",
-  "updated_at": "abc123",
+  "name": "xyz789",
+  "sharing_code": "xyz789",
+  "updated_at": "xyz789",
   "visibility": "PUBLIC"
 }
 
    
@@ -80598,9 +80585,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "PRODUCT_NOT_FOUND",
-  "message": "xyz789",
-  "wishlistId": 4,
-  "wishlistItemId": "4"
+  "message": "abc123",
+  "wishlistId": "4",
+  "wishlistItemId": 4
 }
 
    
                 
@@ -80733,7 +80720,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "added_at": "abc123",
-  "description": "abc123",
+  "description": "xyz789",
   "id": 987,
   "product": ProductInterface,
   "qty": 987.65
@@ -80784,7 +80771,10 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"quantity": 987.65, "wishlist_item_id": 4}
+                  
    {
+  "quantity": 123.45,
+  "wishlist_item_id": "4"
+}
 
    
                 
    
               
    
@@ -80851,10 +80841,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "entered_options": [EnteredOptionInput],
-  "parent_sku": "abc123",
-  "quantity": 123.45,
+  "parent_sku": "xyz789",
+  "quantity": 987.65,
   "selected_options": [4],
-  "sku": "abc123"
+  "sku": "xyz789"
 }
 
    
                 
@@ -80970,10 +80960,10 @@ 
    Example
    
                   
    {
   "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
+  "description": "xyz789",
   "id": 4,
   "product": ProductInterface,
-  "quantity": 123.45
+  "quantity": 987.65
 }
 
    
                 
@@ -81021,7 +81011,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"quantity": 987.65, "wishlist_item_id": 4}
+                  
    {"quantity": 123.45, "wishlist_item_id": 4}
 
    
                 
    
               
    
@@ -81087,11 +81077,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "description": "abc123",
+  "description": "xyz789",
   "entered_options": [EnteredOptionInput],
-  "quantity": 987.65,
+  "quantity": 123.45,
   "selected_options": [4],
-  "wishlist_item_id": 4
+  "wishlist_item_id": "4"
 }
 
    
                 
    
@@ -81207,9 +81197,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "items": [WishlistItem],
-  "items_count": 987,
-  "name": "xyz789",
-  "sharing_code": "xyz789",
+  "items_count": 123,
+  "name": "abc123",
+  "sharing_code": "abc123",
   "updated_at": "xyz789"
 }
 
    
@@ -81301,7 +81291,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}