From 235e7a21e89eb324001c4dd8deb9c1d2fbd055e6 Mon Sep 17 00:00:00 2001 From: jhadobe Date: Tue, 9 Apr 2024 10:46:52 -0500 Subject: [PATCH 1/6] 2.4.7 Schemas --- spectaql/schema.json | 2759 +- spectaql/schema_beta.json | 70124 ---------------- src/openapi/admin-schema-2.4.7.yaml | 34421 ++++++++ src/openapi/customer-schema-2.4.7.yaml | 7409 ++ src/openapi/guest-schema-2.4.7.yaml | 5809 ++ .../beta/javascripts/spectaql.min.js | 1 - .../beta/stylesheets/spectaql.min.css | 1 - static/graphql-api/index.html | 5999 +- 8 files changed, 53622 insertions(+), 72901 deletions(-) delete mode 100644 spectaql/schema_beta.json create mode 100644 src/openapi/admin-schema-2.4.7.yaml create mode 100644 src/openapi/customer-schema-2.4.7.yaml create mode 100644 src/openapi/guest-schema-2.4.7.yaml delete mode 100644 static/graphql-api/beta/javascripts/spectaql.min.js delete mode 100644 static/graphql-api/beta/stylesheets/spectaql.min.css diff --git a/spectaql/schema.json b/spectaql/schema.json index 48d6ea512..a373e8d81 100644 --- a/spectaql/schema.json +++ b/spectaql/schema.json @@ -931,6 +931,68 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "guestOrder", + "description": "Retrieve guest order details based on number, email and postcode.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "OrderInformationInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "guestOrderByToken", + "description": "Retrieve guest order details based on token.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "OrderTokenInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "isCompanyAdminEmailAvailable", "description": "Check whether the specified email can be used to register a company admin.", @@ -2008,6 +2070,29 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "applyCouponsToCart", + "description": "Apply a pre-defined coupon code to the specified cart.", + "args": [ + { + "name": "input", + "description": "An input object that defines the coupon code to apply to the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ApplyCouponsToCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ApplyCouponToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "applyGiftCardToCart", "description": "Apply a pre-defined gift card code to the specified cart.", @@ -2350,6 +2435,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "confirmEmail", + "description": "Confirms the email address for a customer.", + "args": [ + { + "name": "input", + "description": "An input object to identify the customer to confirm the email.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ConfirmEmailInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "contactUs", "description": "Send a 'Contact Us' email to the merchant.", @@ -3351,6 +3463,68 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "estimateShippingMethods", + "description": "Estimate shipping method(s) for cart based on address", + "args": [ + { + "name": "input", + "description": "An input object that specifies details for estimation of available shipping methods", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EstimateTotalsInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AvailableShippingMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "estimateTotals", + "description": "Estimate totals for cart based on the address", + "args": [ + { + "name": "input", + "description": "An input object that specifies details for cart totals estimation", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EstimateTotalsInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EstimateTotalsOutput", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "generateCustomerToken", "description": "Generate a token for specified customer.", @@ -3819,6 +3993,29 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "removeCouponsFromCart", + "description": "Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.", + "args": [ + { + "name": "input", + "description": "An input object that defines which coupon code to remove from the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "RemoveCouponsFromCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveCouponFromCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "removeGiftCardFromCart", "description": "Removes a gift card from the cart.", @@ -4170,33 +4367,6 @@ "isDeprecated": false, "deprecationReason": null }, - { - "name": "renameNegotiableQuote", - "description": "Rename negotiable quote.", - "args": [ - { - "name": "input", - "description": "An input object that defines the quote item name and comment.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "RenameNegotiableQuoteInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RenameNegotiableQuoteOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, { "name": "reorderItems", "description": "Add all products from a customer's previous order to the cart.", @@ -5811,13 +5981,13 @@ "name": "FULL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PARTIAL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -5926,13 +6096,13 @@ "name": "ASC", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DESC", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -6011,1021 +6181,1021 @@ "name": "AFN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ALL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AZN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DZD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AOA", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ARS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AMD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AWG", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AUD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BSD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BHD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BDT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BBD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BYN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BZD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BMD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BTN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BOB", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BAM", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BWP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BRL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GBP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BND", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BGN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BUK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BIF", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KHR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CAD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CVE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CZK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KYD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GQE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CLP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CNY", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "COP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KMF", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CDF", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CRC", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "HRK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CUP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DKK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DJF", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DOP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "XCD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "EGP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SVC", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ERN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "EEK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ETB", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "EUR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FKP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FJD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GMD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GEK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GEL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GHS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GIP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GTQ", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GNF", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GYD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "HTG", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "HNL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "HKD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "HUF", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ISK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "INR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "IDR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "IRR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "IQD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ILS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "JMD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "JPY", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "JOD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KZT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KES", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KWD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KGS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LAK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LVL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LBP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LSL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LRD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LYD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LTL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MOP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MKD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MGA", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MWK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MYR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MVR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LSM", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MRO", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MUR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MXN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MDL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MNT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MAD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MZN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MMK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NAD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NPR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ANG", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "YTL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NZD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NIC", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NGN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KPW", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NOK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "OMR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PKR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PAB", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PGK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PYG", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PEN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PHP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PLN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "QAR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "RHD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "RON", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "RUB", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "RWF", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SHP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "STD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SAR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "RSD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SCR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SLL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SGD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SKK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SBD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SOS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ZAR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KRW", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LKR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SDG", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SRD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SZL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SEK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CHF", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SYP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TWD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TJS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TZS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "THB", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TOP", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TTD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TND", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TMM", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "USD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UGX", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UAH", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UYU", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UZS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "VUV", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "VEB", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "VEF", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "VND", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CHE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CHW", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "XOF", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "WST", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "YER", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ZMK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ZWD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TRY", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AZM", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ROL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TRL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "XPF", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -7081,19 +7251,19 @@ "name": "SUCCESS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FAILURE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MIXED_RESULTS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -7420,19 +7590,19 @@ "name": "NO", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FILTERABLE_WITH_RESULTS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FILTERABLE_NO_RESULT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -7609,25 +7779,25 @@ "name": "ENTITY_NOT_FOUND", "description": "The requested entity was not found.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ATTRIBUTE_NOT_FOUND", "description": "The requested attribute was not found.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FILTER_NOT_FOUND", "description": "The filter cannot be applied as it does not belong to the entity", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNDEFINED", "description": "Not categorized error, see the error message.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -8087,31 +8257,31 @@ "name": "CATALOG_PRODUCT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CATALOG_CATEGORY", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CUSTOMER", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CUSTOMER_ADDRESS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "RMA_ITEM", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -8128,97 +8298,97 @@ "name": "BOOLEAN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DATE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DATETIME", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FILE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GALLERY", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "HIDDEN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "IMAGE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MEDIA_IMAGE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MULTILINE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MULTISELECT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PRICE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SELECT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TEXT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TEXTAREA", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "WEIGHT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNDEFINED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -9814,6 +9984,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "cart_expires_in_days", + "description": "Extended Config Data - checkout/cart/delete_quote_after", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "cart_gift_wrapping", "description": "Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).", @@ -9838,6 +10020,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "cart_summary_display_quantity", + "description": "Extended Config Data - checkout/cart_link/use_qty", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "catalog_default_sort_by", "description": "The default sort order of the search results list.", @@ -10094,6 +10288,30 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "create_account_confirmation", + "description": "Indicates if the new accounts need confirmation.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer_access_token_lifetime", + "description": "Customer access token lifetime.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "default_country", "description": "Extended Config Data - general/country/default", @@ -10622,6 +10840,30 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "minicart_display", + "description": "Extended Config Data - checkout/sidebar/display", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minicart_max_items", + "description": "Extended Config Data - checkout/sidebar/count", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "minimum_password_length", "description": "The minimum number of characters required for a valid password.", @@ -10994,6 +11236,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "shopping_cart_display_tax_gift_wrapping", + "description": "Extended Config Data - tax/cart_display/gift_wrapping", + "args": [], + "type": { + "kind": "ENUM", + "name": "TaxWrappingEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "shopping_cart_display_zero_tax", "description": "Extended Config Data - tax/cart_display/zero_tax", @@ -11737,13 +11991,13 @@ "name": "INCLUDED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "EXCLUDED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -11760,19 +12014,19 @@ "name": "FIXED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PERCENT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DYNAMIC", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -11789,19 +12043,19 @@ "name": "DATE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DATE_TIME", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TIME", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -21158,43 +21412,43 @@ "name": "SIMPLE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "VIRTUAL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BUNDLE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DOWNLOADABLE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CONFIGURABLE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GROUPED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CATEGORY", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -21262,13 +21516,13 @@ "name": "IN_STOCK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "OUT_OF_STOCK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -21368,19 +21622,19 @@ "name": "CMS_PAGE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PRODUCT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CATEGORY", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -21749,15 +22003,54 @@ "name": "AUTO", "description": "Conditions are automatically accepted upon checkout.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MANUAL", "description": "Shoppers must manually accept the conditions to place an order.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ConfirmEmailInput", + "description": "Contains details about a customer email address to confirm.", + "fields": null, + "inputFields": [ + { + "name": "confirmation_key", + "description": "The key to confirm the email address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The email address to be confirmed.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null } ], + "interfaces": null, + "enumValues": null, "possibleTypes": null }, { @@ -22612,6 +22905,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "confirmation_status", + "description": "The customer's confirmation status.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ConfirmationStatusEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "created_at", "description": "Timestamp indicating when the account was created.", @@ -23876,1471 +24185,1471 @@ "name": "AF", "description": "Afghanistan", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AX", "description": "Åland Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AL", "description": "Albania", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DZ", "description": "Algeria", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AS", "description": "American Samoa", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AD", "description": "Andorra", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AO", "description": "Angola", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AI", "description": "Anguilla", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AQ", "description": "Antarctica", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AG", "description": "Antigua & Barbuda", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AR", "description": "Argentina", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AM", "description": "Armenia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AW", "description": "Aruba", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AU", "description": "Australia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AT", "description": "Austria", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AZ", "description": "Azerbaijan", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BS", "description": "Bahamas", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BH", "description": "Bahrain", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BD", "description": "Bangladesh", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BB", "description": "Barbados", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BY", "description": "Belarus", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BE", "description": "Belgium", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BZ", "description": "Belize", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BJ", "description": "Benin", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BM", "description": "Bermuda", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BT", "description": "Bhutan", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BO", "description": "Bolivia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BA", "description": "Bosnia & Herzegovina", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BW", "description": "Botswana", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BV", "description": "Bouvet Island", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BR", "description": "Brazil", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "IO", "description": "British Indian Ocean Territory", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "VG", "description": "British Virgin Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BN", "description": "Brunei", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BG", "description": "Bulgaria", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BF", "description": "Burkina Faso", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BI", "description": "Burundi", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KH", "description": "Cambodia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CM", "description": "Cameroon", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CA", "description": "Canada", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CV", "description": "Cape Verde", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KY", "description": "Cayman Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CF", "description": "Central African Republic", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TD", "description": "Chad", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CL", "description": "Chile", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CN", "description": "China", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CX", "description": "Christmas Island", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CC", "description": "Cocos (Keeling) Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CO", "description": "Colombia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KM", "description": "Comoros", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CG", "description": "Congo-Brazzaville", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CD", "description": "Congo-Kinshasa", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CK", "description": "Cook Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CR", "description": "Costa Rica", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CI", "description": "Côte d’Ivoire", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "HR", "description": "Croatia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CU", "description": "Cuba", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CY", "description": "Cyprus", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CZ", "description": "Czech Republic", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DK", "description": "Denmark", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DJ", "description": "Djibouti", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DM", "description": "Dominica", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DO", "description": "Dominican Republic", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "EC", "description": "Ecuador", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "EG", "description": "Egypt", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SV", "description": "El Salvador", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GQ", "description": "Equatorial Guinea", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ER", "description": "Eritrea", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "EE", "description": "Estonia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SZ", "description": "Eswatini", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ET", "description": "Ethiopia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FK", "description": "Falkland Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FO", "description": "Faroe Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FJ", "description": "Fiji", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FI", "description": "Finland", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FR", "description": "France", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GF", "description": "French Guiana", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PF", "description": "French Polynesia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TF", "description": "French Southern Territories", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GA", "description": "Gabon", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GM", "description": "Gambia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GE", "description": "Georgia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DE", "description": "Germany", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GH", "description": "Ghana", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GI", "description": "Gibraltar", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GR", "description": "Greece", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GL", "description": "Greenland", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GD", "description": "Grenada", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GP", "description": "Guadeloupe", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GU", "description": "Guam", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GT", "description": "Guatemala", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GG", "description": "Guernsey", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GN", "description": "Guinea", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GW", "description": "Guinea-Bissau", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GY", "description": "Guyana", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "HT", "description": "Haiti", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "HM", "description": "Heard & McDonald Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "HN", "description": "Honduras", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "HK", "description": "Hong Kong SAR China", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "HU", "description": "Hungary", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "IS", "description": "Iceland", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "IN", "description": "India", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ID", "description": "Indonesia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "IR", "description": "Iran", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "IQ", "description": "Iraq", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "IE", "description": "Ireland", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "IM", "description": "Isle of Man", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "IL", "description": "Israel", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "IT", "description": "Italy", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "JM", "description": "Jamaica", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "JP", "description": "Japan", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "JE", "description": "Jersey", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "JO", "description": "Jordan", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KZ", "description": "Kazakhstan", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KE", "description": "Kenya", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KI", "description": "Kiribati", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KW", "description": "Kuwait", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KG", "description": "Kyrgyzstan", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LA", "description": "Laos", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LV", "description": "Latvia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LB", "description": "Lebanon", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LS", "description": "Lesotho", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LR", "description": "Liberia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LY", "description": "Libya", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LI", "description": "Liechtenstein", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LT", "description": "Lithuania", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LU", "description": "Luxembourg", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MO", "description": "Macau SAR China", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MK", "description": "Macedonia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MG", "description": "Madagascar", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MW", "description": "Malawi", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MY", "description": "Malaysia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MV", "description": "Maldives", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ML", "description": "Mali", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MT", "description": "Malta", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MH", "description": "Marshall Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MQ", "description": "Martinique", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MR", "description": "Mauritania", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MU", "description": "Mauritius", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "YT", "description": "Mayotte", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MX", "description": "Mexico", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FM", "description": "Micronesia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MD", "description": "Moldova", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MC", "description": "Monaco", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MN", "description": "Mongolia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ME", "description": "Montenegro", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MS", "description": "Montserrat", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MA", "description": "Morocco", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MZ", "description": "Mozambique", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MM", "description": "Myanmar (Burma)", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NA", "description": "Namibia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NR", "description": "Nauru", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NP", "description": "Nepal", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NL", "description": "Netherlands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AN", "description": "Netherlands Antilles", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NC", "description": "New Caledonia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NZ", "description": "New Zealand", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NI", "description": "Nicaragua", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NE", "description": "Niger", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NG", "description": "Nigeria", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NU", "description": "Niue", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NF", "description": "Norfolk Island", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MP", "description": "Northern Mariana Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KP", "description": "North Korea", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NO", "description": "Norway", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "OM", "description": "Oman", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PK", "description": "Pakistan", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PW", "description": "Palau", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PS", "description": "Palestinian Territories", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PA", "description": "Panama", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PG", "description": "Papua New Guinea", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PY", "description": "Paraguay", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PE", "description": "Peru", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PH", "description": "Philippines", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PN", "description": "Pitcairn Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PL", "description": "Poland", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PT", "description": "Portugal", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "QA", "description": "Qatar", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "RE", "description": "Réunion", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "RO", "description": "Romania", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "RU", "description": "Russia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "RW", "description": "Rwanda", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "WS", "description": "Samoa", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SM", "description": "San Marino", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ST", "description": "São Tomé & Príncipe", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SA", "description": "Saudi Arabia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SN", "description": "Senegal", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "RS", "description": "Serbia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SC", "description": "Seychelles", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SL", "description": "Sierra Leone", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SG", "description": "Singapore", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SK", "description": "Slovakia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SI", "description": "Slovenia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SB", "description": "Solomon Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SO", "description": "Somalia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ZA", "description": "South Africa", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GS", "description": "South Georgia & South Sandwich Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KR", "description": "South Korea", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ES", "description": "Spain", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LK", "description": "Sri Lanka", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BL", "description": "St. Barthélemy", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SH", "description": "St. Helena", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "KN", "description": "St. Kitts & Nevis", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LC", "description": "St. Lucia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MF", "description": "St. Martin", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PM", "description": "St. Pierre & Miquelon", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "VC", "description": "St. Vincent & Grenadines", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SD", "description": "Sudan", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SR", "description": "Suriname", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SJ", "description": "Svalbard & Jan Mayen", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SE", "description": "Sweden", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CH", "description": "Switzerland", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SY", "description": "Syria", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TW", "description": "Taiwan", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TJ", "description": "Tajikistan", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TZ", "description": "Tanzania", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TH", "description": "Thailand", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TL", "description": "Timor-Leste", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TG", "description": "Togo", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TK", "description": "Tokelau", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TO", "description": "Tonga", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TT", "description": "Trinidad & Tobago", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TN", "description": "Tunisia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TR", "description": "Turkey", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TM", "description": "Turkmenistan", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TC", "description": "Turks & Caicos Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TV", "description": "Tuvalu", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UG", "description": "Uganda", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UA", "description": "Ukraine", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AE", "description": "United Arab Emirates", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GB", "description": "United Kingdom", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "US", "description": "United States", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UY", "description": "Uruguay", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UM", "description": "U.S. Outlying Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "VI", "description": "U.S. Virgin Islands", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UZ", "description": "Uzbekistan", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "VU", "description": "Vanuatu", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "VA", "description": "Vatican City", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "VE", "description": "Venezuela", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "VN", "description": "Vietnam", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "WF", "description": "Wallis & Futuna", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "EH", "description": "Western Sahara", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "YE", "description": "Yemen", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ZM", "description": "Zambia", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ZW", "description": "Zimbabwe", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -25558,31 +25867,31 @@ "name": "NONE", "description": "There are no templates or filters to be applied.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DATE", "description": "Forces attribute input to follow the date format.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TRIM", "description": "Strip whitespace (or other characters) from the beginning and end of the input.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "STRIPTAGS", "description": "Strip HTML Tags.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ESCAPEHTML", "description": "Escape HTML Entities.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -25634,55 +25943,78 @@ "name": "DATE_RANGE_MAX", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DATE_RANGE_MIN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FILE_EXTENSIONS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "INPUT_VALIDATION", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MAX_TEXT_LENGTH", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MIN_TEXT_LENGTH", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MAX_FILE_SIZE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MAX_IMAGE_HEIGHT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MAX_IMAGE_WIDTH", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ConfirmationStatusEnum", + "description": "List of account confirmation statuses.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACCOUNT_CONFIRMED", + "description": "Account confirmed", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ACCOUNT_CONFIRMATION_NOT_REQUIRED", + "description": "Account confirmation not required", + "isDeprecated": false, + "deprecationReason": null } ], "possibleTypes": null @@ -26371,6 +26703,254 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "ENUM", + "name": "SortQuoteItemsEnum", + "description": "Specifies the field to use for sorting quote items", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ITEM_ID", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_AT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_ID", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SKU", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DESCRIPTION", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WEIGHT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "QTY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_PRICE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOM_PRICE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_PERCENT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_DISCOUNT_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAX_PERCENT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAX_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_TAX_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ROW_TOTAL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_ROW_TOTAL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ROW_TOTAL_WITH_DISCOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ROW_WEIGHT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_TYPE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_TAX_BEFORE_DISCOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAX_BEFORE_DISCOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORIGINAL_CUSTOM_PRICE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_INC_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_PRICE_INC_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ROW_TOTAL_INC_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_ROW_TOTAL_INC_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_TAX_COMPENSATION_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FREE_SHIPPING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "QuoteItemsSortInput", + "description": "Specifies the field to use for sorting quote items", + "fields": null, + "inputFields": [ + { + "name": "field", + "description": "Specifies the quote items field to sort by", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortQuoteItemsEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "order", + "description": "Specifies the order of quote items' sorting", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "CustomizableOptionInput", @@ -27818,16 +28398,87 @@ "name": "PlaceOrderOutput", "description": "Contains the results of the request to place an order.", "fields": [ + { + "name": "errors", + "description": "An array of place order errors.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PlaceOrderError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "order", "description": "The ID of the order.", "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `orderV2` instead." + }, + { + "name": "orderV2", + "description": "Full order information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PlaceOrderError", + "description": "An error encountered while placing an order.", + "fields": [ + { + "name": "code", + "description": "An error code that is specific to place order.", + "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { - "kind": "OBJECT", - "name": "Order", + "kind": "ENUM", + "name": "PlaceOrderErrorCodes", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A localized error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", "ofType": null } }, @@ -28058,6 +28709,49 @@ "ofType": null } }, + "isDeprecated": true, + "deprecationReason": "Use `itemsV2` instead." + }, + { + "name": "itemsV2", + "description": null, + "args": [ + { + "name": "pageSize", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "sort", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "QuoteItemsSortInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartItems", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, @@ -28143,6 +28837,65 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "CartItems", + "description": "", + "fields": [ + { + "name": "items", + "description": "An array of products that have been added to the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Metadata for pagination rendering.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The number of returned cart items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "INTERFACE", "name": "CartAddressInterface", @@ -30421,19 +31174,19 @@ "name": "UNDEFINED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ITEM_QTY", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ITEM_INCREMENTS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -30476,12 +31229,12 @@ "deprecationReason": null }, { - "name": "is_discounting_locked", - "description": "Is quote discounting locked for line item.", + "name": "coupon", + "description": "The coupon related to the discount.", "args": [], "type": { - "kind": "SCALAR", - "name": "Boolean", + "kind": "OBJECT", + "name": "AppliedCoupon", "ofType": null }, "isDeprecated": false, @@ -30545,13 +31298,13 @@ "name": "ITEM", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SHIPPING", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -31093,33 +31846,191 @@ "name": "PRODUCT_NOT_FOUND", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NOT_SALABLE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "INSUFFICIENT_STOCK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNDEFINED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PERMISSION_DENIED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": 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": "INPUT_OBJECT", + "name": "EstimateTotalsInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "address", + "description": "Customer's address to estimate totals.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EstimateAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cart_id", + "description": "The unique ID of the cart to query.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "shipping_method", + "description": "Selected shipping method to estimate totals.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ShippingMethodInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "EstimateTotalsOutput", + "description": "Estimate totals output.", + "fields": [ + { + "name": "cart", + "description": "Cart after totals estimation", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "EstimateAddressInput", + "description": "Contains details about an address.", + "fields": null, + "inputFields": [ + { + "name": "country_code", + "description": "The two-letter code representing the customer's country.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCodeEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "postcode", + "description": "The customer's ZIP or postal code.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region", + "description": "An object containing the region name, region code, and region ID.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressRegionInput", + "ofType": null + }, + "defaultValue": null } ], + "interfaces": null, + "enumValues": null, "possibleTypes": null }, { @@ -32006,25 +32917,25 @@ "name": "OUT_OF_STOCK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNAVAILABLE_SKU", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "OPTIONS_UPDATED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LOW_QUANTITY", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -34588,6 +35499,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "product", + "description": "The ProductInterface object, which contains details about the base product", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "product_name", "description": "The name of the base product.", @@ -36367,13 +37290,13 @@ "name": "ACTIVE", "description": "Only active users.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "INACTIVE", "description": "Only inactive users.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -39739,13 +40662,13 @@ "name": "PRICE_RANGE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AS_LOW_AS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -39762,13 +40685,13 @@ "name": "TOGETHER", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SEPARATELY", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -39878,6 +40801,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "product", + "description": "The ProductInterface object, which contains details about the base product", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "product_name", "description": "The name of the base product.", @@ -42380,25 +43315,25 @@ "name": "PRODUCT_NOT_FOUND", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NOT_SALABLE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "INSUFFICIENT_STOCK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNDEFINED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -42749,13 +43684,13 @@ "name": "PRODUCT_NOT_FOUND", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNDEFINED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -44079,19 +45014,19 @@ "name": "VIRTUAL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PHYSICAL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "COMBINED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -44197,6 +45132,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "product", + "description": "The ProductInterface object, which contains details about the base product", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "product_name", "description": "The name of the base product.", @@ -45733,6 +46680,26 @@ "name": "CustomerOrder", "description": "Contains details about each of the customer's orders.", "fields": [ + { + "name": "applied_coupons", + "description": "Coupons applied to the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppliedCoupon", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "billing_address", "description": "The billing address for the order.", @@ -45801,6 +46768,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "email", + "description": "Order customer email.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "gift_message", "description": "The entered gift message for the order", @@ -46102,6 +47081,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "token", + "description": "The token that can be used to retrieve the order using order query.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "total", "description": "Details about the calculated totals for this order.", @@ -46209,6 +47204,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "product", + "description": "The ProductInterface object, which contains details about the base product", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "product_name", "description": "The name of the base product.", @@ -47382,19 +48389,19 @@ "name": "OUT_OF_STOCK", "description": "Used for handling out of stock products.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NOT_FOUND", "description": "Used for exceptions like EntityNotFound.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNDEFINED", "description": "Used for other exceptions, such as database connection failures.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -48168,13 +49175,13 @@ "name": "ACTIVE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "INACTIVE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -48191,13 +49198,13 @@ "name": "PRIVATE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PUBLIC", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -48521,37 +49528,37 @@ "name": "EVENT_INFORMATION", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PRIVACY_SETTINGS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "REGISTRANT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GENERAL_INFORMATION", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DETAILED_INFORMATION", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SHIPPING_ADDRESS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -53192,6 +54199,125 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "ApplyCouponsToCartInput", + "description": "Apply coupons to the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "coupon_codes", + "description": "An array of valid coupon codes.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "type", + "description": "`replace` to replace the existing coupon(s) or `append` to add the coupon to the coupon(s) list.", + "type": { + "kind": "ENUM", + "name": "ApplyCouponsStrategy", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RemoveCouponsFromCartInput", + "description": "Remove coupons from the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "coupon_codes", + "description": "An array of coupon codes to be removed from the quote. If coupon_codes is empty all coupons will be removed from the quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ApplyCouponsStrategy", + "description": "The strategy to apply coupons to the cart.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "APPEND", + "description": "Append new coupons keeping the coupons that have been applied before.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REPLACE", + "description": "Remove all the coupons from the cart and apply only new provided coupons.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "OBJECT", "name": "ReorderItemsOutput", @@ -53374,13 +54500,13 @@ "name": "NUMBER", "description": "Sorts customer orders by number", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CREATED_AT", "description": "Sorts customer orders by created_at field", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -53740,6 +54866,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "product", + "description": "The ProductInterface object, which contains details about the base product", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "product_name", "description": "The name of the base product.", @@ -55605,31 +56743,31 @@ "name": "REORDER_NOT_AVAILABLE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PRODUCT_NOT_FOUND", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NOT_SALABLE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "INSUFFICIENT_STOCK", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNDEFINED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -55646,23 +56784,101 @@ "name": "GLOBAL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "WEBSITE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "STORE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "OrderTokenInput", + "description": "Input to retrieve an order based on token.", + "fields": null, + "inputFields": [ + { + "name": "token", + "description": "Order token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "OrderInformationInput", + "description": "Input to retrieve an order based on details.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "Order billing address email.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "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": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "RequestNegotiableQuoteInput", @@ -55697,16 +56913,6 @@ }, "defaultValue": null }, - { - "name": "is_draft", - "description": "Flag indicating if quote is draft or not.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, { "name": "quote_name", "description": "The name the buyer assigned to the negotiable quote request.", @@ -56358,55 +57564,6 @@ "enumValues": null, "possibleTypes": null }, - { - "kind": "INPUT_OBJECT", - "name": "RenameNegotiableQuoteInput", - "description": "Sets new name for a negotiable quote.", - "fields": null, - "inputFields": [ - { - "name": "quote_comment", - "description": "The reason for the quote name change specified by the buyer.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "quote_name", - "description": "The new quote name the buyer specified to the negotiable quote request.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "quote_uid", - "description": "The cart ID of the buyer requesting a new negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, { "kind": "OBJECT", "name": "SetLineItemNoteOutput", @@ -56710,29 +57867,6 @@ "enumValues": null, "possibleTypes": null }, - { - "kind": "OBJECT", - "name": "RenameNegotiableQuoteOutput", - "description": "Contains the updated negotiable quote.", - "fields": [ - { - "name": "quote", - "description": "The negotiable quote after updating the name.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuote", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, { "kind": "UNION", "name": "CloseNegotiableQuoteOperationResult", @@ -57111,19 +58245,19 @@ "name": "QUOTE_NAME", "description": "Sorts negotiable quotes by name.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CREATED_AT", "description": "Sorts negotiable quotes by the dates they were created.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sorts negotiable quotes by the dates they were last modified.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -57256,13 +58390,13 @@ "name": "BUYER", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SELLER", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -57542,49 +58676,49 @@ "name": "SUBMITTED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PENDING", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UPDATED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "OPEN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ORDERED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CLOSED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DECLINED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "EXPIRED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -58063,25 +59197,25 @@ "name": "CREATED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UPDATED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CLOSED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UPDATED_BY_SYSTEM", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -59338,37 +60472,37 @@ "name": "ALLOCATION", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UPDATE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PURCHASE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "REIMBURSEMENT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "REFUND", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "REVERT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -59385,13 +60519,13 @@ "name": "CUSTOMER", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ADMIN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -59472,25 +60606,25 @@ "name": "NOT_ACTIVE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SUBSCRIBED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNSUBSCRIBED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNCONFIRMED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -59763,19 +60897,19 @@ "name": "SPECIFIED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CART_PRICE_RULE_RELATED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CATALOG_PRICE_RULE_RELATED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -59792,31 +60926,31 @@ "name": "CONTENT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "HEADER", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FOOTER", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LEFT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "RIGHT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -60238,31 +61372,31 @@ "name": "PRODUCT_DETAIL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MINICART", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CART", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CHECKOUT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ADMIN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -61899,13 +63033,13 @@ "name": "TEST", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LIVE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -62785,31 +63919,31 @@ "name": "NOT_FOUND", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "OPERATION_NOT_APPLICABLE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "COULD_NOT_SAVE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NOT_VALID_DATA", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNDEFINED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -62826,31 +63960,31 @@ "name": "REJECT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CANCEL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "VALIDATE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "APPROVE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PLACE_ORDER", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -62867,55 +64001,55 @@ "name": "PENDING", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "APPROVAL_REQUIRED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "APPROVED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ORDER_IN_PROGRESS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ORDER_PLACED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ORDER_FAILED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "REJECTED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CANCELED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "APPROVED_PENDING_PAYMENT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -64127,25 +65261,25 @@ "name": "MORE_THAN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LESS_THAN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MORE_THAN_OR_EQUAL_TO", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "LESS_THAN_OR_EQUAL_TO", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -64162,13 +65296,13 @@ "name": "ENABLED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DISABLED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -64185,19 +65319,19 @@ "name": "GRAND_TOTAL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SHIPPING_INCL_TAX", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NUMBER_OF_SKUS", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -64332,19 +65466,19 @@ "name": "PENDING", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "APPROVED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "REJECTED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -64484,31 +65618,31 @@ "name": "NOT_FOUND", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "OPERATION_NOT_APPLICABLE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "COULD_NOT_SAVE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NOT_VALID_DATA", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNDEFINED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -64620,13 +65754,13 @@ "name": "UNDEFINED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NOT_FOUND", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -64750,25 +65884,25 @@ "name": "NOT_FOUND", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNAUTHORISED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "INACTIVE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNDEFINED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -64785,61 +65919,61 @@ "name": "PLACE_ORDER", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CONTACT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CUSTOMER_LOGIN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CUSTOMER_FORGOT_PASSWORD", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CUSTOMER_CREATE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CUSTOMER_EDIT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NEWSLETTER", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PRODUCT_REVIEW", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SENDFRIEND", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "BRAINTREE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -65812,13 +66946,13 @@ "name": "SUBSCRIBED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "NOT_SUBSCRIBED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -67348,13 +68482,13 @@ "name": "INFORMATION", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "ERROR", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -67490,73 +68624,73 @@ "name": "PENDING", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AUTHORIZED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PARTIALLY_AUTHORIZED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "RECEIVED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PARTIALLY_RECEIVED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "APPROVED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PARTIALLY_APPROVED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "REJECTED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PARTIALLY_REJECTED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DENIED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PROCESSED_AND_CLOSED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "CLOSED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -67573,37 +68707,37 @@ "name": "PENDING", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "AUTHORIZED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "RECEIVED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "APPROVED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "REJECTED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DENIED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -67620,13 +68754,13 @@ "name": "PUBLIC", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PRIVATE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -68616,109 +69750,138 @@ "name": "BOOLEAN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DATE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DATETIME", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "DROPDOWN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FILE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "GALLERY", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "HIDDEN", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "IMAGE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MEDIA_IMAGE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MULTILINE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "MULTISELECT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "PRICE", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "SELECT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TEXT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "TEXTAREA", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "UNDEFINED", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "VISUAL", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "WEIGHT", "description": "", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "TaxWrappingEnum", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DISPLAY_EXCLUDING_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISPLAY_INCLUDING_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISPLAY_TYPE_BOTH", + "description": "", + "isDeprecated": false, + "deprecationReason": null } ], "possibleTypes": null @@ -68876,13 +70039,13 @@ "name": "card", "description": "phpcs:ignore Magento2.GraphQL.ValidArgumentName", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "account", "description": "phpcs:ignore Magento2.GraphQL.ValidArgumentName", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null @@ -68934,31 +70097,31 @@ "name": "INCLUDE_FPT_WITHOUT_DETAILS", "description": "The displayed price includes the FPT amount without displaying the `ProductPrice.fixed_product_taxes` values. This value corresponds to 'Including FPT only'.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "INCLUDE_FPT_WITH_DETAILS", "description": "The displayed price includes the FPT amount while displaying the values of `ProductPrice.fixed_product_taxes` separately. This value corresponds to 'Including FPT and FPT description'.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "EXCLUDE_FPT_AND_INCLUDE_WITH_DETAILS", "description": "The displayed price does not include the FPT amount. The values of `ProductPrice.fixed_product_taxes` and the price including the FPT are displayed separately. This value corresponds to 'Excluding FPT, Including FPT description and final price.'", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "EXCLUDE_FPT_WITHOUT_DETAILS", "description": "The displayed price does not include the FPT amount. The values from `ProductPrice.fixed_product_taxes` are not displayed. This value corresponds to 'Excluding FPT'.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null }, { "name": "FPT_DISABLED", "description": "The FPT feature is not enabled. You can omit `ProductPrice.fixed_product_taxes` from your query.", "isDeprecated": false, - "deprecationReason": "" + "deprecationReason": null } ], "possibleTypes": null diff --git a/spectaql/schema_beta.json b/spectaql/schema_beta.json deleted file mode 100644 index 48d6ea512..000000000 --- a/spectaql/schema_beta.json +++ /dev/null @@ -1,70124 +0,0 @@ -{ - "__schema": { - "queryType": { - "name": "Query" - }, - "mutationType": { - "name": "Mutation" - }, - "subscriptionType": null, - "types": [ - { - "kind": "OBJECT", - "name": "Query", - "description": "", - "fields": [ - { - "name": "attributesForm", - "description": "Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options.", - "args": [ - { - "name": "formCode", - "description": "Form code.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AttributesFormOutput", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "attributesList", - "description": "Returns a list of attributes metadata for a given entity type.", - "args": [ - { - "name": "entityType", - "description": "Entity type.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "AttributeEntityTypeEnum", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "filters", - "description": "Identifies which filter inputs to search for and return.", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AttributesMetadataOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "availableStores", - "description": "Get a list of available store views and their config information.", - "args": [ - { - "name": "useCurrentGroup", - "description": "Filter store views by the current store group.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "StoreConfig", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "cart", - "description": "Return information about the specified shopping cart.", - "args": [ - { - "name": "cart_id", - "description": "The unique ID of the cart to query.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "categories", - "description": "Return a list of categories that match the specified filter.", - "args": [ - { - "name": "filters", - "description": "Identifies which Category filter inputs to search for and return.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CategoryFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pageSize", - "description": "Specifies the maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "Specifies which page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "OBJECT", - "name": "CategoryResult", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category", - "description": "Search for categories that match the criteria specified in the `search` and `filter` attributes.", - "args": [ - { - "name": "id", - "description": "The category ID to use as the root of the search.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CategoryTree", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `categories` instead." - }, - { - "name": "categoryList", - "description": "Return an array of categories based on the specified filters.", - "args": [ - { - "name": "filters", - "description": "Identifies which Category filter inputs to search for and return.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CategoryFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pageSize", - "description": "Specifies the maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "Specifies which page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CategoryTree", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `categories` instead." - }, - { - "name": "checkoutAgreements", - "description": "Return Terms and Conditions configuration information.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CheckoutAgreement", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "cmsBlocks", - "description": "Return information about CMS blocks.", - "args": [ - { - "name": "identifiers", - "description": "An array of CMS block IDs.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CmsBlocks", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "cmsPage", - "description": "Return details about a CMS page.", - "args": [ - { - "name": "id", - "description": "The ID of the CMS page.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "identifier", - "description": "The identifier of the CMS page.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CmsPage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "company", - "description": "Return detailed information about the authenticated customer's company.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Company", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "compareList", - "description": "Return products that have been added to the specified compare list.", - "args": [ - { - "name": "uid", - "description": "The unique ID of the compare list to be queried.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CompareList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "countries", - "description": "The countries query provides information for all countries.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Country", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country", - "description": "The countries query provides information for a single country.", - "args": [ - { - "name": "id", - "description": "", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "Country", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "currency", - "description": "Return information about the store's currency.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Currency", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customAttributeMetadata", - "description": "Return the attribute type, given an attribute code and entity type.", - "args": [ - { - "name": "attributes", - "description": "An input object that specifies the attribute code and entity type to search.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "AttributeInput", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CustomAttributeMetadata", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `customAttributeMetadataV2` query instead." - }, - { - "name": "customAttributeMetadataV2", - "description": "Retrieve EAV attributes metadata.", - "args": [ - { - "name": "attributes", - "description": "", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "AttributeInput", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AttributesMetadataOutput", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customer", - "description": "Return detailed information about a customer account.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customerCart", - "description": "Return information about the customer's shopping cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customerDownloadableProducts", - "description": "Return a list of downloadable products the customer has purchased.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomerDownloadableProducts", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customerOrders", - "description": null, - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomerOrders", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `customer` query instead." - }, - { - "name": "customerPaymentTokens", - "description": "Return a list of customer payment tokens stored in the vault.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomerPaymentTokens", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "dynamicBlocks", - "description": "Return a list of dynamic blocks filtered by type, location, or UIDs.", - "args": [ - { - "name": "input", - "description": "Defines the filter for returning matching dynamic blocks.", - "type": { - "kind": "INPUT_OBJECT", - "name": "DynamicBlocksFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DynamicBlocks", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "getHostedProUrl", - "description": "Retrieve the secure PayPal URL for a Payments Pro Hosted Solution transaction.", - "args": [ - { - "name": "input", - "description": "An input object that specifies the cart ID.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "HostedProUrlInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "HostedProUrl", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "getPayflowLinkToken", - "description": "Retrieve payment credentials for a transaction. Use this query for Payflow Link and Payments Advanced payment methods.", - "args": [ - { - "name": "input", - "description": "An input object that defines the requirements to receive a payment token.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PayflowLinkTokenInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PayflowLinkToken", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "getPaymentConfig", - "description": "Retrieves the payment configuration for a given location", - "args": [ - { - "name": "location", - "description": "Defines the origin location for that payment request", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "PaymentLocation", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PaymentConfigOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "getPaymentOrder", - "description": "Retrieves the payment details for the order", - "args": [ - { - "name": "cartId", - "description": "The customer cart ID", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "id", - "description": "PayPal order ID", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PaymentOrderOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "getPaymentSDK", - "description": "Gets the payment SDK urls and values", - "args": [ - { - "name": "location", - "description": "Defines the origin location for that payment request", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "PaymentLocation", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "GetPaymentSDKOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "giftCardAccount", - "description": "Return details about a specific gift card.", - "args": [ - { - "name": "input", - "description": "An input object that specifies the gift card code.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "GiftCardAccountInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "GiftCardAccount", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "giftRegistry", - "description": "Return the specified gift registry. Some details will not be available to guests.", - "args": [ - { - "name": "giftRegistryUid", - "description": "The unique ID of the registry to search for.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "GiftRegistry", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "giftRegistryEmailSearch", - "description": "Search for gift registries by specifying a registrant email address.", - "args": [ - { - "name": "email", - "description": "The registrant's email.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftRegistrySearchResult", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "giftRegistryIdSearch", - "description": "Search for gift registries by specifying a registry URL key.", - "args": [ - { - "name": "giftRegistryUid", - "description": "The unique ID of the gift registry.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftRegistrySearchResult", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "giftRegistryTypeSearch", - "description": "Search for gift registries by specifying the registrant name and registry type ID.", - "args": [ - { - "name": "firstName", - "description": "The first name of the registrant.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "lastName", - "description": "The last name of the registrant.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "giftRegistryTypeUid", - "description": "The type UID of the registry.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftRegistrySearchResult", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "giftRegistryTypes", - "description": "Get a list of available gift registry types.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftRegistryType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "isCompanyAdminEmailAvailable", - "description": "Check whether the specified email can be used to register a company admin.", - "args": [ - { - "name": "email", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "IsCompanyAdminEmailAvailableOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "isCompanyEmailAvailable", - "description": "Check whether the specified email can be used to register a new company.", - "args": [ - { - "name": "email", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "IsCompanyEmailAvailableOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "isCompanyRoleNameAvailable", - "description": "Check whether the specified role name is valid for the company.", - "args": [ - { - "name": "name", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "IsCompanyRoleNameAvailableOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "isCompanyUserEmailAvailable", - "description": "Check whether the specified email can be used to register a company user.", - "args": [ - { - "name": "email", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "IsCompanyUserEmailAvailableOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "isEmailAvailable", - "description": "Check whether the specified email has already been used to create a customer account.", - "args": [ - { - "name": "email", - "description": "The email address to check.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "IsEmailAvailableOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "negotiableQuote", - "description": "Retrieve the specified negotiable quote.", - "args": [ - { - "name": "uid", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuote", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "negotiableQuotes", - "description": "Return a list of negotiable quotes that can be viewed by the logged-in customer.", - "args": [ - { - "name": "filter", - "description": "The filter to use to determine which negotiable quotes to return.", - "type": { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "sort", - "description": "The field to use for sorting results.", - "type": { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteSortInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuotesOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "pickupLocations", - "description": "The pickup locations query searches for locations that match the search request requirements.", - "args": [ - { - "name": "area", - "description": "Perform search by location using radius and search term.", - "type": { - "kind": "INPUT_OBJECT", - "name": "AreaInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "filters", - "description": "Apply filters by attributes.", - "type": { - "kind": "INPUT_OBJECT", - "name": "PickupLocationFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "sort", - "description": "Specifies which attribute to sort on, and whether to return the results in ascending or descending order.", - "type": { - "kind": "INPUT_OBJECT", - "name": "PickupLocationSortInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pageSize", - "description": "The maximum number of pickup locations to return at once. The attribute is optional.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "Specifies which page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "productsInfo", - "description": "Information about products which should be delivered.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "ProductInfoInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PickupLocations", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "productReviewRatingsMetadata", - "description": "Return the active ratings attributes and the values each rating can have.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviewRatingsMetadata", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "products", - "description": "Search for products that match the criteria specified in the `search` and `filter` attributes.", - "args": [ - { - "name": "search", - "description": "One or more keywords to use in a full-text search.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "filter", - "description": "The product attributes to search for and return.", - "type": { - "kind": "INPUT_OBJECT", - "name": "ProductAttributeFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "sort", - "description": "Specifies which attributes to sort on, and whether to return the results in ascending or descending order.", - "type": { - "kind": "INPUT_OBJECT", - "name": "ProductAttributeSortInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "Products", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "recaptchaV3Config", - "description": "Returns details about Google reCAPTCHA V3-Invisible configuration.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ReCaptchaConfigurationV3", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "route", - "description": "Return the full details for a specified product, category, or CMS page.", - "args": [ - { - "name": "url", - "description": "A `url_key` appended by the `url_suffix, if one exists.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "storeConfig", - "description": "Return details about the store's configuration.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "StoreConfig", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "urlResolver", - "description": "Return the relative URL for a specified product, category or CMS page.", - "args": [ - { - "name": "url", - "description": "A `url_key` appended by the `url_suffix, if one exists.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "EntityUrl", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `route` query instead." - }, - { - "name": "wishlist", - "description": "Return the contents of a customer's wish list.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "WishlistOutput", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Moved under `Customer.wishlist`." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "SCALAR", - "name": "String", - "description": "The `String` scalar type represents textual data, represented as UTF-8\ncharacter sequences. The String type is most often used by GraphQL to\nrepresent free-form human-readable text.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "SCALAR", - "name": "ID", - "description": "The `ID` scalar type represents a unique identifier, often used to\nrefetch an object or as key for a cache. The ID type appears in a JSON\nresponse as a String; however, it is not intended to be human-readable.\nWhen expected as an input type, any string (such as `\"4\"`) or integer\n(such as `4`) input value will be accepted as an ID.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "SCALAR", - "name": "Boolean", - "description": "The `Boolean` scalar type represents `true` or `false`.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "SCALAR", - "name": "Int", - "description": "The `Int` scalar type represents non-fractional signed whole numeric\nvalues. Int can represent values between -(2^31) and 2^31 - 1. ", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "SCALAR", - "name": "Float", - "description": "The `Float` scalar type represents signed double-precision fractional\nvalues as specified by\n[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). ", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Mutation", - "description": "", - "fields": [ - { - "name": "addBundleProductsToCart", - "description": "Add one or more bundle products to the specified cart. We recommend using `addProductsToCart` instead.", - "args": [ - { - "name": "input", - "description": "An input object that defines which bundle products to add to the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "AddBundleProductsToCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddBundleProductsToCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addConfigurableProductsToCart", - "description": "Add one or more configurable products to the specified cart. We recommend using `addProductsToCart` instead.", - "args": [ - { - "name": "input", - "description": "An input object that defines which configurable products to add to the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "AddConfigurableProductsToCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddConfigurableProductsToCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addDownloadableProductsToCart", - "description": "Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead.", - "args": [ - { - "name": "input", - "description": "An input object that defines which downloadable products to add to the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "AddDownloadableProductsToCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddDownloadableProductsToCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addGiftRegistryRegistrants", - "description": "Add registrants to the specified gift registry.", - "args": [ - { - "name": "giftRegistryUid", - "description": "The unique ID of the gift registry.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "registrants", - "description": "An array registrants to add.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "AddGiftRegistryRegistrantInput", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddGiftRegistryRegistrantsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addProductsToCart", - "description": "Add any type of product to the cart.", - "args": [ - { - "name": "cartId", - "description": "The cart ID of the shopper.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cartItems", - "description": "An array that defines the products to add to the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddProductsToCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addProductsToCompareList", - "description": "Add products to the specified compare list.", - "args": [ - { - "name": "input", - "description": "An input object that defines which products to add to an existing compare list.", - "type": { - "kind": "INPUT_OBJECT", - "name": "AddProductsToCompareListInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CompareList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addProductsToRequisitionList", - "description": "Add items to the specified requisition list.", - "args": [ - { - "name": "requisitionListUid", - "description": "The unique ID of the requisition list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "requisitionListItems", - "description": "An array of products to be added to the requisition list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "RequisitionListItemsInput", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddProductsToRequisitionListOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addProductsToWishlist", - "description": "Add one or more products to the specified wish list. This mutation supports all product types.", - "args": [ - { - "name": "wishlistId", - "description": "The ID of a wish list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "wishlistItems", - "description": "An array of products to add to the wish list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "WishlistItemInput", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddProductsToWishlistOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addPurchaseOrderComment", - "description": "Add a comment to an existing purchase order.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "AddPurchaseOrderCommentInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddPurchaseOrderCommentOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addPurchaseOrderItemsToCart", - "description": "Add purchase order items to the shopping cart.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "AddPurchaseOrderItemsToCartInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddProductsToCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addRequisitionListItemsToCart", - "description": "Add items in the requisition list to the customer's cart.", - "args": [ - { - "name": "requisitionListUid", - "description": "The unique ID of the requisition list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "requisitionListItemUids", - "description": "An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddRequisitionListItemsToCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addReturnComment", - "description": "Add a comment to an existing return.", - "args": [ - { - "name": "input", - "description": "An input object that defines a return comment.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "AddReturnCommentInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddReturnCommentOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addReturnTracking", - "description": "Add tracking information to the return.", - "args": [ - { - "name": "input", - "description": "An input object that defines tracking information.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "AddReturnTrackingInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddReturnTrackingOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addSimpleProductsToCart", - "description": "Add one or more simple products to the specified cart. We recommend using `addProductsToCart` instead.", - "args": [ - { - "name": "input", - "description": "An input object that defines which simple products to add to the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "AddSimpleProductsToCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddSimpleProductsToCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addVirtualProductsToCart", - "description": "Add one or more virtual products to the specified cart. We recommend using `addProductsToCart` instead.", - "args": [ - { - "name": "input", - "description": "An input object that defines which virtual products to add to the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "AddVirtualProductsToCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddVirtualProductsToCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "addWishlistItemsToCart", - "description": "Add items in the specified wishlist to the customer's cart.", - "args": [ - { - "name": "wishlistId", - "description": "The unique ID of the wish list", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "wishlistItemIds", - "description": "An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AddWishlistItemsToCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "applyCouponToCart", - "description": "Apply a pre-defined coupon code to the specified cart.", - "args": [ - { - "name": "input", - "description": "An input object that defines the coupon code to apply to the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "ApplyCouponToCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ApplyCouponToCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "applyGiftCardToCart", - "description": "Apply a pre-defined gift card code to the specified cart.", - "args": [ - { - "name": "input", - "description": "An input object that specifies the gift card code and cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "ApplyGiftCardToCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ApplyGiftCardToCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "applyRewardPointsToCart", - "description": "Apply all available points, up to the cart total. Partial redemption is not available.", - "args": [ - { - "name": "cartId", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ApplyRewardPointsToCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "applyStoreCreditToCart", - "description": "Apply store credit to the specified cart.", - "args": [ - { - "name": "input", - "description": "An input object that specifies the cart ID.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "ApplyStoreCreditToCartInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ApplyStoreCreditToCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "approvePurchaseOrders", - "description": "Approve purchase orders.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PurchaseOrdersActionInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PurchaseOrdersActionOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "assignCompareListToCustomer", - "description": "Assign the specified compare list to the logged in customer.", - "args": [ - { - "name": "uid", - "description": "The unique ID of the compare list to be assigned.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "AssignCompareListToCustomerOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "assignCustomerToGuestCart", - "description": "Assign a logged-in customer to the specified guest shopping cart.", - "args": [ - { - "name": "cart_id", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "cancelOrder", - "description": "Cancel the specified customer order.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CancelOrderInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CancelOrderOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "cancelPurchaseOrders", - "description": "Cancel purchase orders.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PurchaseOrdersActionInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PurchaseOrdersActionOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "changeCustomerPassword", - "description": "Change the password for the logged-in customer.", - "args": [ - { - "name": "currentPassword", - "description": "The customer's original password.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "newPassword", - "description": "The customer's updated password.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "clearCart", - "description": "Remove all items from the specified cart.", - "args": [ - { - "name": "input", - "description": "An input object that defines cart ID of the shopper.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "ClearCartInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ClearCartOutput", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "clearCustomerCart", - "description": "Remove all items from the specified cart.", - "args": [ - { - "name": "cartUid", - "description": "The masked ID of the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ClearCustomerCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "closeNegotiableQuotes", - "description": "Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront.", - "args": [ - { - "name": "input", - "description": "An input object that closes a negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CloseNegotiableQuotesInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CloseNegotiableQuotesOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "contactUs", - "description": "Send a 'Contact Us' email to the merchant.", - "args": [ - { - "name": "input", - "description": "An input object that defines shopper information.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "ContactUsInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ContactUsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "copyItemsBetweenRequisitionLists", - "description": "Copy items from one requisition list to another.", - "args": [ - { - "name": "sourceRequisitionListUid", - "description": "The unique ID of the source requisition list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "destinationRequisitionListUid", - "description": "The unique ID of the destination requisition list. If null, a new requisition list will be created.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "requisitionListItem", - "description": "The list of products to copy.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CopyItemsBetweenRequisitionListsInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CopyItemsFromRequisitionListsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "copyProductsBetweenWishlists", - "description": "Copy products from one wish list to another. The original wish list is unchanged.", - "args": [ - { - "name": "sourceWishlistUid", - "description": "The ID of the original wish list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "destinationWishlistUid", - "description": "The ID of the target wish list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "wishlistItems", - "description": "An array of items to copy.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "WishlistItemCopyInput", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CopyProductsBetweenWishlistsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createBraintreeClientToken", - "description": "Creates Client Token for Braintree Javascript SDK initialization.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createBraintreePayPalClientToken", - "description": "Creates Client Token for Braintree PayPal Javascript SDK initialization.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createBraintreePayPalVaultClientToken", - "description": "Creates Client Token for Braintree PayPal Vault Javascript SDK initialization.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "BraintreeVaultInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createCompany", - "description": "Create a company at the request of either a customer or a guest.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyCreateInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CreateCompanyOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createCompanyRole", - "description": "Create a new company role.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyRoleCreateInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CreateCompanyRoleOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createCompanyTeam", - "description": "Create a new team for the authenticated customer's company.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyTeamCreateInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CreateCompanyTeamOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createCompanyUser", - "description": "Create a new company user at the request of an existing customer.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyUserCreateInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CreateCompanyUserOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createCompareList", - "description": "Create a new compare list. The compare list is saved for logged in customers.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "CreateCompareListInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CompareList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createCustomer", - "description": "Use `createCustomerV2` instead.", - "args": [ - { - "name": "input", - "description": "An input object that defines the customer to be created.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomerInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CustomerOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createCustomerAddress", - "description": "Create a billing or shipping address for a customer or guest.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CustomerAddress", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createCustomerV2", - "description": "Create a customer account.", - "args": [ - { - "name": "input", - "description": "An input object that defines the customer to be created.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomerCreateInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CustomerOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createEmptyCart", - "description": "Create an empty shopping cart for a guest or logged in user", - "args": [ - { - "name": "input", - "description": "An optional input object that assigns the specified ID to the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "createEmptyCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `Mutation.createGuestCart` or `Query.customerCart` for logged in customer" - }, - { - "name": "createGiftRegistry", - "description": "Create a gift registry on behalf of the customer.", - "args": [ - { - "name": "giftRegistry", - "description": "An input object that defines a new gift registry.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CreateGiftRegistryInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CreateGiftRegistryOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createGuestCart", - "description": "Create a new shopping cart", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "CreateGuestCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CreateGuestCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createPayflowProToken", - "description": "Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods", - "args": [ - { - "name": "input", - "description": "An input object that defines the requirements to fetch payment token information.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PayflowProTokenInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CreatePayflowProTokenOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createPaymentOrder", - "description": "Creates a payment order for further payment processing", - "args": [ - { - "name": "input", - "description": "Contains payment order details that are used while processing the payment order", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CreatePaymentOrderInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CreatePaymentOrderOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createPaypalExpressToken", - "description": "Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods.", - "args": [ - { - "name": "input", - "description": "An input object that defines the requirements to receive a payment token.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PaypalExpressTokenInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PaypalExpressTokenOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createProductReview", - "description": "Create a product review for the specified product.", - "args": [ - { - "name": "input", - "description": "An input object that contains the details necessary to create a product review.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CreateProductReviewInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CreateProductReviewOutput", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createPurchaseOrderApprovalRule", - "description": "Create a purchase order approval rule.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PurchaseOrderApprovalRuleInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalRule", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createRequisitionList", - "description": "Create an empty requisition list.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "CreateRequisitionListInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CreateRequisitionListOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createWishlist", - "description": "Create a new wish list.", - "args": [ - { - "name": "input", - "description": "An input object that defines a new wish list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CreateWishlistInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CreateWishlistOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deleteCompanyRole", - "description": "Delete the specified company role.", - "args": [ - { - "name": "id", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "DeleteCompanyRoleOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deleteCompanyTeam", - "description": "Delete the specified company team.", - "args": [ - { - "name": "id", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "DeleteCompanyTeamOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deleteCompanyUser", - "description": "Delete the specified company user.", - "args": [ - { - "name": "id", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "DeleteCompanyUserOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deleteCompareList", - "description": "Delete the specified compare list.", - "args": [ - { - "name": "uid", - "description": "The unique ID of the compare list to be deleted.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "DeleteCompareListOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deleteCustomer", - "description": "Delete customer account", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deleteCustomerAddress", - "description": "Delete the billing or shipping address of a customer.", - "args": [ - { - "name": "id", - "description": "The ID of the customer address to be deleted.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deleteNegotiableQuotes", - "description": "Delete a negotiable quote. The negotiable quote will not be displayed on the storefront.", - "args": [ - { - "name": "input", - "description": "An input object that deletes a negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "DeleteNegotiableQuotesInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "DeleteNegotiableQuotesOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deletePaymentToken", - "description": "Delete a customer's payment token.", - "args": [ - { - "name": "public_hash", - "description": "The reusable payment token securely stored in the vault.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "DeletePaymentTokenOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deletePurchaseOrderApprovalRule", - "description": "Delete existing purchase order approval rules.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "DeletePurchaseOrderApprovalRuleInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "DeletePurchaseOrderApprovalRuleOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deleteRequisitionList", - "description": "Delete a requisition list.", - "args": [ - { - "name": "requisitionListUid", - "description": "The unique ID of the requisition list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "DeleteRequisitionListOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deleteRequisitionListItems", - "description": "Delete items from a requisition list.", - "args": [ - { - "name": "requisitionListUid", - "description": "The unique ID of the requisition list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "requisitionListItemUids", - "description": "An array of UIDs representing products to be removed from the requisition list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "DeleteRequisitionListItemsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deleteWishlist", - "description": "Delete the specified wish list. You cannot delete the customer's default (first) wish list.", - "args": [ - { - "name": "wishlistId", - "description": "The ID of the wish list to delete.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "DeleteWishlistOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "generateCustomerToken", - "description": "Generate a token for specified customer.", - "args": [ - { - "name": "email", - "description": "The customer's email address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "password", - "description": "The customer's password.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CustomerToken", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "generateCustomerTokenAsAdmin", - "description": "Request a customer token so that an administrator can perform remote shopping assistance.", - "args": [ - { - "name": "input", - "description": "An input object that defines the customer email address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "GenerateCustomerTokenAsAdminInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "GenerateCustomerTokenAsAdminOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "handlePayflowProResponse", - "description": "Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods.", - "args": [ - { - "name": "input", - "description": "An input object that includes the payload returned by PayPal and the cart ID.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PayflowProResponseInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PayflowProResponseOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "mergeCarts", - "description": "Transfer the contents of a guest cart into the cart of a logged-in customer.", - "args": [ - { - "name": "source_cart_id", - "description": "The guest's cart ID before they login.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "destination_cart_id", - "description": "The cart ID after the guest logs in.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "moveCartItemsToGiftRegistry", - "description": "Move all items from the cart to a gift registry.", - "args": [ - { - "name": "cartUid", - "description": "The unique ID of the cart containing items to be moved to a gift registry.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "giftRegistryUid", - "description": "The unique ID of the target gift registry.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "MoveCartItemsToGiftRegistryOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "moveItemsBetweenRequisitionLists", - "description": "Move Items from one requisition list to another.", - "args": [ - { - "name": "sourceRequisitionListUid", - "description": "The unique ID of the source requisition list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "destinationRequisitionListUid", - "description": "The unique ID of the destination requisition list. If null, a new requisition list will be created.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "requisitionListItem", - "description": "The list of products to move.", - "type": { - "kind": "INPUT_OBJECT", - "name": "MoveItemsBetweenRequisitionListsInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "MoveItemsBetweenRequisitionListsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "moveProductsBetweenWishlists", - "description": "Move products from one wish list to another.", - "args": [ - { - "name": "sourceWishlistUid", - "description": "The ID of the original wish list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "destinationWishlistUid", - "description": "The ID of the target wish list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "wishlistItems", - "description": "An array of items to move.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "WishlistItemMoveInput", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "MoveProductsBetweenWishlistsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "placeNegotiableQuoteOrder", - "description": "Convert a negotiable quote into an order.", - "args": [ - { - "name": "input", - "description": "An input object that specifies the negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PlaceNegotiableQuoteOrderInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PlaceNegotiableQuoteOrderOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "placeOrder", - "description": "Convert the quote into an order.", - "args": [ - { - "name": "input", - "description": "An input object that defines the shopper's cart ID.", - "type": { - "kind": "INPUT_OBJECT", - "name": "PlaceOrderInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PlaceOrderOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "placeOrderForPurchaseOrder", - "description": "Convert the purchase order into an order.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PlaceOrderForPurchaseOrderInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PlaceOrderForPurchaseOrderOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "placePurchaseOrder", - "description": "Place a purchase order.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PlacePurchaseOrderInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PlacePurchaseOrderOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "redeemGiftCardBalanceAsStoreCredit", - "description": "Redeem a gift card for store credit.", - "args": [ - { - "name": "input", - "description": "An input object that specifies the gift card code to redeem.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "GiftCardAccountInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "GiftCardAccount", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "rejectPurchaseOrders", - "description": "Reject purchase orders.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PurchaseOrdersActionInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PurchaseOrdersActionOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "removeCouponFromCart", - "description": "Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.", - "args": [ - { - "name": "input", - "description": "An input object that defines which coupon code to remove from the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "RemoveCouponFromCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RemoveCouponFromCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "removeGiftCardFromCart", - "description": "Removes a gift card from the cart.", - "args": [ - { - "name": "input", - "description": "An input object that specifies which gift card code to remove from the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "RemoveGiftCardFromCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RemoveGiftCardFromCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "removeGiftRegistry", - "description": "Delete the specified gift registry.", - "args": [ - { - "name": "giftRegistryUid", - "description": "The unique ID of the gift registry to delete.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RemoveGiftRegistryOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "removeGiftRegistryItems", - "description": "Delete the specified items from a gift registry.", - "args": [ - { - "name": "giftRegistryUid", - "description": "The unique ID of the gift registry.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "itemsUid", - "description": "An array of item IDs to remove from the gift registry.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RemoveGiftRegistryItemsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "removeGiftRegistryRegistrants", - "description": "Removes registrants from a gift registry.", - "args": [ - { - "name": "giftRegistryUid", - "description": "The unique ID of the gift registry.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "registrantsUid", - "description": "An array of registrant IDs to remove.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RemoveGiftRegistryRegistrantsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "removeItemFromCart", - "description": "Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist.", - "args": [ - { - "name": "input", - "description": "An input object that defines which products to remove from the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "RemoveItemFromCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RemoveItemFromCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "removeNegotiableQuoteItems", - "description": "Remove one or more products from a negotiable quote.", - "args": [ - { - "name": "input", - "description": "An input object that removes one or more items from a negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "RemoveNegotiableQuoteItemsInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RemoveNegotiableQuoteItemsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "removeProductsFromCompareList", - "description": "Remove products from the specified compare list.", - "args": [ - { - "name": "input", - "description": "An input object that defines which products to remove from a compare list.", - "type": { - "kind": "INPUT_OBJECT", - "name": "RemoveProductsFromCompareListInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CompareList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "removeProductsFromWishlist", - "description": "Remove one or more products from the specified wish list.", - "args": [ - { - "name": "wishlistId", - "description": "The ID of a wish list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "wishlistItemsIds", - "description": "An array of item IDs representing products to be removed.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RemoveProductsFromWishlistOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "removeReturnTracking", - "description": "Remove a tracked shipment from a return.", - "args": [ - { - "name": "input", - "description": "An input object that removes tracking information.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "RemoveReturnTrackingInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RemoveReturnTrackingOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "removeRewardPointsFromCart", - "description": "Cancel the application of reward points to the cart.", - "args": [ - { - "name": "cartId", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RemoveRewardPointsFromCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "removeStoreCreditFromCart", - "description": "Remove store credit that has been applied to the specified cart.", - "args": [ - { - "name": "input", - "description": "An input object that specifies the cart ID.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "RemoveStoreCreditFromCartInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RemoveStoreCreditFromCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "renameNegotiableQuote", - "description": "Rename negotiable quote.", - "args": [ - { - "name": "input", - "description": "An input object that defines the quote item name and comment.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "RenameNegotiableQuoteInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RenameNegotiableQuoteOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "reorderItems", - "description": "Add all products from a customer's previous order to the cart.", - "args": [ - { - "name": "orderNumber", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ReorderItemsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "requestNegotiableQuote", - "description": "Request a new negotiable quote on behalf of the buyer.", - "args": [ - { - "name": "input", - "description": "An input object that contains a request to initiate a negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "RequestNegotiableQuoteInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RequestNegotiableQuoteOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "requestPasswordResetEmail", - "description": "Request an email with a reset password token for the registered customer identified by the specified email.", - "args": [ - { - "name": "email", - "description": "The customer's email address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "requestReturn", - "description": "Initiates a buyer's request to return items for replacement or refund.", - "args": [ - { - "name": "input", - "description": "An input object that contains the fields needed to start a return request.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "RequestReturnInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RequestReturnOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "resetPassword", - "description": "Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`.", - "args": [ - { - "name": "email", - "description": "The customer's email address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "resetPasswordToken", - "description": "A runtime token generated by the `requestPasswordResetEmail` mutation.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "newPassword", - "description": "The customer's new password.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "revokeCustomerToken", - "description": "Revoke the customer token.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RevokeCustomerTokenOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sendEmailToFriend", - "description": "Send a message on behalf of a customer to the specified email addresses.", - "args": [ - { - "name": "input", - "description": "An input object that defines sender, recipients, and product.", - "type": { - "kind": "INPUT_OBJECT", - "name": "SendEmailToFriendInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SendEmailToFriendOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sendNegotiableQuoteForReview", - "description": "Send the negotiable quote to the seller for review.", - "args": [ - { - "name": "input", - "description": "An input object that sends a request for the merchant to review a negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "SendNegotiableQuoteForReviewInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SendNegotiableQuoteForReviewOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "setBillingAddressOnCart", - "description": "Set the billing address on a specific cart.", - "args": [ - { - "name": "input", - "description": "An input object that defines the billing address to be assigned to the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "SetBillingAddressOnCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SetBillingAddressOnCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "setGiftOptionsOnCart", - "description": "Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards.", - "args": [ - { - "name": "input", - "description": "An input object that defines the selected gift options.", - "type": { - "kind": "INPUT_OBJECT", - "name": "SetGiftOptionsOnCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SetGiftOptionsOnCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "setGuestEmailOnCart", - "description": "Assign the email address of a guest to the cart.", - "args": [ - { - "name": "input", - "description": "An input object that defines a guest email address.", - "type": { - "kind": "INPUT_OBJECT", - "name": "SetGuestEmailOnCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SetGuestEmailOnCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "setLineItemNote", - "description": "Add buyer's note to a negotiable quote item.", - "args": [ - { - "name": "input", - "description": "An input object that defines the quote item note.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "LineItemNoteInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SetLineItemNoteOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "setNegotiableQuoteBillingAddress", - "description": "Assign a billing address to a negotiable quote.", - "args": [ - { - "name": "input", - "description": "An input object that defines the billing address to be assigned to a negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "SetNegotiableQuoteBillingAddressInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SetNegotiableQuoteBillingAddressOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "setNegotiableQuotePaymentMethod", - "description": "Set the payment method on a negotiable quote.", - "args": [ - { - "name": "input", - "description": "An input object that defines the payment method for the specified negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "SetNegotiableQuotePaymentMethodInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SetNegotiableQuotePaymentMethodOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "setNegotiableQuoteShippingAddress", - "description": "Assign a previously-defined address as the shipping address for a negotiable quote.", - "args": [ - { - "name": "input", - "description": "An input object that defines the shipping address to be assigned to a negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "SetNegotiableQuoteShippingAddressInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SetNegotiableQuoteShippingAddressOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "setNegotiableQuoteShippingMethods", - "description": "Assign the shipping methods on the negotiable quote.", - "args": [ - { - "name": "input", - "description": "An input object that defines the shipping methods to be assigned to a negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "SetNegotiableQuoteShippingMethodsInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SetNegotiableQuoteShippingMethodsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "setPaymentMethodAndPlaceOrder", - "description": "Set the cart payment method and convert the cart into an order.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "SetPaymentMethodAndPlaceOrderInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PlaceOrderOutput", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Should use setPaymentMethodOnCart and placeOrder mutations in single request." - }, - { - "name": "setPaymentMethodOnCart", - "description": "Apply a payment method to the cart.", - "args": [ - { - "name": "input", - "description": "An input object that defines which payment method to apply to the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "SetPaymentMethodOnCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SetPaymentMethodOnCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "setShippingAddressesOnCart", - "description": "Set one or more shipping addresses on a specific cart.", - "args": [ - { - "name": "input", - "description": "An input object that defines one or more shipping addresses to be assigned to the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "SetShippingAddressesOnCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SetShippingAddressesOnCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "setShippingMethodsOnCart", - "description": "Set one or more delivery methods on a cart.", - "args": [ - { - "name": "input", - "description": "An input object that applies one or more shipping methods to the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "SetShippingMethodsOnCartInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SetShippingMethodsOnCartOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shareGiftRegistry", - "description": "Send an email about the gift registry to a list of invitees.", - "args": [ - { - "name": "giftRegistryUid", - "description": "The unique ID of the gift registry.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "sender", - "description": "The sender's email address and gift message.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "ShareGiftRegistrySenderInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "invitees", - "description": "An array containing invitee names and email addresses.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "ShareGiftRegistryInviteeInput", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ShareGiftRegistryOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "subscribeEmailToNewsletter", - "description": "Subscribe the specified email to the store's newsletter.", - "args": [ - { - "name": "email", - "description": "The email address that will receive the store's newsletter.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "SubscribeEmailToNewsletterOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "syncPaymentOrder", - "description": "Synchronizes the payment order details for further payment processing", - "args": [ - { - "name": "input", - "description": "Describes the variables needed to synchronize the payment order details", - "type": { - "kind": "INPUT_OBJECT", - "name": "SyncPaymentOrderInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateCartItems", - "description": "Modify items in the cart.", - "args": [ - { - "name": "input", - "description": "An input object that defines products to be updated.", - "type": { - "kind": "INPUT_OBJECT", - "name": "UpdateCartItemsInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateCartItemsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateCompany", - "description": "Update company information.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyUpdateInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateCompanyOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateCompanyRole", - "description": "Update company role information.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyRoleUpdateInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateCompanyRoleOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateCompanyStructure", - "description": "Change the parent node of a company team.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyStructureUpdateInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateCompanyStructureOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateCompanyTeam", - "description": "Update company team data.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyTeamUpdateInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateCompanyTeamOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateCompanyUser", - "description": "Update an existing company user.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyUserUpdateInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateCompanyUserOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateCustomer", - "description": "Use `updateCustomerV2` instead.", - "args": [ - { - "name": "input", - "description": "An input object that defines the customer characteristics to update.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomerInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CustomerOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateCustomerAddress", - "description": "Update the billing or shipping address of a customer or guest.", - "args": [ - { - "name": "id", - "description": "The ID assigned to the customer address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "input", - "description": "An input object that contains changes to the customer address.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CustomerAddress", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateCustomerEmail", - "description": "Change the email address for the logged-in customer.", - "args": [ - { - "name": "email", - "description": "The customer's email address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "password", - "description": "The customer's password.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CustomerOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateCustomerV2", - "description": "Update the customer's personal information.", - "args": [ - { - "name": "input", - "description": "An input object that defines the customer characteristics to update.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomerUpdateInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CustomerOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateGiftRegistry", - "description": "Update the specified gift registry.", - "args": [ - { - "name": "giftRegistryUid", - "description": "The unique ID of an existing gift registry.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "giftRegistry", - "description": "An input object that defines which fields to update.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "UpdateGiftRegistryInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateGiftRegistryOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateGiftRegistryItems", - "description": "Update the specified items in the gift registry.", - "args": [ - { - "name": "giftRegistryUid", - "description": "The unique ID of the gift registry.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "items", - "description": "An array of items to be updated.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "UpdateGiftRegistryItemInput", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateGiftRegistryItemsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateGiftRegistryRegistrants", - "description": "Modify the properties of one or more gift registry registrants.", - "args": [ - { - "name": "giftRegistryUid", - "description": "The unique ID of the gift registry.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "registrants", - "description": "An array of registrants to update.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "UpdateGiftRegistryRegistrantInput", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateGiftRegistryRegistrantsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateNegotiableQuoteQuantities", - "description": "Change the quantity of one or more items in an existing negotiable quote.", - "args": [ - { - "name": "input", - "description": "An input object that changes the quantity of one or more items in a negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "UpdateNegotiableQuoteQuantitiesInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateNegotiableQuoteItemsQuantityOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateProductsInWishlist", - "description": "Update one or more products in the specified wish list.", - "args": [ - { - "name": "wishlistId", - "description": "The ID of a wish list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "wishlistItems", - "description": "An array of items to be updated.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "WishlistItemUpdateInput", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateProductsInWishlistOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updatePurchaseOrderApprovalRule", - "description": "Update existing purchase order approval rules.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "UpdatePurchaseOrderApprovalRuleInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalRule", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateRequisitionList", - "description": "Rename a requisition list and change its description.", - "args": [ - { - "name": "requisitionListUid", - "description": "The unique ID of the requisition list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "input", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "UpdateRequisitionListInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateRequisitionListOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateRequisitionListItems", - "description": "Update items in a requisition list.", - "args": [ - { - "name": "requisitionListUid", - "description": "The unique ID of the requisition list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "requisitionListItems", - "description": "Items to be updated in the requisition list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "UpdateRequisitionListItemsInput", - "ofType": null - } - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateRequisitionListItemsOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updateWishlist", - "description": "Change the name and visibility of the specified wish list.", - "args": [ - { - "name": "wishlistId", - "description": "The ID of the wish list to update.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The name assigned to the wish list.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "visibility", - "description": "Indicates the visibility of the wish list.", - "type": { - "kind": "ENUM", - "name": "WishlistVisibilityEnum", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateWishlistOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "validatePurchaseOrders", - "description": "Validate purchase orders.", - "args": [ - { - "name": "input", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "ValidatePurchaseOrdersInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ValidatePurchaseOrdersOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "description": "Defines the comparison operators that can be used in a filter.", - "fields": null, - "inputFields": [ - { - "name": "eq", - "description": "Equals.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "finset", - "description": "", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "from", - "description": "From. Must be used with the `to` field.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "gt", - "description": "Greater than.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "gteq", - "description": "Greater than or equal to.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "in", - "description": "In. The value can contain a set of comma-separated values.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "like", - "description": "Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "lt", - "description": "Less than.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "lteq", - "description": "Less than or equal to.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "moreq", - "description": "More than or equal to.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "neq", - "description": "Not equal to.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "nin", - "description": "Not in. The value can contain a set of comma-separated values.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "notnull", - "description": "Not null.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "null", - "description": "Is null.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "to", - "description": "To. Must be used with the `from` field.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "description": "Defines a filter that matches the input exactly.", - "fields": null, - "inputFields": [ - { - "name": "eq", - "description": "Use this attribute to exactly match the specified string. For example, to filter on a specific category ID, specify a value such as `5`.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "in", - "description": "Use this attribute to filter on an array of values. For example, to filter on category IDs 4, 5, and 6, specify a value of `[\"4\", \"5\", \"6\"]`.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "FilterRangeTypeInput", - "description": "Defines a filter that matches a range of values, such as prices or dates.", - "fields": null, - "inputFields": [ - { - "name": "from", - "description": "Use this attribute to specify the lowest possible value in the range.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "to", - "description": "Use this attribute to specify the highest possible value in the range.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", - "description": "Defines a filter that performs a fuzzy search.", - "fields": null, - "inputFields": [ - { - "name": "match", - "description": "Use this attribute to fuzzy match the specified string. For example, to filter on a specific SKU, specify a value such as `24-MB01`.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "match_type", - "description": "Filter match type for fine-tuned results. Possible values FULL or PARTIAL. If match_type is not provided, returned results will default to FULL match.", - "type": { - "kind": "ENUM", - "name": "FilterMatchTypeEnum", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "FilterMatchTypeEnum", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "FULL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PARTIAL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "FilterStringTypeInput", - "description": "Defines a filter for an input string.", - "fields": null, - "inputFields": [ - { - "name": "eq", - "description": "Filters items that are exactly the same as the specified string.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "in", - "description": "Filters items that are exactly the same as entries specified in an array of strings.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "match", - "description": "Defines a filter that performs a fuzzy search using the specified string.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "description": "Provides navigation for the query response.", - "fields": [ - { - "name": "current_page", - "description": "The specific page to return.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_size", - "description": "The maximum number of items to return per page of results.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_pages", - "description": "The total number of pages in the response.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "SortEnum", - "description": "Indicates whether to return results in ascending or descending order.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "ASC", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DESC", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ComplexTextValue", - "description": "", - "fields": [ - { - "name": "html", - "description": "Text that can contain HTML tags.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Money", - "description": "Defines a monetary value, including a numeric value and a currency code.", - "fields": [ - { - "name": "currency", - "description": "A three-letter currency code, such as USD or EUR.", - "args": [], - "type": { - "kind": "ENUM", - "name": "CurrencyEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "A number expressing a monetary value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CurrencyEnum", - "description": "The list of available currency codes.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "AFN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ALL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AZN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DZD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AOA", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ARS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AMD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AWG", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AUD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BSD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BHD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BDT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BBD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BYN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BZD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BMD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BTN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BOB", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BAM", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BWP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BRL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GBP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BND", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BGN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BUK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BIF", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KHR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CAD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CVE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CZK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KYD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GQE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CLP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CNY", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "COP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KMF", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CDF", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CRC", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "HRK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CUP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DKK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DJF", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DOP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "XCD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "EGP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SVC", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ERN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "EEK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ETB", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "EUR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FKP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FJD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GMD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GEK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GEL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GHS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GIP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GTQ", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GNF", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GYD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "HTG", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "HNL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "HKD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "HUF", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ISK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "INR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "IDR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "IRR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "IQD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ILS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "JMD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "JPY", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "JOD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KZT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KES", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KWD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KGS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LAK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LVL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LBP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LSL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LRD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LYD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LTL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MOP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MKD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MGA", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MWK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MYR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MVR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LSM", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MRO", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MUR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MXN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MDL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MNT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MAD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MZN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MMK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NAD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NPR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ANG", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "YTL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NZD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NIC", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NGN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KPW", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NOK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "OMR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PKR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PAB", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PGK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PYG", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PEN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PHP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PLN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "QAR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "RHD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "RON", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "RUB", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "RWF", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SHP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "STD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SAR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "RSD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SCR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SLL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SGD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SKK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SBD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SOS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ZAR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KRW", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LKR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SDG", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SRD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SZL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SEK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CHF", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SYP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TWD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TJS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TZS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "THB", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TOP", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TTD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TND", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TMM", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "USD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UGX", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UAH", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UYU", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UZS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "VUV", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "VEB", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "VEF", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "VND", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CHE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CHW", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "XOF", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "WST", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "YER", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ZMK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ZWD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TRY", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AZM", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ROL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TRL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "XPF", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "EnteredOptionInput", - "description": "Defines a customer-entered option.", - "fields": null, - "inputFields": [ - { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "value", - "description": "Text the customer entered.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "BatchMutationStatus", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "SUCCESS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FAILURE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MIXED_RESULTS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "ErrorInterface", - "description": "", - "fields": [ - { - "name": "message", - "description": "The returned error message.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "NoSuchEntityUidError", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "InternalError", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteInvalidStateError", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "NoSuchEntityUidError", - "description": "Contains an error message when an invalid UID was specified.", - "fields": [ - { - "name": "message", - "description": "The returned error message.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The specified invalid unique ID of an object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ErrorInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "InternalError", - "description": "Contains an error message when an internal error occurred.", - "fields": [ - { - "name": "message", - "description": "The returned error message.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ErrorInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomAttributeMetadata", - "description": "Defines an array of custom attributes.", - "fields": [ - { - "name": "items", - "description": "An array of attributes.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Attribute", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Attribute", - "description": "Contains details about the attribute, including the code and type.", - "fields": [ - { - "name": "attribute_code", - "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "attribute_options", - "description": "Attribute options list.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AttributeOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "attribute_type", - "description": "The data type of the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "entity_type", - "description": "The type of entity that defines the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "input_type", - "description": "The frontend input type of the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "storefront_properties", - "description": "Details about the storefront properties configured for the attribute.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "StorefrontProperties", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "StorefrontProperties", - "description": "Indicates where an attribute can be displayed.", - "fields": [ - { - "name": "position", - "description": "The relative position of the attribute in the layered navigation block.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "use_in_layered_navigation", - "description": "Indicates whether the attribute is filterable with results, without results, or not at all.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UseInLayeredNavigationOptions", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "use_in_product_listing", - "description": "Indicates whether the attribute is displayed in product listings.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "use_in_search_results_layered_navigation", - "description": "Indicates whether the attribute can be used in layered navigation on search results pages.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "visible_on_catalog_pages", - "description": "Indicates whether the attribute is displayed on product pages.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "UseInLayeredNavigationOptions", - "description": "Defines whether the attribute is filterable in layered navigation.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "NO", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FILTERABLE_WITH_RESULTS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FILTERABLE_NO_RESULT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AttributeOption", - "description": "Defines an attribute option.", - "fields": [ - { - "name": "label", - "description": "The label assigned to the attribute option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The attribute option value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AttributeInput", - "description": "Defines the attribute characteristics to search for the `attribute_code` and `entity_type` to search.", - "fields": null, - "inputFields": [ - { - "name": "attribute_code", - "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "entity_type", - "description": "The type of entity that defines the attribute.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AttributesMetadataOutput", - "description": "Metadata of EAV attributes.", - "fields": [ - { - "name": "errors", - "description": "Errors of retrieving certain attributes metadata.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AttributeMetadataError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "Requested attributes metadata.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomAttributeMetadataInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AttributeMetadataError", - "description": "Attribute metadata retrieval error.", - "fields": [ - { - "name": "message", - "description": "Attribute metadata retrieval error message.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "Attribute metadata retrieval error type.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "AttributeMetadataErrorType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "AttributeMetadataErrorType", - "description": "Attribute metadata retrieval error types.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "ENTITY_NOT_FOUND", - "description": "The requested entity was not found.", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ATTRIBUTE_NOT_FOUND", - "description": "The requested attribute was not found.", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FILTER_NOT_FOUND", - "description": "The filter cannot be applied as it does not belong to the entity", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNDEFINED", - "description": "Not categorized error, see the error message.", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "CustomAttributeMetadataInterface", - "description": "An interface containing fields that define the EAV attribute.", - "fields": [ - { - "name": "code", - "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_value", - "description": "Default attribute value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "entity_type", - "description": "The type of entity that defines the attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "AttributeEntityTypeEnum", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "frontend_class", - "description": "The frontend class of the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "frontend_input", - "description": "The frontend input type of the attribute.", - "args": [], - "type": { - "kind": "ENUM", - "name": "AttributeFrontendInputEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_required", - "description": "Whether the attribute value is required.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_unique", - "description": "Whether the attribute value must be unique.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The label assigned to the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "Attribute options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomAttributeOptionInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "AttributeMetadata", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CatalogAttributeMetadata", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomerAttributeMetadata", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ReturnItemAttributeMetadata", - "ofType": null - } - ] - }, - { - "kind": "INTERFACE", - "name": "CustomAttributeOptionInterface", - "description": "", - "fields": [ - { - "name": "is_default", - "description": "Is the option value default.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The label assigned to the attribute option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The attribute option value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "AttributeOptionMetadata", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "AttributeOptionMetadata", - "description": "Base EAV implementation of CustomAttributeOptionInterface.", - "fields": [ - { - "name": "is_default", - "description": "Is the option value default.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The label assigned to the attribute option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The attribute option value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomAttributeOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AttributeMetadata", - "description": "Base EAV implementation of CustomAttributeMetadataInterface.", - "fields": [ - { - "name": "code", - "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_value", - "description": "Default attribute value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "entity_type", - "description": "The type of entity that defines the attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "AttributeEntityTypeEnum", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "frontend_class", - "description": "The frontend class of the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "frontend_input", - "description": "The frontend input type of the attribute.", - "args": [], - "type": { - "kind": "ENUM", - "name": "AttributeFrontendInputEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_required", - "description": "Whether the attribute value is required.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_unique", - "description": "Whether the attribute value must be unique.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The label assigned to the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "Attribute options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomAttributeOptionInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomAttributeMetadataInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "AttributeEntityTypeEnum", - "description": "List of all entity types. Populated by the modules introducing EAV entities.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "CATALOG_PRODUCT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CATALOG_CATEGORY", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CUSTOMER", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CUSTOMER_ADDRESS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "RMA_ITEM", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "AttributeFrontendInputEnum", - "description": "EAV attribute frontend input types.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "BOOLEAN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DATE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DATETIME", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FILE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GALLERY", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "HIDDEN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "IMAGE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MEDIA_IMAGE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MULTILINE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MULTISELECT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PRICE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SELECT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TEXT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TEXTAREA", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "WEIGHT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNDEFINED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AttributesFormOutput", - "description": "Metadata of EAV attributes associated to form", - "fields": [ - { - "name": "errors", - "description": "Errors of retrieving certain attributes metadata.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AttributeMetadataError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "Requested attributes metadata.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomAttributeMetadataInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "AttributeValueInterface", - "description": "", - "fields": [ - { - "name": "code", - "description": "The attribute code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "AttributeValue", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "AttributeSelectedOptions", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "AttributeValue", - "description": "", - "fields": [ - { - "name": "code", - "description": "The attribute code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The attribute value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "AttributeValueInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AttributeSelectedOptions", - "description": "", - "fields": [ - { - "name": "code", - "description": "The attribute code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "selected_options", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "AttributeSelectedOptionInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "AttributeValueInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "AttributeSelectedOptionInterface", - "description": "", - "fields": [ - { - "name": "label", - "description": "The attribute selected option label.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The attribute selected option value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "AttributeSelectedOption", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "AttributeSelectedOption", - "description": "", - "fields": [ - { - "name": "label", - "description": "The attribute selected option label.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The attribute selected option value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "AttributeSelectedOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AttributeValueInput", - "description": "Specifies the value for attribute.", - "fields": null, - "inputFields": [ - { - "name": "attribute_code", - "description": "The code of the attribute.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "selected_options", - "description": "An array containing selected options for a select or multiselect attribute.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "AttributeInputSelectedOption", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "value", - "description": "The value assigned to the attribute.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AttributeInputSelectedOption", - "description": "Specifies selected option for a select or multiselect attribute value.", - "fields": null, - "inputFields": [ - { - "name": "value", - "description": "The attribute option value.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "description": "An input object that specifies the filters used for attributes.", - "fields": null, - "inputFields": [ - { - "name": "is_comparable", - "description": "Whether a product or category attribute can be compared against another or not.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_filterable", - "description": "Whether a product or category attribute can be filtered or not.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_filterable_in_search", - "description": "Whether a product or category attribute can be filtered in search or not.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_html_allowed_on_front", - "description": "Whether a product or category attribute can use HTML on front or not.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_searchable", - "description": "Whether a product or category attribute can be searched or not.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_used_for_customer_segment", - "description": "Whether a customer or customer address attribute is used for customer segment or not.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_used_for_price_rules", - "description": "Whether a product or category attribute can be used for price rules or not.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_used_for_promo_rules", - "description": "Whether a product or category attribute is used for promo rules or not.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_visible_in_advanced_search", - "description": "Whether a product or category attribute is visible in advanced search or not.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_visible_on_front", - "description": "Whether a product or category attribute is visible on front or not.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_wysiwyg_enabled", - "description": "Whether a product or category attribute has WYSIWYG enabled or not.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "used_in_product_listing", - "description": "Whether a product or category attribute is used in product listing or not.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "StoreConfig", - "description": "Contains information about a store's configuration.", - "fields": [ - { - "name": "absolute_footer", - "description": "Contains scripts that must be included in the HTML before the closing `` tag.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "allow_gift_receipt", - "description": "Indicates if the gift sender has the option to send a gift receipt. Possible values: 1 (Yes) and 0 (No).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "allow_gift_wrapping_on_order", - "description": "Indicates whether gift wrapping can be added for the entire order. Possible values: 1 (Yes) and 0 (No).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "allow_gift_wrapping_on_order_items", - "description": "Indicates whether gift wrapping can be added for individual order items. Possible values: 1 (Yes) and 0 (No).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "allow_guests_to_write_product_reviews", - "description": "Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "allow_items", - "description": "The value of the Allow Gift Messages for Order Items option", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "allow_order", - "description": "The value of the Allow Gift Messages on Order Level option", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "allow_printed_card", - "description": "Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "autocomplete_on_storefront", - "description": "Indicates whether to enable autocomplete on login and forgot password forms.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "base_currency_code", - "description": "The base currency code.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "base_link_url", - "description": "A fully-qualified URL that is used to create relative links to the `base_url`.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "base_media_url", - "description": "The fully-qualified URL that specifies the location of media files.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "base_static_url", - "description": "The fully-qualified URL that specifies the location of static view files.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "base_url", - "description": "The store’s fully-qualified base URL.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_3dsecure_allowspecific", - "description": "Braintree 3D Secure, should 3D Secure be used for specific countries.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_3dsecure_always_request_3ds", - "description": "Braintree 3D Secure, always request 3D Secure flag.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_3dsecure_specificcountry", - "description": "Braintree 3D Secure, the specific countries to use 3D Secure in, to be used if allow specific is status is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_3dsecure_threshold_amount", - "description": "Braintree 3D Secure, threshold above which 3D Secure should be requested.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_3dsecure_verify_3dsecure", - "description": "Braintree 3D Secure enabled/active status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_ach_direct_debit_vault_active", - "description": "Braintree ACH vault status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_applepay_merchant_name", - "description": "Braintree Apple Pay merchant name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_applepay_vault_active", - "description": "Braintree Apple Pay vault status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_cc_vault_active", - "description": "Braintree cc vault status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_cc_vault_cvv", - "description": "Braintree cc vault CVV re-verification enabled status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_environment", - "description": "Braintree environment.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_googlepay_btn_color", - "description": "Braintree Google Pay button color.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_googlepay_cctypes", - "description": "Braintree Google Pay Card types supported.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_googlepay_merchant_id", - "description": "Braintree Google Pay merchant ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_googlepay_vault_active", - "description": "Braintree Google Pay vault status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_local_payment_allowed_methods", - "description": "Braintree Local Payment Methods allowed payment methods.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_local_payment_fallback_button_text", - "description": "Braintree Local Payment Methods fallback button text.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_local_payment_redirect_on_fail", - "description": "Braintree Local Payment Methods redirect URL on failed payment.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_merchant_account_id", - "description": "Braintree Merchant Account ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_credit_color", - "description": "Braintree PayPal Credit mini-cart & cart button style color.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_credit_label", - "description": "Braintree PayPal Credit mini-cart & cart button style label.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_credit_shape", - "description": "Braintree PayPal Credit mini-cart & cart button style shape.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_credit_show", - "description": "Braintree PayPal Credit mini-cart & cart button show status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_messaging_layout", - "description": "Braintree PayPal Pay Later messaging mini-cart & cart style layout.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_messaging_logo", - "description": "Braintree PayPal Pay Later messaging mini-cart & cart style logo.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_messaging_logo_position", - "description": "Braintree PayPal Pay Later messaging mini-cart & cart style logo position.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_messaging_show", - "description": "Braintree PayPal Pay Later messaging mini-cart & cart show status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_messaging_text_color", - "description": "Braintree PayPal Pay Later messaging checkout style text color.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_paylater_color", - "description": "Braintree PayPal Pay Later mini-cart & cart button style color.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_paylater_label", - "description": "Braintree PayPal Pay Later mini-cart & cart button style label.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_paylater_shape", - "description": "Braintree PayPal Pay Later mini-cart & cart button style shape.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_paylater_show", - "description": "Braintree PayPal Pay Later mini-cart & cart button show status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_paypal_color", - "description": "Braintree PayPal mini-cart & cart button style color.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_paypal_label", - "description": "Braintree PayPal mini-cart & cart button style label.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_paypal_shape", - "description": "Braintree PayPal mini-cart & cart button style shape.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_cart_type_paypal_show", - "description": "Braintree PayPal mini-cart & cart button show.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_credit_color", - "description": "Braintree PayPal Credit checkout button style color.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_credit_label", - "description": "Braintree PayPal Credit checkout button style label.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_credit_shape", - "description": "Braintree PayPal Credit checkout button style shape.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_credit_show", - "description": "Braintree PayPal Credit checkout button show status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_messaging_layout", - "description": "Braintree PayPal Pay Later messaging checkout style layout.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_messaging_logo", - "description": "Braintree PayPal Pay Later messaging checkout style logo.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_messaging_logo_position", - "description": "Braintree PayPal Pay Later messaging checkout style logo position.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_messaging_show", - "description": "Braintree PayPal Pay Later messaging checkout show status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_messaging_text_color", - "description": "Braintree PayPal Pay Later messaging checkout style text color.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_paylater_color", - "description": "Braintree PayPal Pay Later checkout button style color.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_paylater_label", - "description": "Braintree PayPal Pay Later checkout button style label.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_paylater_shape", - "description": "Braintree PayPal Pay Later checkout button style shape.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_paylater_show", - "description": "Braintree PayPal Pay Later checkout button show status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_paypal_color", - "description": "Braintree PayPal checkout button style color.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_paypal_label", - "description": "Braintree PayPal checkout button style label.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_paypal_shape", - "description": "Braintree PayPal checkout button style shape.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_checkout_type_paypal_show", - "description": "Braintree PayPal checkout button show.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_credit_color", - "description": "Braintree PayPal Credit PDP button style color.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_credit_label", - "description": "Braintree PayPal Credit PDP button style label.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_credit_shape", - "description": "Braintree PayPal Credit PDP button style shape.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_credit_show", - "description": "Braintree PayPal Credit PDP button show status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_messaging_layout", - "description": "Braintree PayPal Pay Later messaging PDP style layout.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_messaging_logo", - "description": "Braintree PayPal Pay Later messaging PDP style logo.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_messaging_logo_position", - "description": "Braintree PayPal Pay Later messaging PDP style logo position.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_messaging_show", - "description": "Braintree PayPal Pay Later messaging PDP show status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_messaging_text_color", - "description": "Braintree PayPal Pay Later messaging PDP style text color.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_paylater_color", - "description": "Braintree PayPal Pay Later PDP button style color.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_paylater_label", - "description": "Braintree PayPal Pay Later PDP button style label.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_paylater_shape", - "description": "Braintree PayPal Pay Later PDP button style shape.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_paylater_show", - "description": "Braintree PayPal Pay Later PDP button show status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_paypal_color", - "description": "Braintree PayPal PDP button style color.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_paypal_label", - "description": "Braintree PayPal PDP button style label.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_paypal_shape", - "description": "Braintree PayPal PDP button style shape.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_button_location_productpage_type_paypal_show", - "description": "Braintree PayPal PDP button show.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_credit_uk_merchant_name", - "description": "Braintree PayPal Credit Merchant Name on the FCA Register.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_display_on_shopping_cart", - "description": "Should display Braintree PayPal in mini-cart & cart?", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_merchant_country", - "description": "Braintree PayPal merchant's country.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_merchant_name_override", - "description": "Braintree PayPal override for Merchant Name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_require_billing_address", - "description": "Does Braintree PayPal require the customer's billing address?", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_send_cart_line_items", - "description": "Does Braintree PayPal require the order line items?", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "braintree_paypal_vault_active", - "description": "Braintree PayPal vault status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "cart_gift_wrapping", - "description": "Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "cart_printed_card", - "description": "Indicates if printed card prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "catalog_default_sort_by", - "description": "The default sort order of the search results list.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_fixed_product_tax_display_setting", - "description": "Corresponds to the 'Display Prices In Product Lists' field in the Admin. It indicates how FPT information is displayed on category pages.", - "args": [], - "type": { - "kind": "ENUM", - "name": "FixedProductTaxDisplaySettings", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_url_suffix", - "description": "The suffix applied to category pages, such as `.htm` or `.html`.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "check_money_order_enable_for_specific_countries", - "description": "Indicates whether only specific countries can use this payment method.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "check_money_order_enabled", - "description": "Indicates whether the Check/Money Order payment method is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "check_money_order_make_check_payable_to", - "description": "The name of the party to whom the check must be payable.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "check_money_order_max_order_total", - "description": "The maximum order amount required to qualify for the Check/Money Order payment method.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "check_money_order_min_order_total", - "description": "The minimum order amount required to qualify for the Check/Money Order payment method.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "check_money_order_new_order_status", - "description": "The status of new orders placed using the Check/Money Order payment method.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "check_money_order_payment_from_specific_countries", - "description": "A comma-separated list of specific countries allowed to use the Check/Money Order payment method.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "check_money_order_send_check_to", - "description": "The full street address or PO Box where the checks are mailed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "check_money_order_sort_order", - "description": "A number indicating the position of the Check/Money Order payment method in the list of available payment methods during checkout.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "check_money_order_title", - "description": "The title of the Check/Money Order payment method displayed on the storefront.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "cms_home_page", - "description": "The name of the CMS page that identifies the home page for the store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "cms_no_cookies", - "description": "A specific CMS page that displays when cookies are not enabled for the browser.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "cms_no_route", - "description": "A specific CMS page that displays when a 404 'Page Not Found' error occurs.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "code", - "description": "A code assigned to the store to identify it.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `store_code` instead." - }, - { - "name": "configurable_thumbnail_source", - "description": "Indicates whether the `parent` or child (`itself`) thumbnail should be used in the cart for configurable products.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "contact_enabled", - "description": "Indicates whether the Contact Us form in enabled.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "copyright", - "description": "The copyright statement that appears at the bottom of each page.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "countries_with_required_region", - "description": "Extended Config Data - general/region/state_required", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_country", - "description": "Extended Config Data - general/country/default", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_description", - "description": "The description that provides a summary of your site for search engine listings. It should not be more than 160 characters in length.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_display_currency_code", - "description": "The default display currency code.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_keywords", - "description": "A series of keywords that describe your store, each separated by a comma.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_title", - "description": "The title that appears at the title bar of each page when viewed in a browser.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "demonotice", - "description": "Controls the display of the demo store notice at the top of the page. Options: 0 (No) or 1 (Yes).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "display_state_if_optional", - "description": "Extended Config Data - general/region/display_all", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "enable_multiple_wishlists", - "description": "Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "front", - "description": "The landing page that is associated with the base URL.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "grid_per_page", - "description": "The default number of products per page in Grid View.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "grid_per_page_values", - "description": "A list of numbers that define how many products can be displayed in Grid View.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "head_includes", - "description": "Scripts that must be included in the HTML before the closing `` tag.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "head_shortcut_icon", - "description": "The small graphic image (favicon) that appears in the address bar and tab of the browser.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "header_logo_src", - "description": "The path to the logo that appears in the header.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The ID number assigned to the store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `store_code` instead." - }, - { - "name": "is_default_store", - "description": "Indicates whether the store view has been designated as the default within the store group.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_default_store_group", - "description": "Indicates whether the store group has been designated as the default within the website.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_guest_checkout_enabled", - "description": "Extended Config Data - checkout/options/guest_checkout", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_negotiable_quote_active", - "description": "Indicates whether negotiable quote functionality is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_one_page_checkout_enabled", - "description": "Extended Config Data - checkout/options/onepage_checkout_enabled", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_requisition_list_active", - "description": "Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "list_mode", - "description": "The format of the search results list.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "list_per_page", - "description": "The default number of products per page in List View.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "list_per_page_values", - "description": "A list of numbers that define how many products can be displayed in List View.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "locale", - "description": "The store locale.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "logo_alt", - "description": "The Alt text that is associated with the logo.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "logo_height", - "description": "The height of the logo image, in pixels.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "logo_width", - "description": "The width of the logo image, in pixels.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "magento_reward_general_is_enabled", - "description": "Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "magento_reward_general_is_enabled_on_front", - "description": "Indicates whether reward points functionality is enabled on the storefront. Possible values: 1 (Enabled) and 0 (Disabled).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "magento_reward_general_min_points_balance", - "description": "The minimum point balance customers must have before they can redeem them. A null value indicates no minimum.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "magento_reward_general_publish_history", - "description": "When enabled, customers can see a detailed history of their reward points. Possible values: 1 (Enabled) and 0 (Disabled).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "magento_reward_points_invitation_customer", - "description": "The number of points for a referral when an invitee registers on the site.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "magento_reward_points_invitation_customer_limit", - "description": "The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "magento_reward_points_invitation_order", - "description": "The number of points for a referral, when an invitee places their first order on the site.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "magento_reward_points_invitation_order_limit", - "description": "The number of order conversions that can earn points for the customer who sends the invitation. A null value indicates no limit.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "magento_reward_points_newsletter", - "description": "The number of points earned by registered customers who subscribe to a newsletter.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "magento_reward_points_order", - "description": "Indicates customers earn points for shopping according to the reward point exchange rate. In Luma, this also controls whether to show a message in the shopping cart about the rewards points earned for the purchase, as well as the customer’s current reward point balance.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "magento_reward_points_register", - "description": "The number of points customer gets for registering.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "magento_reward_points_review", - "description": "The number of points for writing a review.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "magento_reward_points_review_limit", - "description": "The maximum number of reviews that will qualify for the rewards. A null value indicates no limit.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "magento_wishlist_general_is_enabled", - "description": "Indicates whether wishlists are enabled (1) or disabled (0).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "max_items_in_order_summary", - "description": "Extended Config Data - checkout/options/max_items_display_count", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "maximum_number_of_wishlists", - "description": "If multiple wish lists are enabled, the maximum number of wish lists the customer can have.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "minimum_password_length", - "description": "The minimum number of characters required for a valid password.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "newsletter_enabled", - "description": "Indicates whether newsletters are enabled.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "no_route", - "description": "The default page that displays when a 404 'Page not Found' error occurs.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "optional_zip_countries", - "description": "Extended Config Data - general/country/optional_zip_countries", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_cancellation_enabled", - "description": "Indicates whether orders can be cancelled by customers or not.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_cancellation_reasons", - "description": "An array containing available cancellation reasons.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CancellationReason", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "payment_payflowpro_cc_vault_active", - "description": "Payflow Pro vault status.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "printed_card_price", - "description": "The default price of a printed card that accompanies an order.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_fixed_product_tax_display_setting", - "description": "Corresponds to the 'Display Prices On Product View Page' field in the Admin. It indicates how FPT information is displayed on product pages.", - "args": [], - "type": { - "kind": "ENUM", - "name": "FixedProductTaxDisplaySettings", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_reviews_enabled", - "description": "Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_url_suffix", - "description": "The suffix applied to product pages, such as `.htm` or `.html`.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quickorder_active", - "description": "Indicates whether quick order functionality is enabled.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "required_character_classes_number", - "description": "The number of different character classes (lowercase, uppercase, digits, special characters) required in a password.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "returns_enabled", - "description": "Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "root_category_id", - "description": "The ID of the root category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `root_category_uid` instead." - }, - { - "name": "root_category_uid", - "description": "The unique ID for a `CategoryInterface` object.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sales_fixed_product_tax_display_setting", - "description": "Corresponds to the 'Display Prices In Sales Modules' field in the Admin. It indicates how FPT information is displayed on cart, checkout, and order pages.", - "args": [], - "type": { - "kind": "ENUM", - "name": "FixedProductTaxDisplaySettings", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sales_gift_wrapping", - "description": "Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sales_printed_card", - "description": "Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "secure_base_link_url", - "description": "A secure fully-qualified URL that is used to create relative links to the `base_url`.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "secure_base_media_url", - "description": "The secure fully-qualified URL that specifies the location of media files.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "secure_base_static_url", - "description": "The secure fully-qualified URL that specifies the location of static view files.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "secure_base_url", - "description": "The store’s fully-qualified secure base URL.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "send_friend", - "description": "Email to a Friend configuration.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SendFriendConfiguration", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shopping_cart_display_full_summary", - "description": "Extended Config Data - tax/cart_display/full_summary", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shopping_cart_display_grand_total", - "description": "Extended Config Data - tax/cart_display/grandtotal", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shopping_cart_display_price", - "description": "Extended Config Data - tax/cart_display/price", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shopping_cart_display_shipping", - "description": "Extended Config Data - tax/cart_display/shipping", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shopping_cart_display_subtotal", - "description": "Extended Config Data - tax/cart_display/subtotal", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shopping_cart_display_zero_tax", - "description": "Extended Config Data - tax/cart_display/zero_tax", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "show_cms_breadcrumbs", - "description": "Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "store_code", - "description": "The unique ID of the store view. In the Admin, this is called the Store View Code. When making a GraphQL call, assign this value to the `Store` header to provide the scope.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "store_group_code", - "description": "The unique ID assigned to the store group. In the Admin, this is called the Store Name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "store_group_name", - "description": "The label assigned to the store group.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "store_name", - "description": "The label assigned to the store view.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "store_sort_order", - "description": "The store view sort order.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "timezone", - "description": "The time zone of the store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title_prefix", - "description": "A prefix that appears before the title to create a two- or three-part title.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title_separator", - "description": "The character that separates the category name and subcategory in the browser title bar.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title_suffix", - "description": "A suffix that appears after the title to create a two- or three-part title.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "use_store_in_url", - "description": "Indicates whether the store code should be used in the URL.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "website_code", - "description": "The unique ID for the website.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "website_id", - "description": "The ID number assigned to the website store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "website_name", - "description": "The label assigned to the website.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "weight_unit", - "description": "The unit of weight.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "welcome", - "description": "Text that appears in the header of the page and includes the name of the logged in customer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "zero_subtotal_enable_for_specific_countries", - "description": "Indicates whether only specific countries can use this payment method.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "zero_subtotal_enabled", - "description": "Indicates whether the Zero Subtotal payment method is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "zero_subtotal_new_order_status", - "description": "The status of new orders placed using the Zero Subtotal payment method.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "zero_subtotal_payment_action", - "description": "When the new order status is 'Processing', this can be set to `authorize_capture` to automatically invoice all items that have a zero balance.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "zero_subtotal_payment_from_specific_countries", - "description": "A comma-separated list of specific countries allowed to use the Zero Subtotal payment method.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "zero_subtotal_sort_order", - "description": "A number indicating the position of the Zero Subtotal payment method in the list of available payment methods during checkout.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "zero_subtotal_title", - "description": "The title of the Zero Subtotal payment method displayed on the storefront.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CmsPage", - "description": "Contains details about a CMS page.", - "fields": [ - { - "name": "content", - "description": "The content of the CMS page in raw HTML.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "content_heading", - "description": "The heading that displays at the top of the CMS page.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "identifier", - "description": "The ID of a CMS page.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_description", - "description": "A brief description of the page for search results listings.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_keywords", - "description": "A brief description of the page for search results listings.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_title", - "description": "A page title that is indexed by search engines and appears in search results listings.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_layout", - "description": "The design layout of the page, indicating the number of columns and navigation features used on the page.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The name that appears in the breadcrumb trail navigation and in the browser title bar and tab.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_key", - "description": "The URL key of the CMS page, which is often based on the `content_heading`.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CmsBlocks", - "description": "Contains an array CMS block items.", - "fields": [ - { - "name": "items", - "description": "An array of CMS blocks.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CmsBlock", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CmsBlock", - "description": "Contains details about a specific CMS block.", - "fields": [ - { - "name": "content", - "description": "The content of the CMS block in raw HTML.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "identifier", - "description": "The CMS block identifier.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The title assigned to the CMS block.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Website", - "description": "Deprecated. It should not be used on the storefront. Contains information about a website.", - "fields": [ - { - "name": "code", - "description": "A code assigned to the website to identify it.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "default_group_id", - "description": "The default group ID of the website.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "id", - "description": "The ID number assigned to the website.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "is_default", - "description": "Indicates whether this is the default website.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "name", - "description": "The website name. Websites use this name to identify it easier.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "sort_order", - "description": "The attribute to use for sorting websites.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Price", - "description": "Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments.", - "fields": [ - { - "name": "adjustments", - "description": "An array that provides information about tax, weee, or weee_tax adjustments.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PriceAdjustment", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `ProductPrice` instead." - }, - { - "name": "amount", - "description": "The price of a product plus a three-letter currency code.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `ProductPrice` instead." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PriceAdjustment", - "description": "Deprecated. Taxes will be included or excluded in the price. Defines the amount of money to apply as an adjustment, the type of adjustment to apply, and whether the item is included or excluded from the adjustment.", - "fields": [ - { - "name": "amount", - "description": "The amount of the price adjustment and its currency code.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "code", - "description": "Indicates whether the adjustment involves tax, weee, or weee_tax.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PriceAdjustmentCodesEnum", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`PriceAdjustment` is deprecated." - }, - { - "name": "description", - "description": "Indicates whether the entity described by the code attribute is included or excluded from the adjustment.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PriceAdjustmentDescriptionEnum", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`PriceAdjustment` is deprecated." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PriceAdjustmentCodesEnum", - "description": "`PriceAdjustment.code` is deprecated.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "TAX", - "description": "", - "isDeprecated": true, - "deprecationReason": "`PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog." - }, - { - "name": "WEEE", - "description": "", - "isDeprecated": true, - "deprecationReason": "WEEE code is deprecated. Use `fixed_product_taxes.label` instead." - }, - { - "name": "WEEE_TAX", - "description": "", - "isDeprecated": true, - "deprecationReason": "Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog." - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PriceAdjustmentDescriptionEnum", - "description": "`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "INCLUDED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "EXCLUDED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PriceTypeEnum", - "description": "Defines the price type.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "FIXED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PERCENT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DYNAMIC", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "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": "" - }, - { - "name": "DATE_TIME", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TIME", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductPrices", - "description": "Deprecated. Use `PriceRange` instead. Contains the regular price of an item, as well as its minimum and maximum prices. Only composite products, which include bundle, configurable, and grouped products, can contain a minimum and maximum price.", - "fields": [ - { - "name": "maximalPrice", - "description": "The highest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the `to` value.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Price", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `PriceRange.maximum_price` instead." - }, - { - "name": "minimalPrice", - "description": "The lowest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the `from` value.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Price", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `PriceRange.minimum_price` instead." - }, - { - "name": "regularPrice", - "description": "The base price of a product.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Price", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PriceRange", - "description": "Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same.", - "fields": [ - { - "name": "maximum_price", - "description": "The highest possible price for the product.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductPrice", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "minimum_price", - "description": "The lowest possible price for the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductPrice", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductPrice", - "description": "Represents a product price.", - "fields": [ - { - "name": "discount", - "description": "The price discount. Represents the difference between the regular and final price.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductDiscount", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "final_price", - "description": "The final price of the product after applying discounts.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "fixed_product_taxes", - "description": "An array of the multiple Fixed Product Taxes that can be applied to a product price.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "FixedProductTax", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "regular_price", - "description": "The regular price of the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductDiscount", - "description": "Contains the discount applied to a product price.", - "fields": [ - { - "name": "amount_off", - "description": "The actual value of the discount.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "percent_off", - "description": "The discount expressed a percentage.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductLinks", - "description": "An implementation of `ProductLinksInterface`.", - "fields": [ - { - "name": "link_type", - "description": "One of related, associated, upsell, or crosssell.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "linked_product_sku", - "description": "The SKU of the linked product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "linked_product_type", - "description": "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "position", - "description": "The position within the list of product links.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sku", - "description": "The identifier of the linked product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "description": "Contains information about linked products, including the link type and product type of each item.", - "fields": [ - { - "name": "link_type", - "description": "One of related, associated, upsell, or crosssell.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "linked_product_sku", - "description": "The SKU of the linked product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "linked_product_type", - "description": "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "position", - "description": "The position within the list of product links.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sku", - "description": "The identifier of the linked product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "ProductLinks", - "ofType": null - } - ] - }, - { - "kind": "INTERFACE", - "name": "ProductInterface", - "description": "Contains fields that are common to all types of products.", - "fields": [ - { - "name": "activity", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "categories", - "description": "The categories assigned to a product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_gear", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "climate", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "collar", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "color", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "country_of_manufacture", - "description": "The product's country of origin.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "crosssell_products", - "description": "An array of cross-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gender", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gift_message_available", - "description": "Indicates whether a gift message is available.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The ID number assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." - }, - { - "name": "image", - "description": "The relative path to the main image on the product page.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "material", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "media_gallery", - "description": "An array of media gallery objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "media_gallery_entries", - "description": "An array of MediaGalleryEntry objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "MediaGalleryEntry", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `media_gallery` instead." - }, - { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "new_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new_to_date", - "description": "The end date for new product listings.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "only_x_left_in_stock", - "description": "Product stock only x left count", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "pattern", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "price", - "description": "Indicates the price of an item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductPrices", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_range` for product price information." - }, - { - "name": "price_range", - "description": "The range of prices for the product", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PriceRange", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_tiers", - "description": "An array of `TierPrice` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TierPrice", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_links", - "description": "An array of `ProductLinks` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purpose", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "rating_summary", - "description": "The average of all the ratings given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "related_products", - "description": "An array of related products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "review_count", - "description": "The total count of all the reviews given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "reviews", - "description": "The list of products reviews.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviews", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "size", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "special_price", - "description": "The discounted price of the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_to_date", - "description": "The end date for a product with a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "staged", - "description": "Indicates whether the product is staged for a future campaign.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "stock_status", - "description": "Stock status of the product", - "args": [], - "type": { - "kind": "ENUM", - "name": "ProductStockStatus", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "swatch_image", - "description": "The file name of a swatch image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "tier_prices", - "description": "An array of ProductTierPrices objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductTierPrices", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "type_id", - "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `__typename` instead." - }, - { - "name": "uid", - "description": "The unique ID for a `ProductInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "Timestamp indicating when the product was updated.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "upsell_products", - "description": "An array of up-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_key", - "description": "The part of the URL that identifies the product", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_path", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use product's `canonical_url` or url rewrites instead" - }, - { - "name": "url_rewrites", - "description": "URL rewrites list", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "UrlRewrite", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_suffix", - "description": "The part of the product URL that is appended after the url key", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "websites", - "description": "An array of websites in which the product is available.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Website", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "VirtualProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "SimpleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "DownloadableProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GroupedProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProduct", - "ofType": null - } - ] - }, - { - "kind": "INTERFACE", - "name": "PhysicalProductInterface", - "description": "Contains attributes specific to tangible products.", - "fields": [ - { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "SimpleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GroupedProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProduct", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "CustomizableAreaOption", - "description": "Contains information about a text area that is defined as part of a customizable option.", - "fields": [ - { - "name": "option_id", - "description": "Option ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "product_sku", - "description": "The Stock Keeping Unit of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "required", - "description": "Indicates whether the option is required.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which the option is displayed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "An object that defines a text area.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomizableAreaValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableAreaValue", - "description": "Defines the price and sku of a product whose page contains a customized text area.", - "fields": [ - { - "name": "max_characters", - "description": "The maximum number of characters that can be entered for this customizable option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price", - "description": "The price assigned to this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableAreaValue` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CategoryTree", - "description": "Contains the hierarchy of categories.", - "fields": [ - { - "name": "automatic_sorting", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "available_sort_by", - "description": null, - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "breadcrumbs", - "description": "An array of breadcrumb items.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Breadcrumb", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "children", - "description": "A tree of child categories.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CategoryTree", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "children_count", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "cms_block", - "description": "Contains a category CMS block.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CmsBlock", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "The timestamp indicating when the category was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "custom_layout_update_file", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_sort_by", - "description": "The attribute to use for sorting.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "An optional description of the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "display_mode", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "filter_price_range", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "An ID that uniquely identifies the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "image", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "include_in_menu", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_anchor", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "landing_page", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "level", - "description": "The depth of the category within the tree.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_description", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_keywords", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_title", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The display name of the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "path", - "description": "The full category path.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "path_in_store", - "description": "The category path within the store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "position", - "description": "The position of the category relative to other categories at the same level in tree.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_count", - "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "products", - "description": "The list of products assigned to the category.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "sort", - "description": "The attributes to sort on, and whether to return the results in ascending or descending order.", - "type": { - "kind": "INPUT_OBJECT", - "name": "ProductAttributeSortInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CategoryProducts", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "staged", - "description": "Indicates whether the category is staged for a future campaign.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CategoryInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "The timestamp indicating when the category was updated.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "url_key", - "description": "The URL key assigned to the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_path", - "description": "The URL path assigned to the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_suffix", - "description": "The part of the category URL that is appended after the url key", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CategoryInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CategoryResult", - "description": "Contains a collection of `CategoryTree` objects and pagination information.", - "fields": [ - { - "name": "items", - "description": "A list of categories that match the filter criteria.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CategoryTree", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "An object that includes the `page_info` and `currentPage` values specified in the query.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The total number of categories that match the criteria.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableDateOption", - "description": "Contains information about a date picker that is defined as part of a customizable option.", - "fields": [ - { - "name": "option_id", - "description": "Option ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "product_sku", - "description": "The Stock Keeping Unit of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "required", - "description": "Indicates whether the option is required.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which the option is displayed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "An object that defines a date field in a customizable option.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomizableDateValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableDateValue", - "description": "Defines the price and sku of a product whose page contains a customized date picker.", - "fields": [ - { - "name": "price", - "description": "The price assigned to this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "DATE, DATE_TIME or TIME", - "args": [], - "type": { - "kind": "ENUM", - "name": "CustomizableDateTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableDateValue` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableDropDownOption", - "description": "Contains information about a drop down menu that is defined as part of a customizable option.", - "fields": [ - { - "name": "option_id", - "description": "Option ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "required", - "description": "Indicates whether the option is required.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which the option is displayed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "An array that defines the set of options for a drop down menu.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomizableDropDownValue", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableDropDownValue", - "description": "Defines the price and sku of a product whose page contains a customized drop down menu.", - "fields": [ - { - "name": "option_type_id", - "description": "The ID assigned to the value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price", - "description": "The price assigned to this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which the option is displayed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableDropDownValue` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableMultipleOption", - "description": "Contains information about a multiselect that is defined as part of a customizable option.", - "fields": [ - { - "name": "option_id", - "description": "Option ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "required", - "description": "Indicates whether the option is required.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which the option is displayed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "An array that defines the set of options for a multiselect.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomizableMultipleValue", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableMultipleValue", - "description": "Defines the price and sku of a product whose page contains a customized multiselect.", - "fields": [ - { - "name": "option_type_id", - "description": "The ID assigned to the value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price", - "description": "The price assigned to this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which the option is displayed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableMultipleValue` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableFieldOption", - "description": "Contains information about a text field that is defined as part of a customizable option.", - "fields": [ - { - "name": "option_id", - "description": "Option ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "product_sku", - "description": "The Stock Keeping Unit of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "required", - "description": "Indicates whether the option is required.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which the option is displayed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "An object that defines a text field.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomizableFieldValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableFieldValue", - "description": "Defines the price and sku of a product whose page contains a customized text field.", - "fields": [ - { - "name": "max_characters", - "description": "The maximum number of characters that can be entered for this customizable option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price", - "description": "The price of the custom value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableFieldValue` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableFileOption", - "description": "Contains information about a file picker that is defined as part of a customizable option.", - "fields": [ - { - "name": "option_id", - "description": "Option ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "product_sku", - "description": "The Stock Keeping Unit of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "required", - "description": "Indicates whether the option is required.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which the option is displayed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "An object that defines a file value.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomizableFileValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableFileValue", - "description": "Defines the price and sku of a product whose page contains a customized file picker.", - "fields": [ - { - "name": "file_extension", - "description": "The file extension to accept.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "image_size_x", - "description": "The maximum width of an image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "image_size_y", - "description": "The maximum height of an image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price", - "description": "The price assigned to this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableFileValue` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "description": "Contains basic information about a product image or video.", - "fields": [ - { - "name": "disabled", - "description": "Indicates whether the image is hidden from view.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The label of the product image or video.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "position", - "description": "The media item's position after it has been sorted.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url", - "description": "The URL of the product image or video.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ProductVideo", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "ProductImage", - "description": "Contains product image information, including the image URL and label.", - "fields": [ - { - "name": "disabled", - "description": "Indicates whether the image is hidden from view.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The label of the product image or video.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "position", - "description": "The media item's position after it has been sorted.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url", - "description": "The URL of the product image or video.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductVideo", - "description": "Contains information about a product video.", - "fields": [ - { - "name": "disabled", - "description": "Indicates whether the image is hidden from view.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The label of the product image or video.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "position", - "description": "The media item's position after it has been sorted.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url", - "description": "The URL of the product image or video.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "video_content", - "description": "Contains a `ProductMediaGalleryEntriesVideoContent` object.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductMediaGalleryEntriesVideoContent", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "description": "Contains basic information about a customizable option. It can be implemented by several types of configurable options.", - "fields": [ - { - "name": "option_id", - "description": "Option ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "required", - "description": "Indicates whether the option is required.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which the option is displayed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "CustomizableAreaOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableDateOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableDropDownOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableMultipleOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableFieldOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableFileOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableRadioOption", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CustomizableCheckboxOption", - "ofType": null - } - ] - }, - { - "kind": "INTERFACE", - "name": "CustomizableProductInterface", - "description": "Contains information about customizable product options.", - "fields": [ - { - "name": "options", - "description": "An array of options for a customizable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "VirtualProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "SimpleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "DownloadableProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProduct", - "ofType": null - } - ] - }, - { - "kind": "INTERFACE", - "name": "CategoryInterface", - "description": "Contains the full set of attributes that can be returned in a category search.", - "fields": [ - { - "name": "automatic_sorting", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "available_sort_by", - "description": null, - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "breadcrumbs", - "description": "An array of breadcrumb items.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Breadcrumb", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "children_count", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "cms_block", - "description": "Contains a category CMS block.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CmsBlock", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "The timestamp indicating when the category was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "custom_layout_update_file", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_sort_by", - "description": "The attribute to use for sorting.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "An optional description of the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "display_mode", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "filter_price_range", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "An ID that uniquely identifies the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "image", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "include_in_menu", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_anchor", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "landing_page", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "level", - "description": "The depth of the category within the tree.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_description", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_keywords", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_title", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The display name of the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "path", - "description": "The full category path.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "path_in_store", - "description": "The category path within the store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "position", - "description": "The position of the category relative to other categories at the same level in tree.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_count", - "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "products", - "description": "The list of products assigned to the category.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "sort", - "description": "The attributes to sort on, and whether to return the results in ascending or descending order.", - "type": { - "kind": "INPUT_OBJECT", - "name": "ProductAttributeSortInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CategoryProducts", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "staged", - "description": "Indicates whether the category is staged for a future campaign.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CategoryInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "The timestamp indicating when the category was updated.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "url_key", - "description": "The URL key assigned to the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_path", - "description": "The URL path assigned to the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_suffix", - "description": "The part of the category URL that is appended after the url key", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "CategoryTree", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "Breadcrumb", - "description": "Contains details about an individual category that comprises a breadcrumb.", - "fields": [ - { - "name": "category_id", - "description": "The ID of the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `category_uid` instead." - }, - { - "name": "category_level", - "description": "The category level.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_name", - "description": "The display name of the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_uid", - "description": "The unique ID for a `Breadcrumb` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_url_key", - "description": "The URL key of the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_url_path", - "description": "The URL path of the category.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableRadioOption", - "description": "Contains information about a set of radio buttons that are defined as part of a customizable option.", - "fields": [ - { - "name": "option_id", - "description": "Option ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "required", - "description": "Indicates whether the option is required.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which the option is displayed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "An array that defines a set of radio buttons.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomizableRadioValue", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableRadioValue", - "description": "Defines the price and sku of a product whose page contains a customized set of radio buttons.", - "fields": [ - { - "name": "option_type_id", - "description": "The ID assigned to the value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price", - "description": "The price assigned to this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which the radio button is displayed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableRadioValue` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableCheckboxOption", - "description": "Contains information about a set of checkbox values that are defined as part of a customizable option.", - "fields": [ - { - "name": "option_id", - "description": "Option ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "required", - "description": "Indicates whether the option is required.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which the option is displayed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableOptionInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "An array that defines a set of checkbox values.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomizableCheckboxValue", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomizableCheckboxValue", - "description": "Defines the price and sku of a product whose page contains a customized set of checkbox values.", - "fields": [ - { - "name": "option_type_id", - "description": "The ID assigned to the value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price", - "description": "The price assigned to this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_type", - "description": "FIXED, PERCENT, or DYNAMIC.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sku", - "description": "The Stock Keeping Unit for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which the checkbox value is displayed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CustomizableCheckboxValue` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "VirtualProduct", - "description": "Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory.", - "fields": [ - { - "name": "activity", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "categories", - "description": "The categories assigned to a product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_gear", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "climate", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "collar", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "color", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "country_of_manufacture", - "description": "The product's country of origin.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "crosssell_products", - "description": "An array of cross-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gender", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gift_message_available", - "description": "Indicates whether a gift message is available.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The ID number assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." - }, - { - "name": "image", - "description": "The relative path to the main image on the product page.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "material", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "media_gallery", - "description": "An array of media gallery objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "media_gallery_entries", - "description": "An array of MediaGalleryEntry objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "MediaGalleryEntry", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `media_gallery` instead." - }, - { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "new_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new_to_date", - "description": "The end date for new product listings.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "only_x_left_in_stock", - "description": "Product stock only x left count", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "An array of options for a customizable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "pattern", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "price", - "description": "Indicates the price of an item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductPrices", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_range` for product price information." - }, - { - "name": "price_range", - "description": "The range of prices for the product", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PriceRange", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_tiers", - "description": "An array of `TierPrice` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TierPrice", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_links", - "description": "An array of `ProductLinks` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purpose", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "rating_summary", - "description": "The average of all the ratings given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "related_products", - "description": "An array of related products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "review_count", - "description": "The total count of all the reviews given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "reviews", - "description": "The list of products reviews.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviews", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "size", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "special_price", - "description": "The discounted price of the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_to_date", - "description": "The end date for a product with a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "staged", - "description": "Indicates whether the product is staged for a future campaign.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "stock_status", - "description": "Stock status of the product", - "args": [], - "type": { - "kind": "ENUM", - "name": "ProductStockStatus", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "swatch_image", - "description": "The file name of a swatch image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "tier_prices", - "description": "An array of ProductTierPrices objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductTierPrices", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type_id", - "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `__typename` instead." - }, - { - "name": "uid", - "description": "The unique ID for a `ProductInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "Timestamp indicating when the product was updated.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "upsell_products", - "description": "An array of up-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_key", - "description": "The part of the URL that identifies the product", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_path", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use product's `canonical_url` or url rewrites instead" - }, - { - "name": "url_rewrites", - "description": "URL rewrites list", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "UrlRewrite", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_suffix", - "description": "The part of the product URL that is appended after the url key", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "websites", - "description": "An array of websites in which the product is available.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Website", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "CustomizableProductInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SimpleProduct", - "description": "Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities.", - "fields": [ - { - "name": "activity", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "categories", - "description": "The categories assigned to a product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_gear", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "climate", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "collar", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "color", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "country_of_manufacture", - "description": "The product's country of origin.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "crosssell_products", - "description": "An array of cross-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gender", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gift_message_available", - "description": "Indicates whether a gift message is available.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The ID number assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." - }, - { - "name": "image", - "description": "The relative path to the main image on the product page.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "material", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "media_gallery", - "description": "An array of media gallery objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "media_gallery_entries", - "description": "An array of MediaGalleryEntry objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "MediaGalleryEntry", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `media_gallery` instead." - }, - { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "new_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new_to_date", - "description": "The end date for new product listings.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "only_x_left_in_stock", - "description": "Product stock only x left count", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "An array of options for a customizable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "pattern", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "price", - "description": "Indicates the price of an item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductPrices", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_range` for product price information." - }, - { - "name": "price_range", - "description": "The range of prices for the product", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PriceRange", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_tiers", - "description": "An array of `TierPrice` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TierPrice", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_links", - "description": "An array of `ProductLinks` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purpose", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "rating_summary", - "description": "The average of all the ratings given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "related_products", - "description": "An array of related products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "review_count", - "description": "The total count of all the reviews given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "reviews", - "description": "The list of products reviews.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviews", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "size", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "special_price", - "description": "The discounted price of the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_to_date", - "description": "The end date for a product with a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "staged", - "description": "Indicates whether the product is staged for a future campaign.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "stock_status", - "description": "Stock status of the product", - "args": [], - "type": { - "kind": "ENUM", - "name": "ProductStockStatus", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "swatch_image", - "description": "The file name of a swatch image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "tier_prices", - "description": "An array of ProductTierPrices objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductTierPrices", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type_id", - "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `__typename` instead." - }, - { - "name": "uid", - "description": "The unique ID for a `ProductInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "Timestamp indicating when the product was updated.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "upsell_products", - "description": "An array of up-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_key", - "description": "The part of the URL that identifies the product", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_path", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use product's `canonical_url` or url rewrites instead" - }, - { - "name": "url_rewrites", - "description": "URL rewrites list", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "UrlRewrite", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_suffix", - "description": "The part of the product URL that is appended after the url key", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "websites", - "description": "An array of websites in which the product is available.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Website", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "PhysicalProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "CustomizableProductInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Products", - "description": "Contains the results of a `products` query.", - "fields": [ - { - "name": "aggregations", - "description": "A bucket that contains the attribute code and label for each filterable option.", - "args": [ - { - "name": "filter", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AggregationsFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Aggregation", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "filters", - "description": "Layered navigation filters array.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "LayerFilter", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `aggregations` instead." - }, - { - "name": "items", - "description": "An array of products that match the specified search criteria.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "An object that includes the page_info and currentPage values specified in the query.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_fields", - "description": "An object that includes the default sort field and all available sort fields.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SortFields", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "suggestions", - "description": "An array of search suggestions for case when search query have no results.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SearchSuggestion", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The number of products that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AggregationsFilterInput", - "description": "An input object that specifies the filters used in product aggregations.", - "fields": null, - "inputFields": [ - { - "name": "category", - "description": "Filter category aggregations in layered navigation.", - "type": { - "kind": "INPUT_OBJECT", - "name": "AggregationsCategoryFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AggregationsCategoryFilterInput", - "description": "Filter category aggregations in layered navigation.", - "fields": null, - "inputFields": [ - { - "name": "includeDirectChildrenOnly", - "description": "Indicates whether to include only direct subcategories or all children categories at all levels.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CategoryProducts", - "description": "Contains details about the products assigned to a category.", - "fields": [ - { - "name": "items", - "description": "An array of products that are assigned to the category.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Pagination metadata.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ProductAttributeFilterInput", - "description": "Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", - "fields": null, - "inputFields": [ - { - "name": "activity", - "description": "Attribute label: Activity", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "category_gear", - "description": "Attribute label: Category Gear", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "category_id", - "description": "Deprecated: use `category_uid` to filter product by category ID.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "category_uid", - "description": "Filter product by the unique ID for a `CategoryInterface` object.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "category_url_path", - "description": "Filter product by category URL path.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "climate", - "description": "Attribute label: Climate", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "collar", - "description": "Attribute label: Collar", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "color", - "description": "Attribute label: Color", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "description", - "description": "Attribute label: Description", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "eco_collection", - "description": "Attribute label: Eco Collection", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "erin_recommends", - "description": "Attribute label: Erin Recommends", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "features_bags", - "description": "Attribute label: Features", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "format", - "description": "Attribute label: Format", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "gender", - "description": "Attribute label: Gender", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "material", - "description": "Attribute label: Material", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "name", - "description": "Attribute label: Product Name", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "new", - "description": "Attribute label: New", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pattern", - "description": "Attribute label: Pattern", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "performance_fabric", - "description": "Attribute label: Performance Fabric", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "price", - "description": "Attribute label: Price", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterRangeTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "purpose", - "description": "Attribute label: Purpose", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "sale", - "description": "Attribute label: Sale", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "short_description", - "description": "Attribute label: Short Description", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "size", - "description": "Attribute label: Size", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "sku", - "description": "Attribute label: SKU", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "sleeve", - "description": "Attribute label: Sleeve", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "strap_bags", - "description": "Attribute label: Strap/Handle", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "style_bags", - "description": "Attribute label: Style Bags", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "style_bottom", - "description": "Attribute label: Style Bottom", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "style_general", - "description": "Attribute label: Style General", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "url_key", - "description": "The part of the URL that identifies the product", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CategoryFilterInput", - "description": "Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", - "fields": null, - "inputFields": [ - { - "name": "category_uid", - "description": "Filter by the unique category ID for a `CategoryInterface` object.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "ids", - "description": "Deprecated: use 'category_uid' to filter uniquely identifiers of categories.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "name", - "description": "Filter by the display name of the category.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "parent_category_uid", - "description": "Filter by the unique parent category ID for a `CategoryInterface` object.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "parent_id", - "description": "Filter by the unique parent category ID for a `CategoryInterface` object.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "url_key", - "description": "Filter by the part of the URL that identifies the category.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "url_path", - "description": "Filter by the URL path for the category.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ProductFilterInput", - "description": "ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", - "fields": null, - "inputFields": [ - { - "name": "category_id", - "description": "The category ID the product belongs to.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "country_of_manufacture", - "description": "The product's country of origin.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "created_at", - "description": "The timestamp indicating when the product was created.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "custom_layout", - "description": "The name of a custom layout.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "custom_layout_update", - "description": "XML code that is applied as a layout update to the product page.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "gift_message_available", - "description": "Indicates whether a gift message is available.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "has_options", - "description": "Indicates whether additional attributes have been created for the product.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "image", - "description": "The relative path to the main image on the product page.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "image_label", - "description": "The label assigned to a product image.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "max_price", - "description": "The numeric maximal price of the product. Do not include the currency code.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "min_price", - "description": "The numeric minimal price of the product. Do not include the currency code.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "news_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "news_to_date", - "description": "The end date for new product listings.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "or", - "description": "The keyword required to perform a logical OR comparison.", - "type": { - "kind": "INPUT_OBJECT", - "name": "ProductFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "price", - "description": "The price of an item.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "required_options", - "description": "Indicates whether the product has required options.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "small_image_label", - "description": "The label assigned to a product's small image.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "special_price", - "description": "The discounted price of the product. Do not include the currency code.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "special_to_date", - "description": "The end date that a product has a special price.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "swatch_image", - "description": "The file name of a swatch image.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "thumbnail_label", - "description": "The label assigned to a product's thumbnail image.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "updated_at", - "description": "The timestamp indicating when the product was updated.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "url_key", - "description": "The part of the URL that identifies the product", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "url_path", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductMediaGalleryEntriesContent", - "description": "Contains an image in base64 format and basic information about the image.", - "fields": [ - { - "name": "base64_encoded_data", - "description": "The image in base64 format.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The file name of the image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "The MIME type of the file, such as image/png.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductMediaGalleryEntriesVideoContent", - "description": "Contains a link to a video file and basic information about the video.", - "fields": [ - { - "name": "media_type", - "description": "Must be external-video.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "video_description", - "description": "A description of the video.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "video_metadata", - "description": "Optional data about the video.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "video_provider", - "description": "Describes the video source.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "video_title", - "description": "The title of the video.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "video_url", - "description": "The URL to the video.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ProductSortInput", - "description": "Deprecated. Use `ProductAttributeSortInput` instead. Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.", - "fields": null, - "inputFields": [ - { - "name": "country_of_manufacture", - "description": "The product's country of origin.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "created_at", - "description": "The timestamp indicating when the product was created.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "custom_layout", - "description": "The name of a custom layout.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "custom_layout_update", - "description": "XML code that is applied as a layout update to the product page.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "gift_message_available", - "description": "Indicates whether a gift message is available.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "has_options", - "description": "Indicates whether additional attributes have been created for the product.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "image", - "description": "The relative path to the main image on the product page.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "image_label", - "description": "The label assigned to a product image.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "news_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "news_to_date", - "description": "The end date for new product listings.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "price", - "description": "The price of the item.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "required_options", - "description": "Indicates whether the product has required options.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "small_image_label", - "description": "The label assigned to a product's small image.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "special_price", - "description": "The discounted price of the product.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "special_to_date", - "description": "The end date that a product has a special price.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "swatch_image", - "description": "Indicates the criteria to sort swatches.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "thumbnail_label", - "description": "The label assigned to a product's thumbnail image.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "updated_at", - "description": "The timestamp indicating when the product was updated.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "url_key", - "description": "The part of the URL that identifies the product", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "url_path", - "description": "", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ProductAttributeSortInput", - "description": "Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. It's possible to sort products using searchable attributes with enabled 'Use in Filter Options' option", - "fields": null, - "inputFields": [ - { - "name": "name", - "description": "Attribute label: Product Name", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "position", - "description": "Sort by the position assigned to each product.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "price", - "description": "Attribute label: Price", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "relevance", - "description": "Sort by the search relevance score (default).", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "MediaGalleryEntry", - "description": "Defines characteristics about images and videos associated with a specific product.", - "fields": [ - { - "name": "content", - "description": "Details about the content of the media gallery item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductMediaGalleryEntriesContent", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "disabled", - "description": "Indicates whether the image is hidden from view.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "file", - "description": "The path of the image on the server.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The identifier assigned to the object.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "label", - "description": "The alt text displayed on the storefront when the user points to the image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "media_type", - "description": "Either `image` or `video`.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "position", - "description": "The media item's position after it has been sorted.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "types", - "description": "Array of image types. It can have the following values: image, small_image, thumbnail.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `MediaGalleryEntry` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "video_content", - "description": "Details about the content of a video item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductMediaGalleryEntriesVideoContent", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "LayerFilter", - "description": "Contains information for rendering layered navigation.", - "fields": [ - { - "name": "filter_items", - "description": "An array of filter items.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "LayerFilterItemInterface", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `Aggregation.options` instead." - }, - { - "name": "filter_items_count", - "description": "The count of filter items in filter group.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `Aggregation.count` instead." - }, - { - "name": "name", - "description": "The name of a layered navigation filter.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `Aggregation.label` instead." - }, - { - "name": "request_var", - "description": "The request variable name for a filter query.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `Aggregation.attribute_code` instead." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "LayerFilterItemInterface", - "description": "", - "fields": [ - { - "name": "items_count", - "description": "The count of items per filter.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.count` instead." - }, - { - "name": "label", - "description": "The label for a filter.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.label` instead." - }, - { - "name": "value_string", - "description": "The value of a filter request variable to be used in query.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.value` instead." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "LayerFilterItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "SwatchLayerFilterItem", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "LayerFilterItem", - "description": "", - "fields": [ - { - "name": "items_count", - "description": "The count of items per filter.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.count` instead." - }, - { - "name": "label", - "description": "The label for a filter.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.label` instead." - }, - { - "name": "value_string", - "description": "The value of a filter request variable to be used in query.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.value` instead." - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "LayerFilterItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Aggregation", - "description": "Contains information for each filterable option (such as price, category `UID`, and custom attributes).", - "fields": [ - { - "name": "attribute_code", - "description": "Attribute code of the aggregation group.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "count", - "description": "The number of options in the aggregation group.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The aggregation display name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "Array of options for the aggregation.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AggregationOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "position", - "description": "The relative position of the attribute in a layered navigation block.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SearchSuggestion", - "description": "A string that contains search suggestion", - "fields": [ - { - "name": "search", - "description": "The search suggestion of existing product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "AggregationOptionInterface", - "description": "Defines aggregation option fields.", - "fields": [ - { - "name": "count", - "description": "The number of items that match the aggregation option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display label for an aggregation option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The internal ID that represents the value of the option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "AggregationOption", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "AggregationOption", - "description": "An implementation of `AggregationOptionInterface`.", - "fields": [ - { - "name": "count", - "description": "The number of items that match the aggregation option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display label for an aggregation option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The internal ID that represents the value of the option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "AggregationOptionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SortField", - "description": "Defines a possible sort field.", - "fields": [ - { - "name": "label", - "description": "The label of the sort field.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The attribute code of the sort field.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SortFields", - "description": "Contains a default value for sort fields and all available sort fields.", - "fields": [ - { - "name": "default", - "description": "The default sort field value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "An array of possible sort fields.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SortField", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SimpleWishlistItem", - "description": "Contains a simple product wish list item.", - "fields": [ - { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "The description of the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Product details of the wish list item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "VirtualWishlistItem", - "description": "Contains a virtual product wish list item.", - "fields": [ - { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "The description of the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Product details of the wish list item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CatalogAttributeMetadata", - "description": "Swatch attribute metadata.", - "fields": [ - { - "name": "apply_to", - "description": "To which catalog types an attribute can be applied.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CatalogAttributeApplyToEnum", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "code", - "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_value", - "description": "Default attribute value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "entity_type", - "description": "The type of entity that defines the attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "AttributeEntityTypeEnum", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "frontend_class", - "description": "The frontend class of the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "frontend_input", - "description": "The frontend input type of the attribute.", - "args": [], - "type": { - "kind": "ENUM", - "name": "AttributeFrontendInputEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_comparable", - "description": "Whether a product or category attribute can be compared against another or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_filterable", - "description": "Whether a product or category attribute can be filtered or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_filterable_in_search", - "description": "Whether a product or category attribute can be filtered in search or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_html_allowed_on_front", - "description": "Whether a product or category attribute can use HTML on front or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_required", - "description": "Whether the attribute value is required.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_searchable", - "description": "Whether a product or category attribute can be searched or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_unique", - "description": "Whether the attribute value must be unique.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_used_for_price_rules", - "description": "Whether a product or category attribute can be used for price rules or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_used_for_promo_rules", - "description": "Whether a product or category attribute is used for promo rules or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_visible_in_advanced_search", - "description": "Whether a product or category attribute is visible in advanced search or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_visible_on_front", - "description": "Whether a product or category attribute is visible on front or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_wysiwyg_enabled", - "description": "Whether a product or category attribute has WYSIWYG enabled or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The label assigned to the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "Attribute options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomAttributeOptionInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "swatch_input_type", - "description": "Input type of the swatch attribute option.", - "args": [], - "type": { - "kind": "ENUM", - "name": "SwatchInputTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "update_product_preview_image", - "description": "Whether update product preview image or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "use_product_image_for_swatch", - "description": "Whether use product image for swatch or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "used_in_product_listing", - "description": "Whether a product or category attribute is used in product listing or not.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomAttributeMetadataInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CatalogAttributeApplyToEnum", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "SIMPLE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "VIRTUAL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BUNDLE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DOWNLOADABLE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CONFIGURABLE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GROUPED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CATEGORY", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "description": "Product custom attributes", - "fields": [ - { - "name": "errors", - "description": "Errors when retrieving custom attributes metadata.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AttributeMetadataError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "Requested custom attributes", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "AttributeValueInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "ProductStockStatus", - "description": "This enumeration states whether a product stock status is in stock or out of stock", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "IN_STOCK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "OUT_OF_STOCK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "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": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "description": "This enumeration defines the entity type.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "CMS_PAGE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PRODUCT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CATEGORY", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UrlRewrite", - "description": "Contains URL rewrite details.", - "fields": [ - { - "name": "parameters", - "description": "An array of request parameters.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "HttpQueryParameter", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url", - "description": "The request URL.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "HttpQueryParameter", - "description": "Contains target path parameters.", - "fields": [ - { - "name": "name", - "description": "A parameter name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "A parameter value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RoutableUrl", - "description": "Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity.", - "fields": [ - { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "description": "Routable entities serve as the model for a rendered page.", - "fields": [ - { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "CmsPage", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CategoryTree", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "VirtualProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "SimpleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "RoutableUrl", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "DownloadableProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GroupedProduct", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProduct", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "CheckoutAgreement", - "description": "Defines details about an individual checkout agreement.", - "fields": [ - { - "name": "agreement_id", - "description": "The ID for a checkout agreement.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "checkbox_text", - "description": "The checkbox text for the checkout agreement.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "content", - "description": "Required. The text of the agreement.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "content_height", - "description": "The height of the text box where the Terms and Conditions statement appears during checkout.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_html", - "description": "Indicates whether the `content` text is in HTML format.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "mode", - "description": "Indicates whether agreements are accepted automatically or manually.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CheckoutAgreementMode", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The name given to the condition.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CheckoutAgreementMode", - "description": "Indicates how agreements are accepted.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "AUTO", - "description": "Conditions are automatically accepted upon checkout.", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MANUAL", - "description": "Shoppers must manually accept the conditions to place an order.", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressInput", - "description": "Contains details about a billing or shipping address.", - "fields": null, - "inputFields": [ - { - "name": "city", - "description": "The customer's city or town.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "company", - "description": "The customer's company.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "country_code", - "description": "The two-letter code representing the customer's country.", - "type": { - "kind": "ENUM", - "name": "CountryCodeEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "country_id", - "description": "Deprecated: use `country_code` instead.", - "type": { - "kind": "ENUM", - "name": "CountryCodeEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "custom_attributes", - "description": "Deprecated. Use custom_attributesV2 instead.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressAttributeInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "custom_attributesV2", - "description": "Custom attributes assigned to the customer address.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "AttributeValueInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "default_billing", - "description": "Indicates whether the address is the default billing address.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "default_shipping", - "description": "Indicates whether the address is the default shipping address.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "fax", - "description": "The customer's fax number.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "firstname", - "description": "The first name of the person associated with the billing/shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "lastname", - "description": "The family name of the person associated with the billing/shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "middlename", - "description": "The middle name of the person associated with the billing/shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "postcode", - "description": "The customer's ZIP or postal code.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "prefix", - "description": "An honorific, such as Dr., Mr., or Mrs.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "region", - "description": "An object containing the region name, region code, and region ID.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressRegionInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "street", - "description": "An array of strings that define the street number and name.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "suffix", - "description": "A value such as Sr., Jr., or III.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "telephone", - "description": "The customer's telephone number.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "vat_id", - "description": "The customer's Tax/VAT number (for corporate customers).", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressRegionInput", - "description": "Defines the customer's state or province.", - "fields": null, - "inputFields": [ - { - "name": "region", - "description": "The state or province name.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "region_code", - "description": "The address region code.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "region_id", - "description": "The unique ID for a pre-defined region.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressAttributeInput", - "description": "Specifies the attribute code and value of a customer attribute.", - "fields": null, - "inputFields": [ - { - "name": "attribute_code", - "description": "The name assigned to the attribute.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "value", - "description": "The value assigned to the attribute.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerToken", - "description": "Contains a customer authorization token.", - "fields": [ - { - "name": "token", - "description": "The customer authorization token.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CustomerInput", - "description": "An input object that assigns or updates customer attributes.", - "fields": null, - "inputFields": [ - { - "name": "date_of_birth", - "description": "The customer's date of birth.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "dob", - "description": "Deprecated: Use `date_of_birth` instead.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "email", - "description": "The customer's email address. Required when creating a customer.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "firstname", - "description": "The customer's first name.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "gender", - "description": "The customer's gender (Male - 1, Female - 2).", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_subscribed", - "description": "Indicates whether the customer is subscribed to the company's newsletter.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "lastname", - "description": "The customer's family name.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "middlename", - "description": "The customer's middle name.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "password", - "description": "The customer's password.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "prefix", - "description": "An honorific, such as Dr., Mr., or Mrs.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "suffix", - "description": "A value such as Sr., Jr., or III.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "taxvat", - "description": "The customer's Tax/VAT number (for corporate customers).", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CustomerCreateInput", - "description": "An input object for creating a customer.", - "fields": null, - "inputFields": [ - { - "name": "allow_remote_shopping_assistance", - "description": "Indicates whether the customer has enabled remote shopping assistance.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "custom_attributes", - "description": "The customer's custom attributes.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "AttributeValueInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "date_of_birth", - "description": "The customer's date of birth.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "dob", - "description": "Deprecated: Use `date_of_birth` instead.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "email", - "description": "The customer's email address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "firstname", - "description": "The customer's first name.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "gender", - "description": "The customer's gender (Male - 1, Female - 2).", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_subscribed", - "description": "Indicates whether the customer is subscribed to the company's newsletter.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "lastname", - "description": "The customer's family name.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "middlename", - "description": "The customer's middle name.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "password", - "description": "The customer's password.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "prefix", - "description": "An honorific, such as Dr., Mr., or Mrs.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "suffix", - "description": "A value such as Sr., Jr., or III.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "taxvat", - "description": "The customer's Tax/VAT number (for corporate customers).", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CustomerUpdateInput", - "description": "An input object for updating a customer.", - "fields": null, - "inputFields": [ - { - "name": "allow_remote_shopping_assistance", - "description": "Indicates whether the customer has enabled remote shopping assistance.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "custom_attributes", - "description": "The customer's custom attributes.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "AttributeValueInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "date_of_birth", - "description": "The customer's date of birth.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "dob", - "description": "Deprecated: Use `date_of_birth` instead.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "firstname", - "description": "The customer's first name.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "gender", - "description": "The customer's gender (Male - 1, Female - 2).", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_subscribed", - "description": "Indicates whether the customer is subscribed to the company's newsletter.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "lastname", - "description": "The customer's family name.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "middlename", - "description": "The customer's middle name.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "prefix", - "description": "An honorific, such as Dr., Mr., or Mrs.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "suffix", - "description": "A value such as Sr., Jr., or III.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "taxvat", - "description": "The customer's Tax/VAT number (for corporate customers).", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerOutput", - "description": "Contains details about a newly-created or updated customer.", - "fields": [ - { - "name": "customer", - "description": "Customer details after creating or updating a customer.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RevokeCustomerTokenOutput", - "description": "Contains the result of a request to revoke a customer token.", - "fields": [ - { - "name": "result", - "description": "The result of a request to revoke a customer token.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Customer", - "description": "Defines the customer name, addresses, and other details.", - "fields": [ - { - "name": "addresses", - "description": "An array containing the customer's shipping and billing addresses.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomerAddress", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "allow_remote_shopping_assistance", - "description": "Indicates whether the customer has enabled remote shopping assistance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "compare_list", - "description": "The contents of the customer's compare list.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CompareList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "Timestamp indicating when the account was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_attributes", - "description": "Customer's custom attributes.", - "args": [ - { - "name": "attributeCodes", - "description": "", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "AttributeValueInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "date_of_birth", - "description": "The customer's date of birth.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_billing", - "description": "The ID assigned to the billing address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_shipping", - "description": "The ID assigned to the shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "dob", - "description": "The customer's date of birth.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `date_of_birth` instead." - }, - { - "name": "email", - "description": "The customer's email address. Required.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "firstname", - "description": "The customer's first name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gender", - "description": "The customer's gender (Male - 1, Female - 2).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_registries", - "description": "Details about all of the customer's gift registries.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftRegistry", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_registry", - "description": "Details about a specific gift registry.", - "args": [ - { - "name": "giftRegistryUid", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "GiftRegistry", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "group_id", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Customer group should not be exposed in the storefront scenarios." - }, - { - "name": "id", - "description": "The ID assigned to the customer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`id` is not needed as part of `Customer`, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side." - }, - { - "name": "is_subscribed", - "description": "Indicates whether the customer is subscribed to the company's newsletter.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "job_title", - "description": "The job title of a company user.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "lastname", - "description": "The customer's family name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "middlename", - "description": "The customer's middle name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "orders", - "description": null, - "args": [ - { - "name": "filter", - "description": "Defines the filter to use for searching customer orders.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CustomerOrdersFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "currentPage", - "description": "Specifies which page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "pageSize", - "description": "Specifies the maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "sort", - "description": "Specifies which field to sort on, and whether to return the results in ascending or descending order.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CustomerOrderSortInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "scope", - "description": "Specifies the scope to search for customer orders. The Store request header identifies the customer's store view code. The default value of STORE limits the search to the value specified in the header. Specify WEBSITE to expand the search to include all customer orders assigned to the website that is defined in the header, or specify GLOBAL to include all customer orders across all websites and stores.", - "type": { - "kind": "ENUM", - "name": "ScopeTypeEnum", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CustomerOrders", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prefix", - "description": "An honorific, such as Dr., Mr., or Mrs.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purchase_order", - "description": "Purchase order details.", - "args": [ - { - "name": "uid", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PurchaseOrder", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purchase_order_approval_rule", - "description": "Details about a single purchase order approval rule.", - "args": [ - { - "name": "uid", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalRule", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purchase_order_approval_rule_metadata", - "description": "Purchase order approval rule metadata that can be used for rule edit form rendering.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalRuleMetadata", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purchase_order_approval_rules", - "description": "A list of purchase order approval rules visible to the customer.", - "args": [ - { - "name": "currentPage", - "description": "", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "pageSize", - "description": "", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - } - ], - "type": { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalRules", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purchase_orders", - "description": "A list of purchase orders visible to the customer.", - "args": [ - { - "name": "filter", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "PurchaseOrdersFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "currentPage", - "description": "", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "pageSize", - "description": "", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - } - ], - "type": { - "kind": "OBJECT", - "name": "PurchaseOrders", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purchase_orders_enabled", - "description": "Indicates whether purchase order functionality is enabled for the current customer. Global and company-level settings are factored into the result.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "requisition_lists", - "description": "An object that contains the customer's requisition lists.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "filter", - "description": "The filter to use to limit the number of requisition lists to return.", - "type": { - "kind": "INPUT_OBJECT", - "name": "RequisitionListFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "RequisitionLists", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "return", - "description": "Details about the specified return request from the unique ID for a `Return` object.", - "args": [ - { - "name": "uid", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "Return", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "returns", - "description": "Information about the customer's return requests.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "OBJECT", - "name": "Returns", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "reviews", - "description": "Contains the customer's product reviews.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviews", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "reward_points", - "description": "Customer reward points details.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RewardPoints", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "role", - "description": "The role name and permissions assigned to the company user.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "Indicates whether the company user is ACTIVE or INACTIVE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "CompanyUserStatusEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "store_credit", - "description": "Store credit information applied for the logged in customer.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomerStoreCredit", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "structure_id", - "description": "ID of the company structure", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "suffix", - "description": "A value such as Sr., Jr., or III.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "taxvat", - "description": "The customer's Value-added tax (VAT) number (for corporate customers).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "team", - "description": "The team the company user is assigned to.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CompanyTeam", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "telephone", - "description": "The phone number of the company user.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "wishlist", - "description": "Return a customer's wish lists.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Wishlist", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `Customer.wishlists` or `Customer.wishlist_v2` instead." - }, - { - "name": "wishlist_v2", - "description": "Retrieve the wish list identified by the unique ID for a `Wishlist` object.", - "args": [ - { - "name": "id", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "Wishlist", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "wishlists", - "description": "An array of wishlists. In Magento Open Source, customers are limited to one wish list. The number of wish lists is configurable for Adobe Commerce.", - "args": [ - { - "name": "pageSize", - "description": "Specifies the maximum number of results to return at once. This attribute is optional.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "Specifies which page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Wishlist", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerAddress", - "description": "Contains detailed information about a customer's billing or shipping address.", - "fields": [ - { - "name": "city", - "description": "The customer's city or town.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "company", - "description": "The customer's company.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country_code", - "description": "The customer's country.", - "args": [], - "type": { - "kind": "ENUM", - "name": "CountryCodeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country_id", - "description": "The customer's country.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `country_code` instead." - }, - { - "name": "custom_attributes", - "description": null, - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomerAddressAttribute", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use custom_attributesV2 instead." - }, - { - "name": "custom_attributesV2", - "description": "Custom attributes assigned to the customer address.", - "args": [ - { - "name": "attributeCodes", - "description": "", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "AttributeValueInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customer_id", - "description": "The customer ID", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`customer_id` is not needed as part of `CustomerAddress`. The `id` is a unique identifier for the addresses." - }, - { - "name": "default_billing", - "description": "Indicates whether the address is the customer's default billing address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_shipping", - "description": "Indicates whether the address is the customer's default shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "extension_attributes", - "description": "Contains any extension attributes for the address.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomerAddressAttribute", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "fax", - "description": "The customer's fax number.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "firstname", - "description": "The first name of the person associated with the shipping/billing address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The ID of a `CustomerAddress` object.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "lastname", - "description": "The family name of the person associated with the shipping/billing address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "middlename", - "description": "The middle name of the person associated with the shipping/billing address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "postcode", - "description": "The customer's ZIP or postal code.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prefix", - "description": "An honorific, such as Dr., Mr., or Mrs.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region", - "description": "An object containing the region name, region code, and region ID.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomerAddressRegion", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region_id", - "description": "The unique ID for a pre-defined region.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "street", - "description": "An array of strings that define the street number and name.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "suffix", - "description": "A value such as Sr., Jr., or III.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "telephone", - "description": "The customer's telephone number.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "vat_id", - "description": "The customer's Value-added tax (VAT) number (for corporate customers).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerAddressRegion", - "description": "Defines the customer's state or province.", - "fields": [ - { - "name": "region", - "description": "The state or province name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region_code", - "description": "The address region code.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region_id", - "description": "The unique ID for a pre-defined region.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerAddressAttribute", - "description": "Specifies the attribute code and value of a customer address attribute.", - "fields": [ - { - "name": "attribute_code", - "description": "The name assigned to the customer address attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The value assigned to the customer address attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "IsEmailAvailableOutput", - "description": "Contains the result of the `isEmailAvailable` query.", - "fields": [ - { - "name": "is_email_available", - "description": "Indicates whether the specified email address can be used to create a customer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CountryCodeEnum", - "description": "The list of country codes.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "AF", - "description": "Afghanistan", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AX", - "description": "Åland Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AL", - "description": "Albania", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DZ", - "description": "Algeria", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AS", - "description": "American Samoa", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AD", - "description": "Andorra", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AO", - "description": "Angola", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AI", - "description": "Anguilla", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AQ", - "description": "Antarctica", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AG", - "description": "Antigua & Barbuda", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AR", - "description": "Argentina", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AM", - "description": "Armenia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AW", - "description": "Aruba", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AU", - "description": "Australia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AT", - "description": "Austria", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AZ", - "description": "Azerbaijan", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BS", - "description": "Bahamas", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BH", - "description": "Bahrain", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BD", - "description": "Bangladesh", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BB", - "description": "Barbados", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BY", - "description": "Belarus", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BE", - "description": "Belgium", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BZ", - "description": "Belize", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BJ", - "description": "Benin", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BM", - "description": "Bermuda", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BT", - "description": "Bhutan", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BO", - "description": "Bolivia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BA", - "description": "Bosnia & Herzegovina", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BW", - "description": "Botswana", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BV", - "description": "Bouvet Island", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BR", - "description": "Brazil", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "IO", - "description": "British Indian Ocean Territory", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "VG", - "description": "British Virgin Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BN", - "description": "Brunei", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BG", - "description": "Bulgaria", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BF", - "description": "Burkina Faso", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BI", - "description": "Burundi", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KH", - "description": "Cambodia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CM", - "description": "Cameroon", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CA", - "description": "Canada", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CV", - "description": "Cape Verde", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KY", - "description": "Cayman Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CF", - "description": "Central African Republic", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TD", - "description": "Chad", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CL", - "description": "Chile", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CN", - "description": "China", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CX", - "description": "Christmas Island", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CC", - "description": "Cocos (Keeling) Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CO", - "description": "Colombia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KM", - "description": "Comoros", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CG", - "description": "Congo-Brazzaville", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CD", - "description": "Congo-Kinshasa", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CK", - "description": "Cook Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CR", - "description": "Costa Rica", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CI", - "description": "Côte d’Ivoire", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "HR", - "description": "Croatia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CU", - "description": "Cuba", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CY", - "description": "Cyprus", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CZ", - "description": "Czech Republic", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DK", - "description": "Denmark", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DJ", - "description": "Djibouti", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DM", - "description": "Dominica", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DO", - "description": "Dominican Republic", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "EC", - "description": "Ecuador", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "EG", - "description": "Egypt", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SV", - "description": "El Salvador", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GQ", - "description": "Equatorial Guinea", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ER", - "description": "Eritrea", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "EE", - "description": "Estonia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SZ", - "description": "Eswatini", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ET", - "description": "Ethiopia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FK", - "description": "Falkland Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FO", - "description": "Faroe Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FJ", - "description": "Fiji", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FI", - "description": "Finland", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FR", - "description": "France", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GF", - "description": "French Guiana", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PF", - "description": "French Polynesia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TF", - "description": "French Southern Territories", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GA", - "description": "Gabon", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GM", - "description": "Gambia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GE", - "description": "Georgia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DE", - "description": "Germany", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GH", - "description": "Ghana", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GI", - "description": "Gibraltar", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GR", - "description": "Greece", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GL", - "description": "Greenland", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GD", - "description": "Grenada", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GP", - "description": "Guadeloupe", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GU", - "description": "Guam", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GT", - "description": "Guatemala", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GG", - "description": "Guernsey", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GN", - "description": "Guinea", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GW", - "description": "Guinea-Bissau", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GY", - "description": "Guyana", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "HT", - "description": "Haiti", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "HM", - "description": "Heard & McDonald Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "HN", - "description": "Honduras", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "HK", - "description": "Hong Kong SAR China", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "HU", - "description": "Hungary", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "IS", - "description": "Iceland", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "IN", - "description": "India", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ID", - "description": "Indonesia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "IR", - "description": "Iran", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "IQ", - "description": "Iraq", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "IE", - "description": "Ireland", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "IM", - "description": "Isle of Man", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "IL", - "description": "Israel", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "IT", - "description": "Italy", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "JM", - "description": "Jamaica", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "JP", - "description": "Japan", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "JE", - "description": "Jersey", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "JO", - "description": "Jordan", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KZ", - "description": "Kazakhstan", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KE", - "description": "Kenya", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KI", - "description": "Kiribati", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KW", - "description": "Kuwait", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KG", - "description": "Kyrgyzstan", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LA", - "description": "Laos", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LV", - "description": "Latvia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LB", - "description": "Lebanon", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LS", - "description": "Lesotho", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LR", - "description": "Liberia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LY", - "description": "Libya", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LI", - "description": "Liechtenstein", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LT", - "description": "Lithuania", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LU", - "description": "Luxembourg", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MO", - "description": "Macau SAR China", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MK", - "description": "Macedonia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MG", - "description": "Madagascar", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MW", - "description": "Malawi", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MY", - "description": "Malaysia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MV", - "description": "Maldives", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ML", - "description": "Mali", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MT", - "description": "Malta", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MH", - "description": "Marshall Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MQ", - "description": "Martinique", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MR", - "description": "Mauritania", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MU", - "description": "Mauritius", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "YT", - "description": "Mayotte", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MX", - "description": "Mexico", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FM", - "description": "Micronesia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MD", - "description": "Moldova", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MC", - "description": "Monaco", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MN", - "description": "Mongolia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ME", - "description": "Montenegro", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MS", - "description": "Montserrat", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MA", - "description": "Morocco", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MZ", - "description": "Mozambique", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MM", - "description": "Myanmar (Burma)", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NA", - "description": "Namibia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NR", - "description": "Nauru", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NP", - "description": "Nepal", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NL", - "description": "Netherlands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AN", - "description": "Netherlands Antilles", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NC", - "description": "New Caledonia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NZ", - "description": "New Zealand", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NI", - "description": "Nicaragua", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NE", - "description": "Niger", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NG", - "description": "Nigeria", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NU", - "description": "Niue", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NF", - "description": "Norfolk Island", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MP", - "description": "Northern Mariana Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KP", - "description": "North Korea", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NO", - "description": "Norway", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "OM", - "description": "Oman", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PK", - "description": "Pakistan", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PW", - "description": "Palau", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PS", - "description": "Palestinian Territories", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PA", - "description": "Panama", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PG", - "description": "Papua New Guinea", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PY", - "description": "Paraguay", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PE", - "description": "Peru", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PH", - "description": "Philippines", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PN", - "description": "Pitcairn Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PL", - "description": "Poland", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PT", - "description": "Portugal", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "QA", - "description": "Qatar", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "RE", - "description": "Réunion", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "RO", - "description": "Romania", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "RU", - "description": "Russia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "RW", - "description": "Rwanda", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "WS", - "description": "Samoa", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SM", - "description": "San Marino", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ST", - "description": "São Tomé & Príncipe", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SA", - "description": "Saudi Arabia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SN", - "description": "Senegal", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "RS", - "description": "Serbia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SC", - "description": "Seychelles", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SL", - "description": "Sierra Leone", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SG", - "description": "Singapore", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SK", - "description": "Slovakia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SI", - "description": "Slovenia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SB", - "description": "Solomon Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SO", - "description": "Somalia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ZA", - "description": "South Africa", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GS", - "description": "South Georgia & South Sandwich Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KR", - "description": "South Korea", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ES", - "description": "Spain", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LK", - "description": "Sri Lanka", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BL", - "description": "St. Barthélemy", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SH", - "description": "St. Helena", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "KN", - "description": "St. Kitts & Nevis", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LC", - "description": "St. Lucia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MF", - "description": "St. Martin", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PM", - "description": "St. Pierre & Miquelon", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "VC", - "description": "St. Vincent & Grenadines", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SD", - "description": "Sudan", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SR", - "description": "Suriname", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SJ", - "description": "Svalbard & Jan Mayen", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SE", - "description": "Sweden", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CH", - "description": "Switzerland", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SY", - "description": "Syria", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TW", - "description": "Taiwan", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TJ", - "description": "Tajikistan", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TZ", - "description": "Tanzania", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TH", - "description": "Thailand", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TL", - "description": "Timor-Leste", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TG", - "description": "Togo", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TK", - "description": "Tokelau", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TO", - "description": "Tonga", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TT", - "description": "Trinidad & Tobago", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TN", - "description": "Tunisia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TR", - "description": "Turkey", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TM", - "description": "Turkmenistan", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TC", - "description": "Turks & Caicos Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TV", - "description": "Tuvalu", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UG", - "description": "Uganda", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UA", - "description": "Ukraine", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AE", - "description": "United Arab Emirates", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GB", - "description": "United Kingdom", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "US", - "description": "United States", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UY", - "description": "Uruguay", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UM", - "description": "U.S. Outlying Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "VI", - "description": "U.S. Virgin Islands", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UZ", - "description": "Uzbekistan", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "VU", - "description": "Vanuatu", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "VA", - "description": "Vatican City", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "VE", - "description": "Venezuela", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "VN", - "description": "Vietnam", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "WF", - "description": "Wallis & Futuna", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "EH", - "description": "Western Sahara", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "YE", - "description": "Yemen", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ZM", - "description": "Zambia", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ZW", - "description": "Zimbabwe", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerAttributeMetadata", - "description": "Customer attribute metadata.", - "fields": [ - { - "name": "code", - "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_value", - "description": "Default attribute value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "entity_type", - "description": "The type of entity that defines the attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "AttributeEntityTypeEnum", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "frontend_class", - "description": "The frontend class of the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "frontend_input", - "description": "The frontend input type of the attribute.", - "args": [], - "type": { - "kind": "ENUM", - "name": "AttributeFrontendInputEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "input_filter", - "description": "The template used for the input of the attribute (e.g., 'date').", - "args": [], - "type": { - "kind": "ENUM", - "name": "InputFilterEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_required", - "description": "Whether the attribute value is required.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_unique", - "description": "Whether the attribute value must be unique.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The label assigned to the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "multiline_count", - "description": "The number of lines of the attribute value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "Attribute options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomAttributeOptionInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The position of the attribute in the form.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "validate_rules", - "description": "The validation rules of the attribute value.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ValidationRule", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomAttributeMetadataInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "InputFilterEnum", - "description": "List of templates/filters applied to customer attribute input.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "NONE", - "description": "There are no templates or filters to be applied.", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DATE", - "description": "Forces attribute input to follow the date format.", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TRIM", - "description": "Strip whitespace (or other characters) from the beginning and end of the input.", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "STRIPTAGS", - "description": "Strip HTML Tags.", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ESCAPEHTML", - "description": "Escape HTML Entities.", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ValidationRule", - "description": "Defines a customer attribute validation rule.", - "fields": [ - { - "name": "name", - "description": "Validation rule name applied to a customer attribute.", - "args": [], - "type": { - "kind": "ENUM", - "name": "ValidationRuleEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "Validation rule value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "ValidationRuleEnum", - "description": "List of validation rule names applied to a customer attribute.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "DATE_RANGE_MAX", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DATE_RANGE_MIN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FILE_EXTENSIONS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "INPUT_VALIDATION", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MAX_TEXT_LENGTH", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MIN_TEXT_LENGTH", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MAX_FILE_SIZE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MAX_IMAGE_HEIGHT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MAX_IMAGE_WIDTH", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ComparableItem", - "description": "Defines an object used to iterate through items for product comparisons.", - "fields": [ - { - "name": "attributes", - "description": "An array of product attributes that can be used to compare products.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductAttribute", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about a product in a compare list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID of an item in a compare list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductAttribute", - "description": "Contains a product attribute code and value.", - "fields": [ - { - "name": "code", - "description": "The unique identifier for a product attribute code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The display value of the attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ComparableAttribute", - "description": "Contains an attribute code that is used for product comparisons.", - "fields": [ - { - "name": "code", - "description": "An attribute code that is enabled for product comparisons.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The label of the attribute code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompareList", - "description": "Contains iterable information such as the array of items, the count, and attributes that represent the compare list.", - "fields": [ - { - "name": "attributes", - "description": "An array of attributes that can be used for comparing products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ComparableAttribute", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "item_count", - "description": "The number of items in the compare list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "An array of products to compare.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ComparableItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID assigned to the compare list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CreateCompareListInput", - "description": "Contains an array of product IDs to use for creating a compare list.", - "fields": null, - "inputFields": [ - { - "name": "products", - "description": "An array of product IDs to add to the compare list.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddProductsToCompareListInput", - "description": "Contains products to add to an existing compare list.", - "fields": null, - "inputFields": [ - { - "name": "products", - "description": "An array of product IDs to add to the compare list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "uid", - "description": "The unique identifier of the compare list to modify.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RemoveProductsFromCompareListInput", - "description": "Defines which products to remove from a compare list.", - "fields": null, - "inputFields": [ - { - "name": "products", - "description": "An array of product IDs to remove from the compare list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "uid", - "description": "The unique identifier of the compare list to modify.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeleteCompareListOutput", - "description": "Contains the results of the request to delete a compare list.", - "fields": [ - { - "name": "result", - "description": "Indicates whether the compare list was successfully deleted.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AssignCompareListToCustomerOutput", - "description": "Contains the results of the request to assign a compare list.", - "fields": [ - { - "name": "compare_list", - "description": "The contents of the customer's compare list.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CompareList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "result", - "description": "Indicates whether the compare list was successfully assigned to the customer.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CreateGuestCartInput", - "description": "", - "fields": null, - "inputFields": [ - { - "name": "cart_uid", - "description": "Optional client-generated ID", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "createEmptyCartInput", - "description": "Assigns a specific `cart_id` to the empty cart.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The ID to assign to the cart.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddSimpleProductsToCartInput", - "description": "Defines the simple and group products to add to the cart.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cart_items", - "description": "An array of simple and group items to add.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "SimpleProductCartItemInput", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SimpleProductCartItemInput", - "description": "Defines a single product to add to the cart.", - "fields": null, - "inputFields": [ - { - "name": "customizable_options", - "description": "An array that defines customizable options for the product.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "data", - "description": "An object containing the `sku`, `quantity`, and other relevant information about the product.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddVirtualProductsToCartInput", - "description": "Defines the virtual products to add to the cart.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cart_items", - "description": "An array of virtual products to add.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "VirtualProductCartItemInput", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "VirtualProductCartItemInput", - "description": "Defines a single product to add to the cart.", - "fields": null, - "inputFields": [ - { - "name": "customizable_options", - "description": "An array that defines customizable options for the product.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "data", - "description": "An object containing the `sku`, `quantity`, and other relevant information about the product.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "description": "Defines an item to be added to the cart.", - "fields": null, - "inputFields": [ - { - "name": "entered_options", - "description": "An array of entered options for the base product, such as personalization text.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "EnteredOptionInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "parent_sku", - "description": "For a child product, the SKU of its parent product.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "quantity", - "description": "The amount or number of an item to add.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "selected_options", - "description": "The selected options for the base product, such as color or size, using the unique ID for an object such as `CustomizableRadioOption`, `CustomizableDropDownOption`, or `ConfigurableProductOptionsValues`.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "sku", - "description": "The SKU of the product.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", - "description": "Defines a customizable option.", - "fields": null, - "inputFields": [ - { - "name": "id", - "description": "The customizable option ID of the product.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "value_string", - "description": "The string value of the option.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ApplyCouponToCartInput", - "description": "Specifies the coupon code to apply to the cart.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "coupon_code", - "description": "A valid coupon code.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "UpdateCartItemsInput", - "description": "Modifies the specified items in the cart.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cart_items", - "description": "An array of items to be updated.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemUpdateInput", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CartItemUpdateInput", - "description": "A single item to be updated.", - "fields": null, - "inputFields": [ - { - "name": "cart_item_id", - "description": "Deprecated. Use `cart_item_uid` instead.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "cart_item_uid", - "description": "The unique ID for a `CartItemInterface` object.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "customizable_options", - "description": "An array that defines customizable options for the product.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "gift_message", - "description": "Gift message details for the cart item", - "type": { - "kind": "INPUT_OBJECT", - "name": "GiftMessageInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "gift_wrapping_id", - "description": "The unique ID for a `GiftWrapping` object to be used for the cart item.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "quantity", - "description": "The new quantity of the item.", - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RemoveItemFromCartInput", - "description": "Specifies which items to remove from the cart.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cart_item_id", - "description": "Deprecated. Use `cart_item_uid` instead.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "cart_item_uid", - "description": "Required field. The unique ID for a `CartItemInterface` object.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SetShippingAddressesOnCartInput", - "description": "Specifies an array of addresses to use for shipping.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "shipping_addresses", - "description": "An array of shipping addresses.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "ShippingAddressInput", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ShippingAddressInput", - "description": "Defines a single shipping address.", - "fields": null, - "inputFields": [ - { - "name": "address", - "description": "Defines a shipping address.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CartAddressInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "customer_address_id", - "description": "An ID from the customer's address book that uniquely identifies the address to be used for shipping.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "customer_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.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SetPaymentMethodAndPlaceOrderInput", - "description": "Applies a payment method to the quote.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "payment_method", - "description": "The payment method data to apply to the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PaymentMethodInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PlaceOrderInput", - "description": "Specifies the quote to be converted to an order.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SetPaymentMethodOnCartInput", - "description": "Applies a payment method to the cart.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "payment_method", - "description": "The payment method data to apply to the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PaymentMethodInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PaymentMethodInput", - "description": "Defines the payment method.", - "fields": null, - "inputFields": [ - { - "name": "braintree", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "BraintreeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "braintree_ach_direct_debit", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "BraintreeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "braintree_ach_direct_debit_vault", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "BraintreeVaultInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "braintree_applepay_vault", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "BraintreeVaultInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "braintree_cc_vault", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "BraintreeCcVaultInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "braintree_googlepay_vault", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "BraintreeVaultInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "braintree_paypal", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "BraintreeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "braintree_paypal_vault", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "BraintreeVaultInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "code", - "description": "The internal name for the payment method.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "hosted_pro", - "description": "Required input for PayPal Hosted pro payments.", - "type": { - "kind": "INPUT_OBJECT", - "name": "HostedProInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "payflow_express", - "description": "Required input for Payflow Express Checkout payments.", - "type": { - "kind": "INPUT_OBJECT", - "name": "PayflowExpressInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "payflow_link", - "description": "Required input for PayPal Payflow Link and Payments Advanced payments.", - "type": { - "kind": "INPUT_OBJECT", - "name": "PayflowLinkInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "payflowpro", - "description": "Required input for PayPal Payflow Pro and Payment Pro payments.", - "type": { - "kind": "INPUT_OBJECT", - "name": "PayflowProInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "payflowpro_cc_vault", - "description": "Required input for PayPal Payflow Pro vault payments.", - "type": { - "kind": "INPUT_OBJECT", - "name": "VaultTokenInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "payment_services_paypal_apple_pay", - "description": "Required input for Apple Pay button", - "type": { - "kind": "INPUT_OBJECT", - "name": "ApplePayMethodInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "payment_services_paypal_hosted_fields", - "description": "Required input for Hosted Fields", - "type": { - "kind": "INPUT_OBJECT", - "name": "HostedFieldsInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "payment_services_paypal_smart_buttons", - "description": "Required input for Smart buttons", - "type": { - "kind": "INPUT_OBJECT", - "name": "SmartButtonMethodInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "payment_services_paypal_vault", - "description": "Required input for vault", - "type": { - "kind": "INPUT_OBJECT", - "name": "VaultMethodInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "paypal_express", - "description": "Required input for Express Checkout and Payments Standard payments.", - "type": { - "kind": "INPUT_OBJECT", - "name": "PaypalExpressInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "purchase_order_number", - "description": "The purchase order number. Optional for most payment methods.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SetGuestEmailOnCartInput", - "description": "Defines the guest email and cart.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "email", - "description": "The email address of the guest.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CartPrices", - "description": "Contains details about the final price of items in the cart, including discount and tax information.", - "fields": [ - { - "name": "applied_taxes", - "description": "An array containing the names and amounts of taxes applied to each item in the cart.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartTaxItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discount", - "description": null, - "args": [], - "type": { - "kind": "OBJECT", - "name": "CartDiscount", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use discounts instead." - }, - { - "name": "discounts", - "description": "An array containing cart rule discounts, store credit and gift cards applied to the cart.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_options", - "description": "The list of prices for the selected gift options.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftOptionsPrices", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "grand_total", - "description": "The total, including discounts, taxes, shipping, and other fees.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "subtotal_excluding_tax", - "description": "The subtotal without any applied taxes.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "subtotal_including_tax", - "description": "The subtotal including any applied taxes.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "subtotal_with_discount_excluding_tax", - "description": "The subtotal with any discounts applied, but not taxes.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CartTaxItem", - "description": "Contains tax information about an item in the cart.", - "fields": [ - { - "name": "amount", - "description": "The amount of tax applied to the item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The description of the tax.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CartDiscount", - "description": "Contains information about discounts applied to the cart.", - "fields": [ - { - "name": "amount", - "description": "The amount of the discount applied to the item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The description of the discount.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateGuestCartOutput", - "description": "", - "fields": [ - { - "name": "cart", - "description": "The newly created cart.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SetPaymentMethodOnCartOutput", - "description": "Contains details about the cart after setting the payment method.", - "fields": [ - { - "name": "cart", - "description": "The cart after setting the payment method.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SetBillingAddressOnCartOutput", - "description": "Contains details about the cart after setting the billing address.", - "fields": [ - { - "name": "cart", - "description": "The cart after setting the billing address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SetShippingAddressesOnCartOutput", - "description": "Contains details about the cart after setting the shipping addresses.", - "fields": [ - { - "name": "cart", - "description": "The cart after setting the shipping addresses.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SetShippingMethodsOnCartOutput", - "description": "Contains details about the cart after setting the shipping methods.", - "fields": [ - { - "name": "cart", - "description": "The cart after setting the shipping methods.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ApplyCouponToCartOutput", - "description": "Contains details about the cart after applying a coupon.", - "fields": [ - { - "name": "cart", - "description": "The cart after applying a coupon.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PlaceOrderOutput", - "description": "Contains the results of the request to place an order.", - "fields": [ - { - "name": "order", - "description": "The ID of the order.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Order", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Cart", - "description": "Contains the contents and other details about a guest or customer cart.", - "fields": [ - { - "name": "applied_coupon", - "description": null, - "args": [], - "type": { - "kind": "OBJECT", - "name": "AppliedCoupon", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `applied_coupons` instead." - }, - { - "name": "applied_coupons", - "description": "An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AppliedCoupon", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "applied_gift_cards", - "description": "An array of gift card items applied to the cart.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AppliedGiftCard", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "applied_reward_points", - "description": "The amount of reward points applied to the cart.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RewardPointsAmount", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "applied_store_credit", - "description": "Store credit information applied to the cart.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "AppliedStoreCredit", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "available_gift_wrappings", - "description": "The list of available gift wrapping options for the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "available_payment_methods", - "description": "An array of available payment methods.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AvailablePaymentMethod", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "billing_address", - "description": "The billing address assigned to the cart.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "BillingCartAddress", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "email", - "description": "The email address of the guest or customer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_message", - "description": "The entered gift message for the cart", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftMessage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_receipt_included", - "description": "Indicates whether the shopper requested gift receipt for the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_wrapping", - "description": "The selected gift wrapping for the cart.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `Cart` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_virtual", - "description": "Indicates whether the cart contains only virtual products.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "An array of products that have been added to the cart.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CartItemInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prices", - "description": "Pricing details for the quote.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CartPrices", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "printed_card_included", - "description": "Indicates whether the shopper requested a printed card for the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "selected_payment_method", - "description": "Indicates which payment method was applied to the cart.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SelectedPaymentMethod", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shipping_addresses", - "description": "An array of shipping addresses assigned to the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ShippingCartAddress", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_quantity", - "description": "The total number of items in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "CartAddressInterface", - "description": "", - "fields": [ - { - "name": "city", - "description": "The city specified for the billing or shipping address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "company", - "description": "The company specified for the billing or shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country", - "description": "An object containing the country label and code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartAddressCountry", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_attributes", - "description": "The custom attribute values of the billing or shipping address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "AttributeValueInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "fax", - "description": "The customer's fax number.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "firstname", - "description": "The first name of the customer or guest.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "lastname", - "description": "The last name of the customer or guest.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "middlename", - "description": "The middle name of the person associated with the billing/shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "postcode", - "description": "The ZIP or postal code of the billing or shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prefix", - "description": "An honorific, such as Dr., Mr., or Mrs.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region", - "description": "An object containing the region label and code.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CartAddressRegion", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "street", - "description": "An array containing the street for the billing or shipping address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "suffix", - "description": "A value such as Sr., Jr., or III.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "telephone", - "description": "The telephone number for the billing or shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique id of the customer address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "vat_id", - "description": "The VAT company number for billing or shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "ShippingCartAddress", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BillingCartAddress", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "ShippingCartAddress", - "description": "Contains shipping addresses and methods.", - "fields": [ - { - "name": "available_shipping_methods", - "description": "An array that lists the shipping methods that can be applied to the cart.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AvailableShippingMethod", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "cart_items", - "description": null, - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartItemQuantity", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `cart_items_v2` instead." - }, - { - "name": "cart_items_v2", - "description": "An array that lists the items in the cart.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CartItemInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "city", - "description": "The city specified for the billing or shipping address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "company", - "description": "The company specified for the billing or shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country", - "description": "An object containing the country label and code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartAddressCountry", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_attributes", - "description": "The custom attribute values of the billing or shipping address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "AttributeValueInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customer_notes", - "description": "Text provided by the shopper.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "fax", - "description": "The customer's fax number.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "firstname", - "description": "The first name of the customer or guest.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items_weight", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "This information should not be exposed on the frontend." - }, - { - "name": "lastname", - "description": "The last name of the customer or guest.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "middlename", - "description": "The middle name of the person associated with the billing/shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "pickup_location_code", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "postcode", - "description": "The ZIP or postal code of the billing or shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prefix", - "description": "An honorific, such as Dr., Mr., or Mrs.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region", - "description": "An object containing the region label and code.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CartAddressRegion", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "selected_shipping_method", - "description": "An object that describes the selected shipping method.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SelectedShippingMethod", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "street", - "description": "An array containing the street for the billing or shipping address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "suffix", - "description": "A value such as Sr., Jr., or III.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "telephone", - "description": "The telephone number for the billing or shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique id of the customer address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "vat_id", - "description": "The VAT company number for billing or shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CartAddressInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BillingCartAddress", - "description": "Contains details about the billing address.", - "fields": [ - { - "name": "city", - "description": "The city specified for the billing or shipping address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "company", - "description": "The company specified for the billing or shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country", - "description": "An object containing the country label and code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartAddressCountry", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_attributes", - "description": "The custom attribute values of the billing or shipping address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "AttributeValueInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customer_notes", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field is used only in shipping address." - }, - { - "name": "fax", - "description": "The customer's fax number.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "firstname", - "description": "The first name of the customer or guest.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "lastname", - "description": "The last name of the customer or guest.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "middlename", - "description": "The middle name of the person associated with the billing/shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "postcode", - "description": "The ZIP or postal code of the billing or shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prefix", - "description": "An honorific, such as Dr., Mr., or Mrs.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region", - "description": "An object containing the region label and code.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CartAddressRegion", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "street", - "description": "An array containing the street for the billing or shipping address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "suffix", - "description": "A value such as Sr., Jr., or III.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "telephone", - "description": "The telephone number for the billing or shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique id of the customer address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "vat_id", - "description": "The VAT company number for billing or shipping address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CartAddressInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CartItemQuantity", - "description": "Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.", - "fields": [ - { - "name": "cart_item_id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`." - }, - { - "name": "quantity", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CartAddressRegion", - "description": "Contains details about the region in a billing or shipping address.", - "fields": [ - { - "name": "code", - "description": "The state or province code.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display label for the region.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region_id", - "description": "The unique ID for a pre-defined region.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CartAddressCountry", - "description": "Contains details the country in a billing or shipping address.", - "fields": [ - { - "name": "code", - "description": "The country code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display label for the country.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SelectedShippingMethod", - "description": "Contains details about the selected shipping method and carrier.", - "fields": [ - { - "name": "amount", - "description": "The cost of shipping using this shipping method.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "base_amount", - "description": null, - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "carrier_code", - "description": "A string that identifies a commercial carrier or an offline shipping method.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "carrier_title", - "description": "The label for the carrier code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "method_code", - "description": "A shipping method code associated with a carrier.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "method_title", - "description": "The label for the method code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_excl_tax", - "description": "The cost of shipping using this shipping method, excluding tax.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_incl_tax", - "description": "The cost of shipping using this shipping method, including tax.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AvailableShippingMethod", - "description": "Contains details about the possible shipping methods and carriers.", - "fields": [ - { - "name": "amount", - "description": "The cost of shipping using this shipping method.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "available", - "description": "Indicates whether this shipping method can be applied to the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "base_amount", - "description": null, - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "carrier_code", - "description": "A string that identifies a commercial carrier or an offline shipping method.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "carrier_title", - "description": "The label for the carrier code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "error_message", - "description": "Describes an error condition.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "method_code", - "description": "A shipping method code associated with a carrier. The value could be null if no method is available.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "method_title", - "description": "The label for the shipping method code. The value could be null if no method is available.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_excl_tax", - "description": "The cost of shipping using this shipping method, excluding tax.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_incl_tax", - "description": "The cost of shipping using this shipping method, including tax.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AvailablePaymentMethod", - "description": "Describes a payment method that the shopper can use to pay for the order.", - "fields": [ - { - "name": "code", - "description": "The payment method code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_deferred", - "description": "If the payment method is an online integration", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The payment method title.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SelectedPaymentMethod", - "description": "Describes the payment method the shopper selected.", - "fields": [ - { - "name": "code", - "description": "The payment method code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purchase_order_number", - "description": "The purchase order number.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The payment method title.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AppliedCoupon", - "description": "Contains the applied coupon code.", - "fields": [ - { - "name": "code", - "description": "The coupon code the shopper applied to the card.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RemoveCouponFromCartInput", - "description": "Specifies the cart from which to remove a coupon.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RemoveCouponFromCartOutput", - "description": "Contains details about the cart after removing a coupon.", - "fields": [ - { - "name": "cart", - "description": "The cart after removing a coupon.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddSimpleProductsToCartOutput", - "description": "Contains details about the cart after adding simple or group products.", - "fields": [ - { - "name": "cart", - "description": "The cart after adding products.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddVirtualProductsToCartOutput", - "description": "Contains details about the cart after adding virtual products.", - "fields": [ - { - "name": "cart", - "description": "The cart after adding products.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCartItemsOutput", - "description": "Contains details about the cart after updating items.", - "fields": [ - { - "name": "cart", - "description": "The cart after updating products.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RemoveItemFromCartOutput", - "description": "Contains details about the cart after removing an item.", - "fields": [ - { - "name": "cart", - "description": "The cart after removing an item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SetGuestEmailOnCartOutput", - "description": "Contains details about the cart after setting the email of a guest.", - "fields": [ - { - "name": "cart", - "description": "The cart after setting the guest email.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SimpleCartItem", - "description": "An implementation for simple product cart items.", - "fields": [ - { - "name": "available_gift_wrapping", - "description": "The list of available gift wrapping options for the cart item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "An array containing the customizable options the shopper selected.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discount", - "description": "Contains discount for quote line item.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "errors", - "description": "An array of errors encountered while loading the cart item", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartItemError", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_message", - "description": "The entered gift message for the cart item", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftMessage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_wrapping", - "description": "The selected gift wrapping for the cart item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "is_available", - "description": "True if requested quantity is less than available stock, false otherwise.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_from_buyer", - "description": "The buyer's quote line item note.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_from_seller", - "description": "The seller's quote line item note.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CartItemPrices", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about an item in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this item in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CartItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "VirtualCartItem", - "description": "An implementation for virtual product cart items.", - "fields": [ - { - "name": "customizable_options", - "description": "An array containing customizable options the shopper selected.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discount", - "description": "Contains discount for quote line item.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "errors", - "description": "An array of errors encountered while loading the cart item", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartItemError", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "is_available", - "description": "True if requested quantity is less than available stock, false otherwise.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_from_buyer", - "description": "The buyer's quote line item note.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_from_seller", - "description": "The seller's quote line item note.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CartItemPrices", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about an item in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this item in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CartItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "CartItemInterface", - "description": "An interface for products in a cart.", - "fields": [ - { - "name": "discount", - "description": "Contains discount for quote line item.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "errors", - "description": "An array of errors encountered while loading the cart item", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartItemError", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "is_available", - "description": "True if requested quantity is less than available stock, false otherwise.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_from_buyer", - "description": "The buyer's quote line item note.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_from_seller", - "description": "The seller's quote line item note.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CartItemPrices", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about an item in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this item in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "SimpleCartItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "VirtualCartItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "DownloadableCartItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleCartItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardCartItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableCartItem", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "CartItemError", - "description": "", - "fields": [ - { - "name": "code", - "description": "An error code that describes the error encountered", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CartItemErrorType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "message", - "description": "A localized error message", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CartItemErrorType", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "UNDEFINED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ITEM_QTY", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ITEM_INCREMENTS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Discount", - "description": "Specifies the discount type and value for quote line item.", - "fields": [ - { - "name": "amount", - "description": "The amount of the discount.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "applied_to", - "description": "The type of the entity the discount is applied to.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CartDiscountType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_discounting_locked", - "description": "Is quote discounting locked for line item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "A description of the discount.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "Quote line item discount value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CartDiscountType", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "ITEM", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SHIPPING", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CartItemPrices", - "description": "Contains details about the price of the item, including taxes and discounts.", - "fields": [ - { - "name": "discounts", - "description": "An array of discounts to be applied to the cart item.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "fixed_product_taxes", - "description": "An array of FPTs applied to the cart item.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "FixedProductTax", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price", - "description": "The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_including_tax", - "description": "The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "row_total", - "description": "The value of the price multiplied by the quantity of the item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "row_total_including_tax", - "description": "The value of `row_total` plus the tax applied to the item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_item_discount", - "description": "The total of all discounts applied to the item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "description": "Identifies a customized product that has been placed in a cart.", - "fields": [ - { - "name": "customizable_option_uid", - "description": "The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `SelectedCustomizableOption.customizable_option_uid` instead." - }, - { - "name": "is_required", - "description": "Indicates whether the customizable option is required.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display name of the selected customizable option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "A value indicating the order to display this option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "The type of `CustomizableOptionInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "values", - "description": "An array of selectable values.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOptionValue", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SelectedCustomizableOptionValue", - "description": "Identifies the value of the selected customized option.", - "fields": [ - { - "name": "customizable_option_value_uid", - "description": "The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead." - }, - { - "name": "label", - "description": "The display name of the selected value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price", - "description": "The price of the selected customizable value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartItemSelectedOptionValuePrice", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The text identifying the selected value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CartItemSelectedOptionValuePrice", - "description": "Contains details about the price of a selected customizable value.", - "fields": [ - { - "name": "type", - "description": "Indicates whether the price type is fixed, percent, or dynamic.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "PriceTypeEnum", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "units", - "description": "A string that describes the unit of the value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "A price value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Order", - "description": "Contains the order ID.", - "fields": [ - { - "name": "order_id", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `order_number` instead." - }, - { - "name": "order_number", - "description": "The unique ID for an `Order` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CartUserInputError", - "description": "An error encountered while adding an item to the the cart.", - "fields": [ - { - "name": "code", - "description": "A cart-specific error code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CartUserInputErrorType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "message", - "description": "A localized error message.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddProductsToCartOutput", - "description": "Contains details about the cart after adding products to it.", - "fields": [ - { - "name": "cart", - "description": "The cart after products have been added.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "user_errors", - "description": "Contains errors encountered while adding an item to the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartUserInputError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CartUserInputErrorType", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "PRODUCT_NOT_FOUND", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NOT_SALABLE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "INSUFFICIENT_STOCK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNDEFINED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PERMISSION_DENIED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RequisitionLists", - "description": "Defines customer requisition lists.", - "fields": [ - { - "name": "items", - "description": "An array of requisition lists.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "RequisitionList", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Pagination metadata.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The number of returned requisition lists.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RequisitionList", - "description": "Defines the contents of a requisition list.", - "fields": [ - { - "name": "description", - "description": "Optional text that describes the requisition list.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "An array of products added to the requisition list.", - "args": [ - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "pageSize", - "description": "The maximum number of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - } - ], - "type": { - "kind": "OBJECT", - "name": "RequistionListItems", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items_count", - "description": "The number of items in the list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The requisition list name.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique requisition list ID.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "The time of the last modification of the requisition list.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RequistionListItems", - "description": "Contains an array of items added to a requisition list.", - "fields": [ - { - "name": "items", - "description": "An array of items in the requisition list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "RequisitionListItemInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Pagination metadata.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_pages", - "description": "The number of pages returned.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "RequisitionListItemInterface", - "description": "The interface for requisition list items.", - "fields": [ - { - "name": "customizable_options", - "description": "Selected custom options for an item in the requisition list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about a requisition list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The amount added.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for the requisition list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "SimpleRequisitionListItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "VirtualRequisitionListItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "DownloadableRequisitionListItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleRequisitionListItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableRequisitionListItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardRequisitionListItem", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "SimpleRequisitionListItem", - "description": "Contains details about simple products added to a requisition list.", - "fields": [ - { - "name": "customizable_options", - "description": "Selected custom options for an item in the requisition list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about a requisition list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The amount added.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for the requisition list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "RequisitionListItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "VirtualRequisitionListItem", - "description": "Contains details about virtual products added to a requisition list.", - "fields": [ - { - "name": "customizable_options", - "description": "Selected custom options for an item in the requisition list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about a requisition list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The amount added.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for the requisition list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "RequisitionListItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CreateRequisitionListInput", - "description": "An input object that identifies and describes a new requisition list.", - "fields": null, - "inputFields": [ - { - "name": "description", - "description": "An optional description of the requisition list.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The name assigned to the requisition list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "UpdateRequisitionListInput", - "description": "An input object that defines which requistion list characteristics to update.", - "fields": null, - "inputFields": [ - { - "name": "description", - "description": "The updated description of the requisition list.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The new name of the requisition list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateRequisitionListOutput", - "description": "Output of the request to rename the requisition list.", - "fields": [ - { - "name": "requisition_list", - "description": "The renamed requisition list.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RequisitionList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "UpdateRequisitionListItemsInput", - "description": "Defines which items in a requisition list to update.", - "fields": null, - "inputFields": [ - { - "name": "entered_options", - "description": "An array of customer-entered options.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "EnteredOptionInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "item_id", - "description": "The ID of the requisition list item to update.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "quantity", - "description": "The new quantity of the item.", - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "selected_options", - "description": "An array of selected option IDs.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateRequisitionListItemsOutput", - "description": "Output of the request to update items in the specified requisition list.", - "fields": [ - { - "name": "requisition_list", - "description": "The requisition list after updating items.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RequisitionList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeleteRequisitionListOutput", - "description": "Indicates whether the request to delete the requisition list was successful.", - "fields": [ - { - "name": "requisition_lists", - "description": "The customer's requisition lists after deleting a requisition list.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RequisitionLists", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "Indicates whether the request to delete the requisition list was successful.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddProductsToRequisitionListOutput", - "description": "Output of the request to add products to a requisition list.", - "fields": [ - { - "name": "requisition_list", - "description": "The requisition list after adding products.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RequisitionList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeleteRequisitionListItemsOutput", - "description": "Output of the request to remove items from the requisition list.", - "fields": [ - { - "name": "requisition_list", - "description": "The requisition list after removing items.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RequisitionList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddRequisitionListItemsToCartOutput", - "description": "Output of the request to add items in a requisition list to the cart.", - "fields": [ - { - "name": "add_requisition_list_items_to_cart_user_errors", - "description": "Details about why the attempt to add items to the requistion list was not successful.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AddRequisitionListItemToCartUserError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "cart", - "description": "The cart after adding requisition list items.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "Indicates whether the attempt to add items to the requisition list was successful.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddRequisitionListItemToCartUserError", - "description": "Contains details about why an attempt to add items to the requistion list failed.", - "fields": [ - { - "name": "message", - "description": "A description of the error.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "The type of error that occurred.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "AddRequisitionListItemToCartUserErrorType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "AddRequisitionListItemToCartUserErrorType", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "OUT_OF_STOCK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNAVAILABLE_SKU", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "OPTIONS_UPDATED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LOW_QUANTITY", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CopyItemsBetweenRequisitionListsInput", - "description": "An input object that defines the items in a requisition list to be copied.", - "fields": null, - "inputFields": [ - { - "name": "requisitionListItemUids", - "description": "An array of IDs representing products copied from one requisition list to another.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CopyItemsFromRequisitionListsOutput", - "description": "Output of the request to copy items to the destination requisition list.", - "fields": [ - { - "name": "requisition_list", - "description": "The destination requisition list after the items were copied.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RequisitionList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "MoveItemsBetweenRequisitionListsInput", - "description": "An input object that defines the items in a requisition list to be moved.", - "fields": null, - "inputFields": [ - { - "name": "requisitionListItemUids", - "description": "An array of IDs representing products moved from one requisition list to another.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "MoveItemsBetweenRequisitionListsOutput", - "description": "Output of the request to move items to another requisition list.", - "fields": [ - { - "name": "destination_requisition_list", - "description": "The destination requisition list after moving items.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RequisitionList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "source_requisition_list", - "description": "The source requisition list after moving items.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RequisitionList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RequisitionListFilterInput", - "description": "Defines requisition list filters.", - "fields": null, - "inputFields": [ - { - "name": "name", - "description": "Filter by the display name of the requisition list.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "uids", - "description": "Filter requisition lists by one or more requisition list IDs.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateRequisitionListOutput", - "description": "Output of the request to create a requisition list.", - "fields": [ - { - "name": "requisition_list", - "description": "The created requisition list.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RequisitionList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ClearCustomerCartOutput", - "description": "Output of the request to clear the customer cart.", - "fields": [ - { - "name": "cart", - "description": "The cart after clearing items.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "Indicates whether cart was cleared.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RequisitionListItemsInput", - "description": "Defines the items to add.", - "fields": null, - "inputFields": [ - { - "name": "entered_options", - "description": "Entered option IDs.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "EnteredOptionInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "parent_sku", - "description": "For configurable products, the SKU of the parent product.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "quantity", - "description": "The quantity of the product to add.", - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "selected_options", - "description": "Selected option IDs.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "sku", - "description": "The product SKU.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ContactUsInput", - "description": "", - "fields": null, - "inputFields": [ - { - "name": "comment", - "description": "The shopper's comment to the merchant.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "email", - "description": "The email address of the shopper.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The full name of the shopper.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "telephone", - "description": "The shopper's telephone number.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ContactUsOutput", - "description": "Contains the status of the request.", - "fields": [ - { - "name": "status", - "description": "Indicates whether the request was successful.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ApplyStoreCreditToCartInput", - "description": "Defines the input required to run the `applyStoreCreditToCart` mutation.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID that identifies the customer's cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ApplyStoreCreditToCartOutput", - "description": "Defines the possible output for the `applyStoreCreditToCart` mutation.", - "fields": [ - { - "name": "cart", - "description": "The contents of the specified shopping cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RemoveStoreCreditFromCartInput", - "description": "Defines the input required to run the `removeStoreCreditFromCart` mutation.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID that identifies the customer's cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RemoveStoreCreditFromCartOutput", - "description": "Defines the possible output for the `removeStoreCreditFromCart` mutation.", - "fields": [ - { - "name": "cart", - "description": "The contents of the specified shopping cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AppliedStoreCredit", - "description": "Contains the applied and current balances.", - "fields": [ - { - "name": "applied_balance", - "description": "The applied store credit balance to the current cart.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "current_balance", - "description": "The current balance remaining on store credit.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "enabled", - "description": "Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerStoreCredit", - "description": "Contains store credit information with balance and history.", - "fields": [ - { - "name": "balance_history", - "description": "Contains the customer's store credit balance history. If the history or store credit feature is disabled, then a null value will be returned.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. This value is optional. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "OBJECT", - "name": "CustomerStoreCreditHistory", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "current_balance", - "description": "The current balance of store credit.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "enabled", - "description": "Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerStoreCreditHistory", - "description": "Lists changes to the amount of store credit available to the customer.", - "fields": [ - { - "name": "items", - "description": "An array containing information about changes to the store credit available to the customer.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomerStoreCreditHistoryItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Metadata for pagination rendering.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The number of items returned.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerStoreCreditHistoryItem", - "description": "Contains store credit history information.", - "fields": [ - { - "name": "action", - "description": "The action that was made on the store credit.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "actual_balance", - "description": "The store credit available to the customer as a result of this action. ", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "balance_change", - "description": "The amount added to or subtracted from the store credit as a result of this action.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "date_time_changed", - "description": "The date and time when the store credit change was made.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddDownloadableProductsToCartInput", - "description": "", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The ID of the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cart_items", - "description": "An array of downloadable products to add.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "DownloadableProductCartItemInput", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "DownloadableProductCartItemInput", - "description": "Defines a single downloadable product.", - "fields": null, - "inputFields": [ - { - "name": "customizable_options", - "description": "The ID and value of the option.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "data", - "description": "The quantity and SKU of the downloadable product.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "downloadable_product_links", - "description": "An array of objects containing the link_id of the downloadable product link.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "DownloadableProductLinksInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "DownloadableProductLinksInput", - "description": "Contains the link ID for the downloadable product.", - "fields": null, - "inputFields": [ - { - "name": "link_id", - "description": "The unique ID of the downloadable product link.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddDownloadableProductsToCartOutput", - "description": "Contains details about the cart after adding downloadable products.", - "fields": [ - { - "name": "cart", - "description": "The cart after adding products.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableCartItem", - "description": "An implementation for downloadable product cart items.", - "fields": [ - { - "name": "customizable_options", - "description": "An array containing the customizable options the shopper selected.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discount", - "description": "Contains discount for quote line item.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "errors", - "description": "An array of errors encountered while loading the cart item", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartItemError", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "is_available", - "description": "True if requested quantity is less than available stock, false otherwise.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "links", - "description": "An array containing information about the links for the downloadable product added to the cart.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductLinks", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_from_buyer", - "description": "The buyer's quote line item note.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_from_seller", - "description": "The seller's quote line item note.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CartItemPrices", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about an item in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this item in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "samples", - "description": "An array containing information about samples of the selected downloadable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductSamples", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CartItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableProduct", - "description": "Defines a product that the shopper downloads.", - "fields": [ - { - "name": "activity", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "categories", - "description": "The categories assigned to a product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_gear", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "climate", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "collar", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "color", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "country_of_manufacture", - "description": "The product's country of origin.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "crosssell_products", - "description": "An array of cross-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "downloadable_product_links", - "description": "An array containing information about the links for this downloadable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductLinks", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "downloadable_product_samples", - "description": "An array containing information about samples of this downloadable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductSamples", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gender", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gift_message_available", - "description": "Indicates whether a gift message is available.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The ID number assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." - }, - { - "name": "image", - "description": "The relative path to the main image on the product page.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "links_purchased_separately", - "description": "A value of 1 indicates that each link in the array must be purchased separately.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "links_title", - "description": "The heading above the list of downloadable products.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "material", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "media_gallery", - "description": "An array of media gallery objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "media_gallery_entries", - "description": "An array of MediaGalleryEntry objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "MediaGalleryEntry", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `media_gallery` instead." - }, - { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "new_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new_to_date", - "description": "The end date for new product listings.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "only_x_left_in_stock", - "description": "Product stock only x left count", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "An array of options for a customizable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "pattern", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "price", - "description": "Indicates the price of an item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductPrices", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_range` for product price information." - }, - { - "name": "price_range", - "description": "The range of prices for the product", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PriceRange", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_tiers", - "description": "An array of `TierPrice` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TierPrice", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_links", - "description": "An array of `ProductLinks` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purpose", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "rating_summary", - "description": "The average of all the ratings given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "related_products", - "description": "An array of related products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "review_count", - "description": "The total count of all the reviews given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "reviews", - "description": "The list of products reviews.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviews", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "size", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "special_price", - "description": "The discounted price of the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_to_date", - "description": "The end date for a product with a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "staged", - "description": "Indicates whether the product is staged for a future campaign.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "stock_status", - "description": "Stock status of the product", - "args": [], - "type": { - "kind": "ENUM", - "name": "ProductStockStatus", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "swatch_image", - "description": "The file name of a swatch image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "tier_prices", - "description": "An array of ProductTierPrices objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductTierPrices", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type_id", - "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `__typename` instead." - }, - { - "name": "uid", - "description": "The unique ID for a `ProductInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "Timestamp indicating when the product was updated.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "upsell_products", - "description": "An array of up-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_key", - "description": "The part of the URL that identifies the product", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_path", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use product's `canonical_url` or url rewrites instead" - }, - { - "name": "url_rewrites", - "description": "URL rewrites list", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "UrlRewrite", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_suffix", - "description": "The part of the product URL that is appended after the url key", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "websites", - "description": "An array of websites in which the product is available.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Website", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "CustomizableProductInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "DownloadableFileTypeEnum", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "FILE", - "description": "", - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - }, - { - "name": "URL", - "description": "", - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableProductLinks", - "description": "Defines characteristics of a downloadable product.", - "fields": [ - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "This information should not be exposed on frontend." - }, - { - "name": "is_shareable", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "This information should not be exposed on frontend." - }, - { - "name": "link_type", - "description": null, - "args": [], - "type": { - "kind": "ENUM", - "name": "DownloadableFileTypeEnum", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - }, - { - "name": "number_of_downloads", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "This information should not be exposed on frontend." - }, - { - "name": "price", - "description": "The price of the downloadable product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sample_file", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - }, - { - "name": "sample_type", - "description": null, - "args": [], - "type": { - "kind": "ENUM", - "name": "DownloadableFileTypeEnum", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - }, - { - "name": "sample_url", - "description": "The full URL to the downloadable sample.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "A number indicating the sort order.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name of the link.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `DownloadableProductLinks` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableProductSamples", - "description": "Defines characteristics of a downloadable product.", - "fields": [ - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "This information should not be exposed on frontend." - }, - { - "name": "sample_file", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - }, - { - "name": "sample_type", - "description": null, - "args": [], - "type": { - "kind": "ENUM", - "name": "DownloadableFileTypeEnum", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`sample_url` serves to get the downloadable sample" - }, - { - "name": "sample_url", - "description": "The full URL to the downloadable sample.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "A number indicating the sort order.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name of the sample.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableOrderItem", - "description": "Defines downloadable product options for `OrderItemInterface`.", - "fields": [ - { - "name": "discounts", - "description": "The final discount information for the product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "downloadable_links", - "description": "A list of downloadable links that are ordered from the downloadable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableItemsLinks", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eligible_for_return", - "description": "Indicates whether the order item is eligible to be in a return request.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "entered_options", - "description": "The entered option for the base product, such as a logo or image.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "OrderItemOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_message", - "description": "The selected gift message for the order item", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftMessage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_wrapping", - "description": "The selected gift wrapping for the order item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for an `OrderItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price of the base product, including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_type", - "description": "The type of product, such as simple, configurable, etc.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_url_key", - "description": "URL key of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_canceled", - "description": "The number of canceled items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_invoiced", - "description": "The number of invoiced items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_ordered", - "description": "The number of units ordered for this item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_refunded", - "description": "The number of refunded items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_returned", - "description": "The number of returned items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_shipped", - "description": "The number of shipped items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "selected_options", - "description": "The selected options for the base product, such as color or size.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "OrderItemOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "The status of the order item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableInvoiceItem", - "description": "Defines downloadable product options for `InvoiceItemInterface`.", - "fields": [ - { - "name": "discounts", - "description": "Information about the final discount amount for the base product, including discounts on options.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "downloadable_links", - "description": "A list of downloadable links that are invoiced from the downloadable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableItemsLinks", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for an `InvoiceItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "Details about an individual order item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price for the base product including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_invoiced", - "description": "The number of invoiced items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "InvoiceItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableCreditMemoItem", - "description": "Defines downloadable product options for `CreditMemoItemInterface`.", - "fields": [ - { - "name": "discounts", - "description": "Details about the final discount amount for the base product, including discounts on options.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "downloadable_links", - "description": "A list of downloadable links that are refunded from the downloadable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableItemsLinks", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `CreditMemoItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "The order item the credit memo is applied to.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price for the base product, including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_refunded", - "description": "The number of refunded items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CreditMemoItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableItemsLinks", - "description": "Defines characteristics of the links for downloadable product.", - "fields": [ - { - "name": "sort_order", - "description": "A number indicating the sort order.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name of the link.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `DownloadableItemsLinks` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableWishlistItem", - "description": "A downloadable product wish list item.", - "fields": [ - { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "The description of the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "links_v2", - "description": "An array containing information about the selected links.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductLinks", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Product details of the wish list item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "samples", - "description": "An array containing information about the selected samples.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductSamples", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Company", - "description": "Contains the output schema for a company.", - "fields": [ - { - "name": "acl_resources", - "description": "The list of all resources defined within the company.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyAclResource", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "company_admin", - "description": "An object containing information about the company administrator.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "credit", - "description": "Company credit balances and limits.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyCredit", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "credit_history", - "description": "Details about the history of company credit operations.", - "args": [ - { - "name": "filter", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "CompanyCreditHistoryFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pageSize", - "description": "", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyCreditHistory", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "email", - "description": "The email address of the company contact.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID of a `Company` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "legal_address", - "description": "The address where the company is registered to conduct business.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CompanyLegalAddress", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "legal_name", - "description": "The full legal name of the company.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The name of the company.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "payment_methods", - "description": "The list of payment methods available to a company.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "reseller_id", - "description": "The resale number that is assigned to the company for tax reporting purposes.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "role", - "description": "A company role filtered by the unique ID of a `CompanyRole` object.", - "args": [ - { - "name": "id", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "roles", - "description": "An object that contains a list of company roles.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyRoles", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sales_representative", - "description": "An object containing information about the company sales representative.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CompanySalesRepresentative", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "structure", - "description": "The company structure of teams and customers in depth-first order.", - "args": [ - { - "name": "rootId", - "description": "The ID of the node in the company structure that serves as the root for the query.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "depth", - "description": "The maximum number of levels of the structure to return.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "10" - } - ], - "type": { - "kind": "OBJECT", - "name": "CompanyStructure", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "team", - "description": "The company team data filtered by the unique ID for a `CompanyTeam` object.", - "args": [ - { - "name": "id", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "CompanyTeam", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "user", - "description": "A company user filtered by the unique ID of a `Customer` object.", - "args": [ - { - "name": "id", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "users", - "description": "An object that contains a list of company users based on activity status.", - "args": [ - { - "name": "filter", - "description": "The type of company users to return.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CompanyUsersFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "OBJECT", - "name": "CompanyUsers", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "vat_tax_id", - "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyLegalAddress", - "description": "Contains details about the address where the company is registered to conduct business.", - "fields": [ - { - "name": "city", - "description": "The city where the company is registered to conduct business.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country_code", - "description": "The country code of the company's legal address.", - "args": [], - "type": { - "kind": "ENUM", - "name": "CountryCodeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "postcode", - "description": "The company's postal code.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region", - "description": "An object containing region data for the company.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomerAddressRegion", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "street", - "description": "An array of strings that define the company's street address.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "telephone", - "description": "The company's phone number.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyAdmin", - "description": "Contains details about the company administrator.", - "fields": [ - { - "name": "email", - "description": "The email address of the company administrator.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "firstname", - "description": "The company administrator's first name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gender", - "description": "The company administrator's gender (Male - 1, Female - 2, Not Specified - 3).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `CompanyAdmin` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "job_title", - "description": "The job title of the company administrator.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "lastname", - "description": "The company administrator's last name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanySalesRepresentative", - "description": "Contains details about a company sales representative.", - "fields": [ - { - "name": "email", - "description": "The email address of the company sales representative.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "firstname", - "description": "The company sales representative's first name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "lastname", - "description": "The company sales representative's last name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyUsers", - "description": "Contains details about company users.", - "fields": [ - { - "name": "items", - "description": "An array of `CompanyUser` objects that match the specified filter criteria.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Pagination metadata.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The number of objects returned.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyRoles", - "description": "Contains an array of roles.", - "fields": [ - { - "name": "items", - "description": "A list of company roles that match the specified filter criteria.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Pagination metadata.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The total number of objects matching the specified filter.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyRole", - "description": "Contails details about a single role.", - "fields": [ - { - "name": "id", - "description": "The unique ID for a `CompanyRole` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The name assigned to the role.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "permissions", - "description": "A list of permission resources defined for a role.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyAclResource", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "users_count", - "description": "The total number of users assigned the specified role.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyAclResource", - "description": "Contains details about the access control list settings of a resource.", - "fields": [ - { - "name": "children", - "description": "An array of sub-resources.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyAclResource", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `CompanyAclResource` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The sort order of an ACL resource.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "text", - "description": "The label assigned to the ACL resource.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "IsCompanyRoleNameAvailableOutput", - "description": "Contains the response of a role name validation query.", - "fields": [ - { - "name": "is_role_name_available", - "description": "Indicates whether the specified company role name is available.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "IsCompanyUserEmailAvailableOutput", - "description": "Contains the response of a company user email validation query.", - "fields": [ - { - "name": "is_email_available", - "description": "Indicates whether the specified email address can be used to create a company user.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "IsCompanyAdminEmailAvailableOutput", - "description": "Contains the response of a company admin email validation query.", - "fields": [ - { - "name": "is_email_available", - "description": "Indicates whether the specified email address can be used to create a company administrator.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "IsCompanyEmailAvailableOutput", - "description": "Contains the response of a company email validation query.", - "fields": [ - { - "name": "is_email_available", - "description": "Indicates whether the specified email address can be used to create a company.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "UNION", - "name": "CompanyStructureEntity", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "CompanyTeam", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "CompanyStructure", - "description": "Contains an array of the individual nodes that comprise the company structure.", - "fields": [ - { - "name": "items", - "description": "An array of elements in a company structure.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyStructureItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyTeam", - "description": "Describes a company team.", - "fields": [ - { - "name": "description", - "description": "An optional description of the team.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `CompanyTeam` object.", - "args": [], - "type": { - "kind": "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": "" - }, - { - "name": "INACTIVE", - "description": "Only inactive users.", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateCompanyTeamOutput", - "description": "Contains the response to the request to create a company team.", - "fields": [ - { - "name": "team", - "description": "The new company team instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyTeam", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyTeamOutput", - "description": "Contains the response to the request to update a company team.", - "fields": [ - { - "name": "team", - "description": "The updated company team instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyTeam", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeleteCompanyTeamOutput", - "description": "Contains the status of the request to delete a company team.", - "fields": [ - { - "name": "success", - "description": "Indicates whether the delete operation succeeded.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyTeamCreateInput", - "description": "Defines the input schema for creating a company team.", - "fields": null, - "inputFields": [ - { - "name": "description", - "description": "An optional description of the team.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The display name of the team.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "target_id", - "description": "The ID of a node within a company's structure. This ID will be the parent of the created team.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyTeamUpdateInput", - "description": "Defines the input schema for updating a company team.", - "fields": null, - "inputFields": [ - { - "name": "description", - "description": "An optional description of the team.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "id", - "description": "The unique ID of the `CompanyTeam` object to update.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The display name of the team.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyStructureOutput", - "description": "Contains the response to the request to update the company structure.", - "fields": [ - { - "name": "company", - "description": "The updated company instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Company", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyStructureUpdateInput", - "description": "Defines the input schema for updating the company structure.", - "fields": null, - "inputFields": [ - { - "name": "parent_tree_id", - "description": "The ID of a company that will be the new parent.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "tree_id", - "description": "The ID of the company team that is being moved to another parent.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateCompanyOutput", - "description": "Contains the response to the request to create a company.", - "fields": [ - { - "name": "company", - "description": "The new company instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Company", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyOutput", - "description": "Contains the response to the request to update the company.", - "fields": [ - { - "name": "company", - "description": "The updated company instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Company", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateCompanyUserOutput", - "description": "Contains the response to the request to create a company user.", - "fields": [ - { - "name": "user", - "description": "The new company user instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyUserOutput", - "description": "Contains the response to the request to update the company user.", - "fields": [ - { - "name": "user", - "description": "The updated company user instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeleteCompanyUserOutput", - "description": "Contains the response to the request to delete the company user.", - "fields": [ - { - "name": "success", - "description": "Indicates whether the company user has been deactivated successfully.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateCompanyRoleOutput", - "description": "Contains the response to the request to create a company role.", - "fields": [ - { - "name": "role", - "description": "The new company role instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateCompanyRoleOutput", - "description": "Contains the response to the request to update the company role.", - "fields": [ - { - "name": "role", - "description": "The updated company role instance.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeleteCompanyRoleOutput", - "description": "Contains the response to the request to delete the company role.", - "fields": [ - { - "name": "success", - "description": "SIndicates whether the company role has been deleted successfully.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyCreateInput", - "description": "Defines the input schema for creating a new company.", - "fields": null, - "inputFields": [ - { - "name": "company_admin", - "description": "Defines the company administrator.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyAdminInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "company_email", - "description": "The email address of the company contact.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "company_name", - "description": "The name of the company to create.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "legal_address", - "description": "Defines legal address data of the company.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CompanyLegalAddressCreateInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "legal_name", - "description": "The full legal name of the company.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "reseller_id", - "description": "The resale number that is assigned to the company for tax reporting purposes.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "vat_tax_id", - "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyAdminInput", - "description": "Defines the input schema for creating a company administrator.", - "fields": null, - "inputFields": [ - { - "name": "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 - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyLegalAddressCreateInput", - "description": "Defines the input schema for defining a company's legal address.", - "fields": null, - "inputFields": [ - { - "name": "city", - "description": "The city where the company is registered to conduct business.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "country_id", - "description": "The company's country ID. Use the `countries` query to get this value.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CountryCodeEnum", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "postcode", - "description": "The postal code of the company.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "region", - "description": "An object containing the region name and/or region ID where the company is registered to conduct business.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressRegionInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "street", - "description": "An array of strings that define the street address where the company is registered to conduct business.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "telephone", - "description": "The primary phone number of the company.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyUpdateInput", - "description": "Defines the input schema for updating a company.", - "fields": null, - "inputFields": [ - { - "name": "company_email", - "description": "The email address of the company contact.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "company_name", - "description": "The name of the company to update.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "legal_address", - "description": "The legal address data of the company.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CompanyLegalAddressUpdateInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "legal_name", - "description": "The full legal name of the company.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "reseller_id", - "description": "The resale number that is assigned to the company for tax reporting purposes.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "vat_tax_id", - "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyLegalAddressUpdateInput", - "description": "Defines the input schema for updating a company's legal address.", - "fields": null, - "inputFields": [ - { - "name": "city", - "description": "The city where the company is registered to conduct business.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "country_id", - "description": "The unique ID for a `Country` object.", - "type": { - "kind": "ENUM", - "name": "CountryCodeEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "postcode", - "description": "The postal code of the company.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "region", - "description": "An object containing the region name and/or region ID where the company is registered to conduct business.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressRegionInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "street", - "description": "An array of strings that define the street address where the company is registered to conduct business.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "telephone", - "description": "The primary phone number of the company.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyUserCreateInput", - "description": "Defines the input schema for creating a company user.", - "fields": null, - "inputFields": [ - { - "name": "email", - "description": "The company user's email address", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "firstname", - "description": "The company user's first name.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "job_title", - "description": "The company user's job title or function.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "lastname", - "description": "The company user's last name.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "role_id", - "description": "The unique ID for a `CompanyRole` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "status", - "description": "Indicates whether the company user is ACTIVE or INACTIVE.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CompanyUserStatusEnum", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "target_id", - "description": "The ID of a node within a company's structure. This ID will be the parent of the created company user.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "telephone", - "description": "The company user's phone number.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyUserUpdateInput", - "description": "Defines the input schema for updating a company user.", - "fields": null, - "inputFields": [ - { - "name": "email", - "description": "The company user's email address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "firstname", - "description": "The company user's first name.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "id", - "description": "The unique ID of a `Customer` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "job_title", - "description": "The company user's job title or function.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "lastname", - "description": "The company user's last name.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "role_id", - "description": "The unique ID for a `CompanyRole` object.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "status", - "description": "Indicates whether the company user is ACTIVE or INACTIVE.", - "type": { - "kind": "ENUM", - "name": "CompanyUserStatusEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "telephone", - "description": "The company user's phone number.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyRoleCreateInput", - "description": "Defines the input schema for creating a company role.", - "fields": null, - "inputFields": [ - { - "name": "name", - "description": "The name of the role to create.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "permissions", - "description": "A list of resources the role can access.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyRoleUpdateInput", - "description": "Defines the input schema for updating a company role.", - "fields": null, - "inputFields": [ - { - "name": "id", - "description": "The unique ID for a `CompanyRole` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The name of the role to update.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "permissions", - "description": "A list of resources the role can access.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyStructureItem", - "description": "Defines an individual node in the company structure.", - "fields": [ - { - "name": "entity", - "description": "A union of `CompanyTeam` and `Customer` objects.", - "args": [], - "type": { - "kind": "UNION", - "name": "CompanyStructureEntity", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `CompanyStructureItem` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "parent_id", - "description": "The ID of the parent item in the company hierarchy.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddBundleProductsToCartInput", - "description": "Defines the bundle products to add to the cart.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The ID of the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cart_items", - "description": "An array of bundle products to add.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "BundleProductCartItemInput", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "BundleProductCartItemInput", - "description": "Defines a single bundle product.", - "fields": null, - "inputFields": [ - { - "name": "bundle_options", - "description": "A mandatory array of options for the bundle product, including each chosen option and specified quantity.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "BundleOptionInput", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "customizable_options", - "description": "The ID and value of the option.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "data", - "description": "The quantity and SKU of the bundle product.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "BundleOptionInput", - "description": "Defines the input for a bundle option.", - "fields": null, - "inputFields": [ - { - "name": "id", - "description": "The ID of the option.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "quantity", - "description": "The number of the selected item to add to the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "value", - "description": "An array with the chosen value of the option.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddBundleProductsToCartOutput", - "description": "Contains details about the cart after adding bundle products.", - "fields": [ - { - "name": "cart", - "description": "The cart after adding products.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleCartItem", - "description": "An implementation for bundle product cart items.", - "fields": [ - { - "name": "available_gift_wrapping", - "description": "The list of available gift wrapping options for the cart item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "bundle_options", - "description": "An array containing the bundle options the shopper selected.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedBundleOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "An array containing the customizable options the shopper selected.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discount", - "description": "Contains discount for quote line item.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "errors", - "description": "An array of errors encountered while loading the cart item", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartItemError", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_message", - "description": "The entered gift message for the cart item", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftMessage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_wrapping", - "description": "The selected gift wrapping for the cart item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "is_available", - "description": "True if requested quantity is less than available stock, false otherwise.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_from_buyer", - "description": "The buyer's quote line item note.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_from_seller", - "description": "The seller's quote line item note.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CartItemPrices", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about an item in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this item in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CartItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SelectedBundleOption", - "description": "Contains details about a selected bundle option.", - "fields": [ - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "label", - "description": "The display name of the selected bundle product option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "The type of selected bundle product option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `SelectedBundleOption` object", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "values", - "description": "An array of selected bundle option values.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedBundleOptionValue", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SelectedBundleOptionValue", - "description": "Contains details about a value for a selected bundle option.", - "fields": [ - { - "name": "id", - "description": "Use `uid` instead", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display name of the value for the selected bundle product option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "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": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of the value for the selected bundle product option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `SelectedBundleOptionValue` object", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PriceDetails", - "description": "Can be used to retrieve the main price details in case of bundle product", - "fields": [ - { - "name": "discount_percentage", - "description": "The percentage of discount applied to the main product price", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "main_final_price", - "description": "The final price after applying the discount to the main product", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "main_price", - "description": "The regular price of the main product", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleItem", - "description": "Defines an individual item within a bundle product.", - "fields": [ - { - "name": "option_id", - "description": "An ID assigned to each type of item in a bundle product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "options", - "description": "An array of additional options for this bundle item.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "BundleItemOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "position", - "description": "A number indicating the sequence order of this item compared to the other bundle items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_range", - "description": "The range of prices for the product", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PriceRange", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "required", - "description": "Indicates whether the item must be included in the bundle.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sku", - "description": "The SKU of the bundle product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The display name of the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "The input type that the customer uses to select the item. Examples include radio button and checkbox.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `BundleItem` object.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleItemOption", - "description": "Defines the characteristics that comprise a specific bundle item and its options.", - "fields": [ - { - "name": "can_change_quantity", - "description": "Indicates whether the customer can change the number of items for this option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The ID assigned to the bundled item option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "is_default", - "description": "Indicates whether this option is the default option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The text that identifies the bundled item option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "position", - "description": "When a bundle item contains multiple options, the relative position of this option compared to the other options.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price", - "description": "The price of the selected option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_type", - "description": "One of FIXED, PERCENT, or DYNAMIC.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PriceTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Contains details about this product option.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "qty", - "description": "Indicates the quantity of this specific bundle item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `quantity` instead." - }, - { - "name": "quantity", - "description": "The quantity of this specific bundle item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `BundleItemOption` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleProduct", - "description": "Defines basic features of a bundle product and contains multiple BundleItems.", - "fields": [ - { - "name": "activity", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "categories", - "description": "The categories assigned to a product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_gear", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "climate", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "collar", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "color", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "country_of_manufacture", - "description": "The product's country of origin.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "crosssell_products", - "description": "An array of cross-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "dynamic_price", - "description": "Indicates whether the bundle product has a dynamic price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "dynamic_sku", - "description": "Indicates whether the bundle product has a dynamic SKU.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "dynamic_weight", - "description": "Indicates whether the bundle product has a dynamically calculated weight.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gender", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gift_message_available", - "description": "Indicates whether a gift message is available.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The ID number assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." - }, - { - "name": "image", - "description": "The relative path to the main image on the product page.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "An array containing information about individual bundle items.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "BundleItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "material", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "media_gallery", - "description": "An array of media gallery objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "media_gallery_entries", - "description": "An array of MediaGalleryEntry objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "MediaGalleryEntry", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `media_gallery` instead." - }, - { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "new_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new_to_date", - "description": "The end date for new product listings.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "only_x_left_in_stock", - "description": "Product stock only x left count", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "An array of options for a customizable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "pattern", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "price", - "description": "Indicates the price of an item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductPrices", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_range` for product price information." - }, - { - "name": "price_details", - "description": "The price details of the main product", - "args": [], - "type": { - "kind": "OBJECT", - "name": "PriceDetails", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_range", - "description": "The range of prices for the product", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PriceRange", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_tiers", - "description": "An array of `TierPrice` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TierPrice", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_view", - "description": "One of PRICE_RANGE or AS_LOW_AS.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PriceViewEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_links", - "description": "An array of `ProductLinks` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purpose", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "rating_summary", - "description": "The average of all the ratings given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "related_products", - "description": "An array of related products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "review_count", - "description": "The total count of all the reviews given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "reviews", - "description": "The list of products reviews.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviews", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "ship_bundle_items", - "description": "Indicates whether to ship bundle items together or individually.", - "args": [], - "type": { - "kind": "ENUM", - "name": "ShipBundleItemsEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "size", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "special_price", - "description": "The discounted price of the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_to_date", - "description": "The end date for a product with a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "staged", - "description": "Indicates whether the product is staged for a future campaign.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "stock_status", - "description": "Stock status of the product", - "args": [], - "type": { - "kind": "ENUM", - "name": "ProductStockStatus", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "swatch_image", - "description": "The file name of a swatch image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "tier_prices", - "description": "An array of ProductTierPrices objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductTierPrices", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type_id", - "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `__typename` instead." - }, - { - "name": "uid", - "description": "The unique ID for a `ProductInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "Timestamp indicating when the product was updated.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "upsell_products", - "description": "An array of up-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_key", - "description": "The part of the URL that identifies the product", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_path", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use product's `canonical_url` or url rewrites instead" - }, - { - "name": "url_rewrites", - "description": "URL rewrites list", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "UrlRewrite", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_suffix", - "description": "The part of the product URL that is appended after the url key", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "websites", - "description": "An array of websites in which the product is available.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Website", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "PhysicalProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "CustomizableProductInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PriceViewEnum", - "description": "Defines whether a bundle product's price is displayed as the lowest possible value or as a range.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "PRICE_RANGE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AS_LOW_AS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "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": "" - }, - { - "name": "SEPARATELY", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleOrderItem", - "description": "Defines bundle product options for `OrderItemInterface`.", - "fields": [ - { - "name": "bundle_options", - "description": "A list of bundle options that are assigned to the bundle product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemSelectedBundleOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discounts", - "description": "The final discount information for the product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eligible_for_return", - "description": "Indicates whether the order item is eligible to be in a return request.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "entered_options", - "description": "The entered option for the base product, such as a logo or image.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "OrderItemOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_message", - "description": "The selected gift message for the order item", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftMessage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_wrapping", - "description": "The selected gift wrapping for the order item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for an `OrderItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price of the base product, including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_type", - "description": "The type of product, such as simple, configurable, etc.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_url_key", - "description": "URL key of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_canceled", - "description": "The number of canceled items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_invoiced", - "description": "The number of invoiced items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_ordered", - "description": "The number of units ordered for this item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_refunded", - "description": "The number of refunded items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_returned", - "description": "The number of returned items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_shipped", - "description": "The number of shipped items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "selected_options", - "description": "The selected options for the base product, such as color or size.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "OrderItemOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "The status of the order item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleInvoiceItem", - "description": "Defines bundle product options for `InvoiceItemInterface`.", - "fields": [ - { - "name": "bundle_options", - "description": "A list of bundle options that are assigned to an invoiced bundle product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemSelectedBundleOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discounts", - "description": "Information about the final discount amount for the base product, including discounts on options.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for an `InvoiceItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "Details about an individual order item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price for the base product including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_invoiced", - "description": "The number of invoiced items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "InvoiceItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleShipmentItem", - "description": "Defines bundle product options for `ShipmentItemInterface`.", - "fields": [ - { - "name": "bundle_options", - "description": "A list of bundle options that are assigned to a shipped product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemSelectedBundleOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `ShipmentItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "The order item associated with the shipment item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price for the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_shipped", - "description": "The number of shipped items.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ShipmentItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleCreditMemoItem", - "description": "Defines bundle product options for `CreditMemoItemInterface`.", - "fields": [ - { - "name": "bundle_options", - "description": "A list of bundle options that are assigned to a bundle product that is part of a credit memo.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemSelectedBundleOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discounts", - "description": "Details about the final discount amount for the base product, including discounts on options.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `CreditMemoItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "The order item the credit memo is applied to.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price for the base product, including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_refunded", - "description": "The number of refunded items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CreditMemoItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ItemSelectedBundleOption", - "description": "A list of options of the selected bundle product.", - "fields": [ - { - "name": "id", - "description": "The unique ID for a `ItemSelectedBundleOption` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "label", - "description": "The label of the option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `ItemSelectedBundleOption` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "values", - "description": "A list of products that represent the values of the parent option.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemSelectedBundleOptionValue", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ItemSelectedBundleOptionValue", - "description": "A list of values for the selected bundle product.", - "fields": [ - { - "name": "id", - "description": "The unique ID for a `ItemSelectedBundleOptionValue` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "price", - "description": "The price of the child bundle product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the child bundle product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the child bundle product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The number of this bundle product that were ordered.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `ItemSelectedBundleOptionValue` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleWishlistItem", - "description": "Defines bundle product options for `WishlistItemInterface`.", - "fields": [ - { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "bundle_options", - "description": "An array containing information about the selected bundle items.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedBundleOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "The description of the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Product details of the wish list item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Currency", - "description": "", - "fields": [ - { - "name": "available_currency_codes", - "description": "An array of three-letter currency codes accepted by the store, such as USD and EUR.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "base_currency_code", - "description": "The base currency set for the store, such as USD.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "base_currency_symbol", - "description": "The symbol for the specified base currency, such as $.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_display_currecy_code", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Symbol was missed. Use `default_display_currency_code`." - }, - { - "name": "default_display_currecy_symbol", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Symbol was missed. Use `default_display_currency_code`." - }, - { - "name": "default_display_currency_code", - "description": "The currency that is displayed by default, such as USD.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_display_currency_symbol", - "description": "The currency symbol that is displayed by default, such as $.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "exchange_rates", - "description": "An array of exchange rates for currencies defined in the store.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ExchangeRate", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ExchangeRate", - "description": "Lists the exchange rate.", - "fields": [ - { - "name": "currency_to", - "description": "Specifies the store’s default currency to exchange to.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "rate", - "description": "The exchange rate for the store’s default currency.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Country", - "description": "", - "fields": [ - { - "name": "available_regions", - "description": "An array of regions within a particular country.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Region", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "full_name_english", - "description": "The name of the country in English.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "full_name_locale", - "description": "The name of the country in the current locale.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `Country` object.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "three_letter_abbreviation", - "description": "The three-letter abbreviation of the country, such as USA.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "two_letter_abbreviation", - "description": "The two-letter abbreviation of the country, such as US.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Region", - "description": "", - "fields": [ - { - "name": "code", - "description": "The two-letter code for the region, such as TX for Texas.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `Region` object.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The name of the region, such as Texas.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerDownloadableProducts", - "description": "Contains a list of downloadable products.", - "fields": [ - { - "name": "items", - "description": "An array of purchased downloadable items.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomerDownloadableProduct", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerDownloadableProduct", - "description": "Contains details about a single downloadable product.", - "fields": [ - { - "name": "date", - "description": "The date and time the purchase was made.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "download_url", - "description": "The fully qualified URL to the download file.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_increment_id", - "description": "The unique ID assigned to the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "remaining_downloads", - "description": "The remaining number of times the customer can download the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DownloadableRequisitionListItem", - "description": "Contains details about downloadable products added to a requisition list.", - "fields": [ - { - "name": "customizable_options", - "description": "Selected custom options for an item in the requisition list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "links", - "description": "An array of links for downloadable products in the requisition list.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductLinks", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about a requisition list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of the product added to the requisition list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "samples", - "description": "An array of links to downloadable product samples.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DownloadableProductSamples", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID of an item in a requisition list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "RequisitionListItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "BundleRequisitionListItem", - "description": "Contains details about bundle products added to a requisition list.", - "fields": [ - { - "name": "bundle_options", - "description": "An array of selected options for a bundle product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedBundleOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "Selected custom options for an item in the requisition list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about a requisition list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of the product added to the requisition list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID of an item in a requisition list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "RequisitionListItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ApplyGiftCardToCartInput", - "description": "Defines the input required to run the `applyGiftCardToCart` mutation.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID that identifies the customer's cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "gift_card_code", - "description": "The gift card code to be applied to the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ApplyGiftCardToCartOutput", - "description": "Defines the possible output for the `applyGiftCardToCart` mutation.", - "fields": [ - { - "name": "cart", - "description": "Describes the contents of the specified shopping cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RemoveGiftCardFromCartInput", - "description": "Defines the input required to run the `removeGiftCardFromCart` mutation.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID that identifies the customer's cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "gift_card_code", - "description": "The gift card code to be removed to the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RemoveGiftCardFromCartOutput", - "description": "Defines the possible output for the `removeGiftCardFromCart` mutation.", - "fields": [ - { - "name": "cart", - "description": "The contents of the specified shopping cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AppliedGiftCard", - "description": "Contains an applied gift card with applied and remaining balance.", - "fields": [ - { - "name": "applied_balance", - "description": "The amount applied to the current cart.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "code", - "description": "The gift card account code.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "current_balance", - "description": "The remaining balance on the gift card.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "expiration_date", - "description": "The expiration date of the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "GiftCardAccountInput", - "description": "Contains the gift card code.", - "fields": null, - "inputFields": [ - { - "name": "gift_card_code", - "description": "The applied gift card code.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftCardAccount", - "description": "Contains details about the gift card account.", - "fields": [ - { - "name": "balance", - "description": "The balance remaining on the gift card.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "code", - "description": "The gift card account code.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "expiration_date", - "description": "The expiration date of the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "OrderTotal", - "description": "Contains details about the sales total amounts used to calculate the final price.", - "fields": [ - { - "name": "base_grand_total", - "description": "The final base grand total amount in the base currency.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discounts", - "description": "The applied discounts to the order.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "grand_total", - "description": "The final total amount, including shipping, discounts, and taxes.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shipping_handling", - "description": "Details about the shipping and handling costs for the order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ShippingHandling", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "subtotal", - "description": "The subtotal of the order, excluding shipping, discounts, and taxes.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "taxes", - "description": "The order tax details.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TaxItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_giftcard", - "description": "The gift card balance applied to the order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_shipping", - "description": "The shipping amount for the order.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_tax", - "description": "The amount of tax applied to the order.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "WishlistOutput", - "description": "Deprecated: Use the `Wishlist` type instead.", - "fields": [ - { - "name": "items", - "description": "An array of items in the customer's wish list", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "WishlistItem", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use the `Wishlist.items` field instead." - }, - { - "name": "items_count", - "description": "The number of items in the wish list.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `Wishlist.items_count` field instead." - }, - { - "name": "name", - "description": "When multiple wish lists are enabled, the name the customer assigns to the wishlist.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "This field is related to Commerce functionality and is always `null` in Open Source." - }, - { - "name": "sharing_code", - "description": "An encrypted code that links to the wish list.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `Wishlist.sharing_code` field instead." - }, - { - "name": "updated_at", - "description": "The time of the last modification to the wish list.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `Wishlist.updated_at` field instead." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Wishlist", - "description": "Contains a customer wish list.", - "fields": [ - { - "name": "id", - "description": "The unique ID for a `Wishlist` object.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": null, - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "WishlistItem", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use the `items_v2` field instead." - }, - { - "name": "items_count", - "description": "The number of items in the wish list.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items_v2", - "description": "An array of items in the customer's wish list.", - "args": [ - { - "name": "currentPage", - "description": "", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "pageSize", - "description": "", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - } - ], - "type": { - "kind": "OBJECT", - "name": "WishlistItems", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The name of the wish list.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sharing_code", - "description": "An encrypted code that Magento uses to link to the wish list.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "The time of the last modification to the wish list.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "visibility", - "description": "Indicates whether the wish list is public or private.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "WishlistVisibilityEnum", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "description": "The interface for wish list items.", - "fields": [ - { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "The description of the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Product details of the wish list item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "SimpleWishlistItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "VirtualWishlistItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "DownloadableWishlistItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleWishlistItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardWishlistItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GroupedProductWishlistItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableWishlistItem", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "WishlistItems", - "description": "Contains an array of items in a wish list.", - "fields": [ - { - "name": "items", - "description": "A list of items in the wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Contains pagination metadata.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "WishlistItem", - "description": "Contains details about a wish list item.", - "fields": [ - { - "name": "added_at", - "description": "The time when the customer added the item to the wish list.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "The customer's comment about this item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `WishlistItem` object.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about the wish list item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "qty", - "description": "The quantity of this wish list item", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddWishlistItemsToCartOutput", - "description": "Contains the resultant wish list and any error information.", - "fields": [ - { - "name": "add_wishlist_items_to_cart_user_errors", - "description": "An array of errors encountered while adding products to the customer's cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "WishlistCartUserInputError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "Indicates whether the attempt to add items to the customer's cart was successful.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "wishlist", - "description": "Contains the wish list with all items that were successfully added.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Wishlist", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "WishlistCartUserInputError", - "description": "Contains details about errors encountered when a customer added wish list items to the cart.", - "fields": [ - { - "name": "code", - "description": "An error code that describes the error encountered.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "WishlistCartUserInputErrorType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "message", - "description": "A localized error message.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "wishlistId", - "description": "The unique ID of the `Wishlist` object containing an error.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "wishlistItemId", - "description": "The unique ID of the wish list item containing an error.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "WishlistCartUserInputErrorType", - "description": "A list of possible error types.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "PRODUCT_NOT_FOUND", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NOT_SALABLE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "INSUFFICIENT_STOCK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNDEFINED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "WishlistItemInput", - "description": "Defines the items to add to a wish list.", - "fields": null, - "inputFields": [ - { - "name": "entered_options", - "description": "An array of options that the customer entered.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "EnteredOptionInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "parent_sku", - "description": "For complex product types, the SKU of the parent product.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "quantity", - "description": "The amount or number of items to add.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "selected_options", - "description": "An array of strings corresponding to options the customer selected.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "sku", - "description": "The SKU of the product to add. For complex product types, specify the child product SKU.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddProductsToWishlistOutput", - "description": "Contains the customer's wish list and any errors encountered.", - "fields": [ - { - "name": "user_errors", - "description": "An array of errors encountered while adding products to a wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "WishListUserInputError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "wishlist", - "description": "Contains the wish list with all items that were successfully added.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Wishlist", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RemoveProductsFromWishlistOutput", - "description": "Contains the customer's wish list and any errors encountered.", - "fields": [ - { - "name": "user_errors", - "description": "An array of errors encountered while deleting products from a wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "WishListUserInputError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "wishlist", - "description": "Contains the wish list with after items were successfully deleted.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Wishlist", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "WishlistItemUpdateInput", - "description": "Defines updates to items in a wish list.", - "fields": null, - "inputFields": [ - { - "name": "description", - "description": "Customer-entered comments about the item.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "entered_options", - "description": "An array of options that the customer entered.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "EnteredOptionInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "quantity", - "description": "The new amount or number of this item.", - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "selected_options", - "description": "An array of strings corresponding to options the customer selected.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "wishlist_item_id", - "description": "The unique ID for a `WishlistItemInterface` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateProductsInWishlistOutput", - "description": "Contains the customer's wish list and any errors encountered.", - "fields": [ - { - "name": "user_errors", - "description": "An array of errors encountered while updating products in a wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "WishListUserInputError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "wishlist", - "description": "Contains the wish list with all items that were successfully updated.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Wishlist", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "WishListUserInputError", - "description": "An error encountered while performing operations with WishList.", - "fields": [ - { - "name": "code", - "description": "A wish list-specific error code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "WishListUserInputErrorType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "message", - "description": "A localized error message.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "WishListUserInputErrorType", - "description": "A list of possible error types.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "PRODUCT_NOT_FOUND", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNDEFINED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftCardProduct", - "description": "Defines properties of a gift card.", - "fields": [ - { - "name": "activity", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "allow_message", - "description": "Indicates whether the customer can provide a message to accompany the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "allow_open_amount", - "description": "Indicates whether shoppers have the ability to set the value of the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "categories", - "description": "The categories assigned to a product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_gear", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "climate", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "collar", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "color", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "country_of_manufacture", - "description": "The product's country of origin.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "crosssell_products", - "description": "An array of cross-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gender", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gift_card_options", - "description": "An array of customizable gift card options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_message_available", - "description": "Indicates whether a gift message is available.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "giftcard_amounts", - "description": "An array that contains information about the values and ID of a gift card.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftCardAmounts", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "giftcard_type", - "description": "An enumeration that specifies the type of gift card.", - "args": [], - "type": { - "kind": "ENUM", - "name": "GiftCardTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The ID number assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." - }, - { - "name": "image", - "description": "The relative path to the main image on the product page.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_redeemable", - "description": "Indicates whether the customer can redeem the value on the card for cash.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "lifetime", - "description": "The number of days after purchase until the gift card expires. A null value means there is no limit.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "material", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "media_gallery", - "description": "An array of media gallery objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "media_gallery_entries", - "description": "An array of MediaGalleryEntry objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "MediaGalleryEntry", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `media_gallery` instead." - }, - { - "name": "message_max_length", - "description": "The maximum number of characters the gift message can contain.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "new_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new_to_date", - "description": "The end date for new product listings.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "only_x_left_in_stock", - "description": "Product stock only x left count", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "open_amount_max", - "description": "The maximum acceptable value of an open amount gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "open_amount_min", - "description": "The minimum acceptable value of an open amount gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "An array of options for a customizable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "pattern", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "price", - "description": "Indicates the price of an item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductPrices", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_range` for product price information." - }, - { - "name": "price_range", - "description": "The range of prices for the product", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PriceRange", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_tiers", - "description": "An array of `TierPrice` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TierPrice", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_links", - "description": "An array of `ProductLinks` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purpose", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "rating_summary", - "description": "The average of all the ratings given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "related_products", - "description": "An array of related products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "review_count", - "description": "The total count of all the reviews given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "reviews", - "description": "The list of products reviews.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviews", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "size", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "special_price", - "description": "The discounted price of the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_to_date", - "description": "The end date for a product with a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "staged", - "description": "Indicates whether the product is staged for a future campaign.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "stock_status", - "description": "Stock status of the product", - "args": [], - "type": { - "kind": "ENUM", - "name": "ProductStockStatus", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "swatch_image", - "description": "The file name of a swatch image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "tier_prices", - "description": "An array of ProductTierPrices objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductTierPrices", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type_id", - "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `__typename` instead." - }, - { - "name": "uid", - "description": "The unique ID for a `ProductInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "Timestamp indicating when the product was updated.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "upsell_products", - "description": "An array of up-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_key", - "description": "The part of the URL that identifies the product", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_path", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use product's `canonical_url` or url rewrites instead" - }, - { - "name": "url_rewrites", - "description": "URL rewrites list", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "UrlRewrite", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_suffix", - "description": "The part of the product URL that is appended after the url key", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "websites", - "description": "An array of websites in which the product is available.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Website", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "PhysicalProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "CustomizableProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftCardAmounts", - "description": "Contains the value of a gift card, the website that generated the card, and related information.", - "fields": [ - { - "name": "attribute_id", - "description": "An internal attribute ID.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `GiftCardAmounts` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The value of the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value_id", - "description": "An ID that is assigned to each unique gift card amount.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "website_id", - "description": "The ID of the website that generated the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "website_value", - "description": "The value of the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "GiftCardTypeEnum", - "description": "Specifies the gift card type.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "VIRTUAL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PHYSICAL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "COMBINED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftCardOrderItem", - "description": "", - "fields": [ - { - "name": "discounts", - "description": "The final discount information for the product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eligible_for_return", - "description": "Indicates whether the order item is eligible to be in a return request.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "entered_options", - "description": "The entered option for the base product, such as a logo or image.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "OrderItemOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_card", - "description": "Selected gift card properties for an order item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftCardItem", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_message", - "description": "The selected gift message for the order item", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftMessage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_wrapping", - "description": "The selected gift wrapping for the order item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for an `OrderItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price of the base product, including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_type", - "description": "The type of product, such as simple, configurable, etc.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_url_key", - "description": "URL key of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_canceled", - "description": "The number of canceled items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_invoiced", - "description": "The number of invoiced items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_ordered", - "description": "The number of units ordered for this item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_refunded", - "description": "The number of refunded items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_returned", - "description": "The number of returned items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_shipped", - "description": "The number of shipped items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "selected_options", - "description": "The selected options for the base product, such as color or size.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "OrderItemOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "The status of the order item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftCardInvoiceItem", - "description": "", - "fields": [ - { - "name": "discounts", - "description": "Information about the final discount amount for the base product, including discounts on options.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_card", - "description": "Selected gift card properties for an invoice item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftCardItem", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for an `InvoiceItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "Details about an individual order item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price for the base product including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_invoiced", - "description": "The number of invoiced items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "InvoiceItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftCardCreditMemoItem", - "description": "", - "fields": [ - { - "name": "discounts", - "description": "Details about the final discount amount for the base product, including discounts on options.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_card", - "description": "Selected gift card properties for a credit memo item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftCardItem", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `CreditMemoItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "The order item the credit memo is applied to.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price for the base product, including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_refunded", - "description": "The number of refunded items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CreditMemoItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftCardShipmentItem", - "description": "", - "fields": [ - { - "name": "gift_card", - "description": "Selected gift card properties for a shipment item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftCardItem", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `ShipmentItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "The order item associated with the shipment item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price for the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_shipped", - "description": "The number of shipped items.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ShipmentItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftCardItem", - "description": "Contains details about a gift card.", - "fields": [ - { - "name": "message", - "description": "The message from the sender to the recipient.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "recipient_email", - "description": "The email address of the receiver of a virtual gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "recipient_name", - "description": "The name of the receiver of a physical or virtual gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sender_email", - "description": "The email address of the sender of a virtual gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sender_name", - "description": "The name of the sender of a physical or virtual gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftCardCartItem", - "description": "Contains details about a gift card that has been added to a cart.", - "fields": [ - { - "name": "amount", - "description": "The amount and currency of the gift card.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "An array of customizations applied to the gift card.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discount", - "description": "Contains discount for quote line item.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "errors", - "description": "An array of errors encountered while loading the cart item", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartItemError", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "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": "message", - "description": "The message from the sender to the recipient.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_from_buyer", - "description": "The buyer's quote line item note.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_from_seller", - "description": "The seller's quote line item note.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CartItemPrices", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about an item in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this item in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "recipient_email", - "description": "The email address of the person receiving the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "recipient_name", - "description": "The name of the person receiving the gift card.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sender_email", - "description": "The email address of the sender.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sender_name", - "description": "The name of the sender.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CartItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftCardWishlistItem", - "description": "A single gift card added to a wish list.", - "fields": [ - { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "The description of the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_card_options", - "description": "Details about a gift card.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftCardOptions", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Product details of the wish list item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftCardOptions", - "description": "Contains details about the sender, recipient, and amount of a gift card.", - "fields": [ - { - "name": "amount", - "description": "The amount and currency of the gift card.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_giftcard_amount", - "description": "The custom amount and currency of the gift card.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "message", - "description": "A message to the recipient.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "recipient_email", - "description": "The email address of the person receiving the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "recipient_name", - "description": "The name of the person receiving the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sender_email", - "description": "The email address of the person sending the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sender_name", - "description": "The name of the person sending the gift card.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableCartItem", - "description": "An implementation for configurable product cart items.", - "fields": [ - { - "name": "available_gift_wrapping", - "description": "The list of available gift wrapping options for the cart item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "configurable_options", - "description": "An array containing the configuranle options the shopper selected.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedConfigurableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "configured_variant", - "description": "Product details of the cart item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "An array containing the customizable options the shopper selected.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discount", - "description": "Contains discount for quote line item.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "errors", - "description": "An array of errors encountered while loading the cart item", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CartItemError", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_message", - "description": "The entered gift message for the cart item", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftMessage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_wrapping", - "description": "The selected gift wrapping for the cart item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "is_available", - "description": "True if requested quantity is less than available stock, false otherwise.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_from_buyer", - "description": "The buyer's quote line item note.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_from_seller", - "description": "The seller's quote line item note.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ItemNote", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prices", - "description": "Contains details about the price of the item, including taxes and discounts.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CartItemPrices", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about an item in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this item in the cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `CartItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CartItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftMessage", - "description": "Contains the text of a gift message, its sender, and recipient", - "fields": [ - { - "name": "from", - "description": "Sender name", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "message", - "description": "Gift message text", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "to", - "description": "Recipient name", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "GiftMessageInput", - "description": "Defines a gift message.", - "fields": null, - "inputFields": [ - { - "name": "from", - "description": "The name of the sender.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "message", - "description": "The text of the gift message.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "to", - "description": "The name of the recepient.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SalesItemInterface", - "description": "", - "fields": [ - { - "name": "gift_message", - "description": "The entered gift message for the order item", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftMessage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerOrder", - "description": "Contains details about each of the customer's orders.", - "fields": [ - { - "name": "billing_address", - "description": "The billing address for the order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "OrderAddress", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "carrier", - "description": "The shipping carrier for the order delivery.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "comments", - "description": "Comments about the order.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SalesCommentItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `order_date` field instead." - }, - { - "name": "credit_memos", - "description": "A list of credit memos.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CreditMemo", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_message", - "description": "The entered gift message for the order", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftMessage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_receipt_included", - "description": "Indicates whether the customer requested a gift receipt for the order.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_wrapping", - "description": "The selected gift wrapping for the order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "grand_total", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `totals.grand_total` field instead." - }, - { - "name": "id", - "description": "The unique ID for a `CustomerOrder` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "increment_id", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `id` field instead." - }, - { - "name": "invoices", - "description": "A list of invoices for the order.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Invoice", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "An array containing the items purchased in this order.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items_eligible_for_return", - "description": "A list of order items eligible to be in a return request.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "number", - "description": "The order number.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_date", - "description": "The date the order was placed.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_number", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use the `number` field instead." - }, - { - "name": "payment_methods", - "description": "Payment details for the order.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "OrderPaymentMethod", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "printed_card_included", - "description": "Indicates whether the customer requested a printed card for the order.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "returns", - "description": "Return requests associated with this order.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "OBJECT", - "name": "Returns", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shipments", - "description": "A list of shipments for the order.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "OrderShipment", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shipping_address", - "description": "The shipping address for the order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "OrderAddress", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shipping_method", - "description": "The delivery method for the order.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "The current status of the order.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total", - "description": "Details about the calculated totals for this order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "OrderTotal", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "description": "Order item details.", - "fields": [ - { - "name": "discounts", - "description": "The final discount information for the product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eligible_for_return", - "description": "Indicates whether the order item is eligible to be in a return request.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "entered_options", - "description": "The entered option for the base product, such as a logo or image.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "OrderItemOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_message", - "description": "The selected gift message for the order item", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftMessage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_wrapping", - "description": "The selected gift wrapping for the order item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for an `OrderItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price of the base product, including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_type", - "description": "The type of product, such as simple, configurable, etc.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_url_key", - "description": "URL key of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_canceled", - "description": "The number of canceled items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_invoiced", - "description": "The number of invoiced items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_ordered", - "description": "The number of units ordered for this item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_refunded", - "description": "The number of refunded items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_returned", - "description": "The number of returned items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_shipped", - "description": "The number of shipped items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "selected_options", - "description": "The selected options for the base product, such as color or size.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "OrderItemOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "The status of the order item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "DownloadableOrderItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleOrderItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardOrderItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "OrderItem", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "GiftRegistrySearchResult", - "description": "Contains the results of a gift registry search.", - "fields": [ - { - "name": "event_date", - "description": "The date of the event.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "event_title", - "description": "The title given to the event.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_registry_uid", - "description": "The URL key of the gift registry.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "location", - "description": "The location of the event.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The name of the gift registry owner.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "The type of event being held.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "GiftRegistryDynamicAttributeInput", - "description": "Defines a dynamic attribute.", - "fields": null, - "inputFields": [ - { - "name": "code", - "description": "A unique key for an additional attribute of the event.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "value", - "description": "A string that describes a dynamic attribute.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ShareGiftRegistrySenderInput", - "description": "Defines the sender of an invitation to view a gift registry.", - "fields": null, - "inputFields": [ - { - "name": "message", - "description": "A brief message from the sender.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The sender of the gift registry invitation.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ShareGiftRegistryInviteeInput", - "description": "Defines a gift registry invitee.", - "fields": null, - "inputFields": [ - { - "name": "email", - "description": "The email address of the gift registry invitee.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The name of the gift registry invitee.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddGiftRegistryItemInput", - "description": "Defines an item to add to the gift registry.", - "fields": null, - "inputFields": [ - { - "name": "entered_options", - "description": "An array of options the customer has entered.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "EnteredOptionInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "note", - "description": "A brief note about the item.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "parent_sku", - "description": "For complex product types, the SKU of the parent product.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "quantity", - "description": "The quantity of the product to add.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "selected_options", - "description": "An array of strings corresponding to options the customer has selected.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "sku", - "description": "The SKU of the product to add to the gift registry.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CreateGiftRegistryInput", - "description": "Defines a new gift registry.", - "fields": null, - "inputFields": [ - { - "name": "dynamic_attributes", - "description": "Additional attributes specified as a code-value pair.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "GiftRegistryDynamicAttributeInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "event_name", - "description": "The name of the event.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "gift_registry_type_uid", - "description": "The ID of the selected event type.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "message", - "description": "A message describing the event.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "privacy_settings", - "description": "Indicates whether the registry is PRIVATE or PUBLIC.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "GiftRegistryPrivacySettings", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "registrants", - "description": "The list of people who receive notifications about the registry.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "AddGiftRegistryRegistrantInput", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "shipping_address", - "description": "The shipping address for all gift registry items.", - "type": { - "kind": "INPUT_OBJECT", - "name": "GiftRegistryShippingAddressInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "status", - "description": "Indicates whether the registry is ACTIVE or INACTIVE.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "GiftRegistryStatus", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "UpdateGiftRegistryItemInput", - "description": "Defines updates to an item in a gift registry.", - "fields": null, - "inputFields": [ - { - "name": "gift_registry_item_uid", - "description": "The unique ID of a `giftRegistryItem` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "note", - "description": "The updated description of the item.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "quantity", - "description": "The updated quantity of the gift registry item.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "UpdateGiftRegistryInput", - "description": "Defines updates to a `GiftRegistry` object.", - "fields": null, - "inputFields": [ - { - "name": "dynamic_attributes", - "description": "Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "GiftRegistryDynamicAttributeInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "event_name", - "description": "The updated name of the event.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "message", - "description": "The updated message describing the event.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "privacy_settings", - "description": "Indicates whether the gift registry is PRIVATE or PUBLIC.", - "type": { - "kind": "ENUM", - "name": "GiftRegistryPrivacySettings", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "shipping_address", - "description": "The updated shipping address for all gift registry items.", - "type": { - "kind": "INPUT_OBJECT", - "name": "GiftRegistryShippingAddressInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "status", - "description": "Indicates whether the gift registry is ACTIVE or INACTIVE.", - "type": { - "kind": "ENUM", - "name": "GiftRegistryStatus", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddGiftRegistryRegistrantInput", - "description": "Defines a new registrant.", - "fields": null, - "inputFields": [ - { - "name": "dynamic_attributes", - "description": "Additional attributes specified as a code-value pair.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "GiftRegistryDynamicAttributeInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "email", - "description": "The email address of the registrant.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "firstname", - "description": "The first name of the registrant.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "lastname", - "description": "The last name of the registrant.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "GiftRegistryShippingAddressInput", - "description": "Defines a shipping address for a gift registry. Specify either `address_data` or the `address_id`. If both are provided, validation will fail.", - "fields": null, - "inputFields": [ - { - "name": "address_data", - "description": "Defines the shipping address for this gift registry.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CustomerAddressInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "address_id", - "description": "The ID assigned to this customer address.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "UpdateGiftRegistryRegistrantInput", - "description": "Defines updates to an existing registrant.", - "fields": null, - "inputFields": [ - { - "name": "dynamic_attributes", - "description": "As a result of the update, only the values of provided attributes will be affected. If the attribute is missing in the request, its value will not be changed.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "GiftRegistryDynamicAttributeInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "email", - "description": "The updated email address of the registrant.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "firstname", - "description": "The updated first name of the registrant.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "gift_registry_registrant_uid", - "description": "The unique ID of a `giftRegistryRegistrant` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "lastname", - "description": "The updated last name of the registrant.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "GiftRegistryOutputInterface", - "description": "Contains the customer's gift registry.", - "fields": [ - { - "name": "gift_registry", - "description": "The gift registry.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftRegistry", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "GiftRegistryOutput", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "MoveCartItemsToGiftRegistryOutput", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "GiftRegistryOutput", - "description": "Contains details about the gift registry.", - "fields": [ - { - "name": "gift_registry", - "description": "The gift registry.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftRegistry", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "GiftRegistryOutputInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "GiftRegistryItemUserErrorInterface", - "description": "Contains the status and any errors that encountered with the customer's gift register item.", - "fields": [ - { - "name": "status", - "description": "Indicates whether the attempt to move the cart items to the gift registry was successful.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "user_errors", - "description": "An array of errors encountered while moving items from the cart to the gift registry.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftRegistryItemsUserError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "GiftRegistryItemUserErrors", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "MoveCartItemsToGiftRegistryOutput", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "GiftRegistryItemUserErrors", - "description": "Contains error information.", - "fields": [ - { - "name": "status", - "description": "Indicates whether the attempt to move the cart items to the gift registry was successful.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "user_errors", - "description": "An array of errors encountered while moving items from the cart to the gift registry.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftRegistryItemsUserError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "GiftRegistryItemUserErrorInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftRegistryItemsUserError", - "description": "Contains details about an error that occurred when processing a gift registry item.", - "fields": [ - { - "name": "code", - "description": "An error code that describes the error encountered.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "GiftRegistryItemsUserErrorType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_registry_item_uid", - "description": "The unique ID of the gift registry item containing an error.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_registry_uid", - "description": "The unique ID of the `GiftRegistry` object containing an error.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "message", - "description": "A localized error message.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_uid", - "description": "The unique ID of the product containing an error.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "GiftRegistryItemsUserErrorType", - "description": "Defines the error type.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "OUT_OF_STOCK", - "description": "Used for handling out of stock products.", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NOT_FOUND", - "description": "Used for exceptions like EntityNotFound.", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNDEFINED", - "description": "Used for other exceptions, such as database connection failures.", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "MoveCartItemsToGiftRegistryOutput", - "description": "Contains the customer's gift registry and any errors encountered.", - "fields": [ - { - "name": "gift_registry", - "description": "The gift registry.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftRegistry", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "Indicates whether the attempt to move the cart items to the gift registry was successful.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "user_errors", - "description": "An array of errors encountered while moving items from the cart to the gift registry.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftRegistryItemsUserError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "GiftRegistryOutputInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "GiftRegistryItemUserErrorInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RemoveGiftRegistryOutput", - "description": "Contains the results of a request to delete a gift registry.", - "fields": [ - { - "name": "success", - "description": "Indicates whether the gift registry was successfully deleted.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RemoveGiftRegistryItemsOutput", - "description": "Contains the results of a request to remove an item from a gift registry.", - "fields": [ - { - "name": "gift_registry", - "description": "The gift registry after removing items.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftRegistry", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateGiftRegistryItemsOutput", - "description": "Contains the results of a request to update gift registry items.", - "fields": [ - { - "name": "gift_registry", - "description": "The gift registry after updating updating items.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftRegistry", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ShareGiftRegistryOutput", - "description": "Contains the results of a request to share a gift registry.", - "fields": [ - { - "name": "is_shared", - "description": "Indicates whether the gift registry was successfully shared.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateGiftRegistryOutput", - "description": "Contains the results of a request to create a gift registry.", - "fields": [ - { - "name": "gift_registry", - "description": "The newly-created gift registry.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftRegistry", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateGiftRegistryOutput", - "description": "Contains the results of a request to update a gift registry.", - "fields": [ - { - "name": "gift_registry", - "description": "The updated gift registry.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftRegistry", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddGiftRegistryRegistrantsOutput", - "description": "Contains the results of a request to add registrants.", - "fields": [ - { - "name": "gift_registry", - "description": "The gift registry after adding registrants.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftRegistry", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateGiftRegistryRegistrantsOutput", - "description": "Contains the results a request to update registrants.", - "fields": [ - { - "name": "gift_registry", - "description": "The gift registry after updating registrants.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftRegistry", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RemoveGiftRegistryRegistrantsOutput", - "description": "Contains the results of a request to delete a registrant.", - "fields": [ - { - "name": "gift_registry", - "description": "The gift registry after deleting registrants.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftRegistry", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftRegistry", - "description": "Contains details about a gift registry.", - "fields": [ - { - "name": "created_at", - "description": "The date on which the gift registry was created. Only the registry owner can access this attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "dynamic_attributes", - "description": "An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftRegistryDynamicAttribute", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "event_name", - "description": "The name of the event.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "An array of products added to the gift registry.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "GiftRegistryItemInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "message", - "description": "The message text the customer entered to describe the event.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "owner_name", - "description": "The customer who created the gift registry.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "privacy_settings", - "description": "An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "GiftRegistryPrivacySettings", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "registrants", - "description": "Contains details about each registrant for the event.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftRegistryRegistrant", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shipping_address", - "description": "Contains the customer's shipping address. Only the registry owner can access this attribute.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomerAddress", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "GiftRegistryStatus", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "The type of gift registry.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftRegistryType", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID assigned to the gift registry.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftRegistryType", - "description": "Contains details about a gift registry type.", - "fields": [ - { - "name": "dynamic_attributes_metadata", - "description": "An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "GiftRegistryDynamicAttributeMetadataInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The label assigned to the gift registry type on the Admin.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID assigned to the gift registry type.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "GiftRegistryDynamicAttributeMetadataInterface", - "description": "", - "fields": [ - { - "name": "attribute_group", - "description": "Indicates which group the dynamic attribute a member of.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "code", - "description": "The internal ID of the dynamic attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "input_type", - "description": "The selected input type for this dynamic attribute. The value can be one of several static or custom types.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_required", - "description": "Indicates whether the dynamic attribute is required.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display name of the dynamic attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which to display the dynamic attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "GiftRegistryDynamicAttributeMetadata", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "GiftRegistryDynamicAttributeMetadata", - "description": "", - "fields": [ - { - "name": "attribute_group", - "description": "Indicates which group the dynamic attribute a member of.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "code", - "description": "The internal ID of the dynamic attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "input_type", - "description": "The selected input type for this dynamic attribute. The value can be one of several static or custom types.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_required", - "description": "Indicates whether the dynamic attribute is required.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display name of the dynamic attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The order in which to display the dynamic attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "GiftRegistryDynamicAttributeMetadataInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "GiftRegistryStatus", - "description": "Defines the status of the gift registry.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "ACTIVE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "INACTIVE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "GiftRegistryPrivacySettings", - "description": "Defines the privacy setting of the gift registry.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "PRIVATE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PUBLIC", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftRegistryRegistrant", - "description": "Contains details about a registrant.", - "fields": [ - { - "name": "dynamic_attributes", - "description": "An array of dynamic attributes assigned to the registrant.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftRegistryRegistrantDynamicAttribute", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "email", - "description": "The email address of the registrant. Only the registry owner can access this attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "firstname", - "description": "The first name of the registrant.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "lastname", - "description": "The last name of the registrant.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID assigned to the registrant.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "GiftRegistryDynamicAttributeInterface", - "description": "", - "fields": [ - { - "name": "code", - "description": "The internal ID of the dynamic attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display name of the dynamic attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "A corresponding value for the code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "GiftRegistryRegistrantDynamicAttribute", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftRegistryDynamicAttribute", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "GiftRegistryRegistrantDynamicAttribute", - "description": "", - "fields": [ - { - "name": "code", - "description": "The internal ID of the dynamic attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display name of the dynamic attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "A corresponding value for the code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "GiftRegistryDynamicAttributeInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftRegistryDynamicAttribute", - "description": "", - "fields": [ - { - "name": "code", - "description": "The internal ID of the dynamic attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "group", - "description": "Indicates which group the dynamic attribute is a member of.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "GiftRegistryDynamicAttributeGroup", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display name of the dynamic attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "A corresponding value for the code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "GiftRegistryDynamicAttributeInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "GiftRegistryDynamicAttributeGroup", - "description": "Defines the group type of a gift registry dynamic attribute.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "EVENT_INFORMATION", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PRIVACY_SETTINGS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "REGISTRANT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GENERAL_INFORMATION", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DETAILED_INFORMATION", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SHIPPING_ADDRESS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "GiftRegistryItemInterface", - "description": "", - "fields": [ - { - "name": "created_at", - "description": "The date the product was added to the gift registry.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note", - "description": "A brief message about the gift registry item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about the gift registry item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The requested quantity of the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_fulfilled", - "description": "The fulfilled quantity of the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID of a gift registry item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "GiftRegistryItem", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "GiftRegistryItem", - "description": "", - "fields": [ - { - "name": "created_at", - "description": "The date the product was added to the gift registry.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note", - "description": "A brief message about the gift registry item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about the gift registry item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The requested quantity of the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_fulfilled", - "description": "The fulfilled quantity of the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID of a gift registry item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "GiftRegistryItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftWrapping", - "description": "Contains details about the selected or available gift wrapping options.", - "fields": [ - { - "name": "design", - "description": "The name of the gift wrapping design.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `GiftWrapping` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead" - }, - { - "name": "image", - "description": "The preview image for a gift wrapping option.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftWrappingImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price", - "description": "The gift wrapping price.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `GiftWrapping` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftWrappingImage", - "description": "Points to an image associated with a gift wrapping option.", - "fields": [ - { - "name": "label", - "description": "The gift wrapping preview image label.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url", - "description": "The gift wrapping preview image URL.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftOptionsPrices", - "description": "Contains prices for gift wrapping options.", - "fields": [ - { - "name": "gift_wrapping_for_items", - "description": "Price of the gift wrapping for all individual order items.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_wrapping_for_order", - "description": "Price of the gift wrapping for the whole order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "printed_card", - "description": "Price for the printed card.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SetGiftOptionsOnCartInput", - "description": "Defines the gift options applied to the cart.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID that identifies the shopper's cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "gift_message", - "description": "Gift message details for the cart.", - "type": { - "kind": "INPUT_OBJECT", - "name": "GiftMessageInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "gift_receipt_included", - "description": "Whether customer requested gift receipt for the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "gift_wrapping_id", - "description": "The unique ID for a `GiftWrapping` object to be used for the cart.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "printed_card_included", - "description": "Whether customer requested printed card for the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SetGiftOptionsOnCartOutput", - "description": "Contains the cart after gift options have been applied.", - "fields": [ - { - "name": "cart", - "description": "The modified cart object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductTierPrices", - "description": "Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity discount offered to a specific customer group.", - "fields": [ - { - "name": "customer_group_id", - "description": "The ID of the customer group.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Not relevant for the storefront." - }, - { - "name": "percentage_value", - "description": "The percentage discount of the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `TierPrice.discount` instead." - }, - { - "name": "qty", - "description": "The number of items that must be purchased to qualify for tier pricing.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `TierPrice.quantity` instead." - }, - { - "name": "value", - "description": "The price of the fixed price item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `TierPrice.final_price` instead." - }, - { - "name": "website_id", - "description": "The ID assigned to the website.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Not relevant for the storefront." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "TierPrice", - "description": "Defines a price based on the quantity purchased.", - "fields": [ - { - "name": "discount", - "description": "The price discount that this tier represents.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductDiscount", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "final_price", - "description": "The price of the product at this tier.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The minimum number of items that must be purchased to qualify for this price tier.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GroupedProduct", - "description": "Defines a grouped product, which consists of simple standalone products that are presented as a group.", - "fields": [ - { - "name": "activity", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "categories", - "description": "The categories assigned to a product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_gear", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "climate", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "collar", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "color", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "country_of_manufacture", - "description": "The product's country of origin.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "crosssell_products", - "description": "An array of cross-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gender", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gift_message_available", - "description": "Indicates whether a gift message is available.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The ID number assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." - }, - { - "name": "image", - "description": "The relative path to the main image on the product page.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "An array containing grouped product items.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GroupedProductItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "material", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "media_gallery", - "description": "An array of media gallery objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "media_gallery_entries", - "description": "An array of MediaGalleryEntry objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "MediaGalleryEntry", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `media_gallery` instead." - }, - { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "new_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new_to_date", - "description": "The end date for new product listings.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "only_x_left_in_stock", - "description": "Product stock only x left count", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "pattern", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "price", - "description": "Indicates the price of an item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductPrices", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_range` for product price information." - }, - { - "name": "price_range", - "description": "The range of prices for the product", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PriceRange", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_tiers", - "description": "An array of `TierPrice` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TierPrice", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_links", - "description": "An array of `ProductLinks` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purpose", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "rating_summary", - "description": "The average of all the ratings given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "related_products", - "description": "An array of related products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "review_count", - "description": "The total count of all the reviews given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "reviews", - "description": "The list of products reviews.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviews", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "size", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "special_price", - "description": "The discounted price of the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_to_date", - "description": "The end date for a product with a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "staged", - "description": "Indicates whether the product is staged for a future campaign.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "stock_status", - "description": "Stock status of the product", - "args": [], - "type": { - "kind": "ENUM", - "name": "ProductStockStatus", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "swatch_image", - "description": "The file name of a swatch image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "tier_prices", - "description": "An array of ProductTierPrices objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductTierPrices", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type_id", - "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `__typename` instead." - }, - { - "name": "uid", - "description": "The unique ID for a `ProductInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "Timestamp indicating when the product was updated.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "upsell_products", - "description": "An array of up-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_key", - "description": "The part of the URL that identifies the product", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_path", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use product's `canonical_url` or url rewrites instead" - }, - { - "name": "url_rewrites", - "description": "URL rewrites list", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "UrlRewrite", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_suffix", - "description": "The part of the product URL that is appended after the url key", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "websites", - "description": "An array of websites in which the product is available.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Website", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "PhysicalProductInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GroupedProductItem", - "description": "Contains information about an individual grouped product item.", - "fields": [ - { - "name": "position", - "description": "The relative position of this item compared to the other group items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about this product option.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "qty", - "description": "The quantity of this grouped product item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GroupedProductWishlistItem", - "description": "A grouped product wish list item.", - "fields": [ - { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "The description of the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Product details of the wish list item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProduct", - "description": "Defines basic features of a configurable product and its simple product variants.", - "fields": [ - { - "name": "activity", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "attribute_set_id", - "description": "The attribute set assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "canonical_url", - "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "categories", - "description": "The categories assigned to a product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CategoryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "category_gear", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "climate", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "collar", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "color", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "configurable_options", - "description": "An array of options for the configurable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ConfigurableProductOptions", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "configurable_product_options_selection", - "description": "An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options.", - "args": [ - { - "name": "configurableOptionValueUids", - "description": "", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ConfigurableProductOptionsSelection", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country_of_manufacture", - "description": "The product's country of origin.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "Timestamp indicating when the product was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "crosssell_products", - "description": "An array of cross-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_attributesV2", - "description": "Product custom attributes.", - "args": [ - { - "name": "filters", - "description": "", - "type": { - "kind": "INPUT_OBJECT", - "name": "AttributeFilterInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "ProductCustomAttributes", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "Detailed information about the product. The value can include simple HTML tags.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eco_collection", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "erin_recommends", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "features_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "format", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gender", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "gift_message_available", - "description": "Indicates whether a gift message is available.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The ID number assigned to the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `uid` field instead." - }, - { - "name": "image", - "description": "The relative path to the main image on the product page.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_returnable", - "description": "Indicates whether the product can be returned.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "manufacturer", - "description": "A number representing the product's manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "material", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "media_gallery", - "description": "An array of media gallery objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "media_gallery_entries", - "description": "An array of MediaGalleryEntry objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "MediaGalleryEntry", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `media_gallery` instead." - }, - { - "name": "meta_description", - "description": "A brief overview of the product for search results listings, maximum 255 characters.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_keyword", - "description": "A comma-separated list of keywords that are visible only to search engines.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "meta_title", - "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The product name. Customers use this name to identify the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "new_from_date", - "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "new_to_date", - "description": "The end date for new product listings.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "only_x_left_in_stock", - "description": "Product stock only x left count", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "An array of options for a customizable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomizableOptionInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options_container", - "description": "If the product has multiple options, determines where they appear on the product page.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "pattern", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "performance_fabric", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "price", - "description": "Indicates the price of an item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductPrices", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_range` for product price information." - }, - { - "name": "price_range", - "description": "The range of prices for the product", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PriceRange", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "price_tiers", - "description": "An array of `TierPrice` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TierPrice", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_links", - "description": "An array of `ProductLinks` objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductLinksInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purpose", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "rating_summary", - "description": "The average of all the ratings given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "redirect_code", - "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "related_products", - "description": "An array of related products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "relative_url", - "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "review_count", - "description": "The total count of all the reviews given to the product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "reviews", - "description": "The list of products reviews.", - "args": [ - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviews", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sale", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "short_description", - "description": "A short description of the product. Its use depends on the theme.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ComplexTextValue", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "size", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "sku", - "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sleeve", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "small_image", - "description": "The relative path to the small image, which is used on catalog pages.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_from_date", - "description": "The beginning date that a product has a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "special_price", - "description": "The discounted price of the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "special_to_date", - "description": "The end date for a product with a special price.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "staged", - "description": "Indicates whether the product is staged for a future campaign.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "stock_status", - "description": "Stock status of the product", - "args": [], - "type": { - "kind": "ENUM", - "name": "ProductStockStatus", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "strap_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bags", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_bottom", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "style_general", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use the `custom_attributes` field instead." - }, - { - "name": "swatch_image", - "description": "The file name of a swatch image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "thumbnail", - "description": "The relative path to the product's thumbnail image.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ProductImage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "tier_price", - "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "tier_prices", - "description": "An array of ProductTierPrices objects.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductTierPrices", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `price_tiers` for product tier price information." - }, - { - "name": "type", - "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", - "args": [], - "type": { - "kind": "ENUM", - "name": "UrlRewriteEntityTypeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type_id", - "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `__typename` instead." - }, - { - "name": "uid", - "description": "The unique ID for a `ProductInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "Timestamp indicating when the product was updated.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "upsell_products", - "description": "An array of up-sell products.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_key", - "description": "The part of the URL that identifies the product", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_path", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use product's `canonical_url` or url rewrites instead" - }, - { - "name": "url_rewrites", - "description": "URL rewrites list", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "UrlRewrite", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "url_suffix", - "description": "The part of the product URL that is appended after the url key", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "variants", - "description": "An array of simple product variants.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ConfigurableVariant", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "websites", - "description": "An array of websites in which the product is available.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Website", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "The field should not be used on the storefront." - }, - { - "name": "weight", - "description": "The weight of the item, in units defined by the store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "RoutableInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "PhysicalProductInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "CustomizableProductInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableVariant", - "description": "Contains all the simple product variants of a configurable product.", - "fields": [ - { - "name": "attributes", - "description": "An array of configurable attribute options.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ConfigurableAttributeOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "An array of linked simple products.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SimpleProduct", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableAttributeOption", - "description": "Contains details about a configurable product attribute option.", - "fields": [ - { - "name": "code", - "description": "The ID assigned to the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "A string that describes the configurable attribute option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `ConfigurableAttributeOption` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value_index", - "description": "A unique index number assigned to the configurable product option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProductOptions", - "description": "Defines configurable attributes for the specified product.", - "fields": [ - { - "name": "attribute_code", - "description": "A string that identifies the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "attribute_id", - "description": "The ID assigned to the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `attribute_uid` instead." - }, - { - "name": "attribute_id_v2", - "description": "The ID assigned to the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `attribute_uid` instead." - }, - { - "name": "attribute_uid", - "description": "The unique ID for an `Attribute` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The configurable option ID number assigned by the system.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - }, - { - "name": "label", - "description": "A displayed string that describes the configurable product option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "position", - "description": "A number that indicates the order in which the attribute is displayed.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_id", - "description": "This is the same as a product's `id` field.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "`product_id` is not needed and can be obtained from its parent." - }, - { - "name": "uid", - "description": "The unique ID for a `ConfigurableProductOptions` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "use_default", - "description": "Indicates whether the option is the default.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "values", - "description": "An array that defines the `value_index` codes assigned to the configurable product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ConfigurableProductOptionsValues", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProductOptionsValues", - "description": "Contains the index number assigned to a configurable product option.", - "fields": [ - { - "name": "default_label", - "description": "The label of the product on the default store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The label of the product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "store_label", - "description": "The label of the product on the current store.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "swatch_data", - "description": "Swatch data for a configurable product option.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "SwatchDataInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `ConfigurableProductOptionsValues` object.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "use_default_value", - "description": "Indicates whether to use the default_label.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value_index", - "description": "A unique index number assigned to the configurable product option.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `uid` instead." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddConfigurableProductsToCartInput", - "description": "Defines the configurable products to add to the cart.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The ID of the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cart_items", - "description": "An array of configurable products to add.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "ConfigurableProductCartItemInput", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddConfigurableProductsToCartOutput", - "description": "Contains details about the cart after adding configurable products.", - "fields": [ - { - "name": "cart", - "description": "The cart after adding products.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ConfigurableProductCartItemInput", - "description": "", - "fields": null, - "inputFields": [ - { - "name": "customizable_options", - "description": "The ID and value of the option.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CustomizableOptionInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "data", - "description": "The quantity and SKU of the configurable product.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CartItemInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "parent_sku", - "description": "The SKU of the parent configurable product.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "variant_sku", - "description": "Deprecated. Use `CartItemInput.sku` instead.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SelectedConfigurableOption", - "description": "Contains details about a selected configurable option.", - "fields": [ - { - "name": "configurable_product_option_uid", - "description": "The unique ID for a `ConfigurableProductOptions` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "configurable_product_option_value_uid", - "description": "The unique ID for a `ConfigurableProductOptionsValues` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `SelectedConfigurableOption.configurable_product_option_uid` instead." - }, - { - "name": "option_label", - "description": "The display text for the option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value_id", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead." - }, - { - "name": "value_label", - "description": "The display name of the selected configurable option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableWishlistItem", - "description": "A configurable product wish list item.", - "fields": [ - { - "name": "added_at", - "description": "The date and time the item was added to the wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "child_sku", - "description": "The SKU of the simple product corresponding to a set of selected configurable options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `ConfigurableWishlistItem.configured_variant.sku` instead." - }, - { - "name": "configurable_options", - "description": "An array of selected configurable options.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedConfigurableOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "configured_variant", - "description": "Product details of the selected variant. The value is null if some options are not configured.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "Custom options selected for the wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "The description of the item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `WishlistItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Product details of the wish list item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of this wish list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "WishlistItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProductOptionsSelection", - "description": "Contains metadata corresponding to the selected configurable options.", - "fields": [ - { - "name": "configurable_options", - "description": "An array of all possible configurable options.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ConfigurableProductOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "media_gallery", - "description": "Product images and videos corresponding to the specified configurable options selection.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "MediaGalleryInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options_available_for_selection", - "description": "The configurable options available for further selection based on the current selection.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ConfigurableOptionAvailableForSelection", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "variant", - "description": "A variant represented by the specified configurable options selection. The value is expected to be null until selections are made for each configurable option.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SimpleProduct", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableOptionAvailableForSelection", - "description": "Describes configurable options that have been selected and can be selected as a result of the previous selections.", - "fields": [ - { - "name": "attribute_code", - "description": "An attribute code that uniquely identifies a configurable option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "option_value_uids", - "description": "An array of selectable option value IDs.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProductOption", - "description": "Contains details about configurable product options.", - "fields": [ - { - "name": "attribute_code", - "description": "An attribute code that uniquely identifies a configurable option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display name of the option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID of the configurable option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "values", - "description": "An array of values that are applicable for this option.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ConfigurableProductOptionValue", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableProductOptionValue", - "description": "Defines a value for a configurable product option.", - "fields": [ - { - "name": "is_available", - "description": "Indicates whether the product is available with this selected option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_use_default", - "description": "Indicates whether the value is the default.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display name of the value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "swatch", - "description": "The URL assigned to the thumbnail of the swatch image.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "SwatchDataInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID of the value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AreaInput", - "description": "AreaInput defines the parameters which will be used for filter by specified location.", - "fields": null, - "inputFields": [ - { - "name": "radius", - "description": "The radius for the search in KM.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "search_term", - "description": "The country code where search must be performed. Required parameter together with region, city or postcode.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PickupLocationFilterInput", - "description": "PickupLocationFilterInput defines the list of attributes and filters for the search.", - "fields": null, - "inputFields": [ - { - "name": "city", - "description": "Filter by city.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "country_id", - "description": "Filter by country.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "name", - "description": "Filter by pickup location name.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pickup_location_code", - "description": "Filter by pickup location code.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "postcode", - "description": "Filter by postcode.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "region", - "description": "Filter by region.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "region_id", - "description": "Filter by region id.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "street", - "description": "Filter by street.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterTypeInput", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PickupLocationSortInput", - "description": "PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.", - "fields": null, - "inputFields": [ - { - "name": "city", - "description": "City where pickup location is placed.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "contact_name", - "description": "Name of the contact person.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "country_id", - "description": "Id of the country in two letters.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "description", - "description": "Description of the pickup location.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "distance", - "description": "Distance to the address, requested by distance filter. Applicable only with distance filter. If distance sort order is present, all other sort orders will be ignored.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "email", - "description": "Contact email of the pickup location.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "fax", - "description": "Contact fax of the pickup location.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "latitude", - "description": "Geographic latitude where pickup location is placed.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "longitude", - "description": "Geographic longitude where pickup location is placed.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The pickup location name. Customer use this to identify the pickup location.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "phone", - "description": "Contact phone number of the pickup location.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pickup_location_code", - "description": "A code assigned to pickup location to identify the source.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "postcode", - "description": "Postcode where pickup location is placed.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "region", - "description": "Name of the region.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "region_id", - "description": "Id of the region.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "street", - "description": "Street where pickup location is placed.", - "type": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PickupLocations", - "description": "Top level object returned in a pickup locations search.", - "fields": [ - { - "name": "items", - "description": "An array of pickup locations that match the specific search request.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PickupLocation", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "An object that includes the page_info and currentPage values specified in the query.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The number of products returned.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PickupLocation", - "description": "Defines Pickup Location information.", - "fields": [ - { - "name": "city", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "contact_name", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country_id", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "email", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "fax", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "latitude", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "longitude", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "phone", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "pickup_location_code", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "postcode", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region_id", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "street", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ProductInfoInput", - "description": "Product Information used for Pickup Locations search.", - "fields": null, - "inputFields": [ - { - "name": "sku", - "description": "Product SKU.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "GenerateCustomerTokenAsAdminInput", - "description": "Identifies which customer requires remote shopping assistance.", - "fields": null, - "inputFields": [ - { - "name": "customer_email", - "description": "The email address of the customer requesting remote shopping assistance.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GenerateCustomerTokenAsAdminOutput", - "description": "Contains the generated customer token.", - "fields": [ - { - "name": "customer_token", - "description": "The generated customer token.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ReorderItemsOutput", - "description": "Contains the cart and any errors after adding products.", - "fields": [ - { - "name": "cart", - "description": "Detailed information about the customer's cart.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "userInputErrors", - "description": "An array of reordering errors.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CheckoutUserInputError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CheckoutUserInputError", - "description": "An error encountered while adding an item to the cart.", - "fields": [ - { - "name": "code", - "description": "An error code that is specific to Checkout.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CheckoutUserInputErrorCodes", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "message", - "description": "A localized error message.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "path", - "description": "The path to the input field that caused an error. See the GraphQL specification about path errors for details: http://spec.graphql.org/draft/#sec-Errors", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CustomerOrdersFilterInput", - "description": "Identifies the filter to use for filtering orders.", - "fields": null, - "inputFields": [ - { - "name": "number", - "description": "Filters by order number.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterStringTypeInput", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CustomerOrderSortInput", - "description": "CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order.", - "fields": null, - "inputFields": [ - { - "name": "sort_direction", - "description": "This enumeration indicates whether to return results in ascending or descending order", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "sort_field", - "description": "Specifies the field to use for sorting", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CustomerOrderSortableField", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CustomerOrderSortableField", - "description": "Specifies the field to use for sorting", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "NUMBER", - "description": "Sorts customer orders by number", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CREATED_AT", - "description": "Sorts customer orders by created_at field", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerOrders", - "description": "The collection of orders that match the conditions defined in the filter.", - "fields": [ - { - "name": "items", - "description": "An array of customer orders.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomerOrder", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Contains pagination metadata.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The total count of customer orders.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "OrderAddress", - "description": "Contains detailed information about an order's billing and shipping addresses.", - "fields": [ - { - "name": "city", - "description": "The city or town.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "company", - "description": "The customer's company.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country_code", - "description": "The customer's country.", - "args": [], - "type": { - "kind": "ENUM", - "name": "CountryCodeEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "fax", - "description": "The fax number.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "firstname", - "description": "The first name of the person associated with the shipping/billing address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "lastname", - "description": "The family name of the person associated with the shipping/billing address.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "middlename", - "description": "The middle name of the person associated with the shipping/billing address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "postcode", - "description": "The customer's ZIP or postal code.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prefix", - "description": "An honorific, such as Dr., Mr., or Mrs.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region", - "description": "The state or province name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region_id", - "description": "The unique ID for a `Region` object of a pre-defined region.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "street", - "description": "An array of strings that define the street number and name.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "suffix", - "description": "A value such as Sr., Jr., or III.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "telephone", - "description": "The telephone number.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "vat_id", - "description": "The customer's Value-added tax (VAT) number (for corporate customers).", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "OrderItem", - "description": "", - "fields": [ - { - "name": "discounts", - "description": "The final discount information for the product.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "eligible_for_return", - "description": "Indicates whether the order item is eligible to be in a return request.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "entered_options", - "description": "The entered option for the base product, such as a logo or image.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "OrderItemOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_message", - "description": "The selected gift message for the order item", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftMessage", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_wrapping", - "description": "The selected gift wrapping for the order item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "GiftWrapping", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for an `OrderItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price of the base product, including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_type", - "description": "The type of product, such as simple, configurable, etc.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_url_key", - "description": "URL key of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_canceled", - "description": "The number of canceled items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_invoiced", - "description": "The number of invoiced items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_ordered", - "description": "The number of units ordered for this item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_refunded", - "description": "The number of refunded items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_returned", - "description": "The number of returned items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_shipped", - "description": "The number of shipped items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "selected_options", - "description": "The selected options for the base product, such as color or size.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "OrderItemOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "The status of the order item.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "OrderItemOption", - "description": "Represents order item options like selected or entered.", - "fields": [ - { - "name": "label", - "description": "The name of the option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The value of the option.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "TaxItem", - "description": "Contains tax item details.", - "fields": [ - { - "name": "amount", - "description": "The amount of tax applied to the item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "rate", - "description": "The rate used to calculate the tax.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "A title that describes the tax.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Invoice", - "description": "Contains invoice details.", - "fields": [ - { - "name": "comments", - "description": "Comments on the invoice.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SalesCommentItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `Invoice` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "Invoiced product details.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "InvoiceItemInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "number", - "description": "Sequential invoice number.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total", - "description": "Invoice total amount details.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "InvoiceTotal", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "InvoiceItemInterface", - "description": "Contains detailes about invoiced items.", - "fields": [ - { - "name": "discounts", - "description": "Information about the final discount amount for the base product, including discounts on options.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for an `InvoiceItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "Details about an individual order item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price for the base product including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_invoiced", - "description": "The number of invoiced items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "DownloadableInvoiceItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleInvoiceItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardInvoiceItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "InvoiceItem", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "InvoiceItem", - "description": "", - "fields": [ - { - "name": "discounts", - "description": "Information about the final discount amount for the base product, including discounts on options.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for an `InvoiceItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "Details about an individual order item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price for the base product including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_invoiced", - "description": "The number of invoiced items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "InvoiceItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "InvoiceTotal", - "description": "Contains price details from an invoice.", - "fields": [ - { - "name": "base_grand_total", - "description": "The final base grand total amount in the base currency.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discounts", - "description": "The applied discounts to the invoice.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "grand_total", - "description": "The final total amount, including shipping, discounts, and taxes.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shipping_handling", - "description": "Details about the shipping and handling costs for the invoice.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ShippingHandling", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "subtotal", - "description": "The subtotal of the invoice, excluding shipping, discounts, and taxes.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "taxes", - "description": "The invoice tax details.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TaxItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_shipping", - "description": "The shipping amount for the invoice.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_tax", - "description": "The amount of tax applied to the invoice.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ShippingHandling", - "description": "Contains details about shipping and handling costs.", - "fields": [ - { - "name": "amount_excluding_tax", - "description": "The shipping amount, excluding tax.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "amount_including_tax", - "description": "The shipping amount, including tax.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discounts", - "description": "The applied discounts to the shipping.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ShippingDiscount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "taxes", - "description": "Details about taxes applied for shipping.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TaxItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_amount", - "description": "The total amount for shipping.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ShippingDiscount", - "description": "Defines an individual shipping discount. This discount can be applied to shipping.", - "fields": [ - { - "name": "amount", - "description": "The amount of the discount.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "OrderShipment", - "description": "Contains order shipment details.", - "fields": [ - { - "name": "comments", - "description": "Comments added to the shipment.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SalesCommentItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `OrderShipment` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "An array of items included in the shipment.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ShipmentItemInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "number", - "description": "The sequential credit shipment number.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "tracking", - "description": "An array of shipment tracking details.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ShipmentTracking", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SalesCommentItem", - "description": "Contains details about a comment.", - "fields": [ - { - "name": "message", - "description": "The text of the message.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "timestamp", - "description": "The timestamp of the comment.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "ShipmentItemInterface", - "description": "Order shipment item details.", - "fields": [ - { - "name": "id", - "description": "The unique ID for a `ShipmentItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "The order item associated with the shipment item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price for the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_shipped", - "description": "The number of shipped items.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "BundleShipmentItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardShipmentItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ShipmentItem", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "ShipmentItem", - "description": "", - "fields": [ - { - "name": "id", - "description": "The unique ID for a `ShipmentItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "The order item associated with the shipment item.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price for the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_shipped", - "description": "The number of shipped items.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ShipmentItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ShipmentTracking", - "description": "Contains order shipment tracking details.", - "fields": [ - { - "name": "carrier", - "description": "The shipping carrier for the order delivery.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "number", - "description": "The tracking number of the order shipment.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The shipment tracking title.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "OrderPaymentMethod", - "description": "Contains details about the payment method used to pay for the order.", - "fields": [ - { - "name": "additional_data", - "description": "Additional data per payment method type.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "KeyValue", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The label that describes the payment method.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "The payment method code that indicates how the order was paid for.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreditMemo", - "description": "Contains credit memo details.", - "fields": [ - { - "name": "comments", - "description": "Comments on the credit memo.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SalesCommentItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `CreditMemo` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "An array containing details about refunded items.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CreditMemoItemInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "number", - "description": "The sequential credit memo number.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total", - "description": "Details about the total refunded amount.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CreditMemoTotal", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "CreditMemoItemInterface", - "description": "Credit memo item details.", - "fields": [ - { - "name": "discounts", - "description": "Details about the final discount amount for the base product, including discounts on options.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `CreditMemoItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "The order item the credit memo is applied to.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price for the base product, including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_refunded", - "description": "The number of refunded items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "DownloadableCreditMemoItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "BundleCreditMemoItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "GiftCardCreditMemoItem", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CreditMemoItem", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "CreditMemoItem", - "description": "", - "fields": [ - { - "name": "discounts", - "description": "Details about the final discount amount for the base product, including discounts on options.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The unique ID for a `CreditMemoItemInterface` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "The order item the credit memo is applied to.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_name", - "description": "The name of the base product.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sale_price", - "description": "The sale price for the base product, including selected options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product_sku", - "description": "The SKU of the base product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity_refunded", - "description": "The number of refunded items.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CreditMemoItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreditMemoTotal", - "description": "Contains credit memo price details.", - "fields": [ - { - "name": "adjustment", - "description": "An adjustment manually applied to the order.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "base_grand_total", - "description": "The final base grand total amount in the base currency.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "discounts", - "description": "The applied discounts to the credit memo.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Discount", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "grand_total", - "description": "The final total amount, including shipping, discounts, and taxes.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shipping_handling", - "description": "Details about the shipping and handling costs for the credit memo.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ShippingHandling", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "subtotal", - "description": "The subtotal of the invoice, excluding shipping, discounts, and taxes.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "taxes", - "description": "The credit memo tax details.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "TaxItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_shipping", - "description": "The shipping amount for the credit memo.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_tax", - "description": "The amount of tax applied to the credit memo.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "KeyValue", - "description": "Contains a key-value pair.", - "fields": [ - { - "name": "name", - "description": "The name part of the key/value pair.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The value part of the key/value pair.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CheckoutUserInputErrorCodes", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "REORDER_NOT_AVAILABLE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PRODUCT_NOT_FOUND", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NOT_SALABLE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "INSUFFICIENT_STOCK", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNDEFINED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "ScopeTypeEnum", - "description": "This enumeration defines the scope type for customer orders.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "GLOBAL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "WEBSITE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "STORE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RequestNegotiableQuoteInput", - "description": "Defines properties of a negotiable quote request.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The cart ID of the buyer requesting a new negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "comment", - "description": "Comments the buyer entered to describe the request.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteCommentInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "is_draft", - "description": "Flag indicating if quote is draft or not.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "quote_name", - "description": "The name the buyer assigned to the negotiable quote request.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "UpdateNegotiableQuoteQuantitiesInput", - "description": "Specifies the items to update.", - "fields": null, - "inputFields": [ - { - "name": "items", - "description": "An array of items to update.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteItemQuantityInput", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "quote_uid", - "description": "The unique ID of a `NegotiableQuote` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteItemQuantityInput", - "description": "Specifies the updated quantity of an item.", - "fields": null, - "inputFields": [ - { - "name": "quantity", - "description": "The new quantity of the negotiable quote item.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "quote_item_uid", - "description": "The unique ID of a `CartItemInterface` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateNegotiableQuoteItemsQuantityOutput", - "description": "Contains the updated negotiable quote.", - "fields": [ - { - "name": "quote", - "description": "The updated negotiable quote.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuote", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PlaceNegotiableQuoteOrderInput", - "description": "Specifies the negotiable quote to convert to an order.", - "fields": null, - "inputFields": [ - { - "name": "quote_uid", - "description": "The unique ID of a `NegotiableQuote` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PlaceNegotiableQuoteOrderOutput", - "description": "An output object that returns the generated order.", - "fields": [ - { - "name": "order", - "description": "Contains the generated order number.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Order", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SendNegotiableQuoteForReviewInput", - "description": "Specifies which negotiable quote to send for review.", - "fields": null, - "inputFields": [ - { - "name": "comment", - "description": "A comment for the seller to review.", - "type": { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteCommentInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "quote_uid", - "description": "The unique ID of a `NegotiableQuote` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SendNegotiableQuoteForReviewOutput", - "description": "Contains the negotiable quote.", - "fields": [ - { - "name": "quote", - "description": "The negotiable quote after sending for seller review.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuote", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SetNegotiableQuoteShippingAddressInput", - "description": "Defines the shipping address to assign to the negotiable quote.", - "fields": null, - "inputFields": [ - { - "name": "customer_address_id", - "description": "The unique ID of a `CustomerAddress` object.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "quote_uid", - "description": "The unique ID of a `NegotiableQuote` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "shipping_addresses", - "description": "An array of shipping addresses to apply to the negotiable quote.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteShippingAddressInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteShippingAddressInput", - "description": "Defines shipping addresses for the negotiable quote.", - "fields": null, - "inputFields": [ - { - "name": "address", - "description": "A shipping address.", - "type": { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteAddressInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "customer_address_uid", - "description": "An ID from the company user's address book that uniquely identifies the address to be used for shipping.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "customer_notes", - "description": "Text provided by the company user.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SetNegotiableQuoteBillingAddressInput", - "description": "Sets the billing address.", - "fields": null, - "inputFields": [ - { - "name": "billing_address", - "description": "The billing address to be added.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteBillingAddressInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "quote_uid", - "description": "The unique ID of a `NegotiableQuote` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteBillingAddressInput", - "description": "Defines the billing address.", - "fields": null, - "inputFields": [ - { - "name": "address", - "description": "Defines a billing address.", - "type": { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteAddressInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "customer_address_uid", - "description": "The unique ID of a `CustomerAddress` object.", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "same_as_shipping", - "description": "Indicates whether to set the billing address to be the same as the existing shipping address on the negotiable quote.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "use_for_shipping", - "description": "Indicates whether to set the shipping address to be the same as this billing address.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteAddressInput", - "description": "Defines the billing or shipping address to be applied to the cart.", - "fields": null, - "inputFields": [ - { - "name": "city", - "description": "The city specified for the billing or shipping address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "company", - "description": "The company name.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "country_code", - "description": "The country code and label for the billing or shipping address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "firstname", - "description": "The first name of the company user.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "lastname", - "description": "The last name of the company user.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "postcode", - "description": "The ZIP or postal code of the billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "region", - "description": "A string that defines the state or province of the billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "region_id", - "description": "An integer that defines the state or province of the billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "save_in_address_book", - "description": "Determines whether to save the address in the customer's address book. The default value is true.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "street", - "description": "An array containing the street for the billing or shipping address.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "telephone", - "description": "The telephone number for the billing or shipping address.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SetNegotiableQuoteShippingMethodsInput", - "description": "Defines the shipping method to apply to the negotiable quote.", - "fields": null, - "inputFields": [ - { - "name": "quote_uid", - "description": "The unique ID of a `NegotiableQuote` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "shipping_methods", - "description": "An array of shipping methods to apply to the negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "ShippingMethodInput", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "LineItemNoteInput", - "description": "Sets quote item note.", - "fields": null, - "inputFields": [ - { - "name": "note", - "description": "The note text to be added.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "quote_item_uid", - "description": "The unique ID of a `CartLineItem` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "quote_uid", - "description": "The unique ID of a `NegotiableQuote` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RenameNegotiableQuoteInput", - "description": "Sets new name for a negotiable quote.", - "fields": null, - "inputFields": [ - { - "name": "quote_comment", - "description": "The reason for the quote name change specified by the buyer.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "quote_name", - "description": "The new quote name the buyer specified to the negotiable quote request.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "quote_uid", - "description": "The cart ID of the buyer requesting a new negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SetLineItemNoteOutput", - "description": "Contains the updated negotiable quote.", - "fields": [ - { - "name": "quote", - "description": "The negotiable quote after sending for seller review.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuote", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SetNegotiableQuoteShippingMethodsOutput", - "description": "Contains the negotiable quote.", - "fields": [ - { - "name": "quote", - "description": "The negotiable quote after applying shipping methods.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuote", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SetNegotiableQuoteShippingAddressOutput", - "description": "Contains the negotiable quote.", - "fields": [ - { - "name": "quote", - "description": "The negotiable quote after assigning a shipping address.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuote", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SetNegotiableQuoteBillingAddressOutput", - "description": "Contains the negotiable quote.", - "fields": [ - { - "name": "quote", - "description": "The negotiable quote after assigning a billing address.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuote", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RemoveNegotiableQuoteItemsInput", - "description": "Defines the items to remove from the specified negotiable quote.", - "fields": null, - "inputFields": [ - { - "name": "quote_item_uids", - "description": "An array of IDs indicating which items to remove from the negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "quote_uid", - "description": "The unique ID of a `NegotiableQuote` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RemoveNegotiableQuoteItemsOutput", - "description": "Contains the negotiable quote.", - "fields": [ - { - "name": "quote", - "description": "The negotiable quote after removing items.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuote", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CloseNegotiableQuotesInput", - "description": "Defines the negotiable quotes to mark as closed.", - "fields": null, - "inputFields": [ - { - "name": "quote_uids", - "description": "A list of unique IDs from `NegotiableQuote` objects.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CloseNegotiableQuotesOutput", - "description": "Contains the closed negotiable quotes and other negotiable quotes the company user can view.", - "fields": [ - { - "name": "closed_quotes", - "description": "An array containing the negotiable quotes that were just closed.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "NegotiableQuote", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use `operation_results` instead." - }, - { - "name": "negotiable_quotes", - "description": "A list of negotiable quotes that can be viewed by the logged-in customer", - "args": [ - { - "name": "filter", - "description": "The filter to use to determine which negotiable quotes to close.", - "type": { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "sort", - "description": "The field to use for sorting results.", - "type": { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteSortInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuotesOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "operation_results", - "description": "An array of closed negotiable quote UIDs and details about any errors.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "UNION", - "name": "CloseNegotiableQuoteOperationResult", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "result_status", - "description": "The status of the request to close one or more negotiable quotes.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "BatchMutationStatus", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RenameNegotiableQuoteOutput", - "description": "Contains the updated negotiable quote.", - "fields": [ - { - "name": "quote", - "description": "The negotiable quote after updating the name.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuote", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "UNION", - "name": "CloseNegotiableQuoteOperationResult", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "NegotiableQuoteUidOperationSuccess", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "CloseNegotiableQuoteOperationFailure", - "ofType": null - } - ] - }, - { - "kind": "UNION", - "name": "CloseNegotiableQuoteError", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "NegotiableQuoteInvalidStateError", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "NoSuchEntityUidError", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "InternalError", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "DeleteNegotiableQuotesOutput", - "description": "Contains a list of undeleted negotiable quotes the company user can view.", - "fields": [ - { - "name": "negotiable_quotes", - "description": "A list of negotiable quotes that the customer can view", - "args": [ - { - "name": "filter", - "description": "The filter to use to determine which negotiable quotes to delete.", - "type": { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteFilterInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "pageSize", - "description": "The maximum number of results to return at once. The default value is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "The page of results to return. The default value is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - }, - { - "name": "sort", - "description": "The field to use for sorting results.", - "type": { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteSortInput", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuotesOutput", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "operation_results", - "description": "An array of deleted negotiable quote UIDs and details about any errors.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "UNION", - "name": "DeleteNegotiableQuoteOperationResult", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "result_status", - "description": "The status of the request to delete one or more negotiable quotes.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "BatchMutationStatus", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "UNION", - "name": "DeleteNegotiableQuoteOperationResult", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "NegotiableQuoteUidOperationSuccess", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "DeleteNegotiableQuoteOperationFailure", - "ofType": null - } - ] - }, - { - "kind": "UNION", - "name": "DeleteNegotiableQuoteError", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "NegotiableQuoteInvalidStateError", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "NoSuchEntityUidError", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "InternalError", - "ofType": null - } - ] - }, - { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuotePaymentMethodInput", - "description": "Defines the payment method to be applied to the negotiable quote.", - "fields": null, - "inputFields": [ - { - "name": "code", - "description": "Payment method code", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "purchase_order_number", - "description": "The purchase order number. Optional for most payment methods.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SetNegotiableQuotePaymentMethodOutput", - "description": "Contains details about the negotiable quote after setting the payment method.", - "fields": [ - { - "name": "quote", - "description": "The updated negotiable quote.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuote", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuotesOutput", - "description": "Contains a list of negotiable that match the specified filter.", - "fields": [ - { - "name": "items", - "description": "A list of negotiable quotes", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "NegotiableQuote", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Contains pagination metadata", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_fields", - "description": "Contains the default sort field and all available sort fields.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SortFields", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The number of negotiable quotes returned", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteSortInput", - "description": "Defines the field to use to sort a list of negotiable quotes.", - "fields": null, - "inputFields": [ - { - "name": "sort_direction", - "description": "Whether to return results in ascending or descending order.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "SortEnum", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "sort_field", - "description": "The specified sort field.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "NegotiableQuoteSortableField", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "NegotiableQuoteSortableField", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "QUOTE_NAME", - "description": "Sorts negotiable quotes by name.", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CREATED_AT", - "description": "Sorts negotiable quotes by the dates they were created.", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UPDATED_AT", - "description": "Sorts negotiable quotes by the dates they were last modified.", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteCommentInput", - "description": "Contains the commend provided by the buyer.", - "fields": null, - "inputFields": [ - { - "name": "comment", - "description": "The comment provided by the buyer.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteComment", - "description": "Contains a single plain text comment from either the buyer or seller.", - "fields": [ - { - "name": "author", - "description": "The first and last name of the commenter.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "NegotiableQuoteUser", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "Timestamp indicating when the comment was created.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "creator_type", - "description": "Indicates whether a buyer or seller commented.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "NegotiableQuoteCommentCreatorType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "text", - "description": "The plain text comment.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID of a `NegotiableQuoteComment` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "NegotiableQuoteCommentCreatorType", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "BUYER", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SELLER", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuote", - "description": "Contains details about a negotiable quote.", - "fields": [ - { - "name": "available_payment_methods", - "description": "An array of payment methods that can be applied to the negotiable quote.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AvailablePaymentMethod", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "billing_address", - "description": "The billing address applied to the negotiable quote.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuoteBillingAddress", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "buyer", - "description": "The first and last name of the buyer.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "NegotiableQuoteUser", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "comments", - "description": "A list of comments made by the buyer and seller.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "NegotiableQuoteComment", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "Timestamp indicating when the negotiable quote was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "email", - "description": "The email address of the company user.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "history", - "description": "A list of status and price changes for the negotiable quote.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryEntry", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_virtual", - "description": "Indicates whether the negotiable quote contains only virtual products.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "The list of items in the negotiable quote.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CartItemInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The title assigned to the negotiable quote.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "prices", - "description": "A set of subtotals and totals applied to the negotiable quote.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CartPrices", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "selected_payment_method", - "description": "The payment method that was applied to the negotiable quote.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SelectedPaymentMethod", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shipping_addresses", - "description": "A list of shipping addresses applied to the negotiable quote.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "NegotiableQuoteShippingAddress", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "The status of the negotiable quote.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "NegotiableQuoteStatus", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_quantity", - "description": "The total number of items in the negotiable quote.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID of a `NegotiableQuote` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "Timestamp indicating when the negotiable quote was updated.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "NegotiableQuoteStatus", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "SUBMITTED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PENDING", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UPDATED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "OPEN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ORDERED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CLOSED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DECLINED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "EXPIRED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuoteFilterInput", - "description": "Defines a filter to limit the negotiable quotes to return.", - "fields": null, - "inputFields": [ - { - "name": "ids", - "description": "Filter by the ID of one or more negotiable quotes.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterEqualTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "name", - "description": "Filter by the negotiable quote name.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterMatchTypeInput", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryEntry", - "description": "Contains details about a change for a negotiable quote.", - "fields": [ - { - "name": "author", - "description": "The person who made a change in the status of the negotiable quote.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "NegotiableQuoteUser", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "change_type", - "description": "An enum that describes the why the entry in the negotiable quote history changed status.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "NegotiableQuoteHistoryEntryChangeType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "changes", - "description": "The set of changes in the negotiable quote.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryChanges", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "Timestamp indicating when the negotiable quote entry was created.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID of a `NegotiableQuoteHistoryEntry` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryChanges", - "description": "Contains a list of changes to a negotiable quote.", - "fields": [ - { - "name": "comment_added", - "description": "The comment provided with a change in the negotiable quote history.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryCommentChange", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_changes", - "description": "Lists log entries added by third-party extensions.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuoteCustomLogChange", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "expiration", - "description": "The expiration date of the negotiable quote before and after a change in the quote history.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryExpirationChange", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "products_removed", - "description": "Lists products that were removed as a result of a change in the quote history.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryProductsRemovedChange", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "statuses", - "description": "The status before and after a change in the negotiable quote history.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryStatusesChange", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total", - "description": "The total amount of the negotiable quote before and after a change in the quote history.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryTotalChange", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryStatusChange", - "description": "Lists a new status change applied to a negotiable quote and the previous status.", - "fields": [ - { - "name": "new_status", - "description": "The updated status.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "NegotiableQuoteStatus", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "old_status", - "description": "The previous status. The value will be null for the first history entry in a negotiable quote.", - "args": [], - "type": { - "kind": "ENUM", - "name": "NegotiableQuoteStatus", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryStatusesChange", - "description": "Contains a list of status changes that occurred for the negotiable quote.", - "fields": [ - { - "name": "changes", - "description": "A list of status changes.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryStatusChange", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryCommentChange", - "description": "Contains a comment submitted by a seller or buyer.", - "fields": [ - { - "name": "comment", - "description": "A plain text comment submitted by a seller or buyer.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryTotalChange", - "description": "Contains a new price and the previous price.", - "fields": [ - { - "name": "new_price", - "description": "The total price as a result of the change.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "old_price", - "description": "The previous total price on the negotiable quote.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryExpirationChange", - "description": "Contains a new expiration date and the previous date.", - "fields": [ - { - "name": "new_expiration", - "description": "The expiration date after the change. The value will be 'null' if not set.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "old_expiration", - "description": "The previous expiration date. The value will be 'null' if not previously set.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteHistoryProductsRemovedChange", - "description": "Contains lists of products that have been removed from the catalog and negotiable quote.", - "fields": [ - { - "name": "products_removed_from_catalog", - "description": "A list of product IDs the seller removed from the catalog.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "products_removed_from_quote", - "description": "A list of products removed from the negotiable quote by either the buyer or the seller.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteCustomLogChange", - "description": "Contains custom log entries added by third-party extensions.", - "fields": [ - { - "name": "new_value", - "description": "The new entry content.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "old_value", - "description": "The previous entry in the custom log.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The title of the custom log entry.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "NegotiableQuoteHistoryEntryChangeType", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "CREATED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UPDATED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CLOSED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UPDATED_BY_SYSTEM", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RequestNegotiableQuoteOutput", - "description": "Contains the `NegotiableQuote` object generated when a buyer requests a negotiable quote.", - "fields": [ - { - "name": "quote", - "description": "Details about the negotiable quote.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuote", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "NegotiableQuoteAddressInterface", - "description": "", - "fields": [ - { - "name": "city", - "description": "The company's city or town.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "company", - "description": "The company name associated with the shipping/billing address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country", - "description": "The company's country.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "NegotiableQuoteAddressCountry", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "firstname", - "description": "The first name of the company user.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "lastname", - "description": "The last name of the company user.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "postcode", - "description": "The company's ZIP or postal code.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region", - "description": "An object containing the region name, region code, and region ID.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuoteAddressRegion", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "street", - "description": "An array of strings that define the street number and name.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "telephone", - "description": "The customer's telephone number.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "NegotiableQuoteShippingAddress", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteBillingAddress", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteAddressRegion", - "description": "Defines the company's state or province.", - "fields": [ - { - "name": "code", - "description": "The address region code.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display name of the region.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region_id", - "description": "The unique ID for a pre-defined region.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteAddressCountry", - "description": "Defines the company's country.", - "fields": [ - { - "name": "code", - "description": "The address country code.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display name of the region.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteShippingAddress", - "description": "", - "fields": [ - { - "name": "available_shipping_methods", - "description": "An array of shipping methods available to the buyer.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AvailableShippingMethod", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "city", - "description": "The company's city or town.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "company", - "description": "The company name associated with the shipping/billing address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country", - "description": "The company's country.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "NegotiableQuoteAddressCountry", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "firstname", - "description": "The first name of the company user.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "lastname", - "description": "The last name of the company user.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "postcode", - "description": "The company's ZIP or postal code.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region", - "description": "An object containing the region name, region code, and region ID.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuoteAddressRegion", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "selected_shipping_method", - "description": "The selected shipping method.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SelectedShippingMethod", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "street", - "description": "An array of strings that define the street number and name.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "telephone", - "description": "The customer's telephone number.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "NegotiableQuoteAddressInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteBillingAddress", - "description": "", - "fields": [ - { - "name": "city", - "description": "The company's city or town.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "company", - "description": "The company name associated with the shipping/billing address.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country", - "description": "The company's country.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "NegotiableQuoteAddressCountry", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "firstname", - "description": "The first name of the company user.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "lastname", - "description": "The last name of the company user.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "postcode", - "description": "The company's ZIP or postal code.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region", - "description": "An object containing the region name, region code, and region ID.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "NegotiableQuoteAddressRegion", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "street", - "description": "An array of strings that define the street number and name.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "telephone", - "description": "The customer's telephone number.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "NegotiableQuoteAddressInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteUser", - "description": "A limited view of a Buyer or Seller in the negotiable quote process.", - "fields": [ - { - "name": "firstname", - "description": "The first name of the buyer or seller making a change.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "lastname", - "description": "The buyer's or seller's last name.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "NegotiableQuoteUidNonFatalResultInterface", - "description": "", - "fields": [ - { - "name": "quote_uid", - "description": "The unique ID of a `NegotiableQuote` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "NegotiableQuoteUidOperationSuccess", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteUidOperationSuccess", - "description": "Contains details about a successful operation on a negotiable quote.", - "fields": [ - { - "name": "quote_uid", - "description": "The unique ID of a `NegotiableQuote` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "NegotiableQuoteUidNonFatalResultInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "NegotiableQuoteInvalidStateError", - "description": "An error indicating that an operation was attempted on a negotiable quote in an invalid state.", - "fields": [ - { - "name": "message", - "description": "The returned error message.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "ErrorInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ItemNote", - "description": "The note object for quote line item.", - "fields": [ - { - "name": "created_at", - "description": "Timestamp that reflects note creation date.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "creator_id", - "description": "ID of the user who submitted a note.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "creator_type", - "description": "Type of teh user who submitted a note.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "negotiable_quote_item_uid", - "description": "The unique ID of a `CartItemInterface` object.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note", - "description": "Note text.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "note_uid", - "description": "The unique ID of a `ItemNote` object.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CloseNegotiableQuoteOperationFailure", - "description": "Contains details about a failed close operation on a negotiable quote.", - "fields": [ - { - "name": "errors", - "description": "An array of errors encountered while attempting close the negotiable quote.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "UNION", - "name": "CloseNegotiableQuoteError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quote_uid", - "description": "The unique ID of a `NegotiableQuote` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "DeleteNegotiableQuotesInput", - "description": "", - "fields": null, - "inputFields": [ - { - "name": "quote_uids", - "description": "A list of unique IDs for `NegotiableQuote` objects to delete.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeleteNegotiableQuoteOperationFailure", - "description": "Contains details about a failed delete operation on a negotiable quote.", - "fields": [ - { - "name": "errors", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "UNION", - "name": "DeleteNegotiableQuoteError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quote_uid", - "description": "The unique ID of a `NegotiableQuote` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SetNegotiableQuotePaymentMethodInput", - "description": "Defines the payment method of the specified negotiable quote.", - "fields": null, - "inputFields": [ - { - "name": "payment_method", - "description": "The payment method to be assigned to the negotiable quote.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "NegotiableQuotePaymentMethodInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "quote_uid", - "description": "The unique ID of a `NegotiableQuote` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyCreditHistory", - "description": "Contains details about prior company credit operations.", - "fields": [ - { - "name": "items", - "description": "An array of company credit operations.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyCreditOperation", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Metadata for pagination rendering.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The number of the company credit operations matching the specified filter.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyCreditOperation", - "description": "Contains details about a single company credit operation.", - "fields": [ - { - "name": "amount", - "description": "The amount of the company credit operation.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "balance", - "description": "The credit balance as a result of the operation.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyCredit", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "custom_reference_number", - "description": "The purchase order number associated with the company credit operation.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "date", - "description": "The date the operation occurred.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "The type of the company credit operation.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CompanyCreditOperationType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_by", - "description": "The company user that submitted the company credit operation.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyCreditOperationUser", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyCreditOperationUser", - "description": "Defines the administrator or company user that submitted a company credit operation.", - "fields": [ - { - "name": "name", - "description": "The name of the company user submitting the company credit operation.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "The type of the company user submitting the company credit operation.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CompanyCreditOperationUserType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CompanyCredit", - "description": "Contains company credit balances and limits.", - "fields": [ - { - "name": "available_credit", - "description": "The sum of the credit limit and the outstanding balance. If the company has exceeded the credit limit, the amount is as a negative value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "credit_limit", - "description": "The amount of credit extended to the company.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "outstanding_balance", - "description": "The amount reimbursed, less the total due from all orders placed using the Payment on Account payment method. The amount can be a positive or negative value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CompanyCreditOperationType", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "ALLOCATION", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UPDATE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PURCHASE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "REIMBURSEMENT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "REFUND", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "REVERT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "CompanyCreditOperationUserType", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "CUSTOMER", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ADMIN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CompanyCreditHistoryFilterInput", - "description": "Defines a filter for narrowing the results of a credit history search.", - "fields": null, - "inputFields": [ - { - "name": "custom_reference_number", - "description": "The purchase order number associated with the company credit operation.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "operation_type", - "description": "The type of the company credit operation.", - "type": { - "kind": "ENUM", - "name": "CompanyCreditOperationType", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "updated_by", - "description": "The name of the person submitting the company credit operation.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SubscribeEmailToNewsletterOutput", - "description": "Contains the result of the `subscribeEmailToNewsletter` operation.", - "fields": [ - { - "name": "status", - "description": "The status of the subscription request.", - "args": [], - "type": { - "kind": "ENUM", - "name": "SubscriptionStatusesEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "SubscriptionStatusesEnum", - "description": "Indicates the status of the request.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "NOT_ACTIVE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SUBSCRIBED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNSUBSCRIBED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNCONFIRMED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CancellationReason", - "description": "", - "fields": [ - { - "name": "description", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CancelOrderInput", - "description": "Defines the order to cancel.", - "fields": null, - "inputFields": [ - { - "name": "order_id", - "description": "Order ID.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "reason", - "description": "Cancellation reason.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CancelOrderOutput", - "description": "Contains the updated customer order and error message if any.", - "fields": [ - { - "name": "error", - "description": "Error encountered while cancelling the order.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order", - "description": "Updated customer order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomerOrder", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "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": "" - }, - { - "name": "CART_PRICE_RULE_RELATED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CATALOG_PRICE_RULE_RELATED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "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": "" - }, - { - "name": "HEADER", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FOOTER", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LEFT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "RIGHT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GetPaymentSDKOutput", - "description": "Gets the payment SDK URLs and values", - "fields": [ - { - "name": "sdkParams", - "description": "The payment SDK parameters", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PaymentSDKParamsItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PaymentSDKParamsItem", - "description": "", - "fields": [ - { - "name": "code", - "description": "The payment method code used in the order", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "params", - "description": "The payment SDK parameters", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SDKParams", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PaymentOrderOutput", - "description": "Contains the payment order details", - "fields": [ - { - "name": "id", - "description": "PayPal order ID", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "mp_order_id", - "description": "The order ID generated by Payment Services", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "payment_source_details", - "description": "Details about the card used on the order", - "args": [], - "type": { - "kind": "OBJECT", - "name": "PaymentSourceDetails", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "The status of the payment order", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PaymentSourceDetails", - "description": "", - "fields": [ - { - "name": "card", - "description": "Details about the card used on the order", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Card", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Card", - "description": "", - "fields": [ - { - "name": "bin_details", - "description": "Card bin details", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CardBin", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "card_expiry_month", - "description": "Expiration month of the card", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "card_expiry_year", - "description": "Expiration year of the card", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "last_digits", - "description": "Last four digits of the card", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "Name on the card", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CardBin", - "description": "", - "fields": [ - { - "name": "bin", - "description": "Card bin number", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CreatePaymentOrderInput", - "description": "Contains payment order details that are used while processing the payment order", - "fields": null, - "inputFields": [ - { - "name": "cartId", - "description": "The customer cart ID", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "location", - "description": "Defines the origin location for that payment request", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "PaymentLocation", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "methodCode", - "description": "The code for the payment method used in the order", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "paymentSource", - "description": "The identifiable payment source for the payment method", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "vaultIntent", - "description": "Indicates whether the payment information should be vaulted", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SyncPaymentOrderInput", - "description": "Synchronizes the payment order details", - "fields": null, - "inputFields": [ - { - "name": "cartId", - "description": "The customer cart ID", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "id", - "description": "PayPal order ID", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreatePaymentOrderOutput", - "description": "Contains payment order details that are used while processing the payment order", - "fields": [ - { - "name": "id", - "description": "PayPal order ID", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "mp_order_id", - "description": "The order ID generated by Payment Services", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "The status of the payment order", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PaymentLocation", - "description": "Defines the origin location for that payment request", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "PRODUCT_DETAIL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MINICART", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CART", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CHECKOUT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ADMIN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PaymentConfigOutput", - "description": "Retrieves the payment configuration for a given location", - "fields": [ - { - "name": "apple_pay", - "description": "ApplePay payment method configuration", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ApplePayConfig", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "hosted_fields", - "description": "Hosted fields payment method configuration", - "args": [], - "type": { - "kind": "OBJECT", - "name": "HostedFieldsConfig", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "smart_buttons", - "description": "Smart Buttons payment method configuration", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SmartButtonsConfig", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "PaymentConfigItem", - "description": "Contains payment fields that are common to all types of payment methods.", - "fields": [ - { - "name": "code", - "description": "The payment method code as defined in the payment gateway", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_visible", - "description": "Indicates whether the payment method is displayed", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "payment_intent", - "description": "Defines the payment intent (Authorize or Capture", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sdk_params", - "description": "The PayPal parameters required to load the JS SDK", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SDKParams", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The relative order the payment method is displayed on the checkout page", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The name displayed for the payment method", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "PaymentCommonConfig", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "HostedFieldsConfig", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "SmartButtonsConfig", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ApplePayConfig", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "PaymentCommonConfig", - "description": "", - "fields": [ - { - "name": "code", - "description": "The payment method code as defined in the payment gateway", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_visible", - "description": "Indicates whether the payment method is displayed", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "payment_intent", - "description": "Defines the payment intent (Authorize or Capture", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sdk_params", - "description": "The PayPal parameters required to load the JS SDK", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SDKParams", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The relative order the payment method is displayed on the checkout page", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The name displayed for the payment method", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "PaymentConfigItem", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "HostedFieldsConfig", - "description": "", - "fields": [ - { - "name": "cc_vault_code", - "description": "Vault payment method code", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "code", - "description": "The payment method code as defined in the payment gateway", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_vault_enabled", - "description": "Card vault enabled", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_visible", - "description": "Indicates whether the payment method is displayed", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "payment_intent", - "description": "Defines the payment intent (Authorize or Capture", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "payment_source", - "description": "The payment source for the payment method", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "requires_card_details", - "description": "Card and bin details required", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sdk_params", - "description": "The PayPal parameters required to load the JS SDK", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SDKParams", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The relative order the payment method is displayed on the checkout page", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "three_ds", - "description": "3DS mode", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "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": "SmartButtonsConfig", - "description": "", - "fields": [ - { - "name": "button_styles", - "description": "The styles for the PayPal Smart Button configuration", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ButtonStyles", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "code", - "description": "The payment method code as defined in the payment gateway", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "display_message", - "description": "Indicates whether to display the PayPal Pay Later message", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "display_venmo", - "description": "Indicates whether to display Venmo", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_visible", - "description": "Indicates whether the payment method is displayed", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "message_styles", - "description": "Contains details about the styles for the PayPal Pay Later message", - "args": [], - "type": { - "kind": "OBJECT", - "name": "MessageStyles", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "payment_intent", - "description": "Defines the payment intent (Authorize or Capture", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sdk_params", - "description": "The PayPal parameters required to load the JS SDK", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SDKParams", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The relative order the payment method is displayed on the checkout page", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The name displayed for the payment method", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "PaymentConfigItem", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ApplePayConfig", - "description": "", - "fields": [ - { - "name": "button_styles", - "description": "The styles for the ApplePay Smart Button configuration", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ButtonStyles", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "code", - "description": "The payment method code as defined in the payment gateway", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_visible", - "description": "Indicates whether the payment method is displayed", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "payment_intent", - "description": "Defines the payment intent (Authorize or Capture", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "payment_source", - "description": "The payment source for the payment method", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sdk_params", - "description": "The PayPal parameters required to load the JS SDK", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SDKParams", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The relative order the payment method is displayed on the checkout page", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "title", - "description": "The name displayed for the payment method", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "PaymentConfigItem", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ButtonStyles", - "description": "", - "fields": [ - { - "name": "color", - "description": "Color option", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "height", - "description": "Button height", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "Button label", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "layout", - "description": "Determines the button layout", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shape", - "description": "Shape option", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "tagline", - "description": "Indicates whether to display the tagline", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "use_default_height", - "description": "If false, the button height will be used", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "MessageStyles", - "description": "", - "fields": [ - { - "name": "layout", - "description": "Determines the Pay Later message layout", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "logo", - "description": "The preferences for the Message logo", - "args": [], - "type": { - "kind": "OBJECT", - "name": "MessageStyleLogo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "MessageStyleLogo", - "description": "", - "fields": [ - { - "name": "type", - "description": "The type of logo for the PayPal Pay Later messaging", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SDKParams", - "description": "Defines the name and value of a SDK parameter", - "fields": [ - { - "name": "name", - "description": "The name of a SDK parameter", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The value of a SDK parameter", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "VaultMethodInput", - "description": "Vault payment inputs", - "fields": null, - "inputFields": [ - { - "name": "payment_source", - "description": "The payment source for the payment method", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "payments_order_id", - "description": "The payment services order ID", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "paypal_order_id", - "description": "PayPal order ID", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "public_hash", - "description": "The public hash of the token.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SmartButtonMethodInput", - "description": "Smart button payment inputs", - "fields": null, - "inputFields": [ - { - "name": "payment_source", - "description": "The payment source for the payment method", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "payments_order_id", - "description": "The payment services order ID", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "paypal_order_id", - "description": "PayPal order ID", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ApplePayMethodInput", - "description": "Apple Pay inputs", - "fields": null, - "inputFields": [ - { - "name": "payment_source", - "description": "The payment source for the payment method", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "payments_order_id", - "description": "The payment services order ID", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "paypal_order_id", - "description": "PayPal order ID", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "HostedFieldsInput", - "description": "Hosted Fields payment inputs", - "fields": null, - "inputFields": [ - { - "name": "cardBin", - "description": "Card bin number", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "cardExpiryMonth", - "description": "Expiration month of the card", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "cardExpiryYear", - "description": "Expiration year of the card", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "cardLast4", - "description": "Last four digits of the card", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "holderName", - "description": "Name on the card", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_active_payment_token_enabler", - "description": "Indicates whether details about the shopper's credit/debit card should be tokenized for later usage. Required only if Vault is enabled for the Payment Services payment integration.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "payment_source", - "description": "The payment source for the payment method", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "payments_order_id", - "description": "The payment services order ID", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "paypal_order_id", - "description": "PayPal order ID", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PaypalExpressTokenInput", - "description": "Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID that identifies the customer's cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "code", - "description": "The payment method code.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "express_button", - "description": "Indicates whether the buyer selected the quick checkout button. The default value is false.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "urls", - "description": "A set of relative URLs that PayPal uses in response to various actions during the authorization process.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PaypalExpressUrlsInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "use_paypal_credit", - "description": "Indicates whether the buyer clicked the PayPal credit button. The default value is false.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PaypalExpressToken", - "description": "Deprecated. Use `PaypalExpressTokenOutput` instead.", - "fields": [ - { - "name": "paypal_urls", - "description": "A set of URLs that allow the buyer to authorize payment and adjust checkout details.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "PaypalExpressUrlList", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `PaypalExpressTokenOutput.paypal_urls` instead." - }, - { - "name": "token", - "description": "The token returned by PayPal.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `PaypalExpressTokenOutput.token` instead." - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PaypalExpressTokenOutput", - "description": "Contains the token returned by PayPal and a set of URLs that allow the buyer to authorize payment and adjust checkout details. Applies to Express Checkout and Payments Standard payment methods.", - "fields": [ - { - "name": "paypal_urls", - "description": "A set of URLs that allow the buyer to authorize payment and adjust checkout details.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "PaypalExpressUrlList", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "token", - "description": "The token returned by PayPal.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PayflowLinkToken", - "description": "Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods.", - "fields": [ - { - "name": "mode", - "description": "The mode for the Payflow transaction.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PayflowLinkMode", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "paypal_url", - "description": "The PayPal URL used for requesting a Payflow form.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "secure_token", - "description": "The secure token generated by PayPal.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "secure_token_id", - "description": "The secure token ID generated by PayPal.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "HostedProUrl", - "description": "Contains the secure URL used for the Payments Pro Hosted Solution payment method.", - "fields": [ - { - "name": "secure_form_url", - "description": "The secure URL generated by PayPal.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "HostedProUrlInput", - "description": "Contains the required input to request the secure URL for Payments Pro Hosted Solution payment.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID that identifies the shopper's cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "HostedProInput", - "description": "Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payments Pro Hosted Solution payment method.", - "fields": null, - "inputFields": [ - { - "name": "cancel_url", - "description": "The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. For example, if the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "return_url", - "description": "The relative URL of the final confirmation page that PayPal redirects to upon payment success. For example, if the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PaypalExpressInput", - "description": "Contains required input for Express Checkout and Payments Standard payments.", - "fields": null, - "inputFields": [ - { - "name": "payer_id", - "description": "The unique ID of the PayPal user.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "token", - "description": "The token returned by the `createPaypalExpressToken` mutation.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PayflowExpressInput", - "description": "Contains required input for Payflow Express Checkout payments.", - "fields": null, - "inputFields": [ - { - "name": "payer_id", - "description": "The unique ID of the PayPal user.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "token", - "description": "The token returned by the createPaypalExpressToken mutation.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PaypalExpressUrlsInput", - "description": "Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Express Checkout and Payments Standard payment methods.", - "fields": null, - "inputFields": [ - { - "name": "cancel_url", - "description": "The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "pending_url", - "description": "The relative URL of the page that PayPal redirects to when the payment has been put on hold for additional review. This condition mostly applies to ACH transactions, and is not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success_pending.html, the relative URL is paypal/action/success_pending.html.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "return_url", - "description": "The relative URL of the final confirmation page that PayPal redirects to upon payment success. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "success_url", - "description": "The relative URL of the order confirmation page that PayPal redirects to when the payment is successful and additional confirmation is not needed. Not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success.html, the relative URL is paypal/action/success.html.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PaypalExpressUrlList", - "description": "Contains a set of URLs that allow the buyer to authorize payment and adjust checkout details for Express Checkout and Payments Standard transactions.", - "fields": [ - { - "name": "edit", - "description": "The PayPal URL that allows the buyer to edit their checkout details.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "start", - "description": "The URL to the PayPal login page.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PayflowLinkInput", - "description": "A set of relative URLs that PayPal uses in response to various actions during the authorization process. Adobe Commerce prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payflow Link and Payments Advanced payment methods.", - "fields": null, - "inputFields": [ - { - "name": "cancel_url", - "description": "The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "error_url", - "description": "The relative URL of the transaction error page that PayPal redirects to upon payment error. If the full URL to this page is https://www.example.com/paypal/action/error.html, the relative URL is paypal/action/error.html.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "return_url", - "description": "The relative URL of the order confirmation page that PayPal redirects to when the payment is successful and additional confirmation is not needed. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PayflowLinkTokenInput", - "description": "Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID that identifies the customer's cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PayflowLinkMode", - "description": "Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "TEST", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LIVE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PayflowProTokenInput", - "description": "Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID that identifies the shopper's cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "urls", - "description": "A set of relative URLs that PayPal uses for callback.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "PayflowProUrlInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PayflowProInput", - "description": "Contains input for the Payflow Pro and Payments Pro payment methods.", - "fields": null, - "inputFields": [ - { - "name": "cc_details", - "description": "Required input for credit card related information.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CreditCardDetailsInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "is_active_payment_token_enabler", - "description": "Indicates whether details about the shopper's credit/debit card should be tokenized for later usage. Required only if Vault is enabled for the PayPal Payflow Pro payment integration.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CreditCardDetailsInput", - "description": "Required fields for Payflow Pro and Payments Pro credit card payments.", - "fields": null, - "inputFields": [ - { - "name": "cc_exp_month", - "description": "The credit card expiration month.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cc_exp_year", - "description": "The credit card expiration year.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cc_last_4", - "description": "The last 4 digits of the credit card.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "cc_type", - "description": "The credit card type.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PayflowProUrlInput", - "description": "Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for the Payflow Pro and Payment Pro payment methods.", - "fields": null, - "inputFields": [ - { - "name": "cancel_url", - "description": "The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "error_url", - "description": "The relative URL of the transaction error page that PayPal redirects to upon payment error. If the full URL to this page is https://www.example.com/paypal/action/error.html, the relative URL is paypal/action/error.html.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "return_url", - "description": "The relative URL of the final confirmation page that PayPal redirects to upon payment success. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PayflowProToken", - "description": "Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods.", - "fields": [ - { - "name": "response_message", - "description": "The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "result", - "description": "A non-zero value if any errors occurred.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "result_code", - "description": "The RESULT returned by PayPal. A value of `0` indicates the transaction was approved.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "secure_token", - "description": "A secure token generated by PayPal.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "secure_token_id", - "description": "A secure token ID generated by PayPal.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreatePayflowProTokenOutput", - "description": "Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods.", - "fields": [ - { - "name": "response_message", - "description": "The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "result", - "description": "A non-zero value if any errors occurred.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "result_code", - "description": "The RESULT returned by PayPal. A value of `0` indicates the transaction was approved.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "secure_token", - "description": "A secure token generated by PayPal.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "secure_token_id", - "description": "A secure token ID generated by PayPal.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PayflowProResponseInput", - "description": "Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID that identifies the shopper's cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "paypal_payload", - "description": "The payload returned from PayPal.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PayflowProResponseOutput", - "description": "", - "fields": [ - { - "name": "cart", - "description": "The cart with the updated selected payment method.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "VaultTokenInput", - "description": "Contains required input for payment methods with Vault support.", - "fields": null, - "inputFields": [ - { - "name": "public_hash", - "description": "The public hash of the payment token.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddPurchaseOrderCommentInput", - "description": "Contains the comment to be added to a purchase order.", - "fields": null, - "inputFields": [ - { - "name": "comment", - "description": "Comment text.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "purchase_order_uid", - "description": "The unique ID of a purchase order.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddPurchaseOrderCommentOutput", - "description": "Contains the successfully added comment.", - "fields": [ - { - "name": "comment", - "description": "The purchase order comment.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PurchaseOrderComment", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PurchaseOrder", - "description": "Contains details about a purchase order.", - "fields": [ - { - "name": "approval_flow", - "description": "The approval flows for each applied rules.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PurchaseOrderRuleApprovalFlow", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "available_actions", - "description": "Purchase order actions available to the customer. Can be used to display action buttons on the client.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "PurchaseOrderAction", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "comments", - "description": "The set of comments applied to the purchase order.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PurchaseOrderComment", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "The date the purchase order was created.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_by", - "description": "The company user who created the purchase order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "history_log", - "description": "The log of the events related to the purchase order.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PurchaseOrderHistoryItem", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "number", - "description": "The purchase order number.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order", - "description": "The reference to the order placed based on the purchase order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomerOrder", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quote", - "description": "The quote related to the purchase order.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "The current status of the purchase order.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "PurchaseOrderStatus", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "A unique identifier for the purchase order.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "The date the purchase order was last updated.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PurchaseOrdersActionInput", - "description": "Defines which purchase orders to act on.", - "fields": null, - "inputFields": [ - { - "name": "purchase_order_uids", - "description": "An array of purchase order UIDs.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PurchaseOrdersActionOutput", - "description": "Returns a list of updated purchase orders and any error messages.", - "fields": [ - { - "name": "errors", - "description": "An array of error messages encountered while performing the operation.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PurchaseOrderActionError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purchase_orders", - "description": "A list of purchase orders.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PurchaseOrder", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PurchaseOrderActionError", - "description": "Contains details about a failed action.", - "fields": [ - { - "name": "message", - "description": "The returned error message.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "The error type.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "PurchaseOrderErrorType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PurchaseOrderErrorType", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "NOT_FOUND", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "OPERATION_NOT_APPLICABLE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "COULD_NOT_SAVE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NOT_VALID_DATA", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNDEFINED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PurchaseOrderAction", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "REJECT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CANCEL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "VALIDATE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "APPROVE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PLACE_ORDER", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PurchaseOrderStatus", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "PENDING", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "APPROVAL_REQUIRED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "APPROVED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ORDER_IN_PROGRESS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ORDER_PLACED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ORDER_FAILED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "REJECTED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CANCELED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "APPROVED_PENDING_PAYMENT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PurchaseOrderComment", - "description": "Contains details about a comment.", - "fields": [ - { - "name": "author", - "description": "The user who left the comment.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Customer", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "The date and time when the comment was created.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "text", - "description": "The text of the comment.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "A unique identifier of the comment.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PurchaseOrderHistoryItem", - "description": "Contains details about a status change.", - "fields": [ - { - "name": "activity", - "description": "The activity type of the event.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "The date and time when the event happened.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "message", - "description": "The message representation of the event.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "A unique identifier of the purchase order history item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PurchaseOrdersFilterInput", - "description": "Defines the criteria to use to filter the list of purchase orders.", - "fields": null, - "inputFields": [ - { - "name": "company_purchase_orders", - "description": "Include only purchase orders made by subordinate company users.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "created_date", - "description": "Filter by the creation date of the purchase order.", - "type": { - "kind": "INPUT_OBJECT", - "name": "FilterRangeTypeInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "require_my_approval", - "description": "Include only purchase orders that are waiting for the customer’s approval.", - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "status", - "description": "Filter by the status of the purchase order.", - "type": { - "kind": "ENUM", - "name": "PurchaseOrderStatus", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PurchaseOrders", - "description": "Contains a list of purchase orders.", - "fields": [ - { - "name": "items", - "description": "Purchase orders matching the search criteria.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PurchaseOrder", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Page information of search result's current page.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "Total number of purchase orders found matching the search criteria.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PlacePurchaseOrderInput", - "description": "Specifies the quote to be converted to a purchase order.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PlaceOrderForPurchaseOrderInput", - "description": "Specifies the purchase order to convert to an order.", - "fields": null, - "inputFields": [ - { - "name": "purchase_order_uid", - "description": "The unique ID of a purchase order.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PlacePurchaseOrderOutput", - "description": "Contains the results of the request to place a purchase order.", - "fields": [ - { - "name": "purchase_order", - "description": "Placed purchase order.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PurchaseOrder", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PlaceOrderForPurchaseOrderOutput", - "description": "Contains the results of the request to place an order.", - "fields": [ - { - "name": "order", - "description": "Placed order.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CustomerOrder", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddPurchaseOrderItemsToCartInput", - "description": "Defines the purchase order and cart to act on.", - "fields": null, - "inputFields": [ - { - "name": "cart_id", - "description": "The ID to assign to the cart.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "purchase_order_uid", - "description": "Purchase order unique ID.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "replace_existing_cart_items", - "description": "Replace existing cart or merge items.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "UpdatePurchaseOrderApprovalRuleInput", - "description": "Defines the changes to be made to an approval rule.", - "fields": null, - "inputFields": [ - { - "name": "applies_to", - "description": "An updated list of company user role IDs to which this purchase order approval rule should be applied. When an empty array is provided, the rule is applied to all user roles in the system, including those created in the future.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "approvers", - "description": "An updated list of B2B user roles that can approve this purchase order approval rule.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "condition", - "description": "The updated condition of the purchase order approval rule.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CreatePurchaseOrderApprovalRuleConditionInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "description", - "description": "The updated approval rule description.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The updated approval rule name.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "status", - "description": "The updated status of the purchase order approval rule.", - "type": { - "kind": "ENUM", - "name": "PurchaseOrderApprovalRuleStatus", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "uid", - "description": "Unique identifier for the purchase order approval rule.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "PurchaseOrderApprovalRuleInput", - "description": "Defines a new purchase order approval rule.", - "fields": null, - "inputFields": [ - { - "name": "applies_to", - "description": "A list of company user role IDs to which this purchase order approval rule should be applied. When an empty array is provided, the rule is applied to all user roles in the system, including those created in the future.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "approvers", - "description": "A list of B2B user roles that can approve this purchase order approval rule.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "condition", - "description": "The condition of the purchase order approval rule.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "CreatePurchaseOrderApprovalRuleConditionInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "description", - "description": "A summary of the purpose of the purchase order approval rule.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The purchase order approval rule name.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "status", - "description": "The status of the purchase order approval rule.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "PurchaseOrderApprovalRuleStatus", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CreatePurchaseOrderApprovalRuleConditionInput", - "description": "Defines a set of conditions that apply to a rule.", - "fields": null, - "inputFields": [ - { - "name": "amount", - "description": "The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity.", - "type": { - "kind": "INPUT_OBJECT", - "name": "CreatePurchaseOrderApprovalRuleConditionAmountInput", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "attribute", - "description": "The type of approval rule.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "PurchaseOrderApprovalRuleType", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "operator", - "description": "Defines how to evaluate an amount or quantity in a purchase order.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "PurchaseOrderApprovalRuleConditionOperator", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "quantity", - "description": "The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CreatePurchaseOrderApprovalRuleConditionAmountInput", - "description": "Specifies the amount and currency to evaluate.", - "fields": null, - "inputFields": [ - { - "name": "currency", - "description": "Purchase order approval rule condition amount currency.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CurrencyEnum", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "value", - "description": "Purchase order approval rule condition amount value.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalRuleMetadata", - "description": "Contains metadata that can be used to render rule edit forms.", - "fields": [ - { - "name": "available_applies_to", - "description": "A list of B2B user roles that the rule can be applied to.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "available_condition_currencies", - "description": "A list of currencies that can be used to create approval rules based on amounts, for example shipping cost rules.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "AvailableCurrency", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "available_requires_approval_from", - "description": "A list of B2B user roles that can be specified as approvers for the approval rules.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AvailableCurrency", - "description": "Defines the code and symbol of a currency that can be used for purchase orders.", - "fields": [ - { - "name": "code", - "description": "3-letter currency code, for example USD.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "CurrencyEnum", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "symbol", - "description": "Currency symbol, for example $.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalRules", - "description": "Contains the approval rules that the customer can see.", - "fields": [ - { - "name": "items", - "description": "A list of purchase order approval rules visible to the customer.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalRule", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Result pagination details.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The total number of purchase order approval rules visible to the customer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalRule", - "description": "Contains details about a purchase order approval rule.", - "fields": [ - { - "name": "applies_to_roles", - "description": "The name of the user(s) affected by the the purchase order approval rule.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "approver_roles", - "description": "The name of the user who needs to approve purchase orders that trigger the approval rule.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "CompanyRole", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "condition", - "description": "Condition which triggers the approval rule.", - "args": [], - "type": { - "kind": "INTERFACE", - "name": "PurchaseOrderApprovalRuleConditionInterface", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "The date the purchase order rule was created.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_by", - "description": "The name of the user who created the purchase order approval rule.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": "Description of the purchase order approval rule.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The name of the purchase order approval rule.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "The status of the purchase order approval rule.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "PurchaseOrderApprovalRuleStatus", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique identifier for the purchase order approval rule.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "The date the purchase order rule was last updated.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "PurchaseOrderApprovalRuleConditionInterface", - "description": "Purchase order rule condition details.", - "fields": [ - { - "name": "attribute", - "description": "The type of purchase order approval rule.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PurchaseOrderApprovalRuleType", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "operator", - "description": "The operator to be used for evaluating the approval rule condition.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PurchaseOrderApprovalRuleConditionOperator", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalRuleConditionAmount", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalRuleConditionQuantity", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalRuleConditionAmount", - "description": "Contains approval rule condition details, including the amount to be evaluated.", - "fields": [ - { - "name": "amount", - "description": "The amount to be be used for evaluation of the approval rule condition.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "attribute", - "description": "The type of purchase order approval rule.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PurchaseOrderApprovalRuleType", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "operator", - "description": "The operator to be used for evaluating the approval rule condition.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PurchaseOrderApprovalRuleConditionOperator", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "PurchaseOrderApprovalRuleConditionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalRuleConditionQuantity", - "description": "Contains approval rule condition details, including the quantity to be evaluated.", - "fields": [ - { - "name": "attribute", - "description": "The type of purchase order approval rule.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PurchaseOrderApprovalRuleType", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "operator", - "description": "The operator to be used for evaluating the approval rule condition.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PurchaseOrderApprovalRuleConditionOperator", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity to be used for evaluation of the approval rule condition.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "PurchaseOrderApprovalRuleConditionInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PurchaseOrderApprovalRuleConditionOperator", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "MORE_THAN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LESS_THAN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MORE_THAN_OR_EQUAL_TO", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "LESS_THAN_OR_EQUAL_TO", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PurchaseOrderApprovalRuleStatus", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "ENABLED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DISABLED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PurchaseOrderApprovalRuleType", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "GRAND_TOTAL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SHIPPING_INCL_TAX", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NUMBER_OF_SKUS", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PurchaseOrderRuleApprovalFlow", - "description": "Contains details about approval roles applied to the purchase order and status changes.", - "fields": [ - { - "name": "events", - "description": "The approval flow event related to the rule.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalFlowEvent", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "rule_name", - "description": "The name of the applied rule.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PurchaseOrderApprovalFlowEvent", - "description": "Contains details about a single event in the approval flow of the purchase order.", - "fields": [ - { - "name": "message", - "description": "A formatted message.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The approver name.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "role", - "description": "The approver role.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "The status related to the event.", - "args": [], - "type": { - "kind": "ENUM", - "name": "PurchaseOrderApprovalFlowItemStatus", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updated_at", - "description": "The date and time the event was updated.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PurchaseOrderApprovalFlowItemStatus", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "PENDING", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "APPROVED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "REJECTED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ValidatePurchaseOrdersInput", - "description": "Defines the purchase orders to be validated.", - "fields": null, - "inputFields": [ - { - "name": "purchase_order_uids", - "description": "An array of the purchase order IDs.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ValidatePurchaseOrdersOutput", - "description": "Contains the results of validation attempts.", - "fields": [ - { - "name": "errors", - "description": "An array of error messages encountered while performing the operation.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ValidatePurchaseOrderError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "purchase_orders", - "description": "An array of the purchase orders in the request.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PurchaseOrder", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ValidatePurchaseOrderError", - "description": "Contains details about a failed validation attempt.", - "fields": [ - { - "name": "message", - "description": "The returned error message.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "Error type.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "ValidatePurchaseOrderErrorType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "ValidatePurchaseOrderErrorType", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "NOT_FOUND", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "OPERATION_NOT_APPLICABLE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "COULD_NOT_SAVE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NOT_VALID_DATA", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNDEFINED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "DeletePurchaseOrderApprovalRuleInput", - "description": "Specifies the IDs of the approval rules to delete.", - "fields": null, - "inputFields": [ - { - "name": "approval_rule_uids", - "description": "An array of purchase order approval rule IDs.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeletePurchaseOrderApprovalRuleOutput", - "description": "Contains any errors encountered while attempting to delete approval rules.", - "fields": [ - { - "name": "errors", - "description": "An array of error messages encountered while performing the operation.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "DeletePurchaseOrderApprovalRuleError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeletePurchaseOrderApprovalRuleError", - "description": "Contains details about an error that occurred when deleting an approval rule .", - "fields": [ - { - "name": "message", - "description": "The text of the error message.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "The error type.", - "args": [], - "type": { - "kind": "ENUM", - "name": "DeletePurchaseOrderApprovalRuleErrorType", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "DeletePurchaseOrderApprovalRuleErrorType", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "UNDEFINED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NOT_FOUND", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ClearCartInput", - "description": "Assigns a specific `cart_id` to the empty cart.", - "fields": null, - "inputFields": [ - { - "name": "uid", - "description": "The unique ID of a `Cart` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ClearCartOutput", - "description": "Output of the request to clear the customer cart.", - "fields": [ - { - "name": "cart", - "description": "The cart after clear cart items.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "errors", - "description": "An array of errors encountered while clearing the cart item", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ClearCartError", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ClearCartError", - "description": "Contains details about errors encountered when a customer clear cart.", - "fields": [ - { - "name": "message", - "description": "A localized error message", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "A cart-specific error type.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "ClearCartErrorType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "ClearCartErrorType", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "NOT_FOUND", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNAUTHORISED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "INACTIVE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNDEFINED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "ReCaptchaFormEnum", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "PLACE_ORDER", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CONTACT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CUSTOMER_LOGIN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CUSTOMER_FORGOT_PASSWORD", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CUSTOMER_CREATE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CUSTOMER_EDIT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NEWSLETTER", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PRODUCT_REVIEW", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SENDFRIEND", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "BRAINTREE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ReCaptchaConfigurationV3", - "description": "Contains reCAPTCHA V3-Invisible configuration details.", - "fields": [ - { - "name": "badge_position", - "description": "The position of the invisible reCAPTCHA badge on each page.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "failure_message", - "description": "The message that appears to the user if validation fails.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "forms", - "description": "A list of forms on the storefront that have been configured to use reCAPTCHA V3.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "ReCaptchaFormEnum", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_enabled", - "description": "Return whether recaptcha is enabled or not", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "language_code", - "description": "A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "minimum_score", - "description": "The minimum score that identifies a user interaction as a potential risk.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "website_key", - "description": "The website key generated when the Google reCAPTCHA account was registered.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ConfigurableRequisitionListItem", - "description": "Contains details about configurable products added to a requisition list.", - "fields": [ - { - "name": "configurable_options", - "description": "Selected configurable options for an item in the requisition list.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedConfigurableOption", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customizable_options", - "description": "Selected custom options for an item in the requisition list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about a requisition list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of the product added to the requisition list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID of an item in a requisition list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "RequisitionListItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductReviews", - "description": "Contains an array of product reviews.", - "fields": [ - { - "name": "items", - "description": "An array of product reviews.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReview", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Metadata for pagination rendering.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductReview", - "description": "Contains details of a product review.", - "fields": [ - { - "name": "average_rating", - "description": "The average of all ratings for this product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "The date the review was created.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "nickname", - "description": "The customer's nickname. Defaults to the customer name, if logged in.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "The reviewed product.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ratings_breakdown", - "description": "An array of ratings by rating category, such as quality, price, and value.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviewRating", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "summary", - "description": "The summary (title) of the review.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "text", - "description": "The review text.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductReviewRating", - "description": "Contains data about a single aspect of a product review.", - "fields": [ - { - "name": "name", - "description": "The label assigned to an aspect of a product that is being rated, such as quality or price.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The rating value given by customer. By default, possible values range from 1 to 5.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductReviewRatingsMetadata", - "description": "Contains an array of metadata about each aspect of a product review.", - "fields": [ - { - "name": "items", - "description": "An array of product reviews sorted by position.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviewRatingMetadata", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductReviewRatingMetadata", - "description": "Contains details about a single aspect of a product review.", - "fields": [ - { - "name": "id", - "description": "An encoded rating ID.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The label assigned to an aspect of a product that is being rated, such as quality or price.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "values", - "description": "List of product review ratings sorted by position.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReviewRatingValueMetadata", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ProductReviewRatingValueMetadata", - "description": "Contains details about a single value in a product review.", - "fields": [ - { - "name": "value", - "description": "A ratings scale, such as the number of stars awarded.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value_id", - "description": "An encoded rating value ID.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateProductReviewOutput", - "description": "Contains the completed product review.", - "fields": [ - { - "name": "review", - "description": "Product review details.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ProductReview", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CreateProductReviewInput", - "description": "Defines a new product review.", - "fields": null, - "inputFields": [ - { - "name": "nickname", - "description": "The customer's nickname. Defaults to the customer name, if logged in.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "ratings", - "description": "The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "ProductReviewRatingInput", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "sku", - "description": "The SKU of the reviewed product.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "summary", - "description": "The summary (title) of the review.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "text", - "description": "The review text.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "ProductReviewRatingInput", - "description": "Contains the reviewer's rating for a single aspect of a review.", - "fields": null, - "inputFields": [ - { - "name": "id", - "description": "An encoded rating ID.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "value_id", - "description": "An encoded rating value ID.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RewardPoints", - "description": "Contains details about a customer's reward points.", - "fields": [ - { - "name": "balance", - "description": "The current balance of reward points.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RewardPointsAmount", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "balance_history", - "description": "The balance history of reward points. If the ability for customers to view the balance history has been disabled in the Admin, this field will be set to null.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "RewardPointsBalanceHistoryItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "exchange_rates", - "description": "The current exchange rates for reward points.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RewardPointsExchangeRates", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "subscription_status", - "description": "The subscription status of emails related to reward points.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RewardPointsSubscriptionStatus", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RewardPointsAmount", - "description": "", - "fields": [ - { - "name": "money", - "description": "The reward points amount in store currency.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "points", - "description": "The reward points amount in points.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RewardPointsExchangeRates", - "description": "Lists the reward points exchange rates. The values depend on the customer group.", - "fields": [ - { - "name": "earning", - "description": "How many points are earned for a given amount spent.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RewardPointsRate", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "redemption", - "description": "How many points must be redeemed to get a given amount of currency discount at the checkout.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RewardPointsRate", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RewardPointsRate", - "description": "Contains details about customer's reward points rate.", - "fields": [ - { - "name": "currency_amount", - "description": "The money value for the exchange rate. For earnings, this is the amount spent to earn the specified points. For redemption, this is the amount of money the number of points represents.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "points", - "description": "The number of points for an exchange rate. For earnings, this is the number of points earned. For redemption, this is the number of points needed for redemption.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RewardPointsSubscriptionStatus", - "description": "Indicates whether the customer subscribes to reward points emails.", - "fields": [ - { - "name": "balance_updates", - "description": "Indicates whether the customer subscribes to 'Reward points balance updates' emails.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "RewardPointsSubscriptionStatusesEnum", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "points_expiration_notifications", - "description": "Indicates whether the customer subscribes to 'Reward points expiration notifications' emails.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "RewardPointsSubscriptionStatusesEnum", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "RewardPointsSubscriptionStatusesEnum", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "SUBSCRIBED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "NOT_SUBSCRIBED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RewardPointsBalanceHistoryItem", - "description": "Contain details about the reward points transaction.", - "fields": [ - { - "name": "balance", - "description": "The award points balance after the completion of the transaction.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "RewardPointsAmount", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "change_reason", - "description": "The reason the balance changed.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "date", - "description": "The date of the transaction.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "points_change", - "description": "The number of points added or deducted in the transaction.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ApplyRewardPointsToCartOutput", - "description": "Contains the customer cart.", - "fields": [ - { - "name": "cart", - "description": "The customer cart after reward points are applied.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RemoveRewardPointsFromCartOutput", - "description": "Contains the customer cart.", - "fields": [ - { - "name": "cart", - "description": "The customer cart after reward points are removed.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Cart", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RequestReturnInput", - "description": "Contains information needed to start a return request.", - "fields": null, - "inputFields": [ - { - "name": "comment_text", - "description": "Text the buyer entered that describes the reason for the refund request.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "contact_email", - "description": "The email address the buyer enters to receive notifications about the status of the return.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "items", - "description": "An array of items to be returned.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "RequestReturnItemInput", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "order_uid", - "description": "The unique ID for a `Order` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RequestReturnItemInput", - "description": "Contains details about an item to be returned.", - "fields": null, - "inputFields": [ - { - "name": "entered_custom_attributes", - "description": "Details about a custom attribute that was entered.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "EnteredCustomAttributeInput", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "order_item_uid", - "description": "The unique ID for a `OrderItemInterface` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "quantity_to_return", - "description": "The quantity of the item to be returned.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "selected_custom_attributes", - "description": "An array of selected custom option IDs associated with the item to be returned. For example, the IDs for the selected color and size of a configurable product.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "SelectedCustomAttributeInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "EnteredCustomAttributeInput", - "description": "Contains details about a custom text attribute that the buyer entered.", - "fields": null, - "inputFields": [ - { - "name": "attribute_code", - "description": "A string that identifies the entered custom attribute.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "value", - "description": "The text or other entered value.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SelectedCustomAttributeInput", - "description": "Contains details about an attribute the buyer selected.", - "fields": null, - "inputFields": [ - { - "name": "attribute_code", - "description": "A string that identifies the selected attribute.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "value", - "description": "The unique ID for a `CustomAttribute` object of a selected custom attribute.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RequestReturnOutput", - "description": "Contains the response to a return request.", - "fields": [ - { - "name": "return", - "description": "Details about a single return request.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Return", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "returns", - "description": "An array of return requests.", - "args": [ - { - "name": "pageSize", - "description": "Specifies the maximum number of results to return at once. The default is 20.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "20" - }, - { - "name": "currentPage", - "description": "Specifies which page of results to return. The default is 1.", - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "defaultValue": "1" - } - ], - "type": { - "kind": "OBJECT", - "name": "Returns", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddReturnCommentInput", - "description": "Defines a return comment.", - "fields": null, - "inputFields": [ - { - "name": "comment_text", - "description": "The text added to the return request.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "return_uid", - "description": "The unique ID for a `Return` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddReturnCommentOutput", - "description": "Contains details about the return request.", - "fields": [ - { - "name": "return", - "description": "The modified return.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Return", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "AddReturnTrackingInput", - "description": "Defines tracking information to be added to the return.", - "fields": null, - "inputFields": [ - { - "name": "carrier_uid", - "description": "The unique ID for a `ReturnShippingCarrier` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "return_uid", - "description": "The unique ID for a `Returns` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "tracking_number", - "description": "The shipping tracking number for this return request.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "AddReturnTrackingOutput", - "description": "Contains the response after adding tracking information.", - "fields": [ - { - "name": "return", - "description": "Details about the modified return.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Return", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "return_shipping_tracking", - "description": "Details about shipping for a return.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ReturnShippingTracking", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "RemoveReturnTrackingInput", - "description": "Defines the tracking information to delete.", - "fields": null, - "inputFields": [ - { - "name": "return_shipping_tracking_uid", - "description": "The unique ID for a `ReturnShippingTracking` object.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "RemoveReturnTrackingOutput", - "description": "Contains the response after deleting tracking information.", - "fields": [ - { - "name": "return", - "description": "Contains details about the modified return.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Return", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Returns", - "description": "Contains a list of customer return requests.", - "fields": [ - { - "name": "items", - "description": "A list of return requests.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Return", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "page_info", - "description": "Pagination metadata.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SearchResultPageInfo", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "total_count", - "description": "The total number of return requests.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "Return", - "description": "Contains details about a return.", - "fields": [ - { - "name": "available_shipping_carriers", - "description": "A list of shipping carriers available for returns.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ReturnShippingCarrier", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "comments", - "description": "A list of comments posted for the return request.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ReturnComment", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "The date the return was requested.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "customer", - "description": "Data from the customer who created the return request.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ReturnCustomer", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "items", - "description": "A list of items being returned.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ReturnItem", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "number", - "description": "A human-readable return number.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order", - "description": "The order associated with the return.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomerOrder", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "shipping", - "description": "Shipping information for the return.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ReturnShipping", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "The status of the return request.", - "args": [], - "type": { - "kind": "ENUM", - "name": "ReturnStatus", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `Return` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ReturnCustomer", - "description": "The customer information for the return.", - "fields": [ - { - "name": "email", - "description": "The email address of the customer.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "firstname", - "description": "The first name of the customer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "lastname", - "description": "The last name of the customer.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ReturnItem", - "description": "Contains details about a product being returned.", - "fields": [ - { - "name": "custom_attributes", - "description": "Return item custom attributes that are visible on the storefront.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ReturnCustomAttribute", - "ofType": null - } - }, - "isDeprecated": true, - "deprecationReason": "Use custom_attributesV2 instead." - }, - { - "name": "custom_attributesV2", - "description": "Custom attributes that are visible on the storefront.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "AttributeValueInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "order_item", - "description": "Provides access to the product being returned, including information about selected and entered options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "OrderItemInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The quantity of the item the merchant authorized to be returned.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "request_quantity", - "description": "The quantity of the item requested to be returned.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "The return status of the item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "ReturnItemStatus", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `ReturnItem` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ReturnItemAttributeMetadata", - "description": "Return Item attribute metadata.", - "fields": [ - { - "name": "code", - "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "default_value", - "description": "Default attribute value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "entity_type", - "description": "The type of entity that defines the attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "AttributeEntityTypeEnum", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "frontend_class", - "description": "The frontend class of the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "frontend_input", - "description": "The frontend input type of the attribute.", - "args": [], - "type": { - "kind": "ENUM", - "name": "AttributeFrontendInputEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "input_filter", - "description": "The template used for the input of the attribute (e.g., 'date').", - "args": [], - "type": { - "kind": "ENUM", - "name": "InputFilterEnum", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_required", - "description": "Whether the attribute value is required.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "is_unique", - "description": "Whether the attribute value must be unique.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The label assigned to the attribute.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "multiline_count", - "description": "The number of lines of the attribute value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "options", - "description": "Attribute options.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "CustomAttributeOptionInterface", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sort_order", - "description": "The position of the attribute in the form.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "validate_rules", - "description": "The validation rules of the attribute value.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ValidationRule", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "CustomAttributeMetadataInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ReturnCustomAttribute", - "description": "Contains details about a `ReturnCustomerAttribute` object.", - "fields": [ - { - "name": "label", - "description": "A description of the attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `ReturnCustomAttribute` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "A JSON-encoded value of the attribute.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ReturnComment", - "description": "Contains details about a return comment.", - "fields": [ - { - "name": "author_name", - "description": "The name or author who posted the comment.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "created_at", - "description": "The date and time the comment was posted.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "text", - "description": "The contents of the comment.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `ReturnComment` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ReturnShipping", - "description": "Contains details about the return shipping address.", - "fields": [ - { - "name": "address", - "description": "The merchant-defined return shipping address.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ReturnShippingAddress", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "tracking", - "description": "The unique ID for a `ReturnShippingTracking` object. If a single UID is specified, the array contains a single tracking record. Otherwise, array contains all tracking information.", - "args": [ - { - "name": "uid", - "description": "", - "type": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - }, - "defaultValue": null - } - ], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ReturnShippingTracking", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ReturnShippingCarrier", - "description": "Contains details about the carrier on a return.", - "fields": [ - { - "name": "label", - "description": "A description of the shipping carrier.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ReturnShippingTracking", - "description": "Contains shipping and tracking details.", - "fields": [ - { - "name": "carrier", - "description": "Contains details of a shipping carrier.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "ReturnShippingCarrier", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "status", - "description": "Details about the status of a shipment.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "ReturnShippingTrackingStatus", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "tracking_number", - "description": "A tracking number assigned by the carrier.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for a `ReturnShippingTracking` object assigned to the tracking item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ReturnShippingTrackingStatus", - "description": "Contains the status of a shipment.", - "fields": [ - { - "name": "text", - "description": "Text that describes the status.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "Indicates whether the status type is informational or an error.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "ReturnShippingTrackingStatusType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "ReturnShippingTrackingStatusType", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "INFORMATION", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "ERROR", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ReturnShippingAddress", - "description": "Contains details about the shipping address used for receiving returned items.", - "fields": [ - { - "name": "city", - "description": "The city for product returns.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "contact_name", - "description": "The merchant's contact person.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "country", - "description": "An object that defines the country for product returns.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Country", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "postcode", - "description": "The postal code for product returns.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "region", - "description": "An object that defines the state or province for product returns.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Region", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "street", - "description": "The street address for product returns.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "telephone", - "description": "The telephone number for product returns.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "ReturnStatus", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "PENDING", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AUTHORIZED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PARTIALLY_AUTHORIZED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "RECEIVED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PARTIALLY_RECEIVED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "APPROVED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PARTIALLY_APPROVED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "REJECTED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PARTIALLY_REJECTED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DENIED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PROCESSED_AND_CLOSED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "CLOSED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "ReturnItemStatus", - "description": "", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "PENDING", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "AUTHORIZED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "RECEIVED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "APPROVED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "REJECTED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DENIED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "WishlistVisibilityEnum", - "description": "Defines the wish list visibility types.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "PUBLIC", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PRIVATE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CreateWishlistOutput", - "description": "Contains the wish list.", - "fields": [ - { - "name": "wishlist", - "description": "The newly-created wish list", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Wishlist", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeleteWishlistOutput", - "description": "Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists.", - "fields": [ - { - "name": "status", - "description": "Indicates whether the wish list was deleted.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "wishlists", - "description": "A list of undeleted wish lists.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Wishlist", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CopyProductsBetweenWishlistsOutput", - "description": "Contains the source and target wish lists after copying products.", - "fields": [ - { - "name": "destination_wishlist", - "description": "The destination wish list containing the copied products.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Wishlist", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "source_wishlist", - "description": "The wish list that the products were copied from.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Wishlist", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "user_errors", - "description": "An array of errors encountered while copying products in a wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "WishListUserInputError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "WishlistItemCopyInput", - "description": "Specifies the IDs of items to copy and their quantities.", - "fields": null, - "inputFields": [ - { - "name": "quantity", - "description": "The quantity of this item to copy to the destination wish list. This value can't be greater than the quantity in the source wish list.", - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "wishlist_item_id", - "description": "The unique ID of the `WishlistItemInterface` object to be copied.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "WishlistItemMoveInput", - "description": "Specifies the IDs of the items to move and their quantities.", - "fields": null, - "inputFields": [ - { - "name": "quantity", - "description": "The quantity of this item to move to the destination wish list. This value can't be greater than the quantity in the source wish list.", - "type": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "wishlist_item_id", - "description": "The unique ID of the `WishlistItemInterface` object to be moved.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "CreateWishlistInput", - "description": "Defines the name and visibility of a new wish list.", - "fields": null, - "inputFields": [ - { - "name": "name", - "description": "The name of the new wish list.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "visibility", - "description": "Indicates whether the wish list is public or private.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "WishlistVisibilityEnum", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "UpdateWishlistOutput", - "description": "Contains the name and visibility of an updated wish list.", - "fields": [ - { - "name": "name", - "description": "The wish list name.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID of a `Wishlist` object.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "visibility", - "description": "Indicates whether the wish list is public or private.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "WishlistVisibilityEnum", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "MoveProductsBetweenWishlistsOutput", - "description": "Contains the source and target wish lists after moving products.", - "fields": [ - { - "name": "destination_wishlist", - "description": "The destination wish list after receiving products moved from the source wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Wishlist", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "source_wishlist", - "description": "The source wish list after moving products from it.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Wishlist", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "user_errors", - "description": "An array of errors encountered while moving products to a wish list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "WishListUserInputError", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SendEmailToFriendInput", - "description": "Defines the referenced product and the email sender and recipients.", - "fields": null, - "inputFields": [ - { - "name": "product_id", - "description": "The ID of the product that the sender is referencing.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "recipients", - "description": "An array containing information about each recipient.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "SendEmailToFriendRecipientInput", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "sender", - "description": "Information about the customer and the content of the message.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "SendEmailToFriendSenderInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SendEmailToFriendSenderInput", - "description": "Contains details about the sender.", - "fields": null, - "inputFields": [ - { - "name": "email", - "description": "The email address of the sender.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "message", - "description": "The text of the message to be sent.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The name of the sender.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "SendEmailToFriendRecipientInput", - "description": "Contains details about a recipient.", - "fields": null, - "inputFields": [ - { - "name": "email", - "description": "The email address of the recipient.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "name", - "description": "The name of the recipient.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SendEmailToFriendOutput", - "description": "Contains information about the sender and recipients.", - "fields": [ - { - "name": "recipients", - "description": "An array containing information about each recipient.", - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SendEmailToFriendRecipient", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "sender", - "description": "Information about the customer and the content of the message.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SendEmailToFriendSender", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SendEmailToFriendSender", - "description": "An output object that contains information about the sender.", - "fields": [ - { - "name": "email", - "description": "The email address of the sender.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "message", - "description": "The text of the message to be sent.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The name of the sender.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SendEmailToFriendRecipient", - "description": "An output object that contains information about the recipient.", - "fields": [ - { - "name": "email", - "description": "The email address of the recipient.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": "The name of the recipient.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SendFriendConfiguration", - "description": "Contains details about the configuration of the Email to a Friend feature.", - "fields": [ - { - "name": "enabled_for_customers", - "description": "Indicates whether the Email to a Friend feature is enabled.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "enabled_for_guests", - "description": "Indicates whether the Email to a Friend feature is enabled for guests.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "SwatchLayerFilterItemInterface", - "description": "", - "fields": [ - { - "name": "swatch_data", - "description": "Data required to render a swatch filter item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SwatchData", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "SwatchLayerFilterItem", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "SwatchLayerFilterItem", - "description": "", - "fields": [ - { - "name": "items_count", - "description": "The count of items per filter.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "Int", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.count` instead." - }, - { - "name": "label", - "description": "The label for a filter.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.label` instead." - }, - { - "name": "swatch_data", - "description": "Data required to render a swatch filter item.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "SwatchData", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value_string", - "description": "The value of a filter request variable to be used in query.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": true, - "deprecationReason": "Use `AggregationOption.value` instead." - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "LayerFilterItemInterface", - "ofType": null - }, - { - "kind": "INTERFACE", - "name": "SwatchLayerFilterItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "SwatchData", - "description": "Describes the swatch type and a value.", - "fields": [ - { - "name": "type", - "description": "The type of swatch filter item: 1 - text; 2 - image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The value for the swatch item. It could be text or an image link.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INTERFACE", - "name": "SwatchDataInterface", - "description": "", - "fields": [ - { - "name": "value", - "description": "The value can be represented as color (HEX code), image link, or text.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": [ - { - "kind": "OBJECT", - "name": "ImageSwatchData", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "TextSwatchData", - "ofType": null - }, - { - "kind": "OBJECT", - "name": "ColorSwatchData", - "ofType": null - } - ] - }, - { - "kind": "OBJECT", - "name": "ImageSwatchData", - "description": "", - "fields": [ - { - "name": "thumbnail", - "description": "The URL assigned to the thumbnail of the swatch image.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "value", - "description": "The value can be represented as color (HEX code), image link, or text.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "SwatchDataInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "TextSwatchData", - "description": "", - "fields": [ - { - "name": "value", - "description": "The value can be represented as color (HEX code), image link, or text.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "SwatchDataInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "ColorSwatchData", - "description": "", - "fields": [ - { - "name": "value", - "description": "The value can be represented as color (HEX code), image link, or text.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "SwatchDataInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "SwatchInputTypeEnum", - "description": "Swatch attribute metadata input types.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "BOOLEAN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DATE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DATETIME", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "DROPDOWN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FILE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "GALLERY", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "HIDDEN", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "IMAGE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MEDIA_IMAGE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MULTILINE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "MULTISELECT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "PRICE", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "SELECT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TEXT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "TEXTAREA", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "UNDEFINED", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "VISUAL", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "WEIGHT", - "description": "", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "DeletePaymentTokenOutput", - "description": "Indicates whether the request succeeded and returns the remaining customer payment tokens.", - "fields": [ - { - "name": "customerPaymentTokens", - "description": "A container for the customer's remaining payment tokens.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "CustomerPaymentTokens", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "result", - "description": "Indicates whether the request succeeded.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "CustomerPaymentTokens", - "description": "Contains payment tokens stored in the customer's vault.", - "fields": [ - { - "name": "items", - "description": "An array of payment tokens.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PaymentToken", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PaymentToken", - "description": "The stored payment method available to the customer.", - "fields": [ - { - "name": "details", - "description": "A description of the stored account details.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "payment_method_code", - "description": "The payment method code associated with the token.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "public_hash", - "description": "The public hash of the token.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": "Specifies the payment token type.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "PaymentTokenTypeEnum", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "PaymentTokenTypeEnum", - "description": "The list of available payment token types.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "card", - "description": "phpcs:ignore Magento2.GraphQL.ValidArgumentName", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "account", - "description": "phpcs:ignore Magento2.GraphQL.ValidArgumentName", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "FixedProductTax", - "description": "A single FPT that can be applied to a product price.", - "fields": [ - { - "name": "amount", - "description": "The amount of the Fixed Product Tax.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "Money", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "label", - "description": "The display label assigned to the Fixed Product Tax.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "FixedProductTaxDisplaySettings", - "description": "Lists display settings for the Fixed Product Tax.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "INCLUDE_FPT_WITHOUT_DETAILS", - "description": "The displayed price includes the FPT amount without displaying the `ProductPrice.fixed_product_taxes` values. This value corresponds to 'Including FPT only'.", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "INCLUDE_FPT_WITH_DETAILS", - "description": "The displayed price includes the FPT amount while displaying the values of `ProductPrice.fixed_product_taxes` separately. This value corresponds to 'Including FPT and FPT description'.", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "EXCLUDE_FPT_AND_INCLUDE_WITH_DETAILS", - "description": "The displayed price does not include the FPT amount. The values of `ProductPrice.fixed_product_taxes` and the price including the FPT are displayed separately. This value corresponds to 'Excluding FPT, Including FPT description and final price.'", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "EXCLUDE_FPT_WITHOUT_DETAILS", - "description": "The displayed price does not include the FPT amount. The values from `ProductPrice.fixed_product_taxes` are not displayed. This value corresponds to 'Excluding FPT'.", - "isDeprecated": false, - "deprecationReason": "" - }, - { - "name": "FPT_DISABLED", - "description": "The FPT feature is not enabled. You can omit `ProductPrice.fixed_product_taxes` from your query.", - "isDeprecated": false, - "deprecationReason": "" - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "GiftCardRequisitionListItem", - "description": "Contains details about gift cards added to a requisition list.", - "fields": [ - { - "name": "customizable_options", - "description": "Selected custom options for an item in the requisition list.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "SelectedCustomizableOption", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "gift_card_options", - "description": "An array that defines gift card properties.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "GiftCardOptions", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "product", - "description": "Details about a requisition list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "quantity", - "description": "The amount added.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Float", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "uid", - "description": "The unique ID for the requisition list item.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - { - "kind": "INTERFACE", - "name": "RequisitionListItemInterface", - "ofType": null - } - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "BraintreeInput", - "description": "", - "fields": null, - "inputFields": [ - { - "name": "device_data", - "description": "Contains a fingerprint provided by Braintree JS SDK and should be sent with sale transaction details to the Braintree payment gateway.", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "is_active_payment_token_enabler", - "description": "States whether the payment details (Credit/Debit Card, PayPal Account) entered by a customer should be tokenized for later usage. Required only if Vault is enabled for the relevant Braintree payment integration.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "payment_method_nonce", - "description": "The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "BraintreeCcVaultInput", - "description": "", - "fields": null, - "inputFields": [ - { - "name": "device_data", - "description": "", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "public_hash", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", - "name": "BraintreeVaultInput", - "description": "", - "fields": null, - "inputFields": [ - { - "name": "device_data", - "description": "", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null - }, - { - "name": "public_hash", - "description": "", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - } - ], - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "__Schema", - "description": "A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.", - "fields": [ - { - "name": "types", - "description": "A list of all types supported by this server.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "__Type", - "ofType": null - } - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "queryType", - "description": "The type that query operations will be rooted at.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "__Type", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "mutationType", - "description": "If this server supports mutation, the type that mutation operations will be rooted at.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "__Type", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "subscriptionType", - "description": "If this server support subscription, the type that subscription operations will be rooted at.", - "args": [], - "type": { - "kind": "OBJECT", - "name": "__Type", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "directives", - "description": "A list of all directives supported by this server.", - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "__Directive", - "ofType": null - } - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "__Type", - "description": "The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum.\n\nDepending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.", - "fields": [ - { - "name": "kind", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "__TypeKind", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "name", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "fields", - "description": null, - "args": [ - { - "name": "includeDeprecated", - "description": null, - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": "false" - } - ], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "__Field", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "interfaces", - "description": null, - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "__Type", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "possibleTypes", - "description": null, - "args": [], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "__Type", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "enumValues", - "description": null, - "args": [ - { - "name": "includeDeprecated", - "description": null, - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": "false" - } - ], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "__EnumValue", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "inputFields", - "description": null, - "args": [ - { - "name": "includeDeprecated", - "description": null, - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": "false" - } - ], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "__InputValue", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ofType", - "description": null, - "args": [], - "type": { - "kind": "OBJECT", - "name": "__Type", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "__TypeKind", - "description": "An enum describing what kind of type a given `__Type` is.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "SCALAR", - "description": "Indicates this type is a scalar.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "OBJECT", - "description": "Indicates this type is an object. `fields` and `interfaces` are valid fields.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "INTERFACE", - "description": "Indicates this type is an interface. `fields`, `interfaces`, and `possibleTypes` are valid fields.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "UNION", - "description": "Indicates this type is a union. `possibleTypes` is a valid field.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ENUM", - "description": "Indicates this type is an enum. `enumValues` is a valid field.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "INPUT_OBJECT", - "description": "Indicates this type is an input object. `inputFields` is a valid field.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "LIST", - "description": "Indicates this type is a list. `ofType` is a valid field.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "NON_NULL", - "description": "Indicates this type is a non-null. `ofType` is a valid field.", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "__Field", - "description": "Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.", - "fields": [ - { - "name": "name", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "args", - "description": null, - "args": [ - { - "name": "includeDeprecated", - "description": null, - "type": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - }, - "defaultValue": "false" - } - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "__InputValue", - "ofType": null - } - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "__Type", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "isDeprecated", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deprecationReason", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "__InputValue", - "description": "Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.", - "fields": [ - { - "name": "name", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "type", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "__Type", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "defaultValue", - "description": "A GraphQL-formatted string representing the default value for this input value.", - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "isDeprecated", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deprecationReason", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "__EnumValue", - "description": "One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.", - "fields": [ - { - "name": "name", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "isDeprecated", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "deprecationReason", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "__Directive", - "description": "A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.\n\nIn some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.", - "fields": [ - { - "name": "name", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "description", - "description": null, - "args": [], - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "isRepeatable", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "locations", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "__DirectiveLocation", - "ofType": null - } - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "args", - "description": null, - "args": [], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "__InputValue", - "ofType": null - } - } - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "ENUM", - "name": "__DirectiveLocation", - "description": "A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": [ - { - "name": "QUERY", - "description": "Location adjacent to a query operation.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "MUTATION", - "description": "Location adjacent to a mutation operation.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "SUBSCRIPTION", - "description": "Location adjacent to a subscription operation.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "FIELD", - "description": "Location adjacent to a field.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "FRAGMENT_DEFINITION", - "description": "Location adjacent to a fragment definition.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "FRAGMENT_SPREAD", - "description": "Location adjacent to a fragment spread.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "INLINE_FRAGMENT", - "description": "Location adjacent to an inline fragment.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "VARIABLE_DEFINITION", - "description": "Location adjacent to a variable definition.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "SCHEMA", - "description": "Location adjacent to a schema definition.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "SCALAR", - "description": "Location adjacent to a scalar definition.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "OBJECT", - "description": "Location adjacent to an object type definition.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "FIELD_DEFINITION", - "description": "Location adjacent to a field definition.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ARGUMENT_DEFINITION", - "description": "Location adjacent to an argument definition.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "INTERFACE", - "description": "Location adjacent to an interface definition.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "UNION", - "description": "Location adjacent to a union definition.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ENUM", - "description": "Location adjacent to an enum definition.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "ENUM_VALUE", - "description": "Location adjacent to an enum value definition.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "INPUT_OBJECT", - "description": "Location adjacent to an input object type definition.", - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "INPUT_FIELD_DEFINITION", - "description": "Location adjacent to an input object field definition.", - "isDeprecated": false, - "deprecationReason": null - } - ], - "possibleTypes": null - } - ], - "directives": [ - { - "name": "include", - "description": "Directs the executor to include this field or fragment only when the `if` argument is true.", - "locations": [ - "FIELD", - "FRAGMENT_SPREAD", - "INLINE_FRAGMENT" - ], - "args": [ - { - "name": "if", - "description": "Included when true.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "defaultValue": null - } - ] - }, - { - "name": "skip", - "description": "Directs the executor to skip this field or fragment when the `if` argument is true.", - "locations": [ - "FIELD", - "FRAGMENT_SPREAD", - "INLINE_FRAGMENT" - ], - "args": [ - { - "name": "if", - "description": "Skipped when true.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "defaultValue": null - } - ] - }, - { - "name": "deprecated", - "description": "Marks an element of a GraphQL schema as no longer supported.", - "locations": [ - "FIELD_DEFINITION", - "ENUM_VALUE", - "ARGUMENT_DEFINITION", - "INPUT_FIELD_DEFINITION" - ], - "args": [ - { - "name": "reason", - "description": "Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by [CommonMark](https://commonmark.org/).", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": "\"No longer supported\"" - } - ] - } - ] - } -} \ No newline at end of file diff --git a/src/openapi/admin-schema-2.4.7.yaml b/src/openapi/admin-schema-2.4.7.yaml new file mode 100644 index 000000000..d5c6b35dd --- /dev/null +++ b/src/openapi/admin-schema-2.4.7.yaml @@ -0,0 +1,34421 @@ +--- +securityDefinitions: + api_key: + type: apiKey + name: api_key + in: header +swagger: '2.0' +info: + version: 2.4.7 + 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: 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/assignRoles +- 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}/confirm +- name: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} +- name: customers/{customerId}/permissions/readonly +- name: customers/{customerId}/shippingAddress +- name: customers/{email}/activate +- name: customers/addresses/{addressId} +- 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/eventSubscribe +- 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}/set-payment-information +- name: negotiable-carts/{cartId}/shipping-information +- name: negotiable-carts/{cartId}/totals +- 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: 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: payments-config/{location} +- name: payments-config/apple-pay/{location} +- name: payments-config/hosted-fields/{location} +- name: payments-config/smart-buttons/{location} +- name: payments-sdk/{location} +- name: payments-sdk/{location}/{methodCode} +- 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/duo_security/get-authentication-data +- 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} +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/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: '' + 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 + 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/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/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/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" + '401': + description: 401 Unauthorized + schema: + "$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/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}/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/{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/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/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: + - 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 + '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 + 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" + 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/ + "/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: '' + 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: '' + 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: '' + 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}/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/{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/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/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/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/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 + - signatureResponse + properties: + tfaToken: + type: string + signatureResponse: + 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 + operationId: PostV1TfaProviderDuo_securityAuthenticate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityAuthenticateBody + in: body + schema: + required: + - username + - password + - signatureResponse + properties: + username: + type: string + password: + type: string + signatureResponse: + 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: Get the information required to configure duo + 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: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-duo-data-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/configure + "/V1/tfa/provider/duo_security/get-authentication-data": + post: + tags: + - tfa/provider/duo_security/get-authentication-data + description: Get the information required to configure duo + operationId: PostV1TfaProviderDuo_securityGetauthenticationdata + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityGetauthenticationdataBody + 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-duo-data-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/get-authentication-data + "/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} + "/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 + 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 + 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 + required: + - name + - parent + - fields + - rules + - destination + - priority + 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 + required: + - name + - converter + 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 + 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-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 + 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 + 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 + 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 + 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" + 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: Get job title. + status: + type: integer + description: Customer status. + telephone: + type: string + description: Get telephone. + 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 + 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" + discounts: + type: array + items: + "$ref": "#/definitions/sales-rule-data-rule-discount-interface" + bundle_product_options: + type: array + items: + "$ref": "#/definitions/bundle-data-option-interface" + stock_item: + "$ref": "#/definitions/catalog-inventory-data-stock-item-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 + 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 + 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 + 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 + website_id: + type: integer + value: + type: number + website_value: + type: number + 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 + max_characters: + type: integer + image_size_x: + type: integer + image_size_y: + type: integer + values: + type: array + 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 + 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 + 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" + 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" + 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 + 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" + 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 + 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. + 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 + 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 + 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 + 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 + 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 interface + 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 interface. + 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 + 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 + 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 + two-factor-auth-data-duo-data-interface: + type: object + description: Represents the data needed to use duo + properties: + signature: + type: string + description: The signature + api_hostname: + type: string + description: The api hostname + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-duo-data-extension-interface" + required: + - signature + - api_hostname + two-factor-auth-data-duo-data-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\DuoDataInterface + 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 + analytics-data-link-interface: + type: object + description: Represents link with collected data and initialized vector for decryption. + properties: + url: + type: string + initialization_vector: + type: string + required: + - url + - initialization_vector + 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 + gift-wrapping-data-wrapping-interface: + type: object + description: Interface WrappingInterface + properties: + wrapping_id: + type: integer + design: + type: string + status: + type: integer + base_price: + type: number + image_name: + type: string + image_base64_content: + type: string + base_currency_code: + type: string + website_ids: + type: array + items: + type: integer + image_url: + type: string + description: Wrapping image URL. + extension_attributes: + "$ref": "#/definitions/gift-wrapping-data-wrapping-extension-interface" + required: + - 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 + 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 + 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 + qty: + type: number + 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 + framework-extensible-data-interface: + type: object + description: Interface for entities which can be extended with extension attributes. + 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 + errors: + type: array + 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 + message: + type: string + 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 + title: + type: string + description: + type: 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 + items: + "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-item-interface" + shippable: + type: boolean + 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 + 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 + 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" + 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 + - 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-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" + 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 + - 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 + required: + - id + - mp_order_id + - status + 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 + required: + - payment_source_details + - id + - mp_order_id + - status + 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 + 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 + 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 + 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: 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/role/ + - company/role/{id} + - company/role/{roleId} + - company/role/{roleId}/users + - company/{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/addresses/{addressId} + - 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}/confirm + - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} + - customers/{customerId}/permissions/readonly + - customers/{customerId}/shippingAddress + - 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/eventSubscribe + - 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}/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/{quoteId} + - negotiableQuote/{quoteId}/comments + - negotiableQuote/{quoteId}/shippingMethod +- 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: payments config + tags: + - payments-config/apple-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: 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/duo_security/get-authentication-data + - 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} diff --git a/src/openapi/customer-schema-2.4.7.yaml b/src/openapi/customer-schema-2.4.7.yaml new file mode 100644 index 000000000..cc3ba706c --- /dev/null +++ b/src/openapi/customer-schema-2.4.7.yaml @@ -0,0 +1,7409 @@ +--- +securityDefinitions: + api_key: + type: apiKey + name: api_key + in: header +swagger: '2.0' +info: + version: 2.4.7 + 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}/set-payment-information +- name: negotiable-carts/{cartId}/shipping-information +- name: negotiable-carts/{cartId}/totals +- name: payments-config/{location} +- name: payments-config/apple-pay/{location} +- name: payments-config/hosted-fields/{location} +- name: payments-config/smart-buttons/{location} +- name: payments-sdk/{location} +- name: payments-sdk/{location}/{methodCode} +- 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/duo_security/get-authentication-data +- 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 + 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: + - 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 + '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 + 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" + 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/ + "/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}/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/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/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/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 + - signatureResponse + properties: + tfaToken: + type: string + signatureResponse: + 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 + operationId: PostV1TfaProviderDuo_securityAuthenticate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityAuthenticateBody + in: body + schema: + required: + - username + - password + - signatureResponse + properties: + username: + type: string + password: + type: string + signatureResponse: + 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: Get the information required to configure duo + 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: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-duo-data-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/configure + "/V1/tfa/provider/duo_security/get-authentication-data": + post: + tags: + - tfa/provider/duo_security/get-authentication-data + description: Get the information required to configure duo + operationId: PostV1TfaProviderDuo_securityGetauthenticationdata + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityGetauthenticationdataBody + 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-duo-data-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/get-authentication-data + "/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" + 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: Get job title. + status: + type: integer + description: Customer status. + telephone: + type: string + description: Get telephone. + 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 + 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 + 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" + 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" + 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 + 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 + 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 + two-factor-auth-data-duo-data-interface: + type: object + description: Represents the data needed to use duo + properties: + signature: + type: string + description: The signature + api_hostname: + type: string + description: The api hostname + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-duo-data-extension-interface" + required: + - signature + - api_hostname + two-factor-auth-data-duo-data-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\DuoDataInterface + 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" + 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 + - 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-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" + 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 + - 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 + required: + - id + - mp_order_id + - status + 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 + required: + - payment_source_details + - id + - mp_order_id + - status + 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 + 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}/set-payment-information + - negotiable-carts/{cartId}/shipping-information + - negotiable-carts/{cartId}/totals +- name: payments config + tags: + - payments-config/apple-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: 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/duo_security/get-authentication-data + - 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.7.yaml b/src/openapi/guest-schema-2.4.7.yaml new file mode 100644 index 000000000..fc3b76c99 --- /dev/null +++ b/src/openapi/guest-schema-2.4.7.yaml @@ -0,0 +1,5809 @@ +--- +securityDefinitions: + api_key: + type: apiKey + name: api_key + in: header +swagger: '2.0' +info: + version: 2.4.7 + 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: payments-config/{location} +- name: payments-config/apple-pay/{location} +- name: payments-config/hosted-fields/{location} +- name: payments-config/smart-buttons/{location} +- name: payments-sdk/{location} +- name: payments-sdk/{location}/{methodCode} +- 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/duo_security/get-authentication-data +- 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 + 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" + 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/ + "/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/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/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 + - signatureResponse + properties: + tfaToken: + type: string + signatureResponse: + 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 + operationId: PostV1TfaProviderDuo_securityAuthenticate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityAuthenticateBody + in: body + schema: + required: + - username + - password + - signatureResponse + properties: + username: + type: string + password: + type: string + signatureResponse: + 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: Get the information required to configure duo + 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: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-duo-data-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/configure + "/V1/tfa/provider/duo_security/get-authentication-data": + post: + tags: + - tfa/provider/duo_security/get-authentication-data + description: Get the information required to configure duo + operationId: PostV1TfaProviderDuo_securityGetauthenticationdata + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityGetauthenticationdataBody + 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-duo-data-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/get-authentication-data + "/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" + 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: Get job title. + status: + type: integer + description: Customer status. + telephone: + type: string + description: Get telephone. + 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 + 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 + 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" + 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" + 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 + 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 + two-factor-auth-data-duo-data-interface: + type: object + description: Represents the data needed to use duo + properties: + signature: + type: string + description: The signature + api_hostname: + type: string + description: The api hostname + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-duo-data-extension-interface" + required: + - signature + - api_hostname + two-factor-auth-data-duo-data-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\DuoDataInterface + 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" + 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 + - 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-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" + 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 + - 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 + required: + - id + - mp_order_id + - status + 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 + required: + - payment_source_details + - id + - mp_order_id + - status + 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 + 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: payments config + tags: + - payments-config/apple-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: 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/duo_security/get-authentication-data + - 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/static/graphql-api/beta/javascripts/spectaql.min.js b/static/graphql-api/beta/javascripts/spectaql.min.js deleted file mode 100644 index 45b7a25e6..000000000 --- a/static/graphql-api/beta/javascripts/spectaql.min.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";function scrollSpy(){var l=5,e=document.querySelector("html"),r=(e&&(e=window.getComputedStyle(e).scrollPaddingTop)&&"string"==typeof e&&"auto"!==e&&e.endsWith("px")&&(l+=parseInt(e.split("px")[0])),"nav-scroll-active"),i="nav-scroll-expand",d=null,s=[];function t(){d=null;var e=document.querySelectorAll("[data-traverse-target]");Array.prototype.forEach.call(e,function(e){s.push({id:e.id,top:e.offsetTop})})}var n=debounce(function(){t(),o()},500),o=debounce(function(){var e,t,n,o,c=function(e){for(var t=e+l,n=0;n=s[n].top&&(!o||t{toggleMenu(),scrollSpy()}); \ No newline at end of file diff --git a/static/graphql-api/beta/stylesheets/spectaql.min.css b/static/graphql-api/beta/stylesheets/spectaql.min.css deleted file mode 100644 index c1093ddaf..000000000 --- a/static/graphql-api/beta/stylesheets/spectaql.min.css +++ /dev/null @@ -1 +0,0 @@ -@import url(https://fonts.googleapis.com/css?family=Barlow:ital,wght@0,400;0,700;1,400;1,700&display=swap);#spectaql{padding:0;margin:0}#spectaql pre{overflow:auto;margin-top:0;margin-bottom:20px}#spectaql pre code{display:block;background:#505050}#spectaql table{width:100%;table-layout:fixed;text-align:left;border-collapse:collapse}#spectaql table td,#spectaql table th{margin:0;padding:0}#spectaql #introduction .example-section>*,#spectaql .definition-heading,#spectaql .doc-heading,#spectaql .introduction-item-title,#spectaql .operation-heading{overflow:hidden;text-overflow:ellipsis}#spectaql #page{display:flex}#spectaql #page *{box-sizing:border-box}#spectaql #page.drawer-open #sidebar{z-index:1000;transform:translateX(0)}#spectaql #page.drawer-open .drawer-overlay{display:block;background:rgba(0,0,0,.5);z-index:10}#spectaql #sidebar{position:fixed;min-width:250px;max-width:250px;flex-shrink:0;transition:transform .2s ease-out;transform:translateX(-100%);z-index:10;padding-top:20px;background:#fff}@media (min-width:48em){#spectaql #sidebar{position:relative;transform:none}}@media (min-width:64em){#spectaql #sidebar{min-width:300px;max-width:300px}}#spectaql .sidebar-top-container{display:flex;align-items:center;padding:0 20px}#spectaql #mobile-navbar{display:flex;align-items:center;position:sticky;top:0}@media (min-width:48em){#spectaql #mobile-navbar{display:none}}#spectaql .sidebar-open-button{display:flex;align-items:flex-start;margin:0;padding:0;border:none;background:0 0}#spectaql .sidebar-open-button .hamburger{width:16px;height:14px;cursor:pointer}#spectaql .sidebar-open-button .hamburger::after{display:block;content:"";height:2px;background:#222;box-shadow:0 5px 0 #222,0 10px 0 #222}#spectaql .sidebar-open-button .sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}#spectaql .close-button{display:block}#spectaql .close-button .sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}@media (min-width:48em){#spectaql .close-button{display:none}}#spectaql .drawer-overlay{display:none;position:absolute;top:0;left:0;bottom:0;right:0;background:rgba(0,0,0,0)}@media (min-width:48em){#spectaql .drawer-overlay{display:none!important}}#spectaql #nav{display:flex;flex-direction:column;max-height:calc(100vh - 0px);padding:0 20px;padding-bottom:20px;position:sticky;top:0;overflow:auto}#spectaql #logo{margin-right:auto}#spectaql #logo img{display:block;width:100%;max-width:100%}#spectaql .nav-group-items,#spectaql .nav-group-section-items{padding:0;margin:0}#spectaql .nav-group-items>li,#spectaql .nav-group-section-items>li{list-style:none}#spectaql .nav-group-items .nav-group-section-title,#spectaql .nav-group-items>li,#spectaql .nav-group-section-items .nav-group-section-title,#spectaql .nav-group-section-items>li{overflow:hidden;text-overflow:ellipsis}#spectaql .nav-group-section-items{display:none}#spectaql .nav-scroll-expand .nav-group-section-items{display:block}#spectaql #docs{position:relative;margin:0 auto;min-width:100px;max-width:88em;flex-grow:1;flex-shrink:1;padding:20px}@media (min-width:48em){#spectaql .doc-row{display:flex;flex-wrap:wrap}}#spectaql .doc-row .doc-copy,#spectaql .doc-row .doc-examples{width:100%}@media (min-width:48em){#spectaql .doc-row .doc-copy,#spectaql .doc-row .doc-examples{width:50%}}@media (min-width:48em){#spectaql .doc-row .doc-copy{padding-right:20px}}@media (min-width:48em){#spectaql .doc-row .doc-examples{padding-left:20px}}.hljs{display:block;overflow-x:auto;padding:.5em;background:#23241f}.hljs,.hljs-subst,.hljs-tag{color:#f8f8f2}.hljs-emphasis,.hljs-strong{color:#a8a8a2}.hljs-bullet,.hljs-link,.hljs-literal,.hljs-number,.hljs-quote,.hljs-regexp{color:#ae81ff}.hljs-code,.hljs-section,.hljs-selector-class,.hljs-title{color:#a6e22e}.hljs-strong{font-weight:700}.hljs-emphasis{font-style:italic}.hljs-attr,.hljs-keyword,.hljs-name,.hljs-selector-tag{color:#f92672}.hljs-attribute,.hljs-symbol{color:#66d9ef}.hljs-class .hljs-title,.hljs-params{color:#f8f8f2}.hljs-addition,.hljs-built_in,.hljs-builtin-name,.hljs-selector-attr,.hljs-selector-id,.hljs-selector-pseudo,.hljs-string,.hljs-template-variable,.hljs-type,.hljs-variable{color:#e6db74}.hljs-comment,.hljs-deletion,.hljs-meta{color:#75715e}#spectaql{font-family:Barlow,"Open Sans",serif;font-size:14px;line-height:1.6;background:#fff;color:#222}@media (min-width:32em){#spectaql{font-size:16px}}#spectaql a{color:#0298bf;text-decoration:none}#spectaql a:hover{color:#0182a2}#spectaql a:active,#spectaql a:focus{color:#0298bf}#spectaql code{font-size:.875em;font-family:Consolas,Monaco,Andale Mono,Ubuntu Mono,monospace}#spectaql pre{color:#fff}#spectaql pre code{background:#222}#spectaql pre code,#spectaql pre code.hljs{font-size:.82em;line-height:1.4;padding:15px 20px}#spectaql .doc-heading{line-height:1.2;font-size:2.25em;margin-top:10px}@media (min-width:48em){#spectaql .doc-heading{margin-top:-10px}}#spectaql .close-button{background:0 0;border:none;padding:5px;font-size:16px;font-weight:700;color:#222}#spectaql #introduction{margin-bottom:60px}#spectaql #introduction .example-section:not(.example-section-is-code){margin-bottom:20px}#spectaql #introduction .example-section:not(.example-section-is-code) h5,#spectaql #introduction .example-section:not(.example-section-is-code) p{margin:0;font-size:1em}#spectaql #docs,#spectaql #mobile-navbar,#spectaql #sidebar{padding-top:20px;padding-bottom:20px}@media (min-width:32em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #sidebar{padding-top:30px;padding-bottom:30px}}@media (min-width:48em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #sidebar{padding-top:40px;padding-bottom:40px}}#spectaql #docs,#spectaql #mobile-navbar,#spectaql #nav,#spectaql .sidebar-top-container{padding-left:20px;padding-right:20px}@media (min-width:32em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #nav,#spectaql .sidebar-top-container{padding-left:30px;padding-right:30px}}@media (min-width:48em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #nav,#spectaql .sidebar-top-container{padding-left:50px;padding-right:50px}}#spectaql #sidebar{padding-bottom:0;background:#fff}#spectaql #sidebar a{color:#222}#spectaql #sidebar a.nav-scroll-active,#spectaql #sidebar a:hover{font-weight:700}#spectaql #sidebar a.nav-scroll-active{color:#222}#spectaql #sidebar a:hover{color:#0182a2}@media (min-width:48em){#spectaql #sidebar{border-right:2px solid #d8d8d8}}#spectaql #mobile-navbar{background:#fff;margin-top:-20px;margin-left:-20px;margin-right:-20px}@media (min-width:32em){#spectaql #mobile-navbar{margin-top:-30px;margin-left:-30px;margin-right:-30px}}#spectaql #mobile-navbar .sidebar-open-button::after{display:block;content:"All Topics";margin-left:10px;color:#222}#spectaql #nav .nav-group{margin-top:20px}#spectaql #nav .nav-group li{margin-bottom:5px}#spectaql #nav .nav-group-title{font-size:.875em;font-weight:400;margin:0 0 6px 0;color:#999}#spectaql #nav .nav-group-section-title{font-size:inherit;margin:0;margin-bottom:5px;font-weight:400}#spectaql #nav .nav-group-section-items{margin-left:.75em}#spectaql .definition,#spectaql .operation{margin-bottom:60px}#spectaql .definition .definition-heading,#spectaql .definition .operation-heading,#spectaql .operation .definition-heading,#spectaql .operation .operation-heading{font-size:1.72em}#spectaql .definition .definition-heading code,#spectaql .definition .operation-heading code,#spectaql .operation .definition-heading code,#spectaql .operation .operation-heading code{font-family:inherit;font-size:inherit;font-weight:inherit}@media (min-width:32em){#spectaql .definition .definition-heading,#spectaql .definition .operation-heading,#spectaql .operation .definition-heading,#spectaql .operation .operation-heading{font-size:2.25em}}#spectaql .definition-group-name,#spectaql .group-heading,#spectaql .operation-group-name{border-top:2px solid #d8d8d8;padding-top:3px;color:#999;font-size:inherit;font-weight:inherit}#spectaql .definition-group-name a,#spectaql .group-heading a,#spectaql .operation-group-name a{color:#999}#spectaql .definition-group-name a:hover,#spectaql .group-heading a:hover,#spectaql .operation-group-name a:hover{font-weight:700}#spectaql .doc-examples{margin-top:20px}#spectaql .doc-examples .example-heading{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}#spectaql .doc-examples .example-section-is-code h5{color:#999;text-transform:uppercase;background:#000;font-size:.75em;font-weight:700;padding:.6em 0 .6em 20px;margin:0;opacity:1}@media (min-width:48em){#spectaql .doc-examples{margin-top:0}}#spectaql .doc-copy p{margin:0 0 20px 0}#spectaql .doc-copy p:last-child{margin-bottom:0}#spectaql .doc-copy table tr th{font-weight:400;border-bottom:2px solid #d8d8d8}#spectaql .doc-copy table tr td{border-bottom:1px solid #e0e0e0}#spectaql .doc-copy table tr.row-has-field-arguments td,#spectaql .doc-copy table tr:last-child td{border-bottom:none}#spectaql .doc-copy table tr td,#spectaql .doc-copy table tr th{padding:5px}#spectaql .doc-copy table tr td:first-child,#spectaql .doc-copy table tr th:first-child{padding-left:0}#spectaql .doc-copy table tr td:last-child,#spectaql .doc-copy table tr th:last-child{padding-right:0}#spectaql .doc-copy .doc-copy-section{margin-bottom:30px}#spectaql .doc-copy .doc-copy-section>h5{margin:0 0 5px 0;font-size:inherit;font-weight:inherit;color:#999}#spectaql .doc-copy .definition-description>h5,#spectaql .doc-copy .definition-properties>h5,#spectaql .doc-copy .operation-description>h5{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}#spectaql .field-arguments{font-size:.875em;background-color:#fafbfc;border:1px solid #e0e0e0;padding:10px;margin-bottom:5px}#spectaql .field-arguments p{margin:10px 0 0 0}#spectaql .field-arguments h5.field-arguments-heading{margin:0;padding:0 0 10px 0;font-weight:inherit;color:#999}#spectaql .field-arguments .field-argument{border-top:1px #e0e0e0 solid;padding:10px 0}#spectaql .field-arguments .field-argument:last-child{padding-bottom:0}#spectaql .field-arguments .field-argument-name{margin:0;font-size:inherit;font-weight:inherit}#spectaql .deprecation-reason{word-break:break-word}#spectaql .deprecation-reason::before{display:inline;content:"Deprecated";padding:2px 5px;margin-right:5px;background:#fed7d8;color:#c60609;font-weight:700;font-size:.875em} \ No newline at end of file diff --git a/static/graphql-api/index.html b/static/graphql-api/index.html index d3c19f4d8..ff45daf26 100644 --- a/static/graphql-api/index.html +++ b/static/graphql-api/index.html @@ -136,6 +136,12 @@
  • giftRegistryTypes
    • +
  • + guestOrder +
    • +
  • + guestOrderByToken +
  • isCompanyAdminEmailAvailable
    • @@ -239,6 +245,9 @@
  • applyCouponToCart
    • +
  • + applyCouponsToCart +
  • applyGiftCardToCart
    • @@ -275,6 +284,9 @@
  • closeNegotiableQuotes
    • +
  • + confirmEmail +
  • contactUs
    • @@ -383,6 +395,12 @@
  • deleteWishlist
    • +
  • + estimateShippingMethods +
    • +
  • + estimateTotals +
  • generateCustomerToken
    • @@ -425,6 +443,9 @@
  • removeCouponFromCart
    • +
  • + removeCouponsFromCart +
  • removeGiftCardFromCart
    • @@ -458,9 +479,6 @@
  • removeStoreCreditFromCart
    • -
  • - renameNegotiableQuote -
  • reorderItems
    • @@ -714,6 +732,12 @@

    Types

  • ApplyCouponToCartOutput
    • +
  • + ApplyCouponsStrategy +
    • +
  • + ApplyCouponsToCartInput +
  • ApplyGiftCardToCartInput
    • @@ -924,6 +948,9 @@

    Types

  • CartItemUpdateInput
    • +
  • + CartItems +
  • CartPrices
    • @@ -1158,6 +1185,12 @@

    Types

  • ConfigurableWishlistItem
    • +
  • + ConfirmEmailInput +
    • +
  • + ConfirmationStatusEnum +
  • ContactUsInput
    • @@ -1521,6 +1554,15 @@

    Types

  • ErrorInterface
    • +
  • + EstimateAddressInput +
    • +
  • + EstimateTotalsInput +
    • +
  • + EstimateTotalsOutput +
  • ExchangeRate
    • @@ -1905,6 +1947,9 @@

    Types

  • OrderAddress
    • +
  • + OrderInformationInput +
  • OrderItem
    • @@ -1920,6 +1965,9 @@

    Types

  • OrderShipment
    • +
  • + OrderTokenInput +
  • OrderTotal
    • @@ -2016,6 +2064,12 @@

    Types

  • PlaceNegotiableQuoteOrderOutput
    • +
  • + PlaceOrderError +
    • +
  • + PlaceOrderErrorCodes +
  • PlaceOrderForPurchaseOrderInput
    • @@ -2208,6 +2262,9 @@

    Types

  • PurchaseOrdersFilterInput
    • +
  • + QuoteItemsSortInput +
  • ReCaptchaConfigurationV3
    • @@ -2223,6 +2280,9 @@

    Types

  • RemoveCouponFromCartOutput
    • +
  • + RemoveCouponsFromCartInput +
  • RemoveGiftCardFromCartInput
    • @@ -2271,12 +2331,6 @@

    Types

  • RemoveStoreCreditFromCartOutput
    • -
  • - RenameNegotiableQuoteInput -
    • -
  • - RenameNegotiableQuoteOutput -
  • ReorderItemsOutput
    • @@ -2586,6 +2640,9 @@

    Types

  • SortFields
    • +
  • + SortQuoteItemsEnum +
  • StoreConfig
    • @@ -2622,6 +2679,9 @@

    Types

  • TaxItem
    • +
  • + TaxWrappingEnum +
  • TextSwatchData
    • @@ -2884,7 +2944,7 @@
    Query
    Variables
    - 
    {"formCode": "xyz789"}
+                  
    {"formCode": "abc123"}
 
     
                   
                 
@@ -3156,8 +3216,10 @@ 
    Query
    
     braintree_paypal_require_billing_address
     braintree_paypal_send_cart_line_items
     braintree_paypal_vault_active
+    cart_expires_in_days
     cart_gift_wrapping
     cart_printed_card
+    cart_summary_display_quantity
     catalog_default_sort_by
     category_fixed_product_tax_display_setting
     category_url_suffix
@@ -3179,6 +3241,8 @@ 
    Query
    
     contact_enabled
     copyright
     countries_with_required_region
+    create_account_confirmation
+    customer_access_token_lifetime
     default_country
     default_description
     default_display_currency_code
@@ -3223,6 +3287,8 @@ 
    Query
    
     magento_wishlist_general_is_enabled
     max_items_in_order_summary
     maximum_number_of_wishlists
+    minicart_display
+    minicart_max_items
     minimum_password_length
     newsletter_enabled
     no_route
@@ -3256,6 +3322,7 @@ 
    Query
    
     shopping_cart_display_price
     shopping_cart_display_shipping
     shopping_cart_display_subtotal
+    shopping_cart_display_tax_gift_wrapping
     shopping_cart_display_zero_tax
     show_cms_breadcrumbs
     store_code
@@ -3289,7 +3356,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"useCurrentGroup": false}
+                  
    {"useCurrentGroup": true}
 
     
                   
                 
@@ -3302,216 +3369,223 @@ 
    Response
    
     "availableStores": [
       {
         "absolute_footer": "abc123",
-        "allow_gift_receipt": "abc123",
+        "allow_gift_receipt": "xyz789",
         "allow_gift_wrapping_on_order": "abc123",
         "allow_gift_wrapping_on_order_items": "xyz789",
-        "allow_guests_to_write_product_reviews": "abc123",
+        "allow_guests_to_write_product_reviews": "xyz789",
         "allow_items": "abc123",
-        "allow_order": "xyz789",
-        "allow_printed_card": "xyz789",
-        "autocomplete_on_storefront": true,
+        "allow_order": "abc123",
+        "allow_printed_card": "abc123",
+        "autocomplete_on_storefront": false,
         "base_currency_code": "abc123",
         "base_link_url": "xyz789",
         "base_media_url": "abc123",
         "base_static_url": "abc123",
         "base_url": "xyz789",
-        "braintree_3dsecure_allowspecific": false,
+        "braintree_3dsecure_allowspecific": true,
         "braintree_3dsecure_always_request_3ds": false,
-        "braintree_3dsecure_specificcountry": "xyz789",
+        "braintree_3dsecure_specificcountry": "abc123",
         "braintree_3dsecure_threshold_amount": "abc123",
         "braintree_3dsecure_verify_3dsecure": false,
         "braintree_ach_direct_debit_vault_active": false,
-        "braintree_applepay_merchant_name": "xyz789",
-        "braintree_applepay_vault_active": false,
-        "braintree_cc_vault_active": "abc123",
-        "braintree_cc_vault_cvv": false,
+        "braintree_applepay_merchant_name": "abc123",
+        "braintree_applepay_vault_active": true,
+        "braintree_cc_vault_active": "xyz789",
+        "braintree_cc_vault_cvv": true,
         "braintree_environment": "abc123",
         "braintree_googlepay_btn_color": "xyz789",
         "braintree_googlepay_cctypes": "abc123",
-        "braintree_googlepay_merchant_id": "xyz789",
+        "braintree_googlepay_merchant_id": "abc123",
         "braintree_googlepay_vault_active": false,
         "braintree_local_payment_allowed_methods": "xyz789",
-        "braintree_local_payment_fallback_button_text": "abc123",
-        "braintree_local_payment_redirect_on_fail": "xyz789",
+        "braintree_local_payment_fallback_button_text": "xyz789",
+        "braintree_local_payment_redirect_on_fail": "abc123",
         "braintree_merchant_account_id": "abc123",
-        "braintree_paypal_button_location_cart_type_credit_color": "xyz789",
+        "braintree_paypal_button_location_cart_type_credit_color": "abc123",
         "braintree_paypal_button_location_cart_type_credit_label": "xyz789",
         "braintree_paypal_button_location_cart_type_credit_shape": "abc123",
-        "braintree_paypal_button_location_cart_type_credit_show": true,
-        "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
+        "braintree_paypal_button_location_cart_type_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_show": true,
         "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
         "braintree_paypal_button_location_cart_type_paylater_color": "xyz789",
-        "braintree_paypal_button_location_cart_type_paylater_label": "abc123",
+        "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
         "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
-        "braintree_paypal_button_location_cart_type_paylater_show": false,
+        "braintree_paypal_button_location_cart_type_paylater_show": true,
         "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
-        "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
+        "braintree_paypal_button_location_cart_type_paypal_label": "abc123",
         "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789",
-        "braintree_paypal_button_location_cart_type_paypal_show": true,
+        "braintree_paypal_button_location_cart_type_paypal_show": false,
         "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
-        "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
-        "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
+        "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
+        "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
         "braintree_paypal_button_location_checkout_type_credit_show": true,
-        "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
+        "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
         "braintree_paypal_button_location_checkout_type_messaging_logo": "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": "xyz789",
+        "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
         "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
         "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
         "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
-        "braintree_paypal_button_location_checkout_type_paylater_show": false,
+        "braintree_paypal_button_location_checkout_type_paylater_show": true,
         "braintree_paypal_button_location_checkout_type_paypal_color": "xyz789",
         "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
         "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
-        "braintree_paypal_button_location_checkout_type_paypal_show": true,
-        "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
-        "braintree_paypal_button_location_productpage_type_credit_label": "xyz789",
-        "braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
+        "braintree_paypal_button_location_checkout_type_paypal_show": false,
+        "braintree_paypal_button_location_productpage_type_credit_color": "xyz789",
+        "braintree_paypal_button_location_productpage_type_credit_label": "abc123",
+        "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789",
         "braintree_paypal_button_location_productpage_type_credit_show": false,
         "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
-        "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
-        "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123",
-        "braintree_paypal_button_location_productpage_type_messaging_show": true,
+        "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789",
+        "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
+        "braintree_paypal_button_location_productpage_type_messaging_show": false,
         "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
-        "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
+        "braintree_paypal_button_location_productpage_type_paylater_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_shape": "abc123",
         "braintree_paypal_button_location_productpage_type_paylater_show": false,
-        "braintree_paypal_button_location_productpage_type_paypal_color": "abc123",
-        "braintree_paypal_button_location_productpage_type_paypal_label": "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": "abc123",
-        "braintree_paypal_button_location_productpage_type_paypal_show": false,
-        "braintree_paypal_credit_uk_merchant_name": "abc123",
+        "braintree_paypal_button_location_productpage_type_paypal_show": true,
+        "braintree_paypal_credit_uk_merchant_name": "xyz789",
         "braintree_paypal_display_on_shopping_cart": false,
         "braintree_paypal_merchant_country": "xyz789",
-        "braintree_paypal_merchant_name_override": "abc123",
-        "braintree_paypal_require_billing_address": true,
+        "braintree_paypal_merchant_name_override": "xyz789",
+        "braintree_paypal_require_billing_address": false,
         "braintree_paypal_send_cart_line_items": false,
         "braintree_paypal_vault_active": true,
-        "cart_gift_wrapping": "abc123",
-        "cart_printed_card": "xyz789",
+        "cart_expires_in_days": 987,
+        "cart_gift_wrapping": "xyz789",
+        "cart_printed_card": "abc123",
+        "cart_summary_display_quantity": 123,
         "catalog_default_sort_by": "abc123",
         "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
         "category_url_suffix": "abc123",
-        "check_money_order_enable_for_specific_countries": false,
+        "check_money_order_enable_for_specific_countries": true,
         "check_money_order_enabled": true,
-        "check_money_order_make_check_payable_to": "xyz789",
-        "check_money_order_max_order_total": "abc123",
+        "check_money_order_make_check_payable_to": "abc123",
+        "check_money_order_max_order_total": "xyz789",
         "check_money_order_min_order_total": "abc123",
-        "check_money_order_new_order_status": "abc123",
-        "check_money_order_payment_from_specific_countries": "xyz789",
+        "check_money_order_new_order_status": "xyz789",
+        "check_money_order_payment_from_specific_countries": "abc123",
         "check_money_order_send_check_to": "xyz789",
         "check_money_order_sort_order": 123,
         "check_money_order_title": "xyz789",
-        "cms_home_page": "abc123",
+        "cms_home_page": "xyz789",
         "cms_no_cookies": "xyz789",
         "cms_no_route": "abc123",
-        "code": "abc123",
+        "code": "xyz789",
         "configurable_thumbnail_source": "abc123",
         "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_description": "abc123",
+        "default_description": "xyz789",
         "default_display_currency_code": "xyz789",
-        "default_keywords": "abc123",
-        "default_title": "xyz789",
-        "demonotice": 987,
+        "default_keywords": "xyz789",
+        "default_title": "abc123",
+        "demonotice": 123,
         "display_state_if_optional": false,
         "enable_multiple_wishlists": "xyz789",
-        "front": "xyz789",
+        "front": "abc123",
         "grid_per_page": 987,
         "grid_per_page_values": "abc123",
-        "head_includes": "xyz789",
+        "head_includes": "abc123",
         "head_shortcut_icon": "xyz789",
         "header_logo_src": "abc123",
-        "id": 987,
+        "id": 123,
         "is_default_store": false,
-        "is_default_store_group": false,
+        "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",
         "list_mode": "abc123",
-        "list_per_page": 123,
-        "list_per_page_values": "xyz789",
-        "locale": "xyz789",
-        "logo_alt": "xyz789",
-        "logo_height": 987,
+        "list_per_page": 987,
+        "list_per_page_values": "abc123",
+        "locale": "abc123",
+        "logo_alt": "abc123",
+        "logo_height": 123,
         "logo_width": 987,
-        "magento_reward_general_is_enabled": "xyz789",
-        "magento_reward_general_is_enabled_on_front": "abc123",
+        "magento_reward_general_is_enabled": "abc123",
+        "magento_reward_general_is_enabled_on_front": "xyz789",
         "magento_reward_general_min_points_balance": "abc123",
-        "magento_reward_general_publish_history": "xyz789",
+        "magento_reward_general_publish_history": "abc123",
         "magento_reward_points_invitation_customer": "abc123",
-        "magento_reward_points_invitation_customer_limit": "abc123",
+        "magento_reward_points_invitation_customer_limit": "xyz789",
         "magento_reward_points_invitation_order": "abc123",
-        "magento_reward_points_invitation_order_limit": "xyz789",
-        "magento_reward_points_newsletter": "abc123",
+        "magento_reward_points_invitation_order_limit": "abc123",
+        "magento_reward_points_newsletter": "xyz789",
         "magento_reward_points_order": "abc123",
-        "magento_reward_points_register": "xyz789",
-        "magento_reward_points_review": "xyz789",
-        "magento_reward_points_review_limit": "abc123",
+        "magento_reward_points_register": "abc123",
+        "magento_reward_points_review": "abc123",
+        "magento_reward_points_review_limit": "xyz789",
         "magento_wishlist_general_is_enabled": "abc123",
         "max_items_in_order_summary": 123,
         "maximum_number_of_wishlists": "abc123",
+        "minicart_display": false,
+        "minicart_max_items": 123,
         "minimum_password_length": "xyz789",
-        "newsletter_enabled": true,
+        "newsletter_enabled": false,
         "no_route": "abc123",
         "optional_zip_countries": "xyz789",
-        "order_cancellation_enabled": true,
+        "order_cancellation_enabled": false,
         "order_cancellation_reasons": [
           CancellationReason
         ],
-        "payment_payflowpro_cc_vault_active": "xyz789",
+        "payment_payflowpro_cc_vault_active": "abc123",
         "printed_card_price": "abc123",
         "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-        "product_reviews_enabled": "xyz789",
+        "product_reviews_enabled": "abc123",
         "product_url_suffix": "abc123",
-        "quickorder_active": true,
+        "quickorder_active": false,
         "required_character_classes_number": "xyz789",
-        "returns_enabled": "abc123",
-        "root_category_id": 987,
-        "root_category_uid": "4",
+        "returns_enabled": "xyz789",
+        "root_category_id": 123,
+        "root_category_uid": 4,
         "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
         "sales_gift_wrapping": "abc123",
         "sales_printed_card": "abc123",
-        "secure_base_link_url": "abc123",
+        "secure_base_link_url": "xyz789",
         "secure_base_media_url": "abc123",
         "secure_base_static_url": "xyz789",
         "secure_base_url": "abc123",
         "send_friend": SendFriendConfiguration,
         "shopping_cart_display_full_summary": true,
-        "shopping_cart_display_grand_total": true,
-        "shopping_cart_display_price": 987,
-        "shopping_cart_display_shipping": 123,
+        "shopping_cart_display_grand_total": false,
+        "shopping_cart_display_price": 123,
+        "shopping_cart_display_shipping": 987,
         "shopping_cart_display_subtotal": 987,
+        "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
         "shopping_cart_display_zero_tax": false,
         "show_cms_breadcrumbs": 123,
         "store_code": "4",
         "store_group_code": "4",
         "store_group_name": "abc123",
         "store_name": "abc123",
-        "store_sort_order": 123,
-        "timezone": "xyz789",
-        "title_prefix": "xyz789",
-        "title_separator": "xyz789",
+        "store_sort_order": 987,
+        "timezone": "abc123",
+        "title_prefix": "abc123",
+        "title_separator": "abc123",
         "title_suffix": "xyz789",
         "use_store_in_url": false,
-        "website_code": "4",
-        "website_id": 123,
+        "website_code": 4,
+        "website_id": 987,
         "website_name": "abc123",
-        "weight_unit": "xyz789",
-        "welcome": "xyz789",
-        "zero_subtotal_enable_for_specific_countries": true,
+        "weight_unit": "abc123",
+        "welcome": "abc123",
+        "zero_subtotal_enable_for_specific_countries": false,
         "zero_subtotal_enabled": false,
         "zero_subtotal_new_order_status": "abc123",
         "zero_subtotal_payment_action": "xyz789",
-        "zero_subtotal_payment_from_specific_countries": "xyz789",
+        "zero_subtotal_payment_from_specific_countries": "abc123",
         "zero_subtotal_sort_order": 123,
         "zero_subtotal_title": "xyz789"
       }
@@ -3613,6 +3687,9 @@ 
    Query
    
     items {
       ...CartItemInterfaceFragment
     }
+    itemsV2 {
+      ...CartItemsFragment
+    }
     prices {
       ...CartPricesFragment
     }
@@ -3633,7 +3710,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}
 
     
                   
                 
@@ -3654,18 +3731,19 @@ 
    Response
    
         AvailablePaymentMethod
       ],
       "billing_address": BillingCartAddress,
-      "email": "xyz789",
+      "email": "abc123",
       "gift_message": GiftMessage,
       "gift_receipt_included": false,
       "gift_wrapping": GiftWrapping,
-      "id": "4",
-      "is_virtual": false,
+      "id": 4,
+      "is_virtual": true,
       "items": [CartItemInterface],
+      "itemsV2": CartItems,
       "prices": CartPrices,
       "printed_card_included": true,
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
-      "total_quantity": 987.65
+      "total_quantity": 123.45
     }
   }
 }
@@ -3925,38 +4003,38 @@ 
    Response
    
       "breadcrumbs": [Breadcrumb],
       "canonical_url": "abc123",
       "children": [CategoryTree],
-      "children_count": "abc123",
+      "children_count": "xyz789",
       "cms_block": CmsBlock,
       "created_at": "xyz789",
       "custom_layout_update_file": "abc123",
       "default_sort_by": "abc123",
       "description": "xyz789",
-      "display_mode": "abc123",
+      "display_mode": "xyz789",
       "filter_price_range": 123.45,
-      "id": 123,
+      "id": 987,
       "image": "abc123",
-      "include_in_menu": 987,
+      "include_in_menu": 123,
       "is_anchor": 987,
-      "landing_page": 123,
-      "level": 987,
-      "meta_description": "abc123",
+      "landing_page": 987,
+      "level": 123,
+      "meta_description": "xyz789",
       "meta_keywords": "abc123",
       "meta_title": "abc123",
       "name": "abc123",
       "path": "xyz789",
-      "path_in_store": "xyz789",
+      "path_in_store": "abc123",
       "position": 987,
-      "product_count": 987,
+      "product_count": 123,
       "products": CategoryProducts,
       "redirect_code": 123,
-      "relative_url": "abc123",
-      "staged": false,
+      "relative_url": "xyz789",
+      "staged": true,
       "type": "CMS_PAGE",
-      "uid": 4,
-      "updated_at": "xyz789",
+      "uid": "4",
+      "updated_at": "abc123",
       "url_key": "xyz789",
       "url_path": "abc123",
-      "url_suffix": "abc123"
+      "url_suffix": "xyz789"
     }
   }
 }
@@ -4124,40 +4202,40 @@ 
    Response
    
         "automatic_sorting": "abc123",
         "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": "xyz789",
-        "custom_layout_update_file": "abc123",
-        "default_sort_by": "xyz789",
+        "custom_layout_update_file": "xyz789",
+        "default_sort_by": "abc123",
         "description": "xyz789",
-        "display_mode": "xyz789",
-        "filter_price_range": 123.45,
-        "id": 987,
-        "image": "abc123",
-        "include_in_menu": 987,
+        "display_mode": "abc123",
+        "filter_price_range": 987.65,
+        "id": 123,
+        "image": "xyz789",
+        "include_in_menu": 123,
         "is_anchor": 123,
         "landing_page": 123,
         "level": 123,
-        "meta_description": "xyz789",
-        "meta_keywords": "abc123",
+        "meta_description": "abc123",
+        "meta_keywords": "xyz789",
         "meta_title": "abc123",
         "name": "xyz789",
         "path": "abc123",
-        "path_in_store": "xyz789",
-        "position": 987,
-        "product_count": 987,
+        "path_in_store": "abc123",
+        "position": 123,
+        "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",
+        "uid": 4,
+        "updated_at": "abc123",
+        "url_key": "xyz789",
         "url_path": "xyz789",
-        "url_suffix": "xyz789"
+        "url_suffix": "abc123"
       }
     ]
   }
@@ -4220,11 +4298,11 @@ 
    Response
    
       {
         "agreement_id": 123,
         "checkbox_text": "abc123",
-        "content": "abc123",
-        "content_height": "abc123",
-        "is_html": true,
+        "content": "xyz789",
+        "content_height": "xyz789",
+        "is_html": false,
         "mode": "AUTO",
-        "name": "xyz789"
+        "name": "abc123"
       }
     ]
   }
@@ -4299,7 +4377,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"identifiers": ["xyz789"]}
+                  
    {"identifiers": ["abc123"]}
 
     
                   
                 
@@ -4402,7 +4480,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"id": 987, "identifier": "abc123"}
+                  
    {"id": 123, "identifier": "abc123"}
 
     
                   
                 
@@ -4414,17 +4492,17 @@ 
    Response
    
   "data": {
     "cmsPage": {
       "content": "xyz789",
-      "content_heading": "abc123",
-      "identifier": "xyz789",
-      "meta_description": "xyz789",
-      "meta_keywords": "abc123",
-      "meta_title": "xyz789",
+      "content_heading": "xyz789",
+      "identifier": "abc123",
+      "meta_description": "abc123",
+      "meta_keywords": "xyz789",
+      "meta_title": "abc123",
       "page_layout": "abc123",
-      "redirect_code": 123,
-      "relative_url": "abc123",
+      "redirect_code": 987,
+      "relative_url": "xyz789",
       "title": "abc123",
       "type": "CMS_PAGE",
-      "url_key": "xyz789"
+      "url_key": "abc123"
     }
   }
 }
@@ -4524,12 +4602,12 @@ 
    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": ["xyz789"],
-      "reseller_id": "abc123",
+      "reseller_id": "xyz789",
       "role": CompanyRole,
       "roles": CompanyRoles,
       "sales_representative": CompanySalesRepresentative,
@@ -4537,7 +4615,7 @@ 
    Response
    
       "team": CompanyTeam,
       "user": Customer,
       "users": CompanyUsers,
-      "vat_tax_id": "abc123"
+      "vat_tax_id": "xyz789"
     }
   }
 }
@@ -4616,7 +4694,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"uid": 4}
+                  
    {"uid": "4"}
 
     
                   
                 
@@ -4628,7 +4706,7 @@ 
    Response
    
   "data": {
     "compareList": {
       "attributes": [ComparableAttribute],
-      "item_count": 987,
+      "item_count": 123,
       "items": [ComparableItem],
       "uid": "4"
     }
@@ -4695,8 +4773,8 @@ 
    Response
    
         "full_name_english": "xyz789",
         "full_name_locale": "abc123",
         "id": "abc123",
-        "three_letter_abbreviation": "xyz789",
-        "two_letter_abbreviation": "xyz789"
+        "three_letter_abbreviation": "abc123",
+        "two_letter_abbreviation": "abc123"
       }
     ]
   }
@@ -4788,11 +4866,11 @@ 
    Response
    
   "data": {
     "country": {
       "available_regions": [Region],
-      "full_name_english": "xyz789",
+      "full_name_english": "abc123",
       "full_name_locale": "xyz789",
       "id": "abc123",
       "three_letter_abbreviation": "xyz789",
-      "two_letter_abbreviation": "abc123"
+      "two_letter_abbreviation": "xyz789"
     }
   }
 }
@@ -4855,14 +4933,14 @@ 
    Response
    
   "data": {
     "currency": {
       "available_currency_codes": [
-        "xyz789"
+        "abc123"
       ],
-      "base_currency_code": "abc123",
+      "base_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": "xyz789",
+      "default_display_currecy_symbol": "xyz789",
+      "default_display_currency_code": "xyz789",
+      "default_display_currency_symbol": "abc123",
       "exchange_rates": [ExchangeRate]
     }
   }
@@ -5089,6 +5167,7 @@ 
    Query
    
     compare_list {
       ...CompareListFragment
     }
+    confirmation_status
     created_at
     custom_attributes {
       ...AttributeValueInterfaceFragment
@@ -5183,27 +5262,28 @@ 
    Response
    
   "data": {
     "customer": {
       "addresses": [CustomerAddress],
-      "allow_remote_shopping_assistance": true,
+      "allow_remote_shopping_assistance": false,
       "compare_list": CompareList,
-      "created_at": "abc123",
+      "confirmation_status": "ACCOUNT_CONFIRMED",
+      "created_at": "xyz789",
       "custom_attributes": [AttributeValueInterface],
       "date_of_birth": "xyz789",
       "default_billing": "abc123",
-      "default_shipping": "abc123",
-      "dob": "abc123",
+      "default_shipping": "xyz789",
+      "dob": "xyz789",
       "email": "xyz789",
-      "firstname": "abc123",
+      "firstname": "xyz789",
       "gender": 987,
       "gift_registries": [GiftRegistry],
       "gift_registry": GiftRegistry,
-      "group_id": 123,
-      "id": 123,
+      "group_id": 987,
+      "id": 987,
       "is_subscribed": false,
-      "job_title": "abc123",
+      "job_title": "xyz789",
       "lastname": "xyz789",
       "middlename": "abc123",
       "orders": CustomerOrders,
-      "prefix": "abc123",
+      "prefix": "xyz789",
       "purchase_order": PurchaseOrder,
       "purchase_order_approval_rule": PurchaseOrderApprovalRule,
       "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
@@ -5220,9 +5300,9 @@ 
    Response
    
       "store_credit": CustomerStoreCredit,
       "structure_id": 4,
       "suffix": "xyz789",
-      "taxvat": "xyz789",
+      "taxvat": "abc123",
       "team": CompanyTeam,
-      "telephone": "abc123",
+      "telephone": "xyz789",
       "wishlist": Wishlist,
       "wishlist_v2": Wishlist,
       "wishlists": [Wishlist]
@@ -5302,6 +5382,9 @@ 
    Query
    
     items {
       ...CartItemInterfaceFragment
     }
+    itemsV2 {
+      ...CartItemsFragment
+    }
     prices {
       ...CartPricesFragment
     }
@@ -5335,15 +5418,16 @@ 
    Response
    
         AvailablePaymentMethod
       ],
       "billing_address": BillingCartAddress,
-      "email": "xyz789",
+      "email": "abc123",
       "gift_message": GiftMessage,
-      "gift_receipt_included": false,
+      "gift_receipt_included": true,
       "gift_wrapping": GiftWrapping,
-      "id": 4,
-      "is_virtual": false,
+      "id": "4",
+      "is_virtual": true,
       "items": [CartItemInterface],
+      "itemsV2": CartItems,
       "prices": CartPrices,
-      "printed_card_included": true,
+      "printed_card_included": false,
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
       "total_quantity": 123.45
@@ -5461,7 +5545,7 @@ 
    Response
    
     "customerOrders": {
       "items": [CustomerOrder],
       "page_info": SearchResultPageInfo,
-      "total_count": 987
+      "total_count": 123
     }
   }
 }
@@ -5635,7 +5719,7 @@ 
    Response
    
     "dynamicBlocks": {
       "items": [DynamicBlock],
       "page_info": SearchResultPageInfo,
-      "total_count": 123
+      "total_count": 987
     }
   }
 }
@@ -6006,7 +6090,7 @@ 
    Response
    
                   
    {
   "data": {
     "getPaymentOrder": {
-      "id": "abc123",
+      "id": "xyz789",
       "mp_order_id": "xyz789",
       "payment_source_details": PaymentSourceDetails,
       "status": "abc123"
@@ -6274,7 +6358,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"giftRegistryUid": 4}
+                  
    {"giftRegistryUid": "4"}
 
     
                   
                 
@@ -6291,7 +6375,7 @@ 
    Response
    
       ],
       "event_name": "abc123",
       "items": [GiftRegistryItemInterface],
-      "message": "abc123",
+      "message": "xyz789",
       "owner_name": "abc123",
       "privacy_settings": "PRIVATE",
       "registrants": [GiftRegistryRegistrant],
@@ -6375,7 +6459,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
 
     
                   
                 
@@ -6388,9 +6472,9 @@ 
    Response
    
     "giftRegistryEmailSearch": [
       {
         "event_date": "xyz789",
-        "event_title": "abc123",
-        "gift_registry_uid": "4",
-        "location": "xyz789",
+        "event_title": "xyz789",
+        "gift_registry_uid": 4,
+        "location": "abc123",
         "name": "abc123",
         "type": "xyz789"
       }
@@ -6482,8 +6566,8 @@ 
    Response
    
   "data": {
     "giftRegistryIdSearch": [
       {
-        "event_date": "xyz789",
-        "event_title": "abc123",
+        "event_date": "abc123",
+        "event_title": "xyz789",
         "gift_registry_uid": 4,
         "location": "abc123",
         "name": "xyz789",
@@ -6592,9 +6676,9 @@ 
    Variables
    
                   
                   
                   
    {
-  "firstName": "abc123",
-  "lastName": "abc123",
-  "giftRegistryTypeUid": "4"
+  "firstName": "xyz789",
+  "lastName": "xyz789",
+  "giftRegistryTypeUid": 4
 }
 
     
                   
@@ -6608,10 +6692,10 @@ 
    Response
    
     "giftRegistryTypeSearch": [
       {
         "event_date": "xyz789",
-        "event_title": "abc123",
+        "event_title": "xyz789",
         "gift_registry_uid": "4",
-        "location": "xyz789",
-        "name": "abc123",
+        "location": "abc123",
+        "name": "xyz789",
         "type": "abc123"
       }
     ]
@@ -6675,7 +6759,7 @@ 
    Response
    
           GiftRegistryDynamicAttributeMetadataInterface
         ],
         "label": "abc123",
-        "uid": "4"
+        "uid": 4
       }
     ]
   }
@@ -6686,16 +6770,16 @@ 
    Response
    
               
             
           
-          
    
+          
    
             
    
               Queries
             
    
-            
     isCompanyAdminEmailAvailable 
    
+            
     guestOrder 
    
             
    
               
    
                 
    
                   
    Description
    
-                  
    Check whether the specified email can be used to register a company admin.
    
+                  
    Retrieve guest order details based on number, email and postcode.
    
                 
    
               
    
             
    
@@ -6703,8 +6787,8 @@ 
    Description
    
               
    
                 
    
                   
    Response
    
-                  
     Returns an
-                    IsCompanyAdminEmailAvailableOutput
+                  
     Returns a
+                    CustomerOrder!
                   
    
                 
    
                 
    
@@ -6719,9 +6803,9 @@ 
    Arguments
    
                     
                       
                         
-                          email -
+                          input -
                           
-                            String!
+                            OrderInformationInput!
                           
                         
                          
@@ -6736,9 +6820,64 @@ 
    Example
    
                   
    Query
    
                   
                   
-                  
    query isCompanyAdminEmailAvailable($email: String!) {
-  isCompanyAdminEmailAvailable(email: $email) {
-    is_email_available
+                  
    query guestOrder($input: OrderInformationInput!) {
+  guestOrder(input: $input) {
+    applied_coupons {
+      ...AppliedCouponFragment
+    }
+    billing_address {
+      ...OrderAddressFragment
+    }
+    carrier
+    comments {
+      ...SalesCommentItemFragment
+    }
+    created_at
+    credit_memos {
+      ...CreditMemoFragment
+    }
+    email
+    gift_message {
+      ...GiftMessageFragment
+    }
+    gift_receipt_included
+    gift_wrapping {
+      ...GiftWrappingFragment
+    }
+    grand_total
+    id
+    increment_id
+    invoices {
+      ...InvoiceFragment
+    }
+    items {
+      ...OrderItemInterfaceFragment
+    }
+    items_eligible_for_return {
+      ...OrderItemInterfaceFragment
+    }
+    number
+    order_date
+    order_number
+    payment_methods {
+      ...OrderPaymentMethodFragment
+    }
+    printed_card_included
+    returns {
+      ...ReturnsFragment
+    }
+    shipments {
+      ...OrderShipmentFragment
+    }
+    shipping_address {
+      ...OrderAddressFragment
+    }
+    shipping_method
+    status
+    token
+    total {
+      ...OrderTotalFragment
+    }
   }
 }
 
     
@@ -6748,7 +6887,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"email": "abc123"}
+                  
    {"input": OrderInformationInput}
 
     
                   
                 
    
@@ -6756,23 +6895,56 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}}
+                  
    {
+  "data": {
+    "guestOrder": {
+      "applied_coupons": [AppliedCoupon],
+      "billing_address": OrderAddress,
+      "carrier": "abc123",
+      "comments": [SalesCommentItem],
+      "created_at": "xyz789",
+      "credit_memos": [CreditMemo],
+      "email": "xyz789",
+      "gift_message": GiftMessage,
+      "gift_receipt_included": true,
+      "gift_wrapping": GiftWrapping,
+      "grand_total": 123.45,
+      "id": 4,
+      "increment_id": "xyz789",
+      "invoices": [Invoice],
+      "items": [OrderItemInterface],
+      "items_eligible_for_return": [OrderItemInterface],
+      "number": "abc123",
+      "order_date": "abc123",
+      "order_number": "xyz789",
+      "payment_methods": [OrderPaymentMethod],
+      "printed_card_included": true,
+      "returns": Returns,
+      "shipments": [OrderShipment],
+      "shipping_address": OrderAddress,
+      "shipping_method": "xyz789",
+      "status": "abc123",
+      "token": "abc123",
+      "total": OrderTotal
+    }
+  }
+}
 
     
                   
                 
    
               
             
           
    
-          
    
+          
    
             
    
               Queries
             
    
-            
     isCompanyEmailAvailable 
    
+            
     guestOrderByToken 
    
             
    
               
    
                 
    
                   
    Description
    
-                  
    Check whether the specified email can be used to register a new company.
    
+                  
    Retrieve guest order details based on token.
    
                 
    
               
    
             
    
@@ -6780,8 +6952,8 @@ 
    Description
    
               
    
                 
    
                   
    Response
    
-                  
     Returns an
-                    IsCompanyEmailAvailableOutput
+                  
     Returns a
+                    CustomerOrder!
                   
    
                 
    
                 
    
@@ -6796,9 +6968,9 @@ 
    Arguments
    
                     
                       
                         
-                          email -
+                          input -
                           
-                            String!
+                            OrderTokenInput!
                           
                         
                          
@@ -6813,9 +6985,64 @@ 
    Example
    
                   
    Query
    
                   
                   
-                  
    query isCompanyEmailAvailable($email: String!) {
-  isCompanyEmailAvailable(email: $email) {
-    is_email_available
+                  
    query guestOrderByToken($input: OrderTokenInput!) {
+  guestOrderByToken(input: $input) {
+    applied_coupons {
+      ...AppliedCouponFragment
+    }
+    billing_address {
+      ...OrderAddressFragment
+    }
+    carrier
+    comments {
+      ...SalesCommentItemFragment
+    }
+    created_at
+    credit_memos {
+      ...CreditMemoFragment
+    }
+    email
+    gift_message {
+      ...GiftMessageFragment
+    }
+    gift_receipt_included
+    gift_wrapping {
+      ...GiftWrappingFragment
+    }
+    grand_total
+    id
+    increment_id
+    invoices {
+      ...InvoiceFragment
+    }
+    items {
+      ...OrderItemInterfaceFragment
+    }
+    items_eligible_for_return {
+      ...OrderItemInterfaceFragment
+    }
+    number
+    order_date
+    order_number
+    payment_methods {
+      ...OrderPaymentMethodFragment
+    }
+    printed_card_included
+    returns {
+      ...ReturnsFragment
+    }
+    shipments {
+      ...OrderShipmentFragment
+    }
+    shipping_address {
+      ...OrderAddressFragment
+    }
+    shipping_method
+    status
+    token
+    total {
+      ...OrderTotalFragment
+    }
   }
 }
 
     
@@ -6825,7 +7052,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"email": "xyz789"}
+                  
    {"input": OrderTokenInput}
 
     
                   
                 
    
@@ -6833,23 +7060,56 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"isCompanyEmailAvailable": {"is_email_available": true}}}
+                  
    {
+  "data": {
+    "guestOrderByToken": {
+      "applied_coupons": [AppliedCoupon],
+      "billing_address": OrderAddress,
+      "carrier": "abc123",
+      "comments": [SalesCommentItem],
+      "created_at": "abc123",
+      "credit_memos": [CreditMemo],
+      "email": "xyz789",
+      "gift_message": GiftMessage,
+      "gift_receipt_included": true,
+      "gift_wrapping": GiftWrapping,
+      "grand_total": 987.65,
+      "id": 4,
+      "increment_id": "xyz789",
+      "invoices": [Invoice],
+      "items": [OrderItemInterface],
+      "items_eligible_for_return": [OrderItemInterface],
+      "number": "abc123",
+      "order_date": "abc123",
+      "order_number": "xyz789",
+      "payment_methods": [OrderPaymentMethod],
+      "printed_card_included": false,
+      "returns": Returns,
+      "shipments": [OrderShipment],
+      "shipping_address": OrderAddress,
+      "shipping_method": "xyz789",
+      "status": "xyz789",
+      "token": "abc123",
+      "total": OrderTotal
+    }
+  }
+}
 
     
                   
                 
    
               
             
           
    
-          
    
+          
    
             
    
               Queries
             
    
-            
     isCompanyRoleNameAvailable 
    
+            
     isCompanyAdminEmailAvailable 
    
             
    
               
    
                 
    
                   
    Description
    
-                  
    Check whether the specified role name is valid for the company.
    
+                  
    Check whether the specified email can be used to register a company admin.
    
                 
    
               
    
             
    
@@ -6858,7 +7118,7 @@ 
    Description
    
                 
    
                   
    Response
    
                   
     Returns an
-                    IsCompanyRoleNameAvailableOutput
+                    IsCompanyAdminEmailAvailableOutput
                   
    
                 
    
                 
    
@@ -6873,7 +7133,7 @@ 
    Arguments
    
                     
                       
                         
-                          name -
+                          email -
                           
                             String!
                           
@@ -6890,9 +7150,9 @@ 
    Example
    
                   
    Query
    
                   
                   
-                  
    query isCompanyRoleNameAvailable($name: String!) {
-  isCompanyRoleNameAvailable(name: $name) {
-    is_role_name_available
+                  
    query isCompanyAdminEmailAvailable($email: String!) {
+  isCompanyAdminEmailAvailable(email: $email) {
+    is_email_available
   }
 }
 
     
@@ -6902,7 +7162,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"name": "abc123"}
+                  
    {"email": "xyz789"}
 
     
                   
                 
    
@@ -6910,23 +7170,23 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}}
+                  
    {"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}}
 
     
                   
                 
               
             
           
    
-          
    
+          
    
             
    
               Queries
             
    
-            
     isCompanyUserEmailAvailable 
    
+            
     isCompanyEmailAvailable 
    
             
    
               
    
                 
    
                   
    Description
    
-                  
    Check whether the specified email can be used to register a company user.
    
+                  
    Check whether the specified email can be used to register a new company.
    
                 
    
               
    
             
    
@@ -6935,7 +7195,161 @@ 
    Description
    
                 
    
                   
    Response
    
                   
     Returns an
-                    IsCompanyUserEmailAvailableOutput
+                    IsCompanyEmailAvailableOutput
+                  
    
+                
    
+                
    
+                  
    Arguments
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                    
+                  
    NameDescription
    
+                          email -
+                          
+                            String!
+                          
+                         
    
+                
    
+              
+              
    
+                
    Example
    
+                
    
+                  
    Query
    
+                  
+                  
+                  
    query isCompanyEmailAvailable($email: String!) {
+  isCompanyEmailAvailable(email: $email) {
+    is_email_available
+  }
+}
+
     
+                  
+                
    
+                
    
+                  
    Variables
    
+                  
+                  
+                  
    {"email": "abc123"}
+
     
+                  
+                
    
+                
    
+                  
    Response
    
+                  
+                  
+                  
    {"data": {"isCompanyEmailAvailable": {"is_email_available": false}}}
+
     
+                  
+                
    
+              
    
+            
+          
    
+          
    
+            
    
+              Queries
+            
    
+            
     isCompanyRoleNameAvailable 
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Check whether the specified role name is valid for the company.
    
+                
    
+              
    
+            
    
+            
    
+              
    
+                
    
+                  
    Response
    
+                  
     Returns an
+                    IsCompanyRoleNameAvailableOutput
+                  
    
+                
    
+                
    
+                  
    Arguments
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                    
+                  
    NameDescription
    
+                          name -
+                          
+                            String!
+                          
+                         
    
+                
    
+              
    
+              
    
+                
    Example
    
+                
    
+                  
    Query
    
+                  
+                  
+                  
    query isCompanyRoleNameAvailable($name: String!) {
+  isCompanyRoleNameAvailable(name: $name) {
+    is_role_name_available
+  }
+}
+
     
+                  
+                
    
+                
    
+                  
    Variables
    
+                  
+                  
+                  
    {"name": "abc123"}
+
     
+                  
+                
    
+                
    
+                  
    Response
    
+                  
+                  
+                  
    {"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}}
+
     
+                  
+                
    
+              
    
+            
    
+          
    
+          
    
+            
    
+              Queries
+            
    
+            
     isCompanyUserEmailAvailable 
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Check whether the specified email can be used to register a company user.
    
+                
    
+              
    
+            
    
+            
    
+              
    
+                
    
+                  
    Response
    
+                  
     Returns an
+                    IsCompanyUserEmailAvailableOutput
                   
    
                 
    
                 
    
@@ -6987,7 +7401,7 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}}
+                  
    {"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}}
 
     
                   
                 
    
@@ -7056,7 +7470,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"email": "abc123"}
+                  
    {"email": "xyz789"}
 
     
                   
                 
    
@@ -7686,7 +8100,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "search": "abc123",
+  "search": "xyz789",
   "filter": ProductAttributeFilterInput,
   "pageSize": 20,
   "currentPage": 1,
@@ -7708,7 +8122,7 @@ 
    Response
    
       "page_info": SearchResultPageInfo,
       "sort_fields": SortFields,
       "suggestions": [SearchSuggestion],
-      "total_count": 987
+      "total_count": 123
     }
   }
 }
@@ -7771,9 +8185,9 @@ 
    Response
    
       "failure_message": "xyz789",
       "forms": ["PLACE_ORDER"],
       "is_enabled": true,
-      "language_code": "abc123",
+      "language_code": "xyz789",
       "minimum_score": 987.65,
-      "website_key": "abc123"
+      "website_key": "xyz789"
     }
   }
 }
@@ -7858,8 +8272,8 @@ 
    Response
    
                   
    {
   "data": {
     "route": {
-      "redirect_code": 987,
-      "relative_url": "abc123",
+      "redirect_code": 123,
+      "relative_url": "xyz789",
       "type": "CMS_PAGE"
     }
   }
@@ -7991,8 +8405,10 @@ 
    Query
    
     braintree_paypal_require_billing_address
     braintree_paypal_send_cart_line_items
     braintree_paypal_vault_active
+    cart_expires_in_days
     cart_gift_wrapping
     cart_printed_card
+    cart_summary_display_quantity
     catalog_default_sort_by
     category_fixed_product_tax_display_setting
     category_url_suffix
@@ -8014,6 +8430,8 @@ 
    Query
    
     contact_enabled
     copyright
     countries_with_required_region
+    create_account_confirmation
+    customer_access_token_lifetime
     default_country
     default_description
     default_display_currency_code
@@ -8058,6 +8476,8 @@ 
    Query
    
     magento_wishlist_general_is_enabled
     max_items_in_order_summary
     maximum_number_of_wishlists
+    minicart_display
+    minicart_max_items
     minimum_password_length
     newsletter_enabled
     no_route
@@ -8091,6 +8511,7 @@ 
    Query
    
     shopping_cart_display_price
     shopping_cart_display_shipping
     shopping_cart_display_subtotal
+    shopping_cart_display_tax_gift_wrapping
     shopping_cart_display_zero_tax
     show_cms_breadcrumbs
     store_code
@@ -8127,215 +8548,222 @@ 
    Response
    
                   
    {
   "data": {
     "storeConfig": {
-      "absolute_footer": "xyz789",
-      "allow_gift_receipt": "xyz789",
-      "allow_gift_wrapping_on_order": "abc123",
-      "allow_gift_wrapping_on_order_items": "abc123",
-      "allow_guests_to_write_product_reviews": "xyz789",
-      "allow_items": "abc123",
-      "allow_order": "xyz789",
-      "allow_printed_card": "abc123",
+      "absolute_footer": "abc123",
+      "allow_gift_receipt": "abc123",
+      "allow_gift_wrapping_on_order": "xyz789",
+      "allow_gift_wrapping_on_order_items": "xyz789",
+      "allow_guests_to_write_product_reviews": "abc123",
+      "allow_items": "xyz789",
+      "allow_order": "abc123",
+      "allow_printed_card": "xyz789",
       "autocomplete_on_storefront": false,
       "base_currency_code": "abc123",
       "base_link_url": "xyz789",
       "base_media_url": "xyz789",
-      "base_static_url": "xyz789",
-      "base_url": "abc123",
-      "braintree_3dsecure_allowspecific": true,
-      "braintree_3dsecure_always_request_3ds": true,
+      "base_static_url": "abc123",
+      "base_url": "xyz789",
+      "braintree_3dsecure_allowspecific": false,
+      "braintree_3dsecure_always_request_3ds": false,
       "braintree_3dsecure_specificcountry": "xyz789",
       "braintree_3dsecure_threshold_amount": "xyz789",
-      "braintree_3dsecure_verify_3dsecure": true,
-      "braintree_ach_direct_debit_vault_active": true,
+      "braintree_3dsecure_verify_3dsecure": false,
+      "braintree_ach_direct_debit_vault_active": false,
       "braintree_applepay_merchant_name": "xyz789",
       "braintree_applepay_vault_active": false,
       "braintree_cc_vault_active": "xyz789",
       "braintree_cc_vault_cvv": false,
-      "braintree_environment": "xyz789",
-      "braintree_googlepay_btn_color": "abc123",
+      "braintree_environment": "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": "xyz789",
-      "braintree_local_payment_redirect_on_fail": "xyz789",
-      "braintree_merchant_account_id": "abc123",
+      "braintree_local_payment_fallback_button_text": "abc123",
+      "braintree_local_payment_redirect_on_fail": "abc123",
+      "braintree_merchant_account_id": "xyz789",
       "braintree_paypal_button_location_cart_type_credit_color": "xyz789",
-      "braintree_paypal_button_location_cart_type_credit_label": "abc123",
+      "braintree_paypal_button_location_cart_type_credit_label": "xyz789",
       "braintree_paypal_button_location_cart_type_credit_shape": "abc123",
-      "braintree_paypal_button_location_cart_type_credit_show": true,
+      "braintree_paypal_button_location_cart_type_credit_show": false,
       "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
-      "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789",
+      "braintree_paypal_button_location_cart_type_messaging_logo": "abc123",
       "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
       "braintree_paypal_button_location_cart_type_messaging_show": 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_messaging_text_color": "abc123",
+      "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
       "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
-      "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
-      "braintree_paypal_button_location_cart_type_paylater_show": false,
-      "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
+      "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789",
+      "braintree_paypal_button_location_cart_type_paylater_show": true,
+      "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
       "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
-      "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789",
+      "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
       "braintree_paypal_button_location_cart_type_paypal_show": false,
       "braintree_paypal_button_location_checkout_type_credit_color": "xyz789",
       "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
-      "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
+      "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
       "braintree_paypal_button_location_checkout_type_credit_show": true,
       "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
-      "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
-      "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
+      "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
+      "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123",
       "braintree_paypal_button_location_checkout_type_messaging_show": false,
-      "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
-      "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
+      "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789",
+      "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
       "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
       "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
-      "braintree_paypal_button_location_checkout_type_paylater_show": false,
+      "braintree_paypal_button_location_checkout_type_paylater_show": true,
       "braintree_paypal_button_location_checkout_type_paypal_color": "abc123",
-      "braintree_paypal_button_location_checkout_type_paypal_label": "abc123",
-      "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789",
-      "braintree_paypal_button_location_checkout_type_paypal_show": true,
-      "braintree_paypal_button_location_productpage_type_credit_color": "xyz789",
+      "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
+      "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
+      "braintree_paypal_button_location_checkout_type_paypal_show": false,
+      "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
       "braintree_paypal_button_location_productpage_type_credit_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_logo": "abc123",
+      "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123",
+      "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789",
       "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123",
       "braintree_paypal_button_location_productpage_type_messaging_show": false,
-      "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789",
-      "braintree_paypal_button_location_productpage_type_paylater_color": "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": "abc123",
+      "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789",
       "braintree_paypal_button_location_productpage_type_paylater_show": false,
       "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789",
       "braintree_paypal_button_location_productpage_type_paypal_label": "xyz789",
-      "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789",
-      "braintree_paypal_button_location_productpage_type_paypal_show": true,
-      "braintree_paypal_credit_uk_merchant_name": "xyz789",
+      "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123",
+      "braintree_paypal_button_location_productpage_type_paypal_show": false,
+      "braintree_paypal_credit_uk_merchant_name": "abc123",
       "braintree_paypal_display_on_shopping_cart": true,
-      "braintree_paypal_merchant_country": "abc123",
+      "braintree_paypal_merchant_country": "xyz789",
       "braintree_paypal_merchant_name_override": "abc123",
       "braintree_paypal_require_billing_address": false,
       "braintree_paypal_send_cart_line_items": true,
-      "braintree_paypal_vault_active": false,
-      "cart_gift_wrapping": "xyz789",
+      "braintree_paypal_vault_active": true,
+      "cart_expires_in_days": 987,
+      "cart_gift_wrapping": "abc123",
       "cart_printed_card": "xyz789",
+      "cart_summary_display_quantity": 987,
       "catalog_default_sort_by": "abc123",
       "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-      "category_url_suffix": "xyz789",
+      "category_url_suffix": "abc123",
       "check_money_order_enable_for_specific_countries": true,
-      "check_money_order_enabled": true,
-      "check_money_order_make_check_payable_to": "xyz789",
+      "check_money_order_enabled": false,
+      "check_money_order_make_check_payable_to": "abc123",
       "check_money_order_max_order_total": "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_send_check_to": "abc123",
+      "check_money_order_payment_from_specific_countries": "abc123",
+      "check_money_order_send_check_to": "xyz789",
       "check_money_order_sort_order": 123,
-      "check_money_order_title": "xyz789",
+      "check_money_order_title": "abc123",
       "cms_home_page": "abc123",
-      "cms_no_cookies": "abc123",
-      "cms_no_route": "abc123",
-      "code": "xyz789",
+      "cms_no_cookies": "xyz789",
+      "cms_no_route": "xyz789",
+      "code": "abc123",
       "configurable_thumbnail_source": "abc123",
       "contact_enabled": false,
       "copyright": "abc123",
-      "countries_with_required_region": "abc123",
+      "countries_with_required_region": "xyz789",
+      "create_account_confirmation": false,
+      "customer_access_token_lifetime": 123.45,
       "default_country": "abc123",
-      "default_description": "xyz789",
+      "default_description": "abc123",
       "default_display_currency_code": "xyz789",
-      "default_keywords": "abc123",
-      "default_title": "abc123",
-      "demonotice": 123,
+      "default_keywords": "xyz789",
+      "default_title": "xyz789",
+      "demonotice": 987,
       "display_state_if_optional": false,
       "enable_multiple_wishlists": "xyz789",
-      "front": "xyz789",
+      "front": "abc123",
       "grid_per_page": 987,
       "grid_per_page_values": "xyz789",
       "head_includes": "abc123",
       "head_shortcut_icon": "abc123",
-      "header_logo_src": "xyz789",
-      "id": 987,
-      "is_default_store": false,
-      "is_default_store_group": false,
-      "is_guest_checkout_enabled": true,
+      "header_logo_src": "abc123",
+      "id": 123,
+      "is_default_store": true,
+      "is_default_store_group": true,
+      "is_guest_checkout_enabled": false,
       "is_negotiable_quote_active": false,
-      "is_one_page_checkout_enabled": false,
+      "is_one_page_checkout_enabled": true,
       "is_requisition_list_active": "xyz789",
       "list_mode": "abc123",
-      "list_per_page": 987,
-      "list_per_page_values": "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": "abc123",
+      "logo_height": 987,
+      "logo_width": 987,
+      "magento_reward_general_is_enabled": "xyz789",
+      "magento_reward_general_is_enabled_on_front": "xyz789",
       "magento_reward_general_min_points_balance": "abc123",
       "magento_reward_general_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_points_invitation_order_limit": "xyz789",
       "magento_reward_points_newsletter": "abc123",
       "magento_reward_points_order": "xyz789",
-      "magento_reward_points_register": "abc123",
-      "magento_reward_points_review": "abc123",
+      "magento_reward_points_register": "xyz789",
+      "magento_reward_points_review": "xyz789",
       "magento_reward_points_review_limit": "abc123",
       "magento_wishlist_general_is_enabled": "xyz789",
       "max_items_in_order_summary": 987,
-      "maximum_number_of_wishlists": "xyz789",
+      "maximum_number_of_wishlists": "abc123",
+      "minicart_display": true,
+      "minicart_max_items": 123,
       "minimum_password_length": "xyz789",
-      "newsletter_enabled": true,
+      "newsletter_enabled": false,
       "no_route": "xyz789",
-      "optional_zip_countries": "abc123",
-      "order_cancellation_enabled": false,
+      "optional_zip_countries": "xyz789",
+      "order_cancellation_enabled": true,
       "order_cancellation_reasons": [CancellationReason],
-      "payment_payflowpro_cc_vault_active": "xyz789",
-      "printed_card_price": "xyz789",
+      "payment_payflowpro_cc_vault_active": "abc123",
+      "printed_card_price": "abc123",
       "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-      "product_reviews_enabled": "xyz789",
+      "product_reviews_enabled": "abc123",
       "product_url_suffix": "xyz789",
       "quickorder_active": false,
-      "required_character_classes_number": "xyz789",
-      "returns_enabled": "xyz789",
-      "root_category_id": 987,
-      "root_category_uid": "4",
+      "required_character_classes_number": "abc123",
+      "returns_enabled": "abc123",
+      "root_category_id": 123,
+      "root_category_uid": 4,
       "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
       "sales_gift_wrapping": "xyz789",
-      "sales_printed_card": "abc123",
+      "sales_printed_card": "xyz789",
       "secure_base_link_url": "abc123",
       "secure_base_media_url": "xyz789",
-      "secure_base_static_url": "xyz789",
+      "secure_base_static_url": "abc123",
       "secure_base_url": "xyz789",
       "send_friend": SendFriendConfiguration,
       "shopping_cart_display_full_summary": true,
-      "shopping_cart_display_grand_total": true,
+      "shopping_cart_display_grand_total": false,
       "shopping_cart_display_price": 123,
       "shopping_cart_display_shipping": 123,
-      "shopping_cart_display_subtotal": 987,
-      "shopping_cart_display_zero_tax": true,
-      "show_cms_breadcrumbs": 987,
+      "shopping_cart_display_subtotal": 123,
+      "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
+      "shopping_cart_display_zero_tax": false,
+      "show_cms_breadcrumbs": 123,
       "store_code": 4,
-      "store_group_code": 4,
+      "store_group_code": "4",
       "store_group_name": "abc123",
       "store_name": "abc123",
-      "store_sort_order": 123,
+      "store_sort_order": 987,
       "timezone": "xyz789",
-      "title_prefix": "abc123",
+      "title_prefix": "xyz789",
       "title_separator": "xyz789",
       "title_suffix": "abc123",
       "use_store_in_url": true,
       "website_code": 4,
       "website_id": 123,
-      "website_name": "abc123",
+      "website_name": "xyz789",
       "weight_unit": "abc123",
       "welcome": "abc123",
-      "zero_subtotal_enable_for_specific_countries": true,
+      "zero_subtotal_enable_for_specific_countries": false,
       "zero_subtotal_enabled": true,
-      "zero_subtotal_new_order_status": "abc123",
-      "zero_subtotal_payment_action": "xyz789",
-      "zero_subtotal_payment_from_specific_countries": "abc123",
+      "zero_subtotal_new_order_status": "xyz789",
+      "zero_subtotal_payment_action": "abc123",
+      "zero_subtotal_payment_from_specific_countries": "xyz789",
       "zero_subtotal_sort_order": 123,
       "zero_subtotal_title": "abc123"
     }
@@ -8432,8 +8860,8 @@ 
    Response
    
                   
    {
   "data": {
     "urlResolver": {
-      "canonical_url": "abc123",
-      "entity_uid": "4",
+      "canonical_url": "xyz789",
+      "entity_uid": 4,
       "id": 123,
       "redirectCode": 123,
       "relative_url": "xyz789",
@@ -8505,9 +8933,9 @@ 
    Response
    
     "wishlist": {
       "items": [WishlistItem],
       "items_count": 987,
-      "name": "abc123",
-      "sharing_code": "abc123",
-      "updated_at": "abc123"
+      "name": "xyz789",
+      "sharing_code": "xyz789",
+      "updated_at": "xyz789"
     }
   }
 }
@@ -9051,9 +9479,9 @@ 
    Response
    
   "data": {
     "addProductsToCompareList": {
       "attributes": [ComparableAttribute],
-      "item_count": 123,
+      "item_count": 987,
       "items": [ComparableItem],
-      "uid": 4
+      "uid": "4"
     }
   }
 }
@@ -9143,7 +9571,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "requisitionListUid": "4",
+  "requisitionListUid": 4,
   "requisitionListItems": [RequisitionListItemsInput]
 }
 
     
@@ -9964,10 +10392,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {
-  "wishlistId": "4",
-  "wishlistItemIds": ["4"]
-}
+                  
    {"wishlistId": "4", "wishlistItemIds": [4]}
 
     
                   
                 
    
@@ -10065,6 +10490,85 @@ 
    Response
    
                   
                   
                   
    {"data": {"applyCouponToCart": {"cart": Cart}}}
+
     
+                  
+                
+              
+            
+          
    
+          
    
+            
    
+              Mutations
+            
    
+            
     applyCouponsToCart 
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Apply a pre-defined coupon code to the specified cart.
    
+                
    
+              
    
+            
    
+            
    
+              
    
+                
    
+                  
    Response
    
+                  
     Returns an
+                    ApplyCouponToCartOutput
+                  
    
+                
    
+                
    
+                  
    Arguments
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                    
+                  
    NameDescription
    
+                          input -
+                          
+                            ApplyCouponsToCartInput
+                          
+                         An input object that defines the coupon code to apply to the cart. 
    
+                
    
+              
    
+              
    
+                
    Example
    
+                
    
+                  
    Query
    
+                  
+                  
+                  
    mutation applyCouponsToCart($input: ApplyCouponsToCartInput) {
+  applyCouponsToCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
     
+                  
+                
    
+                
    
+                  
    Variables
    
+                  
+                  
+                  
    {"input": ApplyCouponsToCartInput}
+
     
+                  
+                
    
+                
    
+                  
    Response
    
+                  
+                  
+                  
    {"data": {"applyCouponsToCart": {"cart": Cart}}}
 
     
                   
                 
    
@@ -10214,7 +10718,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"cartId": "4"}
+                  
    {"cartId": 4}
 
     
                   
                 
    
@@ -10474,7 +10978,7 @@ 
    Response
    
   "data": {
     "assignCompareListToCustomer": {
       "compare_list": CompareList,
-      "result": true
+      "result": false
     }
   }
 }
@@ -10573,6 +11077,9 @@ 
    Query
    
     items {
       ...CartItemInterfaceFragment
     }
+    itemsV2 {
+      ...CartItemsFragment
+    }
     prices {
       ...CartPricesFragment
     }
@@ -10614,15 +11121,16 @@ 
    Response
    
         AvailablePaymentMethod
       ],
       "billing_address": BillingCartAddress,
-      "email": "abc123",
+      "email": "xyz789",
       "gift_message": GiftMessage,
       "gift_receipt_included": false,
       "gift_wrapping": GiftWrapping,
       "id": 4,
       "is_virtual": true,
       "items": [CartItemInterface],
+      "itemsV2": CartItems,
       "prices": CartPrices,
-      "printed_card_included": true,
+      "printed_card_included": false,
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
       "total_quantity": 987.65
@@ -10885,6 +11393,7 @@ 
    Query
    
     compare_list {
       ...CompareListFragment
     }
+    confirmation_status
     created_at
     custom_attributes {
       ...AttributeValueInterfaceFragment
@@ -10976,7 +11485,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "currentPassword": "abc123",
+  "currentPassword": "xyz789",
   "newPassword": "abc123"
 }
 
     
@@ -10990,25 +11499,26 @@ 
    Response
    
   "data": {
     "changeCustomerPassword": {
       "addresses": [CustomerAddress],
-      "allow_remote_shopping_assistance": false,
+      "allow_remote_shopping_assistance": true,
       "compare_list": CompareList,
-      "created_at": "xyz789",
+      "confirmation_status": "ACCOUNT_CONFIRMED",
+      "created_at": "abc123",
       "custom_attributes": [AttributeValueInterface],
-      "date_of_birth": "xyz789",
+      "date_of_birth": "abc123",
       "default_billing": "xyz789",
-      "default_shipping": "abc123",
-      "dob": "abc123",
-      "email": "xyz789",
-      "firstname": "xyz789",
+      "default_shipping": "xyz789",
+      "dob": "xyz789",
+      "email": "abc123",
+      "firstname": "abc123",
       "gender": 123,
       "gift_registries": [GiftRegistry],
       "gift_registry": GiftRegistry,
       "group_id": 987,
-      "id": 987,
+      "id": 123,
       "is_subscribed": true,
       "job_title": "xyz789",
-      "lastname": "xyz789",
-      "middlename": "xyz789",
+      "lastname": "abc123",
+      "middlename": "abc123",
       "orders": CustomerOrders,
       "prefix": "abc123",
       "purchase_order": PurchaseOrder,
@@ -11016,7 +11526,7 @@ 
    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,
@@ -11025,9 +11535,9 @@ 
    Response
    
       "role": CompanyRole,
       "status": "ACTIVE",
       "store_credit": CustomerStoreCredit,
-      "structure_id": "4",
+      "structure_id": 4,
       "suffix": "xyz789",
-      "taxvat": "abc123",
+      "taxvat": "xyz789",
       "team": CompanyTeam,
       "telephone": "abc123",
       "wishlist": Wishlist,
@@ -11196,7 +11706,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"cartUid": "abc123"}
+                  
    {"cartUid": "xyz789"}
 
     
                   
                 
    
@@ -11311,6 +11821,85 @@ 
    Response
    
     }
   }
 }
+
     
+                  
+                
+              
+            
+          
+          
    
+            
    
+              Mutations
+            
    
+            
     confirmEmail 
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Confirms the email address for a customer.
    
+                
    
+              
    
+            
    
+            
    
+              
    
+                
    
+                  
    Response
    
+                  
     Returns a
+                    CustomerOutput
+                  
    
+                
    
+                
    
+                  
    Arguments
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                    
+                  
    NameDescription
    
+                          input -
+                          
+                            ConfirmEmailInput!
+                          
+                         An input object to identify the customer to confirm the email. 
    
+                
    
+              
    
+              
    
+                
    Example
    
+                
    
+                  
    Query
    
+                  
+                  
+                  
    mutation confirmEmail($input: ConfirmEmailInput!) {
+  confirmEmail(input: $input) {
+    customer {
+      ...CustomerFragment
+    }
+  }
+}
+
     
+                  
+                
    
+                
    
+                  
    Variables
    
+                  
+                  
+                  
    {"input": ConfirmEmailInput}
+
     
+                  
+                
    
+                
    
+                  
    Response
    
+                  
+                  
+                  
    {"data": {"confirmEmail": {"customer": Customer}}}
 
     
                   
                 
    
@@ -11387,7 +11976,7 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"contactUs": {"status": true}}}
+                  
    {"data": {"contactUs": {"status": false}}}
 
     
                   
                 
    
@@ -11485,8 +12074,8 @@ 
    Variables
    
                   
                   
                   
    {
-  "sourceRequisitionListUid": 4,
-  "destinationRequisitionListUid": 4,
+  "sourceRequisitionListUid": "4",
+  "destinationRequisitionListUid": "4",
   "requisitionListItem": CopyItemsBetweenRequisitionListsInput
 }
 
     
@@ -11607,7 +12196,7 @@ 
    Variables
    
                   
                   
    {
   "sourceWishlistUid": 4,
-  "destinationWishlistUid": "4",
+  "destinationWishlistUid": 4,
   "wishlistItems": [WishlistItemCopyInput]
 }
 
     
@@ -12206,7 +12795,7 @@ 
    Response
    
   "data": {
     "createCompareList": {
       "attributes": [ComparableAttribute],
-      "item_count": 123,
+      "item_count": 987,
       "items": [ComparableItem],
       "uid": "4"
     }
@@ -12407,20 +12996,20 @@ 
    Response
    
       "custom_attributes": [CustomerAddressAttribute],
       "custom_attributesV2": [AttributeValueInterface],
       "customer_id": 123,
-      "default_billing": false,
+      "default_billing": true,
       "default_shipping": false,
       "extension_attributes": [CustomerAddressAttribute],
-      "fax": "xyz789",
+      "fax": "abc123",
       "firstname": "abc123",
       "id": 987,
       "lastname": "xyz789",
       "middlename": "xyz789",
-      "postcode": "xyz789",
-      "prefix": "abc123",
+      "postcode": "abc123",
+      "prefix": "xyz789",
       "region": CustomerAddressRegion,
-      "region_id": 123,
-      "street": ["xyz789"],
-      "suffix": "xyz789",
+      "region_id": 987,
+      "street": ["abc123"],
+      "suffix": "abc123",
       "telephone": "xyz789",
       "vat_id": "xyz789"
     }
@@ -12921,9 +13510,9 @@ 
    Response
    
                   
    {
   "data": {
     "createPaymentOrder": {
-      "id": "xyz789",
-      "mp_order_id": "xyz789",
-      "status": "xyz789"
+      "id": "abc123",
+      "mp_order_id": "abc123",
+      "status": "abc123"
     }
   }
 }
@@ -13010,7 +13599,7 @@ 
    Response
    
   "data": {
     "createPaypalExpressToken": {
       "paypal_urls": PaypalExpressUrlList,
-      "token": "xyz789"
+      "token": "abc123"
     }
   }
 }
@@ -13194,13 +13783,13 @@ 
    Response
    
       "applies_to_roles": [CompanyRole],
       "approver_roles": [CompanyRole],
       "condition": PurchaseOrderApprovalRuleConditionInterface,
-      "created_at": "xyz789",
+      "created_at": "abc123",
       "created_by": "abc123",
       "description": "abc123",
       "name": "xyz789",
       "status": "ENABLED",
-      "uid": 4,
-      "updated_at": "xyz789"
+      "uid": "4",
+      "updated_at": "abc123"
     }
   }
 }
@@ -13436,7 +14025,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"id": "4"}
+                  
    {"id": 4}
 
     
                   
                 
    
@@ -13444,7 +14033,7 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"deleteCompanyRole": {"success": true}}}
+                  
    {"data": {"deleteCompanyRole": {"success": false}}}
 
     
                   
                 
@@ -13675,7 +14264,7 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"deleteCompareList": {"result": false}}}
+                  
    {"data": {"deleteCompareList": {"result": true}}}
 
     
                   
                 
@@ -13720,7 +14309,7 @@ 
    Query
    
                   
    Response
    
                   
                   
-                  
    {"data": {"deleteCustomer": false}}
+                  
    {"data": {"deleteCustomer": true}}
 
     
                   
                 
@@ -13965,7 +14554,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"public_hash": "abc123"}
+                  
    {"public_hash": "xyz789"}
 
     
                   
                 
@@ -14137,7 +14726,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"requisitionListUid": 4}
+                  
    {"requisitionListUid": "4"}
 
     
                   
                 
@@ -14149,7 +14738,7 @@ 
    Response
    
   "data": {
     "deleteRequisitionList": {
       "requisition_lists": RequisitionLists,
-      "status": false
+      "status": true
     }
   }
 }
@@ -14240,7 +14829,7 @@ 
    Variables
    
                   
                   
    {
   "requisitionListUid": "4",
-  "requisitionListItemUids": [4]
+  "requisitionListItemUids": ["4"]
 }
 
     
                   
@@ -14338,11 +14927,201 @@ 
    Response
    
                   
    {
   "data": {
     "deleteWishlist": {
-      "status": true,
+      "status": false,
       "wishlists": [Wishlist]
     }
   }
 }
+
     
+                  
+                
+              
+            
+          
    
+          
    
+            
    
+              Mutations
+            
    
+            
     estimateShippingMethods 
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Estimate shipping method(s) for cart based on address
    
+                
    
+              
    
+            
    
+            
    
+              
    
+                
    
+                  
    Response
    
+                  
     Returns
+                    [AvailableShippingMethod]
+                  
    
+                
    
+                
    
+                  
    Arguments
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                    
+                  
    NameDescription
    
+                          input -
+                          
+                            EstimateTotalsInput!
+                          
+                         An input object that specifies details for estimation of available shipping methods 
    
+                
    
+              
    
+              
    
+                
    Example
    
+                
    
+                  
    Query
    
+                  
+                  
+                  
    mutation estimateShippingMethods($input: EstimateTotalsInput!) {
+  estimateShippingMethods(input: $input) {
+    amount {
+      ...MoneyFragment
+    }
+    available
+    base_amount {
+      ...MoneyFragment
+    }
+    carrier_code
+    carrier_title
+    error_message
+    method_code
+    method_title
+    price_excl_tax {
+      ...MoneyFragment
+    }
+    price_incl_tax {
+      ...MoneyFragment
+    }
+  }
+}
+
     
+                  
+                
    
+                
    
+                  
    Variables
    
+                  
+                  
+                  
    {"input": EstimateTotalsInput}
+
     
+                  
+                
    
+                
    
+                  
    Response
    
+                  
+                  
+                  
    {
+  "data": {
+    "estimateShippingMethods": [
+      {
+        "amount": Money,
+        "available": true,
+        "base_amount": Money,
+        "carrier_code": "abc123",
+        "carrier_title": "xyz789",
+        "error_message": "abc123",
+        "method_code": "abc123",
+        "method_title": "xyz789",
+        "price_excl_tax": Money,
+        "price_incl_tax": Money
+      }
+    ]
+  }
+}
+
     
+                  
+                
    
+              
    
+            
    
+          
    
+          
    
+            
    
+              Mutations
+            
    
+            
     estimateTotals 
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Estimate totals for cart based on the address
    
+                
    
+              
    
+            
    
+            
    
+              
    
+                
    
+                  
    Response
    
+                  
     Returns an
+                    EstimateTotalsOutput!
+                  
    
+                
    
+                
    
+                  
    Arguments
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                    
+                  
    NameDescription
    
+                          input -
+                          
+                            EstimateTotalsInput!
+                          
+                         An input object that specifies details for cart totals estimation 
    
+                
    
+              
    
+              
    
+                
    Example
    
+                
    
+                  
    Query
    
+                  
+                  
+                  
    mutation estimateTotals($input: EstimateTotalsInput!) {
+  estimateTotals(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
     
+                  
+                
    
+                
    
+                  
    Variables
    
+                  
+                  
+                  
    {"input": EstimateTotalsInput}
+
     
+                  
+                
    
+                
    
+                  
    Response
    
+                  
+                  
+                  
    {"data": {"estimateTotals": {"cart": Cart}}}
 
     
                   
                 
    
@@ -14440,7 +15219,7 @@ 
    Response
    
                   
    {
   "data": {
     "generateCustomerToken": {
-      "token": "abc123"
+      "token": "xyz789"
     }
   }
 }
@@ -14716,6 +15495,9 @@ 
    Query
    
     items {
       ...CartItemInterfaceFragment
     }
+    itemsV2 {
+      ...CartItemsFragment
+    }
     prices {
       ...CartPricesFragment
     }
@@ -14760,13 +15542,14 @@ 
    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": false,
       "items": [CartItemInterface],
+      "itemsV2": CartItems,
       "prices": CartPrices,
       "printed_card_included": true,
       "selected_payment_method": SelectedPaymentMethod,
@@ -14864,7 +15647,10 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"cartUid": 4, "giftRegistryUid": "4"}
+                  
    {
+  "cartUid": "4",
+  "giftRegistryUid": "4"
+}
 
     
                   
                 
    
@@ -14981,7 +15767,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "sourceRequisitionListUid": 4,
+  "sourceRequisitionListUid": "4",
   "destinationRequisitionListUid": "4",
   "requisitionListItem": MoveItemsBetweenRequisitionListsInput
 }
@@ -15103,8 +15889,8 @@ 
    Variables
    
                   
                   
                   
    {
-  "sourceWishlistUid": "4",
-  "destinationWishlistUid": 4,
+  "sourceWishlistUid": 4,
+  "destinationWishlistUid": "4",
   "wishlistItems": [WishlistItemMoveInput]
 }
 
     
@@ -15260,9 +16046,15 @@ 
    Query
    
                   
                   
    mutation placeOrder($input: PlaceOrderInput) {
   placeOrder(input: $input) {
+    errors {
+      ...PlaceOrderErrorFragment
+    }
     order {
       ...OrderFragment
     }
+    orderV2 {
+      ...CustomerOrderFragment
+    }
   }
 }
 
     
@@ -15280,7 +16072,15 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"placeOrder": {"order": Order}}}
+                  
    {
+  "data": {
+    "placeOrder": {
+      "errors": [PlaceOrderError],
+      "order": Order,
+      "orderV2": CustomerOrder
+    }
+  }
+}
 
     
                   
                 
    
@@ -15533,7 +16333,7 @@ 
    Response
    
   "data": {
     "redeemGiftCardBalanceAsStoreCredit": {
       "balance": Money,
-      "code": "abc123",
+      "code": "xyz789",
       "expiration_date": "xyz789"
     }
   }
@@ -15706,6 +16506,85 @@ 
    Response
    
                   
                   
                   
    {"data": {"removeCouponFromCart": {"cart": Cart}}}
+
     
+                  
+                
+              
+            
+          
    
+          
    
+            
    
+              Mutations
+            
    
+            
     removeCouponsFromCart 
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.
    
+                
    
+              
    
+            
    
+            
    
+              
    
+                
    
+                  
    Response
    
+                  
     Returns a
+                    RemoveCouponFromCartOutput
+                  
    
+                
    
+                
    
+                  
    Arguments
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                    
+                  
    NameDescription
    
+                          input -
+                          
+                            RemoveCouponsFromCartInput
+                          
+                         An input object that defines which coupon code to remove from the cart. 
    
+                
    
+              
    
+              
    
+                
    Example
    
+                
    
+                  
    Query
    
+                  
+                  
+                  
    mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) {
+  removeCouponsFromCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
     
+                  
+                
    
+                
    
+                  
    Variables
    
+                  
+                  
+                  
    {"input": RemoveCouponsFromCartInput}
+
     
+                  
+                
    
+                
    
+                  
    Response
    
+                  
+                  
+                  
    {"data": {"removeCouponsFromCart": {"cart": Cart}}}
 
     
                   
                 
    
@@ -15853,7 +16732,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"giftRegistryUid": 4}
+                  
    {"giftRegistryUid": "4"}
 
     
                   
                 
    
@@ -15947,7 +16826,10 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"giftRegistryUid": 4, "itemsUid": [4]}
+                  
    {
+  "giftRegistryUid": "4",
+  "itemsUid": ["4"]
+}
 
     
                   
                 
    
@@ -16049,7 +16931,7 @@ 
    Variables
    
                   
                   
    {
   "giftRegistryUid": "4",
-  "registrantsUid": [4]
+  "registrantsUid": ["4"]
 }
 
     
                   
@@ -16318,7 +17200,7 @@ 
    Response
    
       "attributes": [ComparableAttribute],
       "item_count": 123,
       "items": [ComparableItem],
-      "uid": "4"
+      "uid": 4
     }
   }
 }
@@ -16410,7 +17292,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"wishlistId": 4, "wishlistItemsIds": [4]}
+                  
    {"wishlistId": 4, "wishlistItemsIds": ["4"]}
 
     
                   
                 
@@ -16663,89 +17545,6 @@ 
    Response
    
                   
                   
                   
    {"data": {"removeStoreCreditFromCart": {"cart": Cart}}}
-
     
-                  
-                
-              
-            
-          
    
-          
    
-            
    
-              Mutations
-            
    
-            
     renameNegotiableQuote 
    
-            
    
-              
    
-                
    
-                  
    Description
    
-                  
    Rename negotiable quote.
    
-                
    
-              
    
-            
    
-            
    
-              
    
-                
    
-                  
    Response
    
-                  
     Returns a
-                    RenameNegotiableQuoteOutput
-                  
    
-                
    
-                
    
-                  
    Arguments
    
-                  
-                    
-                      
-                        
-                        
-                      
-                    
-                    
-                      
-                        
-                        
-                      
-                    
-                  
    NameDescription
    
-                          input -
-                          
-                            RenameNegotiableQuoteInput!
-                          
-                         An input object that defines the quote item name and comment. 
    
-                
    
-              
    
-              
    
-                
    Example
    
-                
    
-                  
    Query
    
-                  
-                  
-                  
    mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) {
-  renameNegotiableQuote(input: $input) {
-    quote {
-      ...NegotiableQuoteFragment
-    }
-  }
-}
-
     
-                  
-                
    
-                
    
-                  
    Variables
    
-                  
-                  
-                  
    {"input": RenameNegotiableQuoteInput}
-
     
-                  
-                
    
-                
    
-                  
    Response
    
-                  
-                  
-                  
    {
-  "data": {
-    "renameNegotiableQuote": {"quote": NegotiableQuote}
-  }
-}
 
     
                   
                 
    
@@ -16984,7 +17783,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"email": "abc123"}
+                  
    {"email": "xyz789"}
 
     
                   
                 
    
@@ -16992,7 +17791,7 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"requestPasswordResetEmail": false}}
+                  
    {"data": {"requestPasswordResetEmail": true}}
 
     
                   
                 
    
@@ -17175,7 +17974,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "email": "xyz789",
+  "email": "abc123",
   "resetPasswordToken": "abc123",
   "newPassword": "xyz789"
 }
@@ -18129,9 +18928,15 @@ 
    Query
    
                   
                   
    mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInput) {
   setPaymentMethodAndPlaceOrder(input: $input) {
+    errors {
+      ...PlaceOrderErrorFragment
+    }
     order {
       ...OrderFragment
     }
+    orderV2 {
+      ...CustomerOrderFragment
+    }
   }
 }
 
     
@@ -18151,7 +18956,11 @@ 
    Response
    
                   
                   
    {
   "data": {
-    "setPaymentMethodAndPlaceOrder": {"order": Order}
+    "setPaymentMethodAndPlaceOrder": {
+      "errors": [PlaceOrderError],
+      "order": Order,
+      "orderV2": CustomerOrder
+    }
   }
 }
 
     
@@ -18486,7 +19295,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "giftRegistryUid": 4,
+  "giftRegistryUid": "4",
   "sender": ShareGiftRegistrySenderInput,
   "invitees": [ShareGiftRegistryInviteeInput]
 }
@@ -18497,7 +19306,7 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"shareGiftRegistry": {"is_shared": false}}}
+                  
    {"data": {"shareGiftRegistry": {"is_shared": true}}}
 
     
                   
                 
@@ -18566,7 +19375,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"email": "abc123"}
+                  
    {"email": "xyz789"}
 
     
                   
                 
@@ -18649,7 +19458,7 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"syncPaymentOrder": true}}
+                  
    {"data": {"syncPaymentOrder": false}}
 
     
                   
                 
@@ -19316,7 +20125,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"id": 123, "input": CustomerAddressInput}
+                  
    {"id": 987, "input": CustomerAddressInput}
 
     
                   
                 
@@ -19327,29 +20136,29 @@ 
    Response
    
                   
    {
   "data": {
     "updateCustomerAddress": {
-      "city": "xyz789",
-      "company": "xyz789",
+      "city": "abc123",
+      "company": "abc123",
       "country_code": "AF",
-      "country_id": "abc123",
+      "country_id": "xyz789",
       "custom_attributes": [CustomerAddressAttribute],
       "custom_attributesV2": [AttributeValueInterface],
-      "customer_id": 123,
+      "customer_id": 987,
       "default_billing": true,
       "default_shipping": true,
       "extension_attributes": [CustomerAddressAttribute],
       "fax": "xyz789",
-      "firstname": "xyz789",
+      "firstname": "abc123",
       "id": 123,
       "lastname": "abc123",
-      "middlename": "xyz789",
+      "middlename": "abc123",
       "postcode": "xyz789",
-      "prefix": "abc123",
+      "prefix": "xyz789",
       "region": CustomerAddressRegion,
-      "region_id": 123,
+      "region_id": 987,
       "street": ["abc123"],
       "suffix": "abc123",
       "telephone": "xyz789",
-      "vat_id": "xyz789"
+      "vat_id": "abc123"
     }
   }
 }
@@ -19439,7 +20248,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "email": "xyz789",
+  "email": "abc123",
   "password": "xyz789"
 }
 
     
@@ -19716,7 +20525,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "giftRegistryUid": "4",
+  "giftRegistryUid": 4,
   "items": [UpdateGiftRegistryItemInput]
 }
 
     
@@ -20010,7 +20819,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "wishlistId": "4",
+  "wishlistId": 4,
   "wishlistItems": [WishlistItemUpdateInput]
 }
 
     
@@ -20125,12 +20934,12 @@ 
    Response
    
       "applies_to_roles": [CompanyRole],
       "approver_roles": [CompanyRole],
       "condition": PurchaseOrderApprovalRuleConditionInterface,
-      "created_at": "abc123",
+      "created_at": "xyz789",
       "created_by": "abc123",
-      "description": "abc123",
+      "description": "xyz789",
       "name": "xyz789",
       "status": "ENABLED",
-      "uid": "4",
+      "uid": 4,
       "updated_at": "xyz789"
     }
   }
@@ -20221,7 +21030,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "requisitionListUid": 4,
+  "requisitionListUid": "4",
   "input": UpdateRequisitionListInput
 }
 
     
@@ -20441,7 +21250,7 @@ 
    Variables
    
                   
                   
    {
   "wishlistId": 4,
-  "name": "xyz789",
+  "name": "abc123",
   "visibility": "PUBLIC"
 }
 
     
@@ -20951,9 +21760,9 @@ 
    Example
    
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
-  "email": "xyz789",
-  "firstname": "xyz789",
-  "lastname": "abc123"
+  "email": "abc123",
+  "firstname": "abc123",
+  "lastname": "xyz789"
 }
 
     
                   
@@ -21117,7 +21926,10 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"products": ["4"], "uid": 4}
+                  
    {
+  "products": ["4"],
+  "uid": "4"
+}
 
     
                   
                 
@@ -21281,8 +22093,8 @@ 
    Example
    
                   
                   
                   
    {
-  "comment": "abc123",
-  "purchase_order_uid": 4
+  "comment": "xyz789",
+  "purchase_order_uid": "4"
 }
 
     
                   
@@ -21400,9 +22212,9 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "purchase_order_uid": "4",
-  "replace_existing_cart_items": false
+  "replace_existing_cart_items": true
 }
 
     
                   
@@ -21459,7 +22271,7 @@ 
    Example
    
                   
                   
                   
    {
-  "message": "xyz789",
+  "message": "abc123",
   "type": "OUT_OF_STOCK"
 }
 
     
@@ -21647,10 +22459,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {
-  "comment_text": "abc123",
-  "return_uid": "4"
-}
+                  
    {"comment_text": "abc123", "return_uid": 4}
 
     
                   
                 
@@ -21769,7 +22578,7 @@ 
    Example
    
                   
    {
   "carrier_uid": 4,
   "return_uid": 4,
-  "tracking_number": "xyz789"
+  "tracking_number": "abc123"
 }
 
     
                   
@@ -21888,7 +22697,7 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "cart_items": [SimpleProductCartItemInput]
 }
 
     
@@ -21996,7 +22805,7 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "cart_items": [VirtualProductCartItemInput]
 }
 
     
@@ -22197,11 +23006,11 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_code": "abc123",
-  "count": 123,
-  "label": "xyz789",
+  "attribute_code": "xyz789",
+  "count": 987,
+  "label": "abc123",
   "options": [AggregationOption],
-  "position": 123
+  "position": 987
 }
 
     
                   
@@ -22268,8 +23077,8 @@ 
    Example
    
                   
                   
    {
   "count": 123,
-  "label": "xyz789",
-  "value": "xyz789"
+  "label": "abc123",
+  "value": "abc123"
 }
 
     
                   
@@ -22560,13 +23369,13 @@ 
    Example
    
                   
                   
    {
   "button_styles": ButtonStyles,
-  "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": "xyz789",
-  "title": "abc123"
+  "title": "xyz789"
 }
 
     
                   
@@ -22639,7 +23448,7 @@ 
    Example
    
                   
                   
    {
   "payment_source": "abc123",
-  "payments_order_id": "xyz789",
+  "payments_order_id": "abc123",
   "paypal_order_id": "xyz789"
 }
 
     
@@ -22762,7 +23571,7 @@ 
    Example
    
                   
                   
    {
   "applied_balance": Money,
-  "code": "xyz789",
+  "code": "abc123",
   "current_balance": Money,
   "expiration_date": "xyz789"
 }
@@ -22832,7 +23641,7 @@ 
    Example
    
                   
    {
   "applied_balance": Money,
   "current_balance": Money,
-  "enabled": false
+  "enabled": true
 }
 
     
                   
@@ -22893,8 +23702,8 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": "xyz789",
-  "coupon_code": "abc123"
+  "cart_id": "abc123",
+  "coupon_code": "xyz789"
 }
 
     
                   
@@ -22948,48 +23757,38 @@ 
    Example
    
               
             
           
    
-          
    
+          
    
             
    
               Types
             
    
-            
    ApplyGiftCardToCartInput
    
+            
    ApplyCouponsStrategy
    
             
    
               
    
                 
    
                   
    Description
    
-                  
    Defines the input required to run the applyGiftCardToCart mutation.
    
+                  
    The strategy to apply coupons to the cart.
    
                 
    
                 
    
-                  
    Fields
    
+                  
    Values
    
                   
-                        
+                        
-                        
+                        
-                        
+                        
    
                     
                       
    Input FieldEnum Value
                         Description
                       
    
                         
                     
                       
    
                         
-                          cart_id -
-                          
-                            String!
-                          
-                        
-                          
    The unique ID that identifies the customer's cart.
    
+                          
    APPEND
    
                             		 Append new coupons keeping the coupons that have been applied before. 
                       
    
                       
    
                         
-                          gift_card_code -
-                          
-                            String!
-                          
-                        
-                          
    The gift card code to be applied to the cart.
    
+                          
    REPLACE
    
                             		 Remove all the coupons from the cart and apply only new provided coupons. 
                       
    
                         
                   
    
@@ -23000,91 +23799,66 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {
-  "cart_id": "abc123",
-  "gift_card_code": "xyz789"
-}
+                  
    "APPEND"
 
     
                   
                 
    
               
    
             
    
           
    
-          
    
+          
    
             
    
               Types
             
    
-            
    ApplyGiftCardToCartOutput
    
+            
    ApplyCouponsToCartInput
    
             
    
               
    
                 
    
                   
    Description
    
-                  
    Defines the possible output for the applyGiftCardToCart mutation.
    
+                  
    Apply coupons to the cart.
    
                 
    
                 
    
                   
    Fields
    
                   
-                        
+                        
-                        
-                        
+                        
-                    
-                  
    
                     
                       
    Field NameInput Field
                         Description
                       
    
                         
                     
                       
    
-                          cart -
+                        
+                          cart_id -
                           
-                            Cart!
+                            String!
                           
                          Describes the contents of the specified shopping cart. 
+                          
    The unique ID of a Cart object.
    
+                            		
                       
    
-                
    
-              
    
-              
    
-                
    
-                  
    Example
    
-                  
-                  
-                  
    {"cart": Cart}
-
     
-                  
-                
    
-              
    
-            
    
-          
    
-          
    
-            
    
-              Types
-            
    
-            
    ApplyRewardPointsToCartOutput
    
-            
    
-              
    
-                
    
-                  
    Description
    
-                  
    Contains the customer cart.
    
-                
    
-                
    
-                  
    Fields
    
-                  
-                    
-                        
-                        
+                        
+                        
-                    
-                    
-                        
-                        
+                        
    
                       
    Field NameDescription
+                          coupon_codes -
+                          
+                            [String]!
+                          
+                        
+                          
    An array of valid coupon codes.
    
+                            		
                       
    
                       
    
-                          cart -
+                        
+                          type -
                           
-                            Cart!
+                            ApplyCouponsStrategy
                           
                          The customer cart after reward points are applied. 
+                          
    replace to replace the existing coupon(s) or append to add the coupon to the coupon(s) list.
    
+                            		
                       
    
                         
                   
    
@@ -23095,23 +23869,27 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"cart": Cart}
+                  
    {
+  "cart_id": "xyz789",
+  "coupon_codes": ["xyz789"],
+  "type": "APPEND"
+}
 
     
                   
                 
    
               
    
             
    
           
    
-          
    
+          
    
             
    
               Types
             
    
-            
    ApplyStoreCreditToCartInput
    
+            
    ApplyGiftCardToCartInput
    
             
    
               
    
                 
    
                   
    Description
    
-                  
    Defines the input required to run the applyStoreCreditToCart mutation.
    
+                  
    Defines the input required to run the applyGiftCardToCart mutation.
    
                 
    
                 
    
                   
    Fields
    
@@ -23134,6 +23912,17 @@ 
    Fields
    
                           
    The unique ID that identifies the customer's cart.
    
                         
                       
+                      
+                        
+                          gift_card_code -
+                          
+                            String!
+                          
+                        
+                        
+                          
    The gift card code to be applied to the cart.
    
+                        
+                      
                     
                   
                 
    
@@ -23143,7 +23932,150 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"cart_id": "xyz789"}
+                  
    {
+  "cart_id": "xyz789",
+  "gift_card_code": "xyz789"
+}
+
     
+                  
+                
    
+              
    
+            
+          
    
+          
    
+            
    
+              Types
+            
    
+            
    ApplyGiftCardToCartOutput
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Defines the possible output for the applyGiftCardToCart mutation.
    
+                
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                    
+                  
    Field NameDescription
    
+                          cart -
+                          
+                            Cart!
+                          
+                         Describes the contents of the specified shopping cart. 
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {"cart": Cart}
+
     
+                  
+                
    
+              
    
+            
    
+          
    
+          
    
+            
    
+              Types
+            
    
+            
    ApplyRewardPointsToCartOutput
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Contains the customer cart.
    
+                
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                    
+                  
    Field NameDescription
    
+                          cart -
+                          
+                            Cart!
+                          
+                         The customer cart after reward points are applied. 
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {"cart": Cart}
+
     
+                  
+                
    
+              
    
+            
    
+          
    
+          
    
+            
    
+              Types
+            
    
+            
    ApplyStoreCreditToCartInput
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Defines the input required to run the applyStoreCreditToCart mutation.
    
+                
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                    
+                  
    Input FieldDescription
    
+                          cart_id -
+                          
+                            String!
+                          
+                        
+                          
    The unique ID that identifies the customer's cart.
    
+                        
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {"cart_id": "abc123"}
 
     
                   
                 
    
@@ -23248,7 +24180,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"radius": 987, "search_term": "abc123"}
+                  
    {"radius": 123, "search_term": "xyz789"}
 
     
                   
                 
    
@@ -23397,7 +24329,7 @@ 
    Example
    
                   
    {
   "attribute_code": "abc123",
   "attribute_options": [AttributeOption],
-  "attribute_type": "abc123",
+  "attribute_type": "xyz789",
   "entity_type": "xyz789",
   "input_type": "abc123",
   "storefront_properties": StorefrontProperties
@@ -23638,18 +24570,18 @@ 
    Example
    
                   
                   
                   
    {
-  "is_comparable": false,
-  "is_filterable": true,
+  "is_comparable": true,
+  "is_filterable": false,
   "is_filterable_in_search": true,
   "is_html_allowed_on_front": true,
-  "is_searchable": false,
-  "is_used_for_customer_segment": false,
+  "is_searchable": true,
+  "is_used_for_customer_segment": true,
   "is_used_for_price_rules": false,
-  "is_used_for_promo_rules": true,
-  "is_visible_in_advanced_search": true,
+  "is_used_for_promo_rules": false,
+  "is_visible_in_advanced_search": false,
   "is_visible_on_front": false,
-  "is_wysiwyg_enabled": true,
-  "used_in_product_listing": false
+  "is_wysiwyg_enabled": false,
+  "used_in_product_listing": true
 }
 
     
                   
@@ -23843,7 +24775,7 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_code": "xyz789",
+  "attribute_code": "abc123",
   "entity_type": "abc123"
 }
 
     
@@ -24012,14 +24944,14 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "4",
+  "code": 4,
   "default_value": "abc123",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
-  "is_required": true,
-  "is_unique": false,
-  "label": "abc123",
+  "is_required": false,
+  "is_unique": true,
+  "label": "xyz789",
   "options": [CustomAttributeOptionInterface]
 }
 
     
@@ -24077,7 +25009,7 @@ 
    Example
    
                   
                   
                   
    {
-  "message": "xyz789",
+  "message": "abc123",
   "type": "ENTITY_NOT_FOUND"
 }
 
     
@@ -24264,7 +25196,7 @@ 
    Example
    
                   
                   
    {
   "is_default": false,
-  "label": "abc123",
+  "label": "xyz789",
   "value": "abc123"
 }
 
     
@@ -24318,8 +25250,8 @@ 
    Example
    
                   
                   
                   
    {
-  "label": "xyz789",
-  "value": "xyz789"
+  "label": "abc123",
+  "value": "abc123"
 }
 
     
                   
@@ -24500,7 +25432,7 @@ 
    Example
    
                   
                   
    {
   "code": "4",
-  "value": "xyz789"
+  "value": "abc123"
 }
 
     
                   
@@ -24572,9 +25504,9 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_code": "abc123",
+  "attribute_code": "xyz789",
   "selected_options": [AttributeInputSelectedOption],
-  "value": "xyz789"
+  "value": "abc123"
 }
 
     
                   
@@ -24881,7 +25813,7 @@ 
    Example
    
                   
    {
   "code": "xyz789",
   "is_deferred": false,
-  "title": "abc123"
+  "title": "xyz789"
 }
 
     
                   
@@ -25015,11 +25947,11 @@ 
    Example
    
   "amount": Money,
   "available": false,
   "base_amount": Money,
-  "carrier_code": "xyz789",
+  "carrier_code": "abc123",
   "carrier_title": "xyz789",
   "error_message": "abc123",
-  "method_code": "xyz789",
-  "method_title": "abc123",
+  "method_code": "abc123",
+  "method_title": "xyz789",
   "price_excl_tax": Money,
   "price_incl_tax": Money
 }
@@ -25353,22 +26285,22 @@ 
    Example
    
                   
                   
    {
   "city": "xyz789",
-  "company": "abc123",
+  "company": "xyz789",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "customer_notes": "abc123",
+  "customer_notes": "xyz789",
   "fax": "abc123",
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "lastname": "abc123",
   "middlename": "abc123",
   "postcode": "xyz789",
-  "prefix": "xyz789",
+  "prefix": "abc123",
   "region": CartAddressRegion,
   "street": ["xyz789"],
   "suffix": "abc123",
   "telephone": "abc123",
-  "uid": "abc123",
-  "vat_id": "abc123"
+  "uid": "xyz789",
+  "vat_id": "xyz789"
 }
 
     
                   
@@ -25388,16 +26320,7 @@ 
    Description
    
                   
    The Boolean scalar type represents true or false.
    
                 
    
               
-              
    
-                
    
-                  
    Example
    
-                  
-                  
-                  
    true
-
     
-                  
-                
    
-              
    
+              
     
    
             
           
    
           
    
@@ -25445,8 +26368,8 @@ 
    Example
    
                   
                   
                   
    {
-  "device_data": "xyz789",
-  "public_hash": "xyz789"
+  "device_data": "abc123",
+  "public_hash": "abc123"
 }
 
     
                   
@@ -25514,7 +26437,7 @@ 
    Example
    
                   
                   
                   
    {
-  "device_data": "xyz789",
+  "device_data": "abc123",
   "is_active_payment_token_enabler": true,
   "payment_method_nonce": "xyz789"
 }
@@ -25569,7 +26492,7 @@ 
    Example
    
                   
                   
                   
    {
-  "device_data": "xyz789",
+  "device_data": "abc123",
   "public_hash": "abc123"
 }
 
     
@@ -25665,11 +26588,11 @@ 
    Example
    
                   
                   
                   
    {
-  "category_id": 123,
+  "category_id": 987,
   "category_level": 987,
   "category_name": "xyz789",
-  "category_uid": "4",
-  "category_url_key": "abc123",
+  "category_uid": 4,
+  "category_url_key": "xyz789",
   "category_url_path": "abc123"
 }
 
     
@@ -25853,14 +26776,14 @@ 
    Example
    
   "errors": [CartItemError],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "abc123",
-  "is_available": true,
+  "id": "xyz789",
+  "is_available": false,
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
   "quantity": 123.45,
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -25973,12 +26896,12 @@ 
    Example
    
                   
    {
   "bundle_options": [ItemSelectedBundleOption],
   "discounts": [Discount],
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "xyz789",
-  "quantity_refunded": 123.45
+  "quantity_refunded": 987.65
 }
 
     
                   
@@ -26091,12 +27014,12 @@ 
    Example
    
                   
    {
   "bundle_options": [ItemSelectedBundleOption],
   "discounts": [Discount],
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "xyz789",
-  "quantity_invoiced": 987.65
+  "quantity_invoiced": 123.45
 }
 
     
                   
@@ -26223,9 +27146,9 @@ 
    Example
    
   "position": 987,
   "price_range": PriceRange,
   "required": true,
-  "sku": "xyz789",
+  "sku": "abc123",
   "title": "abc123",
-  "type": "xyz789",
+  "type": "abc123",
   "uid": 4
 }
 
     
@@ -26368,11 +27291,11 @@ 
    Example
    
                   
                   
                   
    {
-  "can_change_quantity": false,
+  "can_change_quantity": true,
   "id": 123,
-  "is_default": false,
-  "label": "abc123",
-  "position": 987,
+  "is_default": true,
+  "label": "xyz789",
+  "position": 123,
   "price": 123.45,
   "price_type": "FIXED",
   "product": ProductInterface,
@@ -26451,8 +27374,8 @@ 
    Example
    
                   
                   
    {
   "id": 123,
-  "quantity": 987.65,
-  "value": ["abc123"]
+  "quantity": 123.45,
+  "value": ["xyz789"]
 }
 
     
                   
@@ -26544,6 +27467,15 @@ 
    Fields
    
                         
                          The unique ID for an OrderItemInterface object. 
                       
+                      
+                        
+                          product -
+                          
+                            ProductInterface
+                          
+                        
+                         The ProductInterface object, which contains details about the base product 
+                      
                       
                         
                           product_name -
@@ -26673,24 +27605,25 @@ 
    Example
    
                   
    {
   "bundle_options": [ItemSelectedBundleOption],
   "discounts": [Discount],
-  "eligible_for_return": true,
+  "eligible_for_return": false,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
   "id": 4,
-  "product_name": "abc123",
+  "product": ProductInterface,
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "product_type": "xyz789",
+  "product_type": "abc123",
   "product_url_key": "abc123",
-  "quantity_canceled": 987.65,
-  "quantity_invoiced": 123.45,
-  "quantity_ordered": 987.65,
+  "quantity_canceled": 123.45,
+  "quantity_invoiced": 987.65,
+  "quantity_ordered": 123.45,
   "quantity_refunded": 123.45,
-  "quantity_returned": 123.45,
+  "quantity_returned": 987.65,
   "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "xyz789"
+  "status": "abc123"
 }
 
     
                   
@@ -27617,90 +28550,90 @@ 
    Example
    
                   
                   
                   
    {
-  "activity": "abc123",
-  "attribute_set_id": 123,
+  "activity": "xyz789",
+  "attribute_set_id": 987,
   "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "category_gear": "xyz789",
-  "climate": "xyz789",
+  "category_gear": "abc123",
+  "climate": "abc123",
   "collar": "xyz789",
   "color": 987,
   "country_of_manufacture": "abc123",
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "dynamic_price": true,
   "dynamic_sku": false,
-  "dynamic_weight": true,
-  "eco_collection": 987,
+  "dynamic_weight": false,
+  "eco_collection": 123,
   "erin_recommends": 987,
-  "features_bags": "abc123",
+  "features_bags": "xyz789",
   "format": 987,
-  "gender": "xyz789",
-  "gift_message_available": "xyz789",
+  "gender": "abc123",
+  "gift_message_available": "abc123",
   "id": 123,
   "image": ProductImage,
   "is_returnable": "xyz789",
   "items": [BundleItem],
-  "manufacturer": 987,
-  "material": "abc123",
+  "manufacturer": 123,
+  "material": "xyz789",
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
-  "meta_keyword": "xyz789",
-  "meta_title": "abc123",
-  "name": "xyz789",
-  "new": 987,
+  "meta_description": "xyz789",
+  "meta_keyword": "abc123",
+  "meta_title": "xyz789",
+  "name": "abc123",
+  "new": 123,
   "new_from_date": "xyz789",
   "new_to_date": "abc123",
-  "only_x_left_in_stock": 123.45,
+  "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
-  "options_container": "abc123",
+  "options_container": "xyz789",
   "pattern": "abc123",
-  "performance_fabric": 123,
+  "performance_fabric": 987,
   "price": ProductPrices,
   "price_details": PriceDetails,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "price_view": "PRICE_RANGE",
   "product_links": [ProductLinksInterface],
-  "purpose": 987,
-  "rating_summary": 987.65,
+  "purpose": 123,
+  "rating_summary": 123.45,
   "redirect_code": 123,
   "related_products": [ProductInterface],
   "relative_url": "xyz789",
-  "review_count": 123,
+  "review_count": 987,
   "reviews": ProductReviews,
   "sale": 987,
   "ship_bundle_items": "TOGETHER",
   "short_description": ComplexTextValue,
-  "size": 123,
+  "size": 987,
   "sku": "xyz789",
   "sleeve": "abc123",
   "small_image": ProductImage,
-  "special_from_date": "xyz789",
-  "special_price": 987.65,
-  "special_to_date": "xyz789",
-  "staged": true,
+  "special_from_date": "abc123",
+  "special_price": 123.45,
+  "special_to_date": "abc123",
+  "staged": false,
   "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
+  "strap_bags": "xyz789",
   "style_bags": "xyz789",
   "style_bottom": "abc123",
-  "style_general": "xyz789",
-  "swatch_image": "abc123",
+  "style_general": "abc123",
+  "swatch_image": "xyz789",
   "thumbnail": ProductImage,
-  "tier_price": 987.65,
+  "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "abc123",
+  "type_id": "xyz789",
   "uid": 4,
   "updated_at": "abc123",
   "upsell_products": [ProductInterface],
-  "url_key": "abc123",
-  "url_path": "xyz789",
+  "url_key": "xyz789",
+  "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "xyz789",
+  "url_suffix": "abc123",
   "websites": [Website],
   "weight": 987.65
 }
@@ -27967,12 +28900,12 @@ 
    Example
    
                   
                   
    {
   "bundle_options": [ItemSelectedBundleOption],
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "quantity_shipped": 123.45
+  "product_sku": "abc123",
+  "quantity_shipped": 987.65
 }
 
     
                   
@@ -28077,8 +29010,8 @@ 
    Example
    
   "added_at": "xyz789",
   "bundle_options": [SelectedBundleOption],
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
-  "id": "4",
+  "description": "abc123",
+  "id": 4,
   "product": ProductInterface,
   "quantity": 123.45
 }
@@ -28178,12 +29111,12 @@ 
    Example
    
                   
                   
                   
    {
-  "color": "xyz789",
+  "color": "abc123",
   "height": 987,
-  "label": "abc123",
-  "layout": "abc123",
-  "shape": "xyz789",
-  "tagline": false,
+  "label": "xyz789",
+  "layout": "xyz789",
+  "shape": "abc123",
+  "tagline": true,
   "use_default_height": true
 }
 
     
@@ -28244,7 +29177,10 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"order_id": 4, "reason": "xyz789"}
+                  
    {
+  "order_id": "4",
+  "reason": "abc123"
+}
 
     
                   
                 
@@ -28300,7 +29236,7 @@ 
    Example
    
                   
                   
                   
    {
-  "error": "abc123",
+  "error": "xyz789",
   "order": CustomerOrder
 }
 
     
@@ -28427,7 +29363,7 @@ 
    Example
    
   "card_expiry_month": "abc123",
   "card_expiry_year": "xyz789",
   "last_digits": "abc123",
-  "name": "abc123"
+  "name": "xyz789"
 }
 
     
                   
@@ -28627,13 +29563,57 @@ 
    Fields
    
                          Indicates whether the cart contains only virtual products. 
                       
                       
-                        
+                        
                           items -
                           
                             [CartItemInterface]
                           
                         
-                         An array of products that have been added to the cart. 
+                         An array of products that have been added to the cart.
+                          Use itemsV2 instead.
+                        
+                      
+                      
+                        
+                          itemsV2 -
+                          
+                            CartItems
+                          
+                        
+                         
+                      
+                      
+                        
+                          
    
+                            
     Arguments 
    
+                            
    
+                              
    
+                                
    
+                                  pageSize -
+                                  
+                                    Int
+                                  
+                                
    
+                              
    
+                              
    
+                                
    
+                                  currentPage -
+                                  
+                                    Int
+                                  
+                                
    
+                              
    
+                              
    
+                                
    
+                                  sort -
+                                  
+                                    QuoteItemsSortInput
+                                  
+                                
    
+                              
    
+                            
    
+                          
    
+                        
                       
                       
                         
@@ -28702,9 +29682,10 @@ 
    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,
   "selected_payment_method": SelectedPaymentMethod,
@@ -28766,7 +29747,7 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "abc123",
+  "code": "xyz789",
   "label": "xyz789"
 }
 
     
@@ -28993,21 +29974,21 @@ 
    Example
    
                   
                   
                   
    {
-  "city": "xyz789",
-  "company": "abc123",
+  "city": "abc123",
+  "company": "xyz789",
   "country_code": "xyz789",
   "custom_attributes": [AttributeValueInput],
   "fax": "xyz789",
   "firstname": "xyz789",
-  "lastname": "xyz789",
+  "lastname": "abc123",
   "middlename": "xyz789",
   "postcode": "abc123",
   "prefix": "abc123",
-  "region": "abc123",
+  "region": "xyz789",
   "region_id": 987,
   "save_in_address_book": true,
-  "street": ["xyz789"],
-  "suffix": "abc123",
+  "street": ["abc123"],
+  "suffix": "xyz789",
   "telephone": "abc123",
   "vat_id": "abc123"
 }
@@ -29214,19 +30195,19 @@ 
    Example
    
                   
                   
                   
    {
-  "city": "abc123",
-  "company": "xyz789",
+  "city": "xyz789",
+  "company": "abc123",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "fax": "xyz789",
-  "firstname": "abc123",
-  "lastname": "xyz789",
+  "fax": "abc123",
+  "firstname": "xyz789",
+  "lastname": "abc123",
   "middlename": "xyz789",
   "postcode": "abc123",
-  "prefix": "xyz789",
+  "prefix": "abc123",
   "region": CartAddressRegion,
   "street": ["xyz789"],
-  "suffix": "abc123",
+  "suffix": "xyz789",
   "telephone": "xyz789",
   "uid": "xyz789",
   "vat_id": "xyz789"
@@ -29296,7 +30277,7 @@ 
    Example
    
                   
                   
    {
   "code": "xyz789",
-  "label": "xyz789",
+  "label": "abc123",
   "region_id": 123
 }
 
     
@@ -29355,7 +30336,7 @@ 
    Example
    
                   
                   
    {
   "amount": Money,
-  "label": ["xyz789"]
+  "label": ["abc123"]
 }
 
     
                   
@@ -29452,7 +30433,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"code": "UNDEFINED", "message": "abc123"}
+                  
    {"code": "UNDEFINED", "message": "xyz789"}
 
     
                   
                 
@@ -29597,8 +30578,8 @@ 
    Example
    
                   
                   
    {
   "entered_options": [EnteredOptionInput],
-  "parent_sku": "xyz789",
-  "quantity": 987.65,
+  "parent_sku": "abc123",
+  "quantity": 123.45,
   "selected_options": ["4"],
   "sku": "xyz789"
 }
@@ -29788,13 +30769,13 @@ 
    Example
    
   "discount": [Discount],
   "errors": [CartItemError],
   "id": "abc123",
-  "is_available": false,
+  "is_available": true,
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": "4"
+  "quantity": 987.65,
+  "uid": 4
 }
 
     
                   
@@ -29962,7 +30943,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"cart_item_id": 123, "quantity": 987.65}
+                  
    {"cart_item_id": 987, "quantity": 123.45}
 
     
                   
                 
@@ -30029,7 +31010,7 @@ 
    Example
    
                   
    {
   "type": "FIXED",
   "units": "xyz789",
-  "value": 123.45
+  "value": 987.65
 }
 
     
                   
@@ -30134,12 +31115,76 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_item_id": 987,
-  "cart_item_uid": 4,
+  "cart_item_id": 123,
+  "cart_item_uid": "4",
   "customizable_options": [CustomizableOptionInput],
   "gift_message": GiftMessageInput,
   "gift_wrapping_id": "4",
-  "quantity": 123.45
+  "quantity": 987.65
+}
+
     
+                  
+                
+              
+            
+          
+          
    
+            
    
+              Types
+            
    
+            
    CartItems
    
+            
    
+              
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                    
+                  
    Field NameDescription
    
+                          items -
+                          
+                            [CartItemInterface]!
+                          
+                         An array of products that have been added to the cart. 
    
+                          page_info -
+                          
+                            SearchResultPageInfo
+                          
+                         Metadata for pagination rendering. 
    
+                          total_count -
+                          
+                            Int!
+                          
+                         The number of returned cart items. 
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {
+  "items": [CartItemInterface],
+  "page_info": SearchResultPageInfo,
+  "total_count": 123
 }
 
     
                   
@@ -30317,7 +31362,7 @@ 
    Example
    
                   
                   
    {
   "amount": Money,
-  "label": "abc123"
+  "label": "xyz789"
 }
 
     
                   
@@ -30769,28 +31814,28 @@ 
    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": true,
-  "is_filterable": false,
-  "is_filterable_in_search": true,
+  "is_filterable": true,
+  "is_filterable_in_search": false,
   "is_html_allowed_on_front": false,
   "is_required": true,
-  "is_searchable": true,
+  "is_searchable": false,
   "is_unique": false,
-  "is_used_for_price_rules": true,
-  "is_used_for_promo_rules": true,
-  "is_visible_in_advanced_search": true,
+  "is_used_for_price_rules": false,
+  "is_used_for_promo_rules": false,
+  "is_visible_in_advanced_search": false,
   "is_visible_on_front": true,
   "is_wysiwyg_enabled": true,
   "label": "xyz789",
   "options": [CustomAttributeOptionInterface],
   "swatch_input_type": "BOOLEAN",
-  "update_product_preview_image": true,
-  "use_product_image_for_swatch": false,
+  "update_product_preview_image": false,
+  "use_product_image_for_swatch": true,
   "used_in_product_listing": true
 }
 
     
@@ -31310,39 +32355,39 @@ 
    Example
    
                   
                   
                   
    {
-  "automatic_sorting": "abc123",
+  "automatic_sorting": "xyz789",
   "available_sort_by": ["xyz789"],
   "breadcrumbs": [Breadcrumb],
   "canonical_url": "xyz789",
   "children_count": "xyz789",
   "cms_block": CmsBlock,
   "created_at": "abc123",
-  "custom_layout_update_file": "abc123",
+  "custom_layout_update_file": "xyz789",
   "default_sort_by": "abc123",
   "description": "abc123",
   "display_mode": "abc123",
-  "filter_price_range": 123.45,
+  "filter_price_range": 987.65,
   "id": 987,
-  "image": "abc123",
+  "image": "xyz789",
   "include_in_menu": 987,
-  "is_anchor": 123,
+  "is_anchor": 987,
   "landing_page": 123,
   "level": 987,
   "meta_description": "xyz789",
   "meta_keywords": "abc123",
-  "meta_title": "xyz789",
+  "meta_title": "abc123",
   "name": "abc123",
   "path": "xyz789",
   "path_in_store": "abc123",
-  "position": 987,
+  "position": 123,
   "product_count": 987,
   "products": CategoryProducts,
-  "staged": true,
-  "uid": 4,
+  "staged": false,
+  "uid": "4",
   "updated_at": "abc123",
   "url_key": "abc123",
-  "url_path": "xyz789",
-  "url_suffix": "abc123"
+  "url_path": "abc123",
+  "url_suffix": "xyz789"
 }
 
     
                   
@@ -31478,7 +32523,7 @@ 
    Example
    
                   
    {
   "items": [CategoryTree],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
     
                   
@@ -31892,43 +32937,43 @@ 
    Example
    
                   
                   
                   
    {
-  "automatic_sorting": "xyz789",
+  "automatic_sorting": "abc123",
   "available_sort_by": ["abc123"],
   "breadcrumbs": [Breadcrumb],
   "canonical_url": "xyz789",
   "children": [CategoryTree],
-  "children_count": "xyz789",
+  "children_count": "abc123",
   "cms_block": CmsBlock,
   "created_at": "abc123",
   "custom_layout_update_file": "abc123",
-  "default_sort_by": "xyz789",
-  "description": "xyz789",
+  "default_sort_by": "abc123",
+  "description": "abc123",
   "display_mode": "xyz789",
-  "filter_price_range": 987.65,
+  "filter_price_range": 123.45,
   "id": 987,
   "image": "xyz789",
   "include_in_menu": 123,
   "is_anchor": 987,
   "landing_page": 987,
   "level": 123,
-  "meta_description": "xyz789",
+  "meta_description": "abc123",
   "meta_keywords": "abc123",
-  "meta_title": "xyz789",
-  "name": "xyz789",
+  "meta_title": "abc123",
+  "name": "abc123",
   "path": "xyz789",
-  "path_in_store": "xyz789",
-  "position": 987,
+  "path_in_store": "abc123",
+  "position": 123,
   "product_count": 987,
   "products": CategoryProducts,
   "redirect_code": 987,
   "relative_url": "abc123",
-  "staged": false,
+  "staged": true,
   "type": "CMS_PAGE",
   "uid": 4,
-  "updated_at": "xyz789",
-  "url_key": "abc123",
+  "updated_at": "abc123",
+  "url_key": "xyz789",
   "url_path": "abc123",
-  "url_suffix": "abc123"
+  "url_suffix": "xyz789"
 }
 
     
                   
@@ -32030,13 +33075,13 @@ 
    Example
    
                   
                   
                   
    {
-  "agreement_id": 123,
-  "checkbox_text": "xyz789",
-  "content": "xyz789",
+  "agreement_id": 987,
+  "checkbox_text": "abc123",
+  "content": "abc123",
   "content_height": "abc123",
   "is_html": true,
   "mode": "AUTO",
-  "name": "xyz789"
+  "name": "abc123"
 }
 
     
                   
@@ -32274,7 +33319,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"message": "xyz789", "type": "NOT_FOUND"}
+                  
    {"message": "abc123", "type": "NOT_FOUND"}
 
     
                   
                 
    
@@ -32379,7 +33424,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"uid": 4}
+                  
    {"uid": "4"}
 
     
                   
                 
    
@@ -32602,7 +33647,7 @@ 
    Example
    
                   
                   
    {
   "errors": [NegotiableQuoteInvalidStateError],
-  "quote_uid": 4
+  "quote_uid": "4"
 }
 
     
                   
@@ -32697,7 +33742,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"quote_uids": [4]}
+                  
    {"quote_uids": ["4"]}
 
     
                   
                 
    
@@ -32891,7 +33936,7 @@ 
    Example
    
                   
    {
   "content": "abc123",
   "identifier": "xyz789",
-  "title": "abc123"
+  "title": "xyz789"
 }
 
     
                   
@@ -33093,9 +34138,9 @@ 
    Example
    
   "page_layout": "xyz789",
   "redirect_code": 123,
   "relative_url": "xyz789",
-  "title": "xyz789",
+  "title": "abc123",
   "type": "CMS_PAGE",
-  "url_key": "xyz789"
+  "url_key": "abc123"
 }
 
     
                   
@@ -33526,7 +34571,7 @@ 
    Example
    
   "credit": CompanyCredit,
   "credit_history": CompanyCreditHistory,
   "email": "abc123",
-  "id": 4,
+  "id": "4",
   "legal_address": CompanyLegalAddress,
   "legal_name": "xyz789",
   "name": "abc123",
@@ -33539,7 +34584,7 @@ 
    Example
    
   "team": CompanyTeam,
   "user": Customer,
   "users": CompanyUsers,
-  "vat_tax_id": "xyz789"
+  "vat_tax_id": "abc123"
 }
 
     
                   
@@ -33615,9 +34660,9 @@ 
    Example
    
                   
                   
    {
   "children": [CompanyAclResource],
-  "id": 4,
-  "sort_order": 123,
-  "text": "abc123"
+  "id": "4",
+  "sort_order": 987,
+  "text": "xyz789"
 }
 
     
                   
@@ -33711,7 +34756,7 @@ 
    Example
    
                   
                   
                   
    {
-  "email": "abc123",
+  "email": "xyz789",
   "firstname": "xyz789",
   "gender": 123,
   "job_title": "abc123",
@@ -33832,12 +34877,12 @@ 
    Example
    
                   
                   
    {
   "company_admin": CompanyAdminInput,
-  "company_email": "xyz789",
+  "company_email": "abc123",
   "company_name": "abc123",
   "legal_address": CompanyLegalAddressCreateInput,
   "legal_name": "abc123",
-  "reseller_id": "abc123",
-  "vat_tax_id": "abc123"
+  "reseller_id": "xyz789",
+  "vat_tax_id": "xyz789"
 }
 
     
                   
@@ -33973,7 +35018,7 @@ 
    Example
    
                   
    {
   "items": [CompanyCreditOperation],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
     
                   
@@ -34045,9 +35090,9 @@ 
    Example
    
                   
                   
                   
    {
-  "custom_reference_number": "xyz789",
+  "custom_reference_number": "abc123",
   "operation_type": "ALLOCATION",
-  "updated_by": "xyz789"
+  "updated_by": "abc123"
 }
 
     
                   
@@ -34142,8 +35187,8 @@ 
    Example
    
                   
    {
   "amount": Money,
   "balance": CompanyCredit,
-  "custom_reference_number": "abc123",
-  "date": "xyz789",
+  "custom_reference_number": "xyz789",
+  "date": "abc123",
   "type": "ALLOCATION",
   "updated_by": CompanyCreditOperationUser
 }
@@ -34407,11 +35452,11 @@ 
    Example
    
                   
                   
                   
    {
-  "city": "xyz789",
+  "city": "abc123",
   "country_code": "AF",
   "postcode": "abc123",
   "region": CustomerAddressRegion,
-  "street": ["abc123"],
+  "street": ["xyz789"],
   "telephone": "abc123"
 }
 
     
@@ -34517,12 +35562,12 @@ 
    Example
    
                   
                   
                   
    {
-  "city": "xyz789",
+  "city": "abc123",
   "country_id": "AF",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "region": CustomerAddressRegionInput,
   "street": ["xyz789"],
-  "telephone": "xyz789"
+  "telephone": "abc123"
 }
 
     
                   
@@ -34629,9 +35674,9 @@ 
    Example
    
                   
    {
   "city": "abc123",
   "country_id": "AF",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": CustomerAddressRegionInput,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "telephone": "xyz789"
 }
 
     
@@ -34844,7 +35889,7 @@ 
    Example
    
                   
                   
                   
    {
-  "id": 4,
+  "id": "4",
   "name": "xyz789",
   "permissions": ["abc123"]
 }
@@ -34914,7 +35959,7 @@ 
    Example
    
                   
    {
   "items": [CompanyRole],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
     
                   
@@ -34980,9 +36025,9 @@ 
    Example
    
                   
                   
                   
    {
-  "email": "xyz789",
+  "email": "abc123",
   "firstname": "abc123",
-  "lastname": "abc123"
+  "lastname": "xyz789"
 }
 
     
                   
@@ -35141,8 +36186,8 @@ 
    Example
    
                   
                   
    {
   "entity": CompanyTeam,
-  "id": "4",
-  "parent_id": 4
+  "id": 4,
+  "parent_id": "4"
 }
 
     
                   
@@ -35202,7 +36247,10 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"parent_tree_id": 4, "tree_id": 4}
+                  
    {
+  "parent_tree_id": "4",
+  "tree_id": "4"
+}
 
     
                   
                 
@@ -35277,8 +36325,8 @@ 
    Example
    
                   
                   
    {
   "description": "abc123",
-  "id": "4",
-  "name": "abc123",
+  "id": 4,
+  "name": "xyz789",
   "structure_id": 4
 }
 
     
@@ -35353,7 +36401,7 @@ 
    Example
    
                   
    {
   "description": "xyz789",
   "name": "abc123",
-  "target_id": "4"
+  "target_id": 4
 }
 
     
                   
@@ -35425,9 +36473,9 @@ 
    Example
    
                   
                   
                   
    {
-  "description": "xyz789",
-  "id": "4",
-  "name": "xyz789"
+  "description": "abc123",
+  "id": 4,
+  "name": "abc123"
 }
 
     
                   
@@ -35533,10 +36581,10 @@ 
    Example
    
                   
                   
    {
   "company_email": "abc123",
-  "company_name": "abc123",
+  "company_name": "xyz789",
   "legal_address": CompanyLegalAddressUpdateInput,
   "legal_name": "abc123",
-  "reseller_id": "abc123",
+  "reseller_id": "xyz789",
   "vat_tax_id": "abc123"
 }
 
     
@@ -35665,8 +36713,8 @@ 
    Example
    
                   
                   
    {
   "email": "xyz789",
-  "firstname": "xyz789",
-  "job_title": "xyz789",
+  "firstname": "abc123",
+  "job_title": "abc123",
   "lastname": "xyz789",
   "role_id": 4,
   "status": "ACTIVE",
@@ -35847,14 +36895,14 @@ 
    Example
    
                   
                   
                   
    {
-  "email": "abc123",
-  "firstname": "xyz789",
+  "email": "xyz789",
+  "firstname": "abc123",
   "id": "4",
   "job_title": "abc123",
   "lastname": "xyz789",
   "role_id": "4",
   "status": "ACTIVE",
-  "telephone": "abc123"
+  "telephone": "xyz789"
 }
 
     
                   
@@ -35922,7 +36970,7 @@ 
    Example
    
                   
    {
   "items": [Customer],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
     
                   
@@ -36027,7 +37075,7 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "xyz789",
+  "code": "abc123",
   "label": "abc123"
 }
 
     
@@ -36096,7 +37144,7 @@ 
    Example
    
                   
    {
   "attributes": [ProductAttribute],
   "product": ProductInterface,
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -36172,7 +37220,7 @@ 
    Example
    
                   
                   
    {
   "attributes": [ComparableAttribute],
-  "item_count": 123,
+  "item_count": 987,
   "items": [ComparableItem],
   "uid": 4
 }
@@ -36217,7 +37265,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"html": "xyz789"}
+                  
    {"html": "abc123"}
 
     
                   
                 
@@ -36292,9 +37340,9 @@ 
    Example
    
                   
                   
    {
   "code": "xyz789",
-  "label": "abc123",
+  "label": "xyz789",
   "uid": 4,
-  "value_index": 123
+  "value_index": 987
 }
 
     
                   
@@ -36487,14 +37535,14 @@ 
    Example
    
   "errors": [CartItemError],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "xyz789",
-  "is_available": false,
+  "id": "abc123",
+  "is_available": true,
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
   "quantity": 123.45,
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -37461,82 +38509,82 @@ 
    Example
    
                   
                   
    {
   "activity": "abc123",
-  "attribute_set_id": 987,
-  "canonical_url": "abc123",
+  "attribute_set_id": 123,
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
   "category_gear": "abc123",
   "climate": "abc123",
-  "collar": "xyz789",
+  "collar": "abc123",
   "color": 123,
   "configurable_options": [ConfigurableProductOptions],
   "configurable_product_options_selection": ConfigurableProductOptionsSelection,
-  "country_of_manufacture": "xyz789",
-  "created_at": "xyz789",
+  "country_of_manufacture": "abc123",
+  "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "eco_collection": 987,
-  "erin_recommends": 987,
+  "erin_recommends": 123,
   "features_bags": "xyz789",
-  "format": 123,
-  "gender": "abc123",
-  "gift_message_available": "xyz789",
+  "format": 987,
+  "gender": "xyz789",
+  "gift_message_available": "abc123",
   "id": 987,
   "image": ProductImage,
-  "is_returnable": "abc123",
-  "manufacturer": 123,
+  "is_returnable": "xyz789",
+  "manufacturer": 987,
   "material": "abc123",
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
   "meta_description": "xyz789",
-  "meta_keyword": "abc123",
+  "meta_keyword": "xyz789",
   "meta_title": "abc123",
-  "name": "xyz789",
-  "new": 987,
+  "name": "abc123",
+  "new": 123,
   "new_from_date": "abc123",
-  "new_to_date": "abc123",
-  "only_x_left_in_stock": 123.45,
+  "new_to_date": "xyz789",
+  "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
-  "options_container": "abc123",
+  "options_container": "xyz789",
   "pattern": "xyz789",
   "performance_fabric": 123,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 987,
+  "purpose": 123,
   "rating_summary": 123.45,
   "redirect_code": 987,
   "related_products": [ProductInterface],
-  "relative_url": "abc123",
+  "relative_url": "xyz789",
   "review_count": 123,
   "reviews": ProductReviews,
   "sale": 987,
   "short_description": ComplexTextValue,
   "size": 987,
-  "sku": "abc123",
+  "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": false,
   "stock_status": "IN_STOCK",
-  "strap_bags": "xyz789",
-  "style_bags": "abc123",
+  "strap_bags": "abc123",
+  "style_bags": "xyz789",
   "style_bottom": "abc123",
-  "style_general": "abc123",
-  "swatch_image": "abc123",
+  "style_general": "xyz789",
+  "swatch_image": "xyz789",
   "thumbnail": ProductImage,
   "tier_price": 987.65,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "xyz789",
-  "uid": 4,
+  "type_id": "abc123",
+  "uid": "4",
   "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
-  "url_key": "abc123",
-  "url_path": "xyz789",
+  "url_key": "xyz789",
+  "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
   "url_suffix": "abc123",
   "variants": [ConfigurableVariant],
@@ -37623,7 +38671,7 @@ 
    Example
    
   "customizable_options": [CustomizableOptionInput],
   "data": CartItemInput,
   "parent_sku": "abc123",
-  "variant_sku": "xyz789"
+  "variant_sku": "abc123"
 }
 
     
                   
@@ -37698,9 +38746,9 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_code": "xyz789",
+  "attribute_code": "abc123",
   "label": "xyz789",
-  "uid": "4",
+  "uid": 4,
   "values": [ConfigurableProductOptionValue]
 }
 
     
@@ -37785,9 +38833,9 @@ 
    Example
    
                   
                   
                   
    {
-  "is_available": true,
+  "is_available": false,
   "is_use_default": false,
-  "label": "abc123",
+  "label": "xyz789",
   "swatch": SwatchDataInterface,
   "uid": 4
 }
@@ -37935,10 +38983,10 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_code": "xyz789",
-  "attribute_id": "abc123",
+  "attribute_code": "abc123",
+  "attribute_id": "xyz789",
   "attribute_id_v2": 123,
-  "attribute_uid": 4,
+  "attribute_uid": "4",
   "id": 123,
   "label": "xyz789",
   "position": 123,
@@ -38129,13 +39177,13 @@ 
    Example
    
                   
                   
                   
    {
-  "default_label": "xyz789",
-  "label": "abc123",
-  "store_label": "xyz789",
+  "default_label": "abc123",
+  "label": "xyz789",
+  "store_label": "abc123",
   "swatch_data": SwatchDataInterface,
   "uid": "4",
   "use_default_value": true,
-  "value_index": 987
+  "value_index": 123
 }
 
     
                   
@@ -38222,7 +39270,7 @@ 
    Example
    
   "configurable_options": [SelectedConfigurableOption],
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "uid": 4
 }
 
     
@@ -38413,6 +39461,117 @@ 
    Example
    
   "product": ProductInterface,
   "quantity": 123.45
 }
+
     
+                  
+                
+              
+            
+          
+          
    
+            
    
+              Types
+            
    
+            
    ConfirmEmailInput
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Contains details about a customer email address to confirm.
    
+                
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                    
+                  
    Input FieldDescription
    
+                          confirmation_key -
+                          
+                            String!
+                          
+                        
+                          
    The key to confirm the email address.
    
+                        
    
+                          email -
+                          
+                            String!
+                          
+                        
+                          
    The email address to be confirmed.
    
+                        
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {
+  "confirmation_key": "abc123",
+  "email": "xyz789"
+}
+
     
+                  
+                
    
+              
    
+            
    
+          
    
+          
    
+            
    
+              Types
+            
    
+            
    ConfirmationStatusEnum
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    List of account confirmation statuses.
    
+                
    
+                
    
+                  
    Values
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                    
+                  
    Enum ValueDescription
    
+                          
    ACCOUNT_CONFIRMED
    
+                            		 Account confirmed 
    
+                          
    ACCOUNT_CONFIRMATION_NOT_REQUIRED
    
+                            		 Account confirmation not required 
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    "ACCOUNT_CONFIRMED"
 
     
                   
                 
    
@@ -38493,7 +39652,7 @@ 
    Example
    
   "comment": "abc123",
   "email": "xyz789",
   "name": "abc123",
-  "telephone": "xyz789"
+  "telephone": "abc123"
 }
 
     
                   
@@ -38588,7 +39747,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"requisitionListItemUids": ["4"]}
+                  
    {"requisitionListItemUids": [4]}
 
     
                   
                 
@@ -38792,10 +39951,10 @@ 
    Example
    
                   
    {
   "available_regions": [Region],
   "full_name_english": "xyz789",
-  "full_name_locale": "abc123",
-  "id": "abc123",
-  "three_letter_abbreviation": "xyz789",
-  "two_letter_abbreviation": "abc123"
+  "full_name_locale": "xyz789",
+  "id": "xyz789",
+  "three_letter_abbreviation": "abc123",
+  "two_letter_abbreviation": "xyz789"
 }
 
     
                   
@@ -40535,7 +41694,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"products": [4]}
+                  
    {"products": ["4"]}
 
     
                   
                 
@@ -40664,7 +41823,7 @@ 
    Example
    
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
-  "event_name": "abc123",
+  "event_name": "xyz789",
   "gift_registry_type_uid": 4,
   "message": "xyz789",
   "privacy_settings": "PRIVATE",
@@ -40887,10 +42046,10 @@ 
    Example
    
                   
                   
    {
   "response_message": "xyz789",
-  "result": 123,
-  "result_code": 123,
-  "secure_token": "xyz789",
-  "secure_token_id": "xyz789"
+  "result": 987,
+  "result_code": 987,
+  "secure_token": "abc123",
+  "secure_token_id": "abc123"
 }
 
     
                   
@@ -40984,11 +42143,11 @@ 
    Example
    
                   
                   
                   
    {
-  "cartId": "abc123",
+  "cartId": "xyz789",
   "location": "PRODUCT_DETAIL",
-  "methodCode": "xyz789",
-  "paymentSource": "xyz789",
-  "vaultIntent": true
+  "methodCode": "abc123",
+  "paymentSource": "abc123",
+  "vaultIntent": false
 }
 
     
                   
@@ -41054,9 +42213,9 @@ 
    Example
    
                   
                   
                   
    {
-  "id": "xyz789",
+  "id": "abc123",
   "mp_order_id": "abc123",
-  "status": "abc123"
+  "status": "xyz789"
 }
 
     
                   
@@ -41154,7 +42313,7 @@ 
    Example
    
   "ratings": [ProductReviewRatingInput],
   "sku": "abc123",
   "summary": "abc123",
-  "text": "xyz789"
+  "text": "abc123"
 }
 
     
                   
@@ -41345,7 +42504,7 @@ 
    Example
    
   "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput,
   "attribute": "GRAND_TOTAL",
   "operator": "MORE_THAN",
-  "quantity": 123
+  "quantity": 987
 }
 
     
                   
@@ -41406,7 +42565,7 @@ 
    Example
    
                   
                   
                   
    {
-  "description": "xyz789",
+  "description": "abc123",
   "name": "abc123"
 }
 
     
@@ -41513,7 +42672,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"name": "abc123", "visibility": "PUBLIC"}
+                  
    {"name": "xyz789", "visibility": "PUBLIC"}
 
     
                   
                 
@@ -41641,7 +42800,7 @@ 
    Example
    
                   
                   
                   
    {
-  "cc_exp_month": 987,
+  "cc_exp_month": 123,
   "cc_exp_year": 123,
   "cc_last_4": 987,
   "cc_type": "xyz789"
@@ -41729,9 +42888,9 @@ 
    Example
    
                   
                   
    {
   "comments": [SalesCommentItem],
-  "id": 4,
+  "id": "4",
   "items": [CreditMemoItemInterface],
-  "number": "xyz789",
+  "number": "abc123",
   "total": CreditMemoTotal
 }
 
     
@@ -41835,7 +42994,7 @@ 
    Example
    
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
+  "product_sku": "abc123",
   "quantity_refunded": 123.45
 }
 
     
@@ -41981,10 +43140,10 @@ 
    Example
    
   "discounts": [Discount],
   "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "quantity_refunded": 123.45
+  "quantity_refunded": 987.65
 }
 
     
                   
@@ -42224,12 +43383,12 @@ 
    Example
    
                   
                   
    {
   "available_currency_codes": ["xyz789"],
-  "base_currency_code": "xyz789",
-  "base_currency_symbol": "abc123",
+  "base_currency_code": "abc123",
+  "base_currency_symbol": "xyz789",
   "default_display_currecy_code": "xyz789",
-  "default_display_currecy_symbol": "xyz789",
-  "default_display_currency_code": "abc123",
-  "default_display_currency_symbol": "xyz789",
+  "default_display_currecy_symbol": "abc123",
+  "default_display_currency_code": "xyz789",
+  "default_display_currency_symbol": "abc123",
   "exchange_rates": [ExchangeRate]
 }
 
     
@@ -43494,12 +44653,12 @@ 
    Example
    
                   
                   
    {
   "code": 4,
-  "default_value": "xyz789",
+  "default_value": "abc123",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "xyz789",
+  "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
-  "is_required": false,
-  "is_unique": false,
+  "is_required": true,
+  "is_unique": true,
   "label": "xyz789",
   "options": [CustomAttributeOptionInterface]
 }
@@ -43640,6 +44799,15 @@ 
    Fields
    
                         
                          The contents of the customer's compare list. 
                       
+                      
+                        
+                          confirmation_status -
+                          
+                            ConfirmationStatusEnum!
+                          
+                        
+                         The customer's confirmation status. 
+                      
                       
                         
                           created_at -
@@ -44361,23 +45529,24 @@ 
    Example
    
   "addresses": [CustomerAddress],
   "allow_remote_shopping_assistance": true,
   "compare_list": CompareList,
-  "created_at": "xyz789",
+  "confirmation_status": "ACCOUNT_CONFIRMED",
+  "created_at": "abc123",
   "custom_attributes": [AttributeValueInterface],
   "date_of_birth": "abc123",
-  "default_billing": "abc123",
-  "default_shipping": "abc123",
+  "default_billing": "xyz789",
+  "default_shipping": "xyz789",
   "dob": "abc123",
   "email": "xyz789",
   "firstname": "abc123",
-  "gender": 987,
+  "gender": 123,
   "gift_registries": [GiftRegistry],
   "gift_registry": GiftRegistry,
-  "group_id": 123,
-  "id": 987,
+  "group_id": 987,
+  "id": 123,
   "is_subscribed": false,
-  "job_title": "xyz789",
+  "job_title": "abc123",
   "lastname": "xyz789",
-  "middlename": "abc123",
+  "middlename": "xyz789",
   "orders": CustomerOrders,
   "prefix": "abc123",
   "purchase_order": PurchaseOrder,
@@ -44385,7 +45554,7 @@ 
    Example
    
   "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,
@@ -44395,10 +45564,10 @@ 
    Example
    
   "status": "ACTIVE",
   "store_credit": CustomerStoreCredit,
   "structure_id": "4",
-  "suffix": "xyz789",
-  "taxvat": "abc123",
+  "suffix": "abc123",
+  "taxvat": "xyz789",
   "team": CompanyTeam,
-  "telephone": "xyz789",
+  "telephone": "abc123",
   "wishlist": Wishlist,
   "wishlist_v2": Wishlist,
   "wishlists": [Wishlist]
@@ -44678,20 +45847,20 @@ 
    Example
    
   "custom_attributesV2": [AttributeValueInterface],
   "customer_id": 123,
   "default_billing": true,
-  "default_shipping": true,
+  "default_shipping": false,
   "extension_attributes": [CustomerAddressAttribute],
-  "fax": "abc123",
+  "fax": "xyz789",
   "firstname": "xyz789",
   "id": 987,
-  "lastname": "abc123",
-  "middlename": "xyz789",
-  "postcode": "xyz789",
+  "lastname": "xyz789",
+  "middlename": "abc123",
+  "postcode": "abc123",
   "prefix": "xyz789",
   "region": CustomerAddressRegion,
-  "region_id": 987,
+  "region_id": 123,
   "street": ["xyz789"],
   "suffix": "xyz789",
-  "telephone": "abc123",
+  "telephone": "xyz789",
   "vat_id": "xyz789"
 }
 
     
@@ -44750,7 +45919,7 @@ 
    Example
    
                   
                   
    {
   "attribute_code": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
     
                   
@@ -44811,7 +45980,7 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_code": "xyz789",
+  "attribute_code": "abc123",
   "value": "abc123"
 }
 
     
@@ -45066,18 +46235,18 @@ 
    Example
    
   "country_id": "AF",
   "custom_attributes": [CustomerAddressAttributeInput],
   "custom_attributesV2": [AttributeValueInput],
-  "default_billing": false,
+  "default_billing": true,
   "default_shipping": true,
   "fax": "abc123",
   "firstname": "abc123",
-  "lastname": "abc123",
-  "middlename": "xyz789",
+  "lastname": "xyz789",
+  "middlename": "abc123",
   "postcode": "xyz789",
-  "prefix": "abc123",
+  "prefix": "xyz789",
   "region": CustomerAddressRegionInput,
   "street": ["xyz789"],
-  "suffix": "xyz789",
-  "telephone": "abc123",
+  "suffix": "abc123",
+  "telephone": "xyz789",
   "vat_id": "xyz789"
 }
 
     
@@ -45145,8 +46314,8 @@ 
    Example
    
                   
                   
    {
   "region": "abc123",
-  "region_code": "abc123",
-  "region_id": 123
+  "region_code": "xyz789",
+  "region_id": 987
 }
 
     
                   
@@ -45218,9 +46387,9 @@ 
    Example
    
                   
                   
                   
    {
-  "region": "abc123",
+  "region": "xyz789",
   "region_code": "abc123",
-  "region_id": 123
+  "region_id": 987
 }
 
     
                   
@@ -45382,12 +46551,12 @@ 
    Example
    
   "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
   "input_filter": "NONE",
-  "is_required": false,
-  "is_unique": true,
+  "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]
 }
 
     
@@ -45584,17 +46753,17 @@ 
    Example
    
   "allow_remote_shopping_assistance": false,
   "custom_attributes": [AttributeValueInput],
   "date_of_birth": "abc123",
-  "dob": "xyz789",
+  "dob": "abc123",
   "email": "abc123",
-  "firstname": "xyz789",
-  "gender": 987,
+  "firstname": "abc123",
+  "gender": 123,
   "is_subscribed": true,
   "lastname": "xyz789",
   "middlename": "abc123",
   "password": "abc123",
   "prefix": "xyz789",
   "suffix": "abc123",
-  "taxvat": "abc123"
+  "taxvat": "xyz789"
 }
 
     
                   
@@ -45679,7 +46848,7 @@ 
    Example
    
                   
                   
    {
   "date": "xyz789",
-  "download_url": "xyz789",
+  "download_url": "abc123",
   "order_increment_id": "xyz789",
   "remaining_downloads": "xyz789",
   "status": "xyz789"
@@ -45900,16 +47069,16 @@ 
    Example
    
                   
                   
    {
   "date_of_birth": "xyz789",
-  "dob": "abc123",
+  "dob": "xyz789",
   "email": "abc123",
   "firstname": "xyz789",
   "gender": 123,
-  "is_subscribed": true,
-  "lastname": "abc123",
-  "middlename": "abc123",
-  "password": "xyz789",
-  "prefix": "abc123",
-  "suffix": "abc123",
+  "is_subscribed": false,
+  "lastname": "xyz789",
+  "middlename": "xyz789",
+  "password": "abc123",
+  "prefix": "xyz789",
+  "suffix": "xyz789",
   "taxvat": "xyz789"
 }
 
     
@@ -45939,6 +47108,15 @@ 
    Fields
    
                       
                     
                     
+                      
+                        
+                          applied_coupons -
+                          
+                            [AppliedCoupon]!
+                          
+                        
+                         Coupons applied to the order. 
+                      
                       
                         
                           billing_address -
@@ -45986,6 +47164,15 @@ 
    Fields
    
                         
                          A list of credit memos. 
                       
+                      
+                        
+                          email -
+                          
+                            String
+                          
+                        
+                         Order customer email. 
+                      
                       
                         
                           gift_message -
@@ -46190,6 +47377,15 @@ 
    
                         
                          The current status of the order. 
                       
+                      
+                        
+                          token -
+                          
+                            String!
+                          
+                        
+                         The token that can be used to retrieve the order using order query. 
+                      
                       
                         
                           total -
@@ -46209,22 +47405,24 @@ 
    Example
    
                   
                   
                   
    {
+  "applied_coupons": [AppliedCoupon],
   "billing_address": OrderAddress,
-  "carrier": "abc123",
+  "carrier": "xyz789",
   "comments": [SalesCommentItem],
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "credit_memos": [CreditMemo],
+  "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],
   "items": [OrderItemInterface],
   "items_eligible_for_return": [OrderItemInterface],
-  "number": "abc123",
-  "order_date": "xyz789",
+  "number": "xyz789",
+  "order_date": "abc123",
   "order_number": "xyz789",
   "payment_methods": [OrderPaymentMethod],
   "printed_card_included": false,
@@ -46233,6 +47431,7 @@ 
    Example
    
   "shipping_address": OrderAddress,
   "shipping_method": "xyz789",
   "status": "xyz789",
+  "token": "abc123",
   "total": OrderTotal
 }
 
     
@@ -46409,7 +47608,7 @@ 
    Example
    
                   
    {
   "items": [CustomerOrder],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
     
                   
@@ -46712,7 +47911,7 @@ 
    Example
    
                   
    {
   "items": [CustomerStoreCreditHistoryItem],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
     
                   
@@ -46787,10 +47986,10 @@ 
    Example
    
                   
                   
                   
    {
-  "action": "xyz789",
+  "action": "abc123",
   "actual_balance": Money,
   "balance_change": Money,
-  "date_time_changed": "abc123"
+  "date_time_changed": "xyz789"
 }
 
     
                   
@@ -47009,14 +48208,14 @@ 
    Example
    
                   
    {
   "allow_remote_shopping_assistance": true,
   "custom_attributes": [AttributeValueInput],
-  "date_of_birth": "abc123",
+  "date_of_birth": "xyz789",
   "dob": "abc123",
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "gender": 123,
   "is_subscribed": true,
-  "lastname": "abc123",
-  "middlename": "abc123",
-  "prefix": "xyz789",
+  "lastname": "xyz789",
+  "middlename": "xyz789",
+  "prefix": "abc123",
   "suffix": "xyz789",
   "taxvat": "abc123"
 }
@@ -47122,12 +48321,12 @@ 
    Example
    
                   
                   
                   
    {
-  "option_id": 123,
+  "option_id": 987,
   "product_sku": "xyz789",
   "required": false,
-  "sort_order": 987,
-  "title": "xyz789",
-  "uid": "4",
+  "sort_order": 123,
+  "title": "abc123",
+  "uid": 4,
   "value": CustomizableAreaValue
 }
 
     
@@ -47212,8 +48411,8 @@ 
    Example
    
                   
                   
                   
    {
-  "max_characters": 123,
-  "price": 987.65,
+  "max_characters": 987,
+  "price": 123.45,
   "price_type": "FIXED",
   "sku": "xyz789",
   "uid": 4
@@ -47311,10 +48510,10 @@ 
    Example
    
                   
                   
                   
    {
-  "option_id": 987,
+  "option_id": 123,
   "required": false,
-  "sort_order": 987,
-  "title": "xyz789",
+  "sort_order": 123,
+  "title": "abc123",
   "uid": "4",
   "value": [CustomizableCheckboxValue]
 }
@@ -47418,8 +48617,8 @@ 
    Example
    
                   
                   
                   
    {
-  "option_type_id": 987,
-  "price": 123.45,
+  "option_type_id": 123,
+  "price": 987.65,
   "price_type": "FIXED",
   "sku": "xyz789",
   "sort_order": 987,
@@ -47529,10 +48728,10 @@ 
    Example
    
                   
                   
    {
   "option_id": 123,
-  "product_sku": "abc123",
+  "product_sku": "xyz789",
   "required": true,
-  "sort_order": 987,
-  "title": "xyz789",
+  "sort_order": 123,
+  "title": "abc123",
   "uid": "4",
   "value": CustomizableDateValue
 }
@@ -47673,9 +48872,9 @@ 
    Example
    
                   
                   
                   
    {
-  "price": 987.65,
+  "price": 123.45,
   "price_type": "FIXED",
-  "sku": "abc123",
+  "sku": "xyz789",
   "type": "DATE",
   "uid": "4"
 }
@@ -47776,7 +48975,7 @@ 
    Example
    
   "required": true,
   "sort_order": 987,
   "title": "xyz789",
-  "uid": "4",
+  "uid": 4,
   "value": [CustomizableDropDownValue]
 }
 
     
@@ -47879,13 +49078,13 @@ 
    Example
    
                   
                   
                   
    {
-  "option_type_id": 987,
+  "option_type_id": 123,
   "price": 123.45,
   "price_type": "FIXED",
   "sku": "xyz789",
-  "sort_order": 123,
-  "title": "abc123",
-  "uid": "4"
+  "sort_order": 987,
+  "title": "xyz789",
+  "uid": 4
 }
 
     
                   
@@ -47991,9 +49190,9 @@ 
    Example
    
                   
    {
   "option_id": 987,
   "product_sku": "xyz789",
-  "required": false,
-  "sort_order": 987,
-  "title": "abc123",
+  "required": true,
+  "sort_order": 123,
+  "title": "xyz789",
   "uid": 4,
   "value": CustomizableFieldValue
 }
@@ -48079,11 +49278,11 @@ 
    Example
    
                   
                   
                   
    {
-  "max_characters": 987,
+  "max_characters": 123,
   "price": 987.65,
   "price_type": "FIXED",
   "sku": "abc123",
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -48187,11 +49386,11 @@ 
    Example
    
                   
                   
                   
    {
-  "option_id": 123,
+  "option_id": 987,
   "product_sku": "abc123",
   "required": true,
   "sort_order": 987,
-  "title": "xyz789",
+  "title": "abc123",
   "uid": "4",
   "value": CustomizableFileValue
 }
@@ -48295,9 +49494,9 @@ 
    Example
    
                   
                   
                   
    {
-  "file_extension": "abc123",
-  "image_size_x": 123,
-  "image_size_y": 987,
+  "file_extension": "xyz789",
+  "image_size_x": 987,
+  "image_size_y": 123,
   "price": 123.45,
   "price_type": "FIXED",
   "sku": "abc123",
@@ -48396,11 +49595,11 @@ 
    Example
    
                   
                   
                   
    {
-  "option_id": 987,
+  "option_id": 123,
   "required": false,
-  "sort_order": 123,
+  "sort_order": 987,
   "title": "abc123",
-  "uid": "4",
+  "uid": 4,
   "value": [CustomizableMultipleValue]
 }
 
     
@@ -48507,9 +49706,9 @@ 
    Example
    
   "price": 987.65,
   "price_type": "FIXED",
   "sku": "xyz789",
-  "sort_order": 987,
+  "sort_order": 123,
   "title": "abc123",
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -48582,8 +49781,8 @@ 
    Example
    
                   
                   
    {
   "id": 987,
-  "uid": "4",
-  "value_string": "xyz789"
+  "uid": 4,
+  "value_string": "abc123"
 }
 
     
                   
@@ -48741,7 +49940,7 @@ 
    Example
    
   "required": false,
   "sort_order": 123,
   "title": "xyz789",
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -48936,9 +50135,9 @@ 
    Example
    
                   
                   
                   
    {
-  "option_id": 987,
-  "required": false,
-  "sort_order": 987,
+  "option_id": 123,
+  "required": true,
+  "sort_order": 123,
   "title": "xyz789",
   "uid": 4,
   "value": [CustomizableRadioValue]
@@ -49043,12 +50242,12 @@ 
    Example
    
                   
                   
                   
    {
-  "option_type_id": 123,
+  "option_type_id": 987,
   "price": 123.45,
   "price_type": "FIXED",
   "sku": "xyz789",
-  "sort_order": 123,
-  "title": "xyz789",
+  "sort_order": 987,
+  "title": "abc123",
   "uid": "4"
 }
 
     
@@ -49344,7 +50543,7 @@ 
    Example
    
                   
                   
    {
   "errors": [NegotiableQuoteInvalidStateError],
-  "quote_uid": "4"
+  "quote_uid": 4
 }
 
     
                   
@@ -49435,7 +50634,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"quote_uids": [4]}
+                  
    {"quote_uids": ["4"]}
 
     
                   
                 
@@ -49663,7 +50862,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"message": "xyz789", "type": "UNDEFINED"}
+                  
    {"message": "abc123", "type": "UNDEFINED"}
 
     
                   
                 
@@ -49958,7 +51157,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"status": false, "wishlists": [Wishlist]}
+                  
    {"status": true, "wishlists": [Wishlist]}
 
     
                   
                 
@@ -50006,12 +51205,12 @@ 
    Fields
    
                       
                       
                         
-                          is_discounting_locked -
+                          coupon -
                           
-                            Boolean
+                            AppliedCoupon
                           
                         
-                         Is quote discounting locked for line item. 
+                         The coupon related to the discount. 
                       
                       
                         
@@ -50052,9 +51251,9 @@ 
    Example
    
                   
    {
   "amount": Money,
   "applied_to": "ITEM",
-  "is_discounting_locked": false,
-  "label": "abc123",
-  "type": "abc123",
+  "coupon": AppliedCoupon,
+  "label": "xyz789",
+  "type": "xyz789",
   "value": 987.65
 }
 
     
@@ -50216,16 +51415,16 @@ 
    Example
    
   "customizable_options": [SelectedCustomizableOption],
   "discount": [Discount],
   "errors": [CartItemError],
-  "id": "abc123",
-  "is_available": false,
+  "id": "xyz789",
+  "is_available": true,
   "links": [DownloadableProductLinks],
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "samples": [DownloadableProductSamples],
-  "uid": "4"
+  "uid": 4
 }
 
     
                   
@@ -50338,7 +51537,7 @@ 
    Example
    
                   
    {
   "discounts": [Discount],
   "downloadable_links": [DownloadableItemsLinks],
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
@@ -50505,12 +51704,12 @@ 
    Example
    
                   
    {
   "discounts": [Discount],
   "downloadable_links": [DownloadableItemsLinks],
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_invoiced": 123.45
+  "product_sku": "xyz789",
+  "quantity_invoiced": 987.65
 }
 
     
                   
@@ -50577,7 +51776,7 @@ 
    Example
    
                   
                   
    {
   "sort_order": 123,
-  "title": "xyz789",
+  "title": "abc123",
   "uid": "4"
 }
 
     
@@ -50670,6 +51869,15 @@ 
    Fields
    
                         
                          The unique ID for an OrderItemInterface object. 
                       
+                      
+                        
+                          product -
+                          
+                            ProductInterface
+                          
+                        
+                         The ProductInterface object, which contains details about the base product 
+                      
                       
                         
                           product_name -
@@ -50803,18 +52011,19 @@ 
    Example
    
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": 4,
+  "id": "4",
+  "product": ProductInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "xyz789",
-  "product_type": "abc123",
+  "product_type": "xyz789",
   "product_url_key": "abc123",
   "quantity_canceled": 987.65,
   "quantity_invoiced": 123.45,
   "quantity_ordered": 123.45,
   "quantity_refunded": 123.45,
-  "quantity_returned": 987.65,
-  "quantity_shipped": 987.65,
+  "quantity_returned": 123.45,
+  "quantity_shipped": 123.45,
   "selected_options": [OrderItemOption],
   "status": "abc123"
 }
@@ -51708,14 +52917,14 @@ 
    Example
    
                   
                   
    {
   "activity": "xyz789",
-  "attribute_set_id": 123,
-  "canonical_url": "abc123",
+  "attribute_set_id": 987,
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "category_gear": "xyz789",
-  "climate": "abc123",
+  "category_gear": "abc123",
+  "climate": "xyz789",
   "collar": "xyz789",
-  "color": 987,
-  "country_of_manufacture": "xyz789",
+  "color": 123,
+  "country_of_manufacture": "abc123",
   "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
@@ -51726,72 +52935,72 @@ 
    Example
    
   "downloadable_product_samples": [
     DownloadableProductSamples
   ],
-  "eco_collection": 987,
-  "erin_recommends": 987,
+  "eco_collection": 123,
+  "erin_recommends": 123,
   "features_bags": "abc123",
   "format": 987,
   "gender": "abc123",
   "gift_message_available": "xyz789",
-  "id": 123,
+  "id": 987,
   "image": ProductImage,
-  "is_returnable": "abc123",
-  "links_purchased_separately": 987,
+  "is_returnable": "xyz789",
+  "links_purchased_separately": 123,
   "links_title": "xyz789",
-  "manufacturer": 987,
-  "material": "xyz789",
+  "manufacturer": 123,
+  "material": "abc123",
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "xyz789",
+  "meta_description": "abc123",
   "meta_keyword": "abc123",
-  "meta_title": "abc123",
-  "name": "xyz789",
-  "new": 987,
+  "meta_title": "xyz789",
+  "name": "abc123",
+  "new": 123,
   "new_from_date": "xyz789",
-  "new_to_date": "xyz789",
+  "new_to_date": "abc123",
   "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
   "options_container": "xyz789",
   "pattern": "abc123",
-  "performance_fabric": 123,
+  "performance_fabric": 987,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 123,
-  "rating_summary": 987.65,
+  "purpose": 987,
+  "rating_summary": 123.45,
   "redirect_code": 123,
   "related_products": [ProductInterface],
   "relative_url": "abc123",
-  "review_count": 123,
+  "review_count": 987,
   "reviews": ProductReviews,
   "sale": 123,
   "short_description": ComplexTextValue,
-  "size": 123,
-  "sku": "xyz789",
+  "size": 987,
+  "sku": "abc123",
   "sleeve": "xyz789",
   "small_image": ProductImage,
-  "special_from_date": "xyz789",
+  "special_from_date": "abc123",
   "special_price": 987.65,
   "special_to_date": "xyz789",
   "staged": false,
   "stock_status": "IN_STOCK",
-  "strap_bags": "xyz789",
+  "strap_bags": "abc123",
   "style_bags": "abc123",
   "style_bottom": "xyz789",
-  "style_general": "xyz789",
-  "swatch_image": "abc123",
+  "style_general": "abc123",
+  "swatch_image": "xyz789",
   "thumbnail": ProductImage,
   "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "xyz789",
-  "uid": 4,
+  "type_id": "abc123",
+  "uid": "4",
   "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
-  "url_key": "abc123",
+  "url_key": "xyz789",
   "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "xyz789",
+  "url_suffix": "abc123",
   "websites": [Website]
 }
 
     
@@ -52018,15 +53227,15 @@ 
    Example
    
                   
                   
                   
    {
-  "id": 987,
-  "is_shareable": false,
+  "id": 123,
+  "is_shareable": true,
   "link_type": "FILE",
   "number_of_downloads": 987,
-  "price": 987.65,
-  "sample_file": "xyz789",
+  "price": 123.45,
+  "sample_file": "abc123",
   "sample_type": "FILE",
-  "sample_url": "abc123",
-  "sort_order": 987,
+  "sample_url": "xyz789",
+  "sort_order": 123,
   "title": "xyz789",
   "uid": "4"
 }
@@ -52178,9 +53387,9 @@ 
    Example
    
   "id": 123,
   "sample_file": "xyz789",
   "sample_type": "FILE",
-  "sample_url": "xyz789",
-  "sort_order": 987,
-  "title": "xyz789"
+  "sample_url": "abc123",
+  "sort_order": 123,
+  "title": "abc123"
 }
 
     
                   
@@ -52715,7 +53924,11 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"dynamic_block_uids": [4], "locations": ["CONTENT"], "type": "SPECIFIED"}
+                  
    {
+  "dynamic_block_uids": ["4"],
+  "locations": ["CONTENT"],
+  "type": "SPECIFIED"
+}
 
     
                   
                 
@@ -52775,7 +53988,7 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_code": "xyz789",
+  "attribute_code": "abc123",
   "value": "xyz789"
 }
 
     
@@ -52836,7 +54049,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"uid": 4, "value": "xyz789"}
+                  
    {"uid": 4, "value": "abc123"}
 
     
                   
                 
@@ -52934,9 +54147,9 @@ 
    Example
    
                   
    {
   "canonical_url": "abc123",
   "entity_uid": 4,
-  "id": 987,
+  "id": 123,
   "redirectCode": 987,
-  "relative_url": "xyz789",
+  "relative_url": "abc123",
   "type": "CMS_PAGE"
 }
 
     
@@ -53013,7 +54226,197 @@ 
    Possible Types
    
                   
    Example
    
                   
                   
-                  
    {"message": "xyz789"}
+                  
    {"message": "abc123"}
+
     
+                  
+                
+              
+            
+          
+          
    
+            
    
+              Types
+            
    
+            
    EstimateAddressInput
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Contains details about an address.
    
+                
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                    
+                  
    Input FieldDescription
    
+                          country_code -
+                          
+                            CountryCodeEnum!
+                          
+                        
+                          
    The two-letter code representing the customer's country.
    
+                        
    
+                          postcode -
+                          
+                            String
+                          
+                        
+                          
    The customer's ZIP or postal code.
    
+                        
    
+                          region -
+                          
+                            CustomerAddressRegionInput
+                          
+                        
+                          
    An object containing the region name, region code, and region ID.
    
+                        
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {
+  "country_code": "AF",
+  "postcode": "xyz789",
+  "region": CustomerAddressRegionInput
+}
+
     
+                  
+                
    
+              
    
+            
    
+          
    
+          
    
+            
    
+              Types
+            
    
+            
    EstimateTotalsInput
    
+            
    
+              
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                    
+                  
    Input FieldDescription
    
+                          address -
+                          
+                            EstimateAddressInput!
+                          
+                        
+                          
    Customer's address to estimate totals.
    
+                        
    
+                          cart_id -
+                          
+                            String!
+                          
+                        
+                          
    The unique ID of the cart to query.
    
+                        
    
+                          shipping_method -
+                          
+                            ShippingMethodInput
+                          
+                        
+                          
    Selected shipping method to estimate totals.
    
+                        
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {
+  "address": EstimateAddressInput,
+  "cart_id": "abc123",
+  "shipping_method": ShippingMethodInput
+}
+
     
+                  
+                
    
+              
    
+            
    
+          
    
+          
    
+            
    
+              Types
+            
    
+            
    EstimateTotalsOutput
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Estimate totals output.
    
+                
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                    
+                  
    Field NameDescription
    
+                          cart -
+                          
+                            Cart
+                          
+                         Cart after totals estimation 
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {"cart": Cart}
 
     
                   
                 
    
@@ -53068,7 +54471,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"currency_to": "abc123", "rate": 123.45}
+                  
    {"currency_to": "xyz789", "rate": 987.65}
 
     
                   
                 
    
@@ -53128,8 +54531,8 @@ 
    Example
    
                   
                   
                   
    {
-  "eq": "xyz789",
-  "in": ["xyz789"]
+  "eq": "abc123",
+  "in": ["abc123"]
 }
 
     
                   
@@ -53234,7 +54637,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"match": "abc123", "match_type": "FULL"}
+                  
    {"match": "xyz789", "match_type": "FULL"}
 
     
                   
                 
    
@@ -53294,8 +54697,8 @@ 
    Example
    
                   
                   
                   
    {
-  "from": "abc123",
-  "to": "xyz789"
+  "from": "xyz789",
+  "to": "abc123"
 }
 
     
                   
@@ -53367,7 +54770,7 @@ 
    Example
    
                   
                   
                   
    {
-  "eq": "xyz789",
+  "eq": "abc123",
   "in": ["xyz789"],
   "match": "abc123"
 }
@@ -53571,21 +54974,21 @@ 
    Example
    
                   
                   
                   
    {
-  "eq": "abc123",
-  "finset": ["xyz789"],
-  "from": "xyz789",
+  "eq": "xyz789",
+  "finset": ["abc123"],
+  "from": "abc123",
   "gt": "abc123",
-  "gteq": "abc123",
-  "in": ["abc123"],
-  "like": "abc123",
+  "gteq": "xyz789",
+  "in": ["xyz789"],
+  "like": "xyz789",
   "lt": "xyz789",
-  "lteq": "xyz789",
-  "moreq": "abc123",
-  "neq": "xyz789",
-  "nin": ["abc123"],
-  "notnull": "xyz789",
-  "null": "abc123",
-  "to": "abc123"
+  "lteq": "abc123",
+  "moreq": "xyz789",
+  "neq": "abc123",
+  "nin": ["xyz789"],
+  "notnull": "abc123",
+  "null": "xyz789",
+  "to": "xyz789"
 }
 
     
                   
@@ -53942,8 +55345,8 @@ 
    Example
    
                   
                   
    {
   "balance": Money,
-  "code": "xyz789",
-  "expiration_date": "abc123"
+  "code": "abc123",
+  "expiration_date": "xyz789"
 }
 
     
                   
@@ -53992,7 +55395,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"gift_card_code": "abc123"}
+                  
    {"gift_card_code": "xyz789"}
 
     
                   
                 
@@ -54087,11 +55490,11 @@ 
    Example
    
                   
                   
    {
   "attribute_id": 987,
-  "uid": "4",
+  "uid": 4,
   "value": 987.65,
   "value_id": 123,
   "website_id": 987,
-  "website_value": 123.45
+  "website_value": 987.65
 }
 
     
                   
@@ -54290,18 +55693,18 @@ 
    Example
    
   "discount": [Discount],
   "errors": [CartItemError],
   "id": "xyz789",
-  "is_available": true,
-  "message": "abc123",
+  "is_available": false,
+  "message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 987.65,
-  "recipient_email": "abc123",
-  "recipient_name": "xyz789",
+  "quantity": 123.45,
+  "recipient_email": "xyz789",
+  "recipient_name": "abc123",
   "sender_email": "xyz789",
-  "sender_name": "xyz789",
-  "uid": "4"
+  "sender_name": "abc123",
+  "uid": 4
 }
 
     
                   
@@ -54410,12 +55813,12 @@ 
    Example
    
                   
    {
   "discounts": [Discount],
   "gift_card": GiftCardItem,
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "quantity_refunded": 987.65
+  "quantity_refunded": 123.45
 }
 
     
                   
@@ -54524,12 +55927,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
 }
 
     
                   
@@ -54613,11 +56016,11 @@ 
    Example
    
                   
                   
                   
    {
-  "message": "abc123",
+  "message": "xyz789",
   "recipient_email": "abc123",
   "recipient_name": "abc123",
   "sender_email": "abc123",
-  "sender_name": "xyz789"
+  "sender_name": "abc123"
 }
 
     
                   
@@ -54722,10 +56125,10 @@ 
    Example
    
   "amount": Money,
   "custom_giftcard_amount": Money,
   "message": "abc123",
-  "recipient_email": "abc123",
+  "recipient_email": "xyz789",
   "recipient_name": "xyz789",
   "sender_email": "abc123",
-  "sender_name": "abc123"
+  "sender_name": "xyz789"
 }
 
     
                   
@@ -54813,6 +56216,15 @@ 
    Fields
    
                         
                          The unique ID for an OrderItemInterface object. 
                       
+                      
+                        
+                          product -
+                          
+                            ProductInterface
+                          
+                        
+                         The ProductInterface object, which contains details about the base product 
+                      
                       
                         
                           product_name -
@@ -54941,19 +56353,20 @@ 
    Example
    
                   
                   
    {
   "discounts": [Discount],
-  "eligible_for_return": false,
+  "eligible_for_return": true,
   "entered_options": [OrderItemOption],
   "gift_card": GiftCardItem,
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
   "id": "4",
+  "product": ProductInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "product_type": "abc123",
+  "product_sku": "xyz789",
+  "product_type": "xyz789",
   "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_returned": 987.65,
@@ -55913,93 +57326,93 @@ 
    Example
    
                   
                   
                   
    {
-  "activity": "abc123",
+  "activity": "xyz789",
   "allow_message": true,
-  "allow_open_amount": false,
+  "allow_open_amount": true,
   "attribute_set_id": 123,
-  "canonical_url": "xyz789",
+  "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
+  "category_gear": "xyz789",
   "climate": "xyz789",
-  "collar": "abc123",
-  "color": 987,
+  "collar": "xyz789",
+  "color": 123,
   "country_of_manufacture": "xyz789",
   "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 987,
+  "eco_collection": 123,
   "erin_recommends": 987,
   "features_bags": "abc123",
   "format": 987,
   "gender": "xyz789",
   "gift_card_options": [CustomizableOptionInterface],
-  "gift_message_available": "xyz789",
+  "gift_message_available": "abc123",
   "giftcard_amounts": [GiftCardAmounts],
   "giftcard_type": "VIRTUAL",
-  "id": 987,
+  "id": 123,
   "image": ProductImage,
-  "is_redeemable": false,
+  "is_redeemable": true,
   "is_returnable": "abc123",
   "lifetime": 123,
   "manufacturer": 123,
-  "material": "xyz789",
+  "material": "abc123",
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
   "message_max_length": 123,
-  "meta_description": "xyz789",
-  "meta_keyword": "abc123",
+  "meta_description": "abc123",
+  "meta_keyword": "xyz789",
   "meta_title": "xyz789",
-  "name": "abc123",
-  "new": 123,
-  "new_from_date": "xyz789",
-  "new_to_date": "abc123",
-  "only_x_left_in_stock": 987.65,
+  "name": "xyz789",
+  "new": 987,
+  "new_from_date": "abc123",
+  "new_to_date": "xyz789",
+  "only_x_left_in_stock": 123.45,
   "open_amount_max": 123.45,
   "open_amount_min": 123.45,
   "options": [CustomizableOptionInterface],
   "options_container": "xyz789",
   "pattern": "xyz789",
-  "performance_fabric": 123,
+  "performance_fabric": 987,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
   "purpose": 123,
-  "rating_summary": 123.45,
+  "rating_summary": 987.65,
   "redirect_code": 987,
   "related_products": [ProductInterface],
-  "relative_url": "abc123",
-  "review_count": 123,
+  "relative_url": "xyz789",
+  "review_count": 987,
   "reviews": ProductReviews,
   "sale": 987,
   "short_description": ComplexTextValue,
   "size": 123,
   "sku": "abc123",
-  "sleeve": "abc123",
+  "sleeve": "xyz789",
   "small_image": ProductImage,
   "special_from_date": "abc123",
-  "special_price": 123.45,
-  "special_to_date": "abc123",
+  "special_price": 987.65,
+  "special_to_date": "xyz789",
   "staged": false,
   "stock_status": "IN_STOCK",
   "strap_bags": "abc123",
-  "style_bags": "xyz789",
-  "style_bottom": "abc123",
+  "style_bags": "abc123",
+  "style_bottom": "xyz789",
   "style_general": "xyz789",
-  "swatch_image": "xyz789",
+  "swatch_image": "abc123",
   "thumbnail": ProductImage,
-  "tier_price": 123.45,
+  "tier_price": 987.65,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "xyz789",
+  "type_id": "abc123",
   "uid": 4,
-  "updated_at": "abc123",
+  "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
-  "url_key": "xyz789",
-  "url_path": "xyz789",
+  "url_key": "abc123",
+  "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "xyz789",
+  "url_suffix": "abc123",
   "websites": [Website],
   "weight": 123.45
 }
@@ -56088,7 +57501,7 @@ 
    Example
    
   "customizable_options": [SelectedCustomizableOption],
   "gift_card_options": GiftCardOptions,
   "product": ProductInterface,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "uid": 4
 }
 
     
@@ -56192,8 +57605,8 @@ 
    Example
    
   "order_item": OrderItemInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_shipped": 987.65
+  "product_sku": "xyz789",
+  "quantity_shipped": 123.45
 }
 
     
                   
@@ -56350,13 +57763,13 @@ 
    Example
    
                   
                   
                   
    {
-  "added_at": "abc123",
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
+  "description": "abc123",
   "gift_card_options": GiftCardOptions,
   "id": 4,
   "product": ProductInterface,
-  "quantity": 987.65
+  "quantity": 123.45
 }
 
     
                   
@@ -56423,8 +57836,8 @@ 
    Example
    
                   
                   
    {
   "from": "abc123",
-  "message": "abc123",
-  "to": "xyz789"
+  "message": "xyz789",
+  "to": "abc123"
 }
 
     
                   
@@ -56497,8 +57910,8 @@ 
    Example
    
                   
                   
    {
   "from": "xyz789",
-  "message": "abc123",
-  "to": "xyz789"
+  "message": "xyz789",
+  "to": "abc123"
 }
 
     
                   
@@ -56718,13 +58131,13 @@ 
    Example
    
   "event_name": "xyz789",
   "items": [GiftRegistryItemInterface],
   "message": "abc123",
-  "owner_name": "abc123",
+  "owner_name": "xyz789",
   "privacy_settings": "PRIVATE",
   "registrants": [GiftRegistryRegistrant],
   "shipping_address": CustomerAddress,
   "status": "ACTIVE",
   "type": GiftRegistryType,
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -56795,9 +58208,9 @@ 
    Example
    
                   
                   
                   
    {
-  "code": 4,
+  "code": "4",
   "group": "EVENT_INFORMATION",
-  "label": "xyz789",
+  "label": "abc123",
   "value": "abc123"
 }
 
     
@@ -56931,7 +58344,10 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"code": 4, "value": "abc123"}
+                  
    {
+  "code": "4",
+  "value": "xyz789"
+}
 
     
                   
                 
@@ -57019,8 +58435,8 @@ 
    Example
    
                   
                   
    {
   "code": 4,
-  "label": "xyz789",
-  "value": "xyz789"
+  "label": "abc123",
+  "value": "abc123"
 }
 
     
                   
@@ -57109,12 +58525,12 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_group": "abc123",
-  "code": 4,
+  "attribute_group": "xyz789",
+  "code": "4",
   "input_type": "xyz789",
   "is_required": true,
   "label": "xyz789",
-  "sort_order": 987
+  "sort_order": 123
 }
 
     
                   
@@ -57222,12 +58638,12 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_group": "abc123",
-  "code": "4",
-  "input_type": "abc123",
+  "attribute_group": "xyz789",
+  "code": 4,
+  "input_type": "xyz789",
   "is_required": false,
   "label": "xyz789",
-  "sort_order": 123
+  "sort_order": 987
 }
 
     
                   
@@ -57316,12 +58732,12 @@ 
    Example
    
                   
                   
                   
    {
-  "created_at": "xyz789",
-  "note": "abc123",
+  "created_at": "abc123",
+  "note": "xyz789",
   "product": ProductInterface,
   "quantity": 987.65,
-  "quantity_fulfilled": 987.65,
-  "uid": "4"
+  "quantity_fulfilled": 123.45,
+  "uid": 4
 }
 
     
                   
@@ -57430,11 +58846,11 @@ 
    Example
    
                   
                   
    {
   "created_at": "xyz789",
-  "note": "abc123",
+  "note": "xyz789",
   "product": ProductInterface,
   "quantity": 987.65,
   "quantity_fulfilled": 123.45,
-  "uid": "4"
+  "uid": 4
 }
 
     
                   
@@ -57598,8 +59014,8 @@ 
    Example
    
   "code": "OUT_OF_STOCK",
   "gift_registry_item_uid": 4,
   "gift_registry_uid": "4",
-  "message": "abc123",
-  "product_uid": 4
+  "message": "xyz789",
+  "product_uid": "4"
 }
 
     
                   
@@ -57856,9 +59272,9 @@ 
    Example
    
     GiftRegistryRegistrantDynamicAttribute
   ],
   "email": "abc123",
-  "firstname": "abc123",
-  "lastname": "xyz789",
-  "uid": "4"
+  "firstname": "xyz789",
+  "lastname": "abc123",
+  "uid": 4
 }
 
     
                   
@@ -57920,8 +59336,8 @@ 
    Example
    
                   
                   
                   
    {
-  "code": 4,
-  "label": "xyz789",
+  "code": "4",
+  "label": "abc123",
   "value": "abc123"
 }
 
     
@@ -58015,11 +59431,11 @@ 
    Example
    
                   
                   
                   
    {
-  "event_date": "xyz789",
-  "event_title": "xyz789",
-  "gift_registry_uid": 4,
-  "location": "xyz789",
-  "name": "abc123",
+  "event_date": "abc123",
+  "event_title": "abc123",
+  "gift_registry_uid": "4",
+  "location": "abc123",
+  "name": "xyz789",
   "type": "abc123"
 }
 
     
@@ -58198,7 +59614,7 @@ 
    Example
    
     GiftRegistryDynamicAttributeMetadataInterface
   ],
   "label": "abc123",
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -58285,10 +59701,10 @@ 
    Example
    
                   
                   
    {
   "design": "xyz789",
-  "id": 4,
+  "id": "4",
   "image": GiftWrappingImage,
   "price": Money,
-  "uid": "4"
+  "uid": 4
 }
 
     
                   
@@ -58345,8 +59761,8 @@ 
    Example
    
                   
                   
                   
    {
-  "label": "abc123",
-  "url": "abc123"
+  "label": "xyz789",
+  "url": "xyz789"
 }
 
     
                   
@@ -59215,37 +60631,37 @@ 
    Example
    
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
   "category_gear": "abc123",
-  "climate": "abc123",
-  "collar": "xyz789",
-  "color": 123,
+  "climate": "xyz789",
+  "collar": "abc123",
+  "color": 987,
   "country_of_manufacture": "abc123",
   "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 987,
+  "eco_collection": 123,
   "erin_recommends": 123,
   "features_bags": "xyz789",
-  "format": 987,
-  "gender": "abc123",
-  "gift_message_available": "abc123",
-  "id": 987,
+  "format": 123,
+  "gender": "xyz789",
+  "gift_message_available": "xyz789",
+  "id": 123,
   "image": ProductImage,
-  "is_returnable": "xyz789",
+  "is_returnable": "abc123",
   "items": [GroupedProductItem],
   "manufacturer": 123,
-  "material": "xyz789",
+  "material": "abc123",
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
   "meta_description": "abc123",
-  "meta_keyword": "xyz789",
-  "meta_title": "xyz789",
-  "name": "abc123",
+  "meta_keyword": "abc123",
+  "meta_title": "abc123",
+  "name": "xyz789",
   "new": 123,
   "new_from_date": "xyz789",
   "new_to_date": "abc123",
-  "only_x_left_in_stock": 123.45,
-  "options_container": "xyz789",
+  "only_x_left_in_stock": 987.65,
+  "options_container": "abc123",
   "pattern": "xyz789",
   "performance_fabric": 123,
   "price": ProductPrices,
@@ -59254,41 +60670,41 @@ 
    Example
    
   "product_links": [ProductLinksInterface],
   "purpose": 123,
   "rating_summary": 987.65,
-  "redirect_code": 987,
+  "redirect_code": 123,
   "related_products": [ProductInterface],
   "relative_url": "xyz789",
-  "review_count": 987,
+  "review_count": 123,
   "reviews": ProductReviews,
   "sale": 123,
   "short_description": ComplexTextValue,
   "size": 123,
-  "sku": "xyz789",
-  "sleeve": "xyz789",
+  "sku": "abc123",
+  "sleeve": "abc123",
   "small_image": ProductImage,
   "special_from_date": "abc123",
   "special_price": 987.65,
-  "special_to_date": "abc123",
+  "special_to_date": "xyz789",
   "staged": true,
   "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
+  "strap_bags": "xyz789",
   "style_bags": "abc123",
-  "style_bottom": "xyz789",
-  "style_general": "abc123",
+  "style_bottom": "abc123",
+  "style_general": "xyz789",
   "swatch_image": "xyz789",
   "thumbnail": ProductImage,
-  "tier_price": 987.65,
+  "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "xyz789",
+  "type_id": "abc123",
   "uid": "4",
   "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
   "url_key": "abc123",
   "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "xyz789",
+  "url_suffix": "abc123",
   "websites": [Website],
-  "weight": 123.45
+  "weight": 987.65
 }
 
     
                   
@@ -59356,7 +60772,7 @@ 
    Example
    
                   
    {
   "position": 123,
   "product": ProductInterface,
-  "qty": 987.65
+  "qty": 123.45
 }
 
     
                   
@@ -59451,10 +60867,10 @@ 
    Example
    
                   
    {
   "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
-  "id": "4",
+  "description": "xyz789",
+  "id": 4,
   "product": ProductInterface,
-  "quantity": 123.45
+  "quantity": 987.65
 }
 
     
                   
@@ -59590,15 +61006,15 @@ 
    Example
    
                   
    {
   "cc_vault_code": "xyz789",
   "code": "xyz789",
-  "is_vault_enabled": false,
-  "is_visible": false,
+  "is_vault_enabled": true,
+  "is_visible": true,
   "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": true,
-  "title": "xyz789"
+  "three_ds": false,
+  "title": "abc123"
 }
 
     
                   
@@ -59736,14 +61152,14 @@ 
    Example
    
                   
                   
                   
    {
-  "cardBin": "abc123",
+  "cardBin": "xyz789",
   "cardExpiryMonth": "xyz789",
   "cardExpiryYear": "abc123",
   "cardLast4": "abc123",
   "holderName": "abc123",
-  "is_active_payment_token_enabler": false,
-  "payment_source": "abc123",
-  "payments_order_id": "xyz789",
+  "is_active_payment_token_enabler": true,
+  "payment_source": "xyz789",
+  "payments_order_id": "abc123",
   "paypal_order_id": "xyz789"
 }
 
     
@@ -59808,8 +61224,8 @@ 
    Example
    
                   
                   
                   
    {
-  "cancel_url": "abc123",
-  "return_url": "xyz789"
+  "cancel_url": "xyz789",
+  "return_url": "abc123"
 }
 
     
                   
@@ -59856,7 +61272,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"secure_form_url": "abc123"}
+                  
    {"secure_form_url": "xyz789"}
 
     
                   
                 
@@ -59961,7 +61377,7 @@ 
    Example
    
                   
                   
    {
   "name": "abc123",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
     
                   
@@ -59986,7 +61402,7 @@ 
    Description
    
                   
    Example
    
                   
                   
-                  
    4
+                  
    "4"
 
     
                   
                 
@@ -60039,7 +61455,7 @@ 
    Example
    
                   
                   
    {
   "thumbnail": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
     
                   
@@ -60263,7 +61679,7 @@ 
    Example
    
   "comments": [SalesCommentItem],
   "id": 4,
   "items": [InvoiceItemInterface],
-  "number": "abc123",
+  "number": "xyz789",
   "total": InvoiceTotal
 }
 
     
@@ -60365,9 +61781,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": 987.65
 }
 
     
@@ -60513,10 +61929,10 @@ 
    Example
    
   "discounts": [Discount],
   "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
 }
 
     
                   
@@ -60681,7 +62097,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"is_email_available": true}
+                  
    {"is_email_available": false}
 
     
                   
                 
@@ -60727,7 +62143,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"is_email_available": false}
+                  
    {"is_email_available": true}
 
     
                   
                 
@@ -60819,7 +62235,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"is_email_available": true}
+                  
    {"is_email_available": false}
 
     
                   
                 
@@ -60959,7 +62375,7 @@ 
    Example
    
                   
    {
   "created_at": "abc123",
   "creator_id": 987,
-  "creator_type": 123,
+  "creator_type": 987,
   "negotiable_quote_item_uid": "4",
   "note": "abc123",
   "note_uid": "4"
@@ -61040,8 +62456,8 @@ 
    Example
    
                   
                   
    {
   "id": "4",
-  "label": "xyz789",
-  "uid": 4,
+  "label": "abc123",
+  "uid": "4",
   "values": [ItemSelectedBundleOptionValue]
 }
 
     
@@ -61139,10 +62555,10 @@ 
    Example
    
                   
    {
   "id": "4",
   "price": Money,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sku": "xyz789",
-  "quantity": 987.65,
-  "uid": 4
+  "quantity": 123.45,
+  "uid": "4"
 }
 
     
                   
@@ -61199,8 +62615,8 @@ 
    Example
    
                   
                   
                   
    {
-  "name": "xyz789",
-  "value": "abc123"
+  "name": "abc123",
+  "value": "xyz789"
 }
 
     
                   
@@ -61285,7 +62701,7 @@ 
    Example
    
                   
    {
   "filter_items": [LayerFilterItemInterface],
   "filter_items_count": 987,
-  "name": "abc123",
+  "name": "xyz789",
   "request_var": "xyz789"
 }
 
     
@@ -61354,7 +62770,7 @@ 
    Example
    
                   
                   
                   
    {
-  "items_count": 123,
+  "items_count": 987,
   "label": "xyz789",
   "value_string": "abc123"
 }
@@ -61450,8 +62866,8 @@ 
    Example
    
                   
                   
                   
    {
-  "items_count": 123,
-  "label": "abc123",
+  "items_count": 987,
+  "label": "xyz789",
   "value_string": "abc123"
 }
 
     
@@ -61524,9 +62940,9 @@ 
    Example
    
                   
                   
                   
    {
-  "note": "xyz789",
-  "quote_item_uid": "4",
-  "quote_uid": "4"
+  "note": "abc123",
+  "quote_item_uid": 4,
+  "quote_uid": 4
 }
 
     
                   
@@ -61658,14 +63074,14 @@ 
    Example
    
                   
                   
    {
   "content": ProductMediaGalleryEntriesContent,
-  "disabled": true,
+  "disabled": false,
   "file": "abc123",
-  "id": 123,
+  "id": 987,
   "label": "xyz789",
   "media_type": "xyz789",
-  "position": 123,
+  "position": 987,
   "types": ["abc123"],
-  "uid": "4",
+  "uid": 4,
   "video_content": ProductMediaGalleryEntriesVideoContent
 }
 
     
@@ -61768,8 +63184,8 @@ 
    Example
    
                   
                   
    {
   "disabled": false,
-  "label": "abc123",
-  "position": 987,
+  "label": "xyz789",
+  "position": 123,
   "url": "xyz789"
 }
 
     
@@ -61865,7 +63281,7 @@ 
    Example
    
                   
                   
                   
    {
-  "layout": "abc123",
+  "layout": "xyz789",
   "logo": MessageStyleLogo
 }
 
     
@@ -62038,7 +63454,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"requisitionListItemUids": [4]}
+                  
    {"requisitionListItemUids": ["4"]}
 
     
                   
                 
@@ -62360,7 +63776,7 @@ 
    Example
    
   "buyer": NegotiableQuoteUser,
   "comments": [NegotiableQuoteComment],
   "created_at": "xyz789",
-  "email": "xyz789",
+  "email": "abc123",
   "history": [NegotiableQuoteHistoryEntry],
   "is_virtual": true,
   "items": [CartItemInterface],
@@ -62371,7 +63787,7 @@ 
    Example
    
   "status": "SUBMITTED",
   "total_quantity": 987.65,
   "uid": "4",
-  "updated_at": "xyz789"
+  "updated_at": "abc123"
 }
 
     
                   
@@ -62589,16 +64005,16 @@ 
    Example
    
                   
                   
                   
    {
-  "city": "xyz789",
-  "company": "abc123",
-  "country_code": "abc123",
+  "city": "abc123",
+  "company": "xyz789",
+  "country_code": "xyz789",
   "firstname": "xyz789",
   "lastname": "abc123",
   "postcode": "abc123",
   "region": "xyz789",
   "region_id": 987,
   "save_in_address_book": true,
-  "street": ["abc123"],
+  "street": ["xyz789"],
   "telephone": "abc123"
 }
 
     
@@ -62745,11 +64161,11 @@ 
    Example
    
   "company": "abc123",
   "country": NegotiableQuoteAddressCountry,
   "firstname": "abc123",
-  "lastname": "abc123",
+  "lastname": "xyz789",
   "postcode": "xyz789",
   "region": NegotiableQuoteAddressRegion,
-  "street": ["abc123"],
-  "telephone": "xyz789"
+  "street": ["xyz789"],
+  "telephone": "abc123"
 }
 
     
                   
@@ -62815,8 +64231,8 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "xyz789",
-  "label": "abc123",
+  "code": "abc123",
+  "label": "xyz789",
   "region_id": 987
 }
 
     
@@ -62933,14 +64349,14 @@ 
    Example
    
                   
                   
                   
    {
-  "city": "xyz789",
-  "company": "abc123",
+  "city": "abc123",
+  "company": "xyz789",
   "country": NegotiableQuoteAddressCountry,
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "lastname": "abc123",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": NegotiableQuoteAddressRegion,
-  "street": ["abc123"],
+  "street": ["xyz789"],
   "telephone": "abc123"
 }
 
     
@@ -63025,8 +64441,8 @@ 
    Example
    
                   
                   
    {
   "address": NegotiableQuoteAddressInput,
-  "customer_address_uid": 4,
-  "same_as_shipping": true,
+  "customer_address_uid": "4",
+  "same_as_shipping": false,
   "use_for_shipping": false
 }
 
     
@@ -63569,8 +64985,8 @@ 
    Example
    
   "author": NegotiableQuoteUser,
   "change_type": "CREATED",
   "changes": NegotiableQuoteHistoryChanges,
-  "created_at": "xyz789",
-  "uid": "4"
+  "created_at": "abc123",
+  "uid": 4
 }
 
     
                   
@@ -63684,7 +65100,7 @@ 
    Example
    
                   
                   
                   
    {
-  "new_expiration": "abc123",
+  "new_expiration": "xyz789",
   "old_expiration": "abc123"
 }
 
     
@@ -63742,7 +65158,7 @@ 
    Example
    
                   
                   
                   
    {
-  "products_removed_from_catalog": ["4"],
+  "products_removed_from_catalog": [4],
   "products_removed_from_quote": [ProductInterface]
 }
 
     
@@ -63949,7 +65365,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"message": "xyz789"}
+                  
    {"message": "abc123"}
 
     
                   
                 
@@ -64068,7 +65484,7 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "xyz789",
+  "code": "abc123",
   "purchase_order_number": "abc123"
 }
 
     
@@ -64205,15 +65621,15 @@ 
    Example
    
                   
    {
   "available_shipping_methods": [AvailableShippingMethod],
   "city": "xyz789",
-  "company": "abc123",
+  "company": "xyz789",
   "country": NegotiableQuoteAddressCountry,
-  "firstname": "xyz789",
+  "firstname": "abc123",
   "lastname": "abc123",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": NegotiableQuoteAddressRegion,
   "selected_shipping_method": SelectedShippingMethod,
   "street": ["abc123"],
-  "telephone": "abc123"
+  "telephone": "xyz789"
 }
 
     
                   
@@ -64286,7 +65702,7 @@ 
    Example
    
                   
                   
    {
   "address": NegotiableQuoteAddressInput,
-  "customer_address_uid": 4,
+  "customer_address_uid": "4",
   "customer_notes": "abc123"
 }
 
     
@@ -64586,7 +66002,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"quote_uid": 4}
+                  
    {"quote_uid": "4"}
 
     
                   
                 
@@ -64642,8 +66058,8 @@ 
    Example
    
                   
                   
                   
    {
-  "firstname": "xyz789",
-  "lastname": "xyz789"
+  "firstname": "abc123",
+  "lastname": "abc123"
 }
 
     
                   
@@ -64721,7 +66137,7 @@ 
    Example
    
   "items": [NegotiableQuote],
   "page_info": SearchResultPageInfo,
   "sort_fields": SortFields,
-  "total_count": 987
+  "total_count": 123
 }
 
     
                   
@@ -64778,7 +66194,7 @@ 
    Example
    
                   
                   
                   
    {
-  "message": "abc123",
+  "message": "xyz789",
   "uid": "4"
 }
 
     
@@ -64838,7 +66254,7 @@ 
    Example
    
                   
                   
                   
    {
-  "order_id": "xyz789",
+  "order_id": "abc123",
   "order_number": "abc123"
 }
 
     
@@ -65016,19 +66432,93 @@ 
    Example
    
   "city": "xyz789",
   "company": "abc123",
   "country_code": "AF",
-  "fax": "abc123",
+  "fax": "xyz789",
   "firstname": "abc123",
   "lastname": "abc123",
-  "middlename": "xyz789",
-  "postcode": "abc123",
+  "middlename": "abc123",
+  "postcode": "xyz789",
   "prefix": "xyz789",
-  "region": "xyz789",
+  "region": "abc123",
   "region_id": "4",
-  "street": ["abc123"],
-  "suffix": "abc123",
-  "telephone": "xyz789",
+  "street": ["xyz789"],
+  "suffix": "xyz789",
+  "telephone": "abc123",
   "vat_id": "abc123"
 }
+
     
+                  
+                
+              
+            
+          
+          
    
+            
    
+              Types
+            
    
+            
    OrderInformationInput
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Input to retrieve an order based on details.
    
+                
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                    
+                  
    Input FieldDescription
    
+                          email -
+                          
+                            String!
+                          
+                        
+                          
    Order billing address email.
    
+                        
    
+                          number -
+                          
+                            String!
+                          
+                        
+                          
    Order number.
    
+                        
    
+                          postcode -
+                          
+                            String!
+                          
+                        
+                          
    Order billing address postcode.
    
+                        
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {
+  "email": "abc123",
+  "number": "xyz789",
+  "postcode": "xyz789"
+}
 
     
                   
                 
    
@@ -65106,6 +66596,15 @@ 
    Fields
    
                         
                          The unique ID for an OrderItemInterface object. 
                       
+                      
+                        
+                          product -
+                          
+                            ProductInterface
+                          
+                        
+                         The ProductInterface object, which contains details about the base product 
+                      
                       
                         
                           product_name -
@@ -65234,22 +66733,23 @@ 
    Example
    
                   
                   
    {
   "discounts": [Discount],
-  "eligible_for_return": false,
+  "eligible_for_return": true,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "4",
+  "id": 4,
+  "product": ProductInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "xyz789",
-  "product_type": "abc123",
+  "product_type": "xyz789",
   "product_url_key": "abc123",
   "quantity_canceled": 123.45,
   "quantity_invoiced": 123.45,
   "quantity_ordered": 123.45,
-  "quantity_refunded": 123.45,
-  "quantity_returned": 123.45,
-  "quantity_shipped": 123.45,
+  "quantity_refunded": 987.65,
+  "quantity_returned": 987.65,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
   "status": "xyz789"
 }
@@ -65334,6 +66834,15 @@ 
    Fields
    
                         
                          The unique ID for an OrderItemInterface object. 
                       
+                      
+                        
+                          product -
+                          
+                            ProductInterface
+                          
+                        
+                         The ProductInterface object, which contains details about the base product 
+                      
                       
                         
                           product_name -
@@ -65502,22 +67011,23 @@ 
    Example
    
                   
                   
    {
   "discounts": [Discount],
-  "eligible_for_return": false,
+  "eligible_for_return": true,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": 4,
+  "id": "4",
+  "product": ProductInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "product_type": "xyz789",
+  "product_sku": "xyz789",
+  "product_type": "abc123",
   "product_url_key": "abc123",
-  "quantity_canceled": 987.65,
-  "quantity_invoiced": 987.65,
-  "quantity_ordered": 987.65,
-  "quantity_refunded": 987.65,
-  "quantity_returned": 987.65,
-  "quantity_shipped": 987.65,
+  "quantity_canceled": 123.45,
+  "quantity_invoiced": 123.45,
+  "quantity_ordered": 123.45,
+  "quantity_refunded": 123.45,
+  "quantity_returned": 123.45,
+  "quantity_shipped": 123.45,
   "selected_options": [OrderItemOption],
   "status": "xyz789"
 }
@@ -65577,7 +67087,7 @@ 
    Example
    
                   
                   
    {
   "label": "abc123",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
     
                   
@@ -65644,7 +67154,7 @@ 
    Example
    
                   
                   
    {
   "additional_data": [KeyValue],
-  "name": "abc123",
+  "name": "xyz789",
   "type": "xyz789"
 }
 
     
@@ -65732,9 +67242,57 @@ 
    Example
    
   "comments": [SalesCommentItem],
   "id": 4,
   "items": [ShipmentItemInterface],
-  "number": "xyz789",
+  "number": "abc123",
   "tracking": [ShipmentTracking]
 }
+
     
+                  
+                
    
+              
    
+            
+          
    
+          
    
+            
    
+              Types
+            
    
+            
    OrderTokenInput
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Input to retrieve an order based on token.
    
+                
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                    
+                  
    Input FieldDescription
    
+                          token -
+                          
+                            String!
+                          
+                        
+                          
    Order token.
    
+                        
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {"token": "xyz789"}
 
     
                   
                 
    
@@ -65923,7 +67481,7 @@ 
    Example
    
                   
                   
    {
   "payer_id": "abc123",
-  "token": "xyz789"
+  "token": "abc123"
 }
 
     
                   
@@ -65999,8 +67557,8 @@ 
    Example
    
                   
                   
                   
    {
-  "cancel_url": "xyz789",
-  "error_url": "abc123",
+  "cancel_url": "abc123",
+  "error_url": "xyz789",
   "return_url": "xyz789"
 }
 
     
@@ -66177,7 +67735,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}
 
     
                   
                 
    
@@ -66480,9 +68038,9 @@ 
    Example
    
                   
                   
                   
    {
-  "cancel_url": "xyz789",
+  "cancel_url": "abc123",
   "error_url": "xyz789",
-  "return_url": "abc123"
+  "return_url": "xyz789"
 }
 
     
                   
@@ -66613,7 +68171,7 @@ 
    Example
    
   "payment_intent": "abc123",
   "sdk_params": [SDKParams],
   "sort_order": "abc123",
-  "title": "abc123"
+  "title": "xyz789"
 }
 
     
                   
@@ -67010,7 +68568,7 @@ 
    Example
    
   "payment_services_paypal_smart_buttons": SmartButtonMethodInput,
   "payment_services_paypal_vault": VaultMethodInput,
   "paypal_express": PaypalExpressInput,
-  "purchase_order_number": "xyz789"
+  "purchase_order_number": "abc123"
 }
 
     
                   
@@ -67085,7 +68643,7 @@ 
    Example
    
                   
                   
                   
    {
-  "id": "xyz789",
+  "id": "abc123",
   "mp_order_id": "abc123",
   "payment_source_details": PaymentSourceDetails,
   "status": "abc123"
@@ -67259,9 +68817,9 @@ 
    Example
    
                   
                   
                   
    {
-  "details": "abc123",
-  "payment_method_code": "abc123",
-  "public_hash": "abc123",
+  "details": "xyz789",
+  "payment_method_code": "xyz789",
+  "public_hash": "xyz789",
   "type": "card"
 }
 
     
@@ -67373,7 +68931,7 @@ 
    Example
    
                   
                   
    {
   "payer_id": "xyz789",
-  "token": "abc123"
+  "token": "xyz789"
 }
 
     
                   
@@ -67468,10 +69026,10 @@ 
    Example
    
                   
                   
    {
   "cart_id": "xyz789",
-  "code": "abc123",
-  "express_button": true,
+  "code": "xyz789",
+  "express_button": false,
   "urls": PaypalExpressUrlsInput,
-  "use_paypal_credit": false
+  "use_paypal_credit": true
 }
 
     
                   
@@ -67587,7 +69145,7 @@ 
    Example
    
                   
                   
    {
   "edit": "abc123",
-  "start": "abc123"
+  "start": "xyz789"
 }
 
     
                   
@@ -67675,9 +69233,9 @@ 
    Example
    
                   
                   
                   
    {
-  "cancel_url": "xyz789",
-  "pending_url": "xyz789",
-  "return_url": "abc123",
+  "cancel_url": "abc123",
+  "pending_url": "abc123",
+  "return_url": "xyz789",
   "success_url": "xyz789"
 }
 
     
@@ -67772,7 +69330,7 @@ 
    Possible Types
    
                   
    Example
    
                   
                   
-                  
    {"weight": 123.45}
+                  
    {"weight": 987.65}
 
     
                   
                 
@@ -67945,19 +69503,19 @@ 
    Example
    
                   
                   
                   
    {
-  "city": "abc123",
+  "city": "xyz789",
   "contact_name": "xyz789",
-  "country_id": "xyz789",
+  "country_id": "abc123",
   "description": "xyz789",
   "email": "abc123",
-  "fax": "xyz789",
-  "latitude": 123.45,
-  "longitude": 123.45,
-  "name": "abc123",
-  "phone": "abc123",
-  "pickup_location_code": "abc123",
+  "fax": "abc123",
+  "latitude": 987.65,
+  "longitude": 987.65,
+  "name": "xyz789",
+  "phone": "xyz789",
+  "pickup_location_code": "xyz789",
   "postcode": "abc123",
-  "region": "abc123",
+  "region": "xyz789",
   "region_id": 123,
   "street": "xyz789"
 }
@@ -68440,7 +69998,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"quote_uid": "4"}
+                  
    {"quote_uid": 4}
 
     
                   
                 
@@ -68487,6 +70045,127 @@ 
    Example
    
                   
                   
                   
    {"order": Order}
+
     
+                  
+                
+              
+            
+          
+          
    
+            
    
+              Types
+            
    
+            
    PlaceOrderError
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    An error encountered while placing an order.
    
+                
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                    
+                  
    Field NameDescription
    
+                          code -
+                          
+                            PlaceOrderErrorCodes!
+                          
+                         An error code that is specific to place order. 
    
+                          message -
+                          
+                            String!
+                          
+                         A localized error message. 
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {
+  "code": "CART_NOT_FOUND",
+  "message": "xyz789"
+}
+
     
+                  
+                
    
+              
    
+            
    
+          
    
+          
    
+            
    
+              Types
+            
    
+            
    PlaceOrderErrorCodes
    
+            
    
+              
    
+                
    
+                  
    Values
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                    
+                  
    Enum ValueDescription
    
+                          
    CART_NOT_FOUND
    
+                            		 
    
+                          
    CART_NOT_ACTIVE
    
+                            		 
    
+                          
    GUEST_EMAIL_MISSING
    
+                            		 
    
+                          
    UNABLE_TO_PLACE_ORDER
    
+                            		 
    
+                          
    UNDEFINED
    
+                            		 
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    "CART_NOT_FOUND"
 
     
                   
                 
    
@@ -68628,7 +70307,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
 
     
                   
                 
    
@@ -68658,12 +70337,32 @@ 
    Fields
    
                     
                       
                         
+                          errors -
+                          
+                            [PlaceOrderError]!
+                          
+                        
+                         An array of place order errors. 
+                      
+                      
+                        
                           order -
                           
-                            Order!
+                            Order
+                          
+                        
+                         The ID of the order.
+                          Use orderV2 instead.
+                        
+                      
+                      
+                        
+                          orderV2 -
+                          
+                            CustomerOrder
                           
                         
-                         The ID of the order. 
+                         Full order information. 
                       
                     
                   
@@ -68674,7 +70373,11 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"order": Order}
+                  
    {
+  "errors": [PlaceOrderError],
+  "order": Order,
+  "orderV2": CustomerOrder
+}
 
     
                   
                 
    
@@ -69078,7 +70781,7 @@ 
    Example
    
                   
                   
    {
   "discount_percentage": 987.65,
-  "main_final_price": 123.45,
+  "main_final_price": 987.65,
   "main_price": 123.45
 }
 
     
@@ -69299,7 +71002,7 @@ 
    Example
    
                   
                   
    {
   "code": "xyz789",
-  "value": "xyz789"
+  "value": "abc123"
 }
 
     
                   
@@ -70482,8 +72185,8 @@ 
    Example
    
                   
                   
                   
    {
-  "disabled": false,
-  "label": "abc123",
+  "disabled": true,
+  "label": "xyz789",
   "position": 987,
   "url": "abc123"
 }
@@ -71415,77 +73118,77 @@ 
    Example
    
                   
    {
   "activity": "xyz789",
   "attribute_set_id": 123,
-  "canonical_url": "xyz789",
+  "canonical_url": "abc123",
   "categories": [CategoryInterface],
   "category_gear": "abc123",
   "climate": "abc123",
   "collar": "xyz789",
-  "color": 123,
+  "color": 987,
   "country_of_manufacture": "xyz789",
   "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 123,
-  "erin_recommends": 987,
+  "eco_collection": 987,
+  "erin_recommends": 123,
   "features_bags": "xyz789",
   "format": 987,
   "gender": "abc123",
   "gift_message_available": "abc123",
   "id": 123,
   "image": ProductImage,
-  "is_returnable": "abc123",
+  "is_returnable": "xyz789",
   "manufacturer": 123,
-  "material": "xyz789",
+  "material": "abc123",
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
   "meta_description": "abc123",
-  "meta_keyword": "xyz789",
-  "meta_title": "abc123",
-  "name": "xyz789",
+  "meta_keyword": "abc123",
+  "meta_title": "xyz789",
+  "name": "abc123",
   "new": 987,
-  "new_from_date": "xyz789",
+  "new_from_date": "abc123",
   "new_to_date": "abc123",
-  "only_x_left_in_stock": 987.65,
+  "only_x_left_in_stock": 123.45,
   "options_container": "abc123",
-  "pattern": "xyz789",
+  "pattern": "abc123",
   "performance_fabric": 123,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 987,
-  "rating_summary": 987.65,
+  "purpose": 123,
+  "rating_summary": 123.45,
   "related_products": [ProductInterface],
   "review_count": 123,
   "reviews": ProductReviews,
-  "sale": 123,
+  "sale": 987,
   "short_description": ComplexTextValue,
   "size": 123,
-  "sku": "abc123",
-  "sleeve": "xyz789",
+  "sku": "xyz789",
+  "sleeve": "abc123",
   "small_image": ProductImage,
   "special_from_date": "abc123",
-  "special_price": 987.65,
-  "special_to_date": "abc123",
+  "special_price": 123.45,
+  "special_to_date": "xyz789",
   "staged": false,
   "stock_status": "IN_STOCK",
-  "strap_bags": "xyz789",
+  "strap_bags": "abc123",
   "style_bags": "xyz789",
   "style_bottom": "abc123",
-  "style_general": "xyz789",
+  "style_general": "abc123",
   "swatch_image": "xyz789",
   "thumbnail": ProductImage,
   "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
   "type_id": "abc123",
   "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]
 }
 
     
@@ -71571,7 +73274,7 @@ 
    Example
    
                   
                   
    {
   "link_type": "abc123",
-  "linked_product_sku": "xyz789",
+  "linked_product_sku": "abc123",
   "linked_product_type": "xyz789",
   "position": 987,
   "sku": "xyz789"
@@ -71679,7 +73382,7 @@ 
    Example
    
                   
    {
   "link_type": "xyz789",
   "linked_product_sku": "abc123",
-  "linked_product_type": "abc123",
+  "linked_product_type": "xyz789",
   "position": 987,
   "sku": "abc123"
 }
@@ -71747,9 +73450,9 @@ 
    Example
    
                   
                   
                   
    {
-  "base64_encoded_data": "abc123",
+  "base64_encoded_data": "xyz789",
   "name": "abc123",
-  "type": "abc123"
+  "type": "xyz789"
 }
 
     
                   
@@ -71843,10 +73546,10 @@ 
    Example
    
                   
                   
    {
   "media_type": "xyz789",
-  "video_description": "xyz789",
-  "video_metadata": "xyz789",
-  "video_provider": "abc123",
-  "video_title": "abc123",
+  "video_description": "abc123",
+  "video_metadata": "abc123",
+  "video_provider": "xyz789",
+  "video_title": "xyz789",
   "video_url": "abc123"
 }
 
     
@@ -72102,12 +73805,12 @@ 
    Example
    
                   
                   
    {
   "average_rating": 123.45,
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "nickname": "xyz789",
   "product": ProductInterface,
   "ratings_breakdown": [ProductReviewRating],
-  "summary": "abc123",
-  "text": "xyz789"
+  "summary": "xyz789",
+  "text": "abc123"
 }
 
     
                   
@@ -72164,7 +73867,7 @@ 
    Example
    
                   
                   
                   
    {
-  "name": "abc123",
+  "name": "xyz789",
   "value": "xyz789"
 }
 
     
@@ -72226,8 +73929,8 @@ 
    Example
    
                   
                   
                   
    {
-  "id": "abc123",
-  "value_id": "abc123"
+  "id": "xyz789",
+  "value_id": "xyz789"
 }
 
     
                   
@@ -72293,7 +73996,7 @@ 
    Example
    
                   
                   
                   
    {
-  "id": "abc123",
+  "id": "xyz789",
   "name": "xyz789",
   "values": [ProductReviewRatingValueMetadata]
 }
@@ -72600,9 +74303,9 @@ 
    Example
    
                   
                   
                   
    {
-  "customer_group_id": "abc123",
-  "percentage_value": 123.45,
-  "qty": 987.65,
+  "customer_group_id": "xyz789",
+  "percentage_value": 987.65,
+  "qty": 123.45,
   "value": 123.45,
   "website_id": 123.45
 }
@@ -72689,9 +74392,9 @@ 
    Example
    
                   
                   
    {
   "disabled": true,
-  "label": "xyz789",
-  "position": 123,
-  "url": "xyz789",
+  "label": "abc123",
+  "position": 987,
+  "url": "abc123",
   "video_content": ProductMediaGalleryEntriesVideoContent
 }
 
     
@@ -72969,15 +74672,15 @@ 
    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",
-  "updated_at": "xyz789"
+  "uid": 4,
+  "updated_at": "abc123"
 }
 
     
                   
@@ -73366,10 +75069,10 @@ 
    Example
    
   "applies_to_roles": [CompanyRole],
   "approver_roles": [CompanyRole],
   "condition": PurchaseOrderApprovalRuleConditionInterface,
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "created_by": "xyz789",
-  "description": "abc123",
-  "name": "xyz789",
+  "description": "xyz789",
+  "name": "abc123",
   "status": "ENABLED",
   "uid": "4",
   "updated_at": "abc123"
@@ -73643,7 +75346,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123}
+                  
    {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}
 
     
                   
                 
@@ -73750,7 +75453,7 @@ 
    Example
    
   "applies_to": ["4"],
   "approvers": [4],
   "condition": CreatePurchaseOrderApprovalRuleConditionInput,
-  "description": "abc123",
+  "description": "xyz789",
   "name": "xyz789",
   "status": "ENABLED"
 }
@@ -73984,7 +75687,7 @@ 
    Example
    
                   
    {
   "items": [PurchaseOrderApprovalRule],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
     
                   
@@ -74200,10 +75903,10 @@ 
    Example
    
                   
                   
                   
    {
-  "activity": "xyz789",
-  "created_at": "abc123",
+  "activity": "abc123",
+  "created_at": "xyz789",
   "message": "abc123",
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -74465,7 +76168,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"purchase_order_uids": ["4"]}
+                  
    {"purchase_order_uids": [4]}
 
     
                   
                 
@@ -74607,9 +76310,68 @@ 
    Example
    
                   
    {
   "company_purchase_orders": false,
   "created_date": FilterRangeTypeInput,
-  "require_my_approval": false,
+  "require_my_approval": true,
   "status": "PENDING"
 }
+
     
+                  
+                
+              
+            
+          
    
+          
    
+            
    
+              Types
+            
    
+            
    QuoteItemsSortInput
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Specifies the field to use for sorting quote items
    
+                
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                    
+                  
    Input FieldDescription
    
+                          field -
+                          
+                            SortQuoteItemsEnum!
+                          
+                        
+                          
    Specifies the quote items field to sort by
    
+                        
    
+                          order -
+                          
+                            SortEnum!
+                          
+                        
+                          
    Specifies the order of quote items' sorting
    
+                        
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {"field": "ITEM_ID", "order": "ASC"}
 
     
                   
                 
    
@@ -74710,13 +76472,13 @@ 
    Example
    
                   
                   
                   
    {
-  "badge_position": "xyz789",
-  "failure_message": "abc123",
+  "badge_position": "abc123",
+  "failure_message": "xyz789",
   "forms": ["PLACE_ORDER"],
   "is_enabled": false,
   "language_code": "abc123",
   "minimum_score": 123.45,
-  "website_key": "xyz789"
+  "website_key": "abc123"
 }
 
     
                   
@@ -74871,8 +76633,8 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "xyz789",
-  "id": 987,
+  "code": "abc123",
+  "id": 123,
   "name": "abc123"
 }
 
     
@@ -74922,7 +76684,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
 
     
                   
                 
    
@@ -74969,6 +76731,68 @@ 
    Example
    
                   
                   
                   
    {"cart": Cart}
+
     
+                  
+                
    
+              
+            
+          
    
+          
    
+            
    
+              Types
+            
    
+            
    RemoveCouponsFromCartInput
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Remove coupons from the cart.
    
+                
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                    
+                  
    Input FieldDescription
    
+                          cart_id -
+                          
+                            String!
+                          
+                        
+                          
    The unique ID of a Cart object.
    
+                        
    
+                          coupon_codes -
+                          
+                            [String]!
+                          
+                        
+                          
    An array of coupon codes to be removed from the quote. If coupon_codes is empty all coupons will be removed from the quote.
    
+                        
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {
+  "cart_id": "abc123",
+  "coupon_codes": ["abc123"]
+}
 
     
                   
                 
    
@@ -75168,7 +76992,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"success": true}
+                  
    {"success": false}
 
     
                   
                 
    
@@ -75287,7 +77111,7 @@ 
    Example
    
                   
    {
   "cart_id": "xyz789",
   "cart_item_id": 123,
-  "cart_item_uid": 4
+  "cart_item_uid": "4"
 }
 
     
                   
@@ -75393,7 +77217,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"quote_item_uids": ["4"], "quote_uid": 4}
+                  
    {"quote_item_uids": [4], "quote_uid": "4"}
 
     
                   
                 
    
@@ -75498,7 +77322,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"products": [4], "uid": "4"}
+                  
    {"products": [4], "uid": 4}
 
     
                   
                 
@@ -75604,7 +77428,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"return_shipping_tracking_uid": "4"}
+                  
    {"return_shipping_tracking_uid": 4}
 
     
                   
                 
@@ -75791,126 +77615,6 @@ 
    Example
    
                   
                   
                   
    {"cart": Cart}
-
     
-                  
-                
-              
-            
-          
    
-          
    
-            
    
-              Types
-            
    
-            
    RenameNegotiableQuoteInput
    
-            
    
-              
    
-                
    
-                  
    Description
    
-                  
    Sets new name for a negotiable quote.
    
-                
    
-                
    
-                  
    Fields
    
-                  
-                    
-                      
-                        
-                        
-                      
-                    
-                    
-                      
-                        
-                        
-                      
-                      
-                        
-                        
-                      
-                      
-                        
-                        
-                      
-                    
-                  
    Input FieldDescription
    
-                          quote_comment -
-                          
-                            String
-                          
-                        
-                          
    The reason for the quote name change specified by the buyer.
    
-                        
    
-                          quote_name -
-                          
-                            String!
-                          
-                        
-                          
    The new quote name the buyer specified to the negotiable quote request.
    
-                        
    
-                          quote_uid -
-                          
-                            ID!
-                          
-                        
-                          
    The cart ID of the buyer requesting a new negotiable quote.
    
-                        
    
-                
    
-              
    
-              
    
-                
    
-                  
    Example
    
-                  
-                  
-                  
    {
-  "quote_comment": "abc123",
-  "quote_name": "xyz789",
-  "quote_uid": 4
-}
-
     
-                  
-                
    
-              
    
-            
    
-          
    
-          
    
-            
    
-              Types
-            
    
-            
    RenameNegotiableQuoteOutput
    
-            
    
-              
    
-                
    
-                  
    Description
    
-                  
    Contains the updated negotiable quote.
    
-                
    
-                
    
-                  
    Fields
    
-                  
-                    
-                      
-                        
-                        
-                      
-                    
-                    
-                      
-                        
-                        
-                      
-                    
-                  
    Field NameDescription
    
-                          quote -
-                          
-                            NegotiableQuote
-                          
-                         The negotiable quote after updating the name. 
    
-                
    
-              
    
-              
    
-                
    
-                  
    Example
    
-                  
-                  
-                  
    {"quote": NegotiableQuote}
 
     
                   
                 
    
@@ -76018,17 +77722,6 @@ 
    Fields
    
                           
    Comments the buyer entered to describe the request.
    
                         
                       
-                      
-                        
-                          is_draft -
-                          
-                            Boolean
-                          
-                        
-                        
-                          
    Flag indicating if quote is draft or not.
    
-                        
-                      
                       
                         
                           quote_name -
@@ -76050,10 +77743,9 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": "4",
+  "cart_id": 4,
   "comment": NegotiableQuoteCommentInput,
-  "is_draft": false,
-  "quote_name": "abc123"
+  "quote_name": "xyz789"
 }
 
     
                   
@@ -76182,10 +77874,10 @@ 
    Example
    
                   
                   
                   
    {
-  "comment_text": "abc123",
-  "contact_email": "xyz789",
+  "comment_text": "xyz789",
+  "contact_email": "abc123",
   "items": [RequestReturnItemInput],
-  "order_uid": 4
+  "order_uid": "4"
 }
 
     
                   
@@ -76480,12 +78172,12 @@ 
    Example
    
                   
                   
                   
    {
-  "description": "xyz789",
+  "description": "abc123",
   "items": RequistionListItems,
-  "items_count": 987,
+  "items_count": 123,
   "name": "abc123",
   "uid": 4,
-  "updated_at": "abc123"
+  "updated_at": "xyz789"
 }
 
     
                   
@@ -76678,8 +78370,8 @@ 
    Example
    
                   
    {
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": "4"
+  "quantity": 987.65,
+  "uid": 4
 }
 
     
                   
@@ -76775,7 +78467,7 @@ 
    Example
    
                   
    {
   "entered_options": [EnteredOptionInput],
   "parent_sku": "xyz789",
-  "quantity": 123.45,
+  "quantity": 987.65,
   "selected_options": ["xyz789"],
   "sku": "xyz789"
 }
@@ -77044,14 +78736,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
 }
 
     
                   
@@ -77128,8 +78820,8 @@ 
    Example
    
                   
    {
   "author_name": "abc123",
   "created_at": "xyz789",
-  "text": "abc123",
-  "uid": 4
+  "text": "xyz789",
+  "uid": "4"
 }
 
     
                   
@@ -77263,9 +78955,9 @@ 
    Example
    
                   
                   
                   
    {
-  "email": "xyz789",
+  "email": "abc123",
   "firstname": "xyz789",
-  "lastname": "abc123"
+  "lastname": "xyz789"
 }
 
     
                   
@@ -77375,7 +79067,7 @@ 
    Example
    
   "quantity": 987.65,
   "request_quantity": 123.45,
   "status": "PENDING",
-  "uid": "4"
+  "uid": 4
 }
 
     
                   
@@ -77532,17 +79224,17 @@ 
    Example
    
                   
                   
    {
   "code": "4",
-  "default_value": "xyz789",
+  "default_value": "abc123",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "abc123",
+  "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
   "input_filter": "NONE",
   "is_required": true,
   "is_unique": false,
-  "label": "abc123",
+  "label": "xyz789",
   "multiline_count": 987,
   "options": [CustomAttributeOptionInterface],
-  "sort_order": 123,
+  "sort_order": 987,
   "validate_rules": [ValidationRule]
 }
 
     
@@ -77790,7 +79482,7 @@ 
    Example
    
                   
                   
    {
   "city": "abc123",
-  "contact_name": "xyz789",
+  "contact_name": "abc123",
   "country": Country,
   "postcode": "abc123",
   "region": Region,
@@ -77851,7 +79543,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"label": "abc123", "uid": 4}
+                  
    {"label": "xyz789", "uid": 4}
 
     
                   
                 
    
@@ -77927,8 +79619,8 @@ 
    Example
    
                   
    {
   "carrier": ReturnShippingCarrier,
   "status": ReturnShippingTrackingStatus,
-  "tracking_number": "abc123",
-  "uid": 4
+  "tracking_number": "xyz789",
+  "uid": "4"
 }
 
     
                   
@@ -78201,7 +79893,7 @@ 
    Example
    
                   
    {
   "items": [Return],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
     
                   
@@ -78248,7 +79940,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"result": false}
+                  
    {"result": true}
 
     
                   
                 
    
@@ -78454,7 +80146,7 @@ 
    Example
    
   "balance": RewardPointsAmount,
   "change_reason": "abc123",
   "date": "abc123",
-  "points_change": 123.45
+  "points_change": 987.65
 }
 
     
                   
@@ -78568,7 +80260,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"currency_amount": 123.45, "points": 987.65}
+                  
    {"currency_amount": 123.45, "points": 123.45}
 
     
                   
                 
@@ -78819,7 +80511,7 @@ 
    Example
    
                   
                   
    {
   "redirect_code": 123,
-  "relative_url": "xyz789",
+  "relative_url": "abc123",
   "type": "CMS_PAGE"
 }
 
     
@@ -78887,7 +80579,7 @@ 
    Example
    
                   
                   
    {
   "redirect_code": 123,
-  "relative_url": "xyz789",
+  "relative_url": "abc123",
   "type": "CMS_PAGE"
 }
 
     
@@ -79003,8 +80695,8 @@ 
    Example
    
                   
                   
                   
    {
-  "message": "abc123",
-  "timestamp": "xyz789"
+  "message": "xyz789",
+  "timestamp": "abc123"
 }
 
     
                   
@@ -79124,7 +80816,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"current_page": 123, "page_size": 987, "total_pages": 123}
+                  
    {"current_page": 123, "page_size": 987, "total_pages": 987}
 
     
                   
                 
@@ -79170,7 +80862,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"search": "abc123"}
+                  
    {"search": "xyz789"}
 
     
                   
                 
@@ -79255,10 +80947,10 @@ 
    Example
    
                   
                   
                   
    {
-  "id": 987,
+  "id": 123,
   "label": "abc123",
   "type": "abc123",
-  "uid": "4",
+  "uid": 4,
   "values": [SelectedBundleOptionValue]
 }
 
     
@@ -79344,7 +81036,7 @@ 
    Example
    
                   
                   
    {
   "id": 123,
-  "label": "xyz789",
+  "label": "abc123",
   "price": 123.45,
   "quantity": 987.65,
   "uid": "4"
@@ -79444,12 +81136,12 @@ 
    Example
    
                   
                   
                   
    {
-  "configurable_product_option_uid": "4",
-  "configurable_product_option_value_uid": "4",
+  "configurable_product_option_uid": 4,
+  "configurable_product_option_value_uid": 4,
   "id": 987,
   "option_label": "xyz789",
-  "value_id": 987,
-  "value_label": "abc123"
+  "value_id": 123,
+  "value_label": "xyz789"
 }
 
     
                   
@@ -79510,7 +81202,7 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_code": "abc123",
+  "attribute_code": "xyz789",
   "value": "4"
 }
 
     
@@ -79617,10 +81309,10 @@ 
    Example
    
                   
    {
   "customizable_option_uid": 4,
   "id": 123,
-  "is_required": true,
-  "label": "abc123",
+  "is_required": false,
+  "label": "xyz789",
   "sort_order": 987,
-  "type": "xyz789",
+  "type": "abc123",
   "values": [SelectedCustomizableOptionValue]
 }
 
     
@@ -79707,8 +81399,8 @@ 
    Example
    
                   
                   
                   
    {
-  "customizable_option_value_uid": 4,
-  "id": 123,
+  "customizable_option_value_uid": "4",
+  "id": 987,
   "label": "xyz789",
   "price": CartItemSelectedOptionValuePrice,
   "value": "xyz789"
@@ -79778,7 +81470,7 @@ 
    Example
    
                   
                   
    {
   "code": "abc123",
-  "purchase_order_number": "xyz789",
+  "purchase_order_number": "abc123",
   "title": "abc123"
 }
 
     
@@ -79896,7 +81588,7 @@ 
    Example
    
   "base_amount": Money,
   "carrier_code": "xyz789",
   "carrier_title": "abc123",
-  "method_code": "xyz789",
+  "method_code": "abc123",
   "method_title": "xyz789",
   "price_excl_tax": Money,
   "price_incl_tax": Money
@@ -80089,7 +81781,7 @@ 
    Example
    
                   
                   
    {
   "email": "abc123",
-  "name": "xyz789"
+  "name": "abc123"
 }
 
     
                   
@@ -80151,7 +81843,7 @@ 
    Example
    
                   
                   
    {
   "email": "xyz789",
-  "name": "xyz789"
+  "name": "abc123"
 }
 
     
                   
@@ -80217,9 +81909,9 @@ 
    Example
    
                   
                   
                   
    {
-  "email": "xyz789",
+  "email": "abc123",
   "message": "abc123",
-  "name": "xyz789"
+  "name": "abc123"
 }
 
     
                   
@@ -80291,7 +81983,7 @@ 
    Example
    
                   
                   
                   
    {
-  "email": "xyz789",
+  "email": "abc123",
   "message": "xyz789",
   "name": "xyz789"
 }
@@ -80349,7 +82041,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"enabled_for_customers": false, "enabled_for_guests": true}
+                  
    {"enabled_for_customers": true, "enabled_for_guests": true}
 
     
                   
                 
@@ -80515,7 +82207,7 @@ 
    Example
    
                   
                   
    {
   "billing_address": BillingAddressInput,
-  "cart_id": "xyz789"
+  "cart_id": "abc123"
 }
 
     
                   
@@ -80655,10 +82347,10 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "gift_message": GiftMessageInput,
   "gift_receipt_included": false,
-  "gift_wrapping_id": 4,
+  "gift_wrapping_id": "4",
   "printed_card_included": false
 }
 
     
@@ -80921,7 +82613,7 @@ 
    Example
    
                   
                   
    {
   "billing_address": NegotiableQuoteBillingAddressInput,
-  "quote_uid": 4
+  "quote_uid": "4"
 }
 
     
                   
@@ -81029,7 +82721,7 @@ 
    Example
    
                   
                   
    {
   "payment_method": NegotiableQuotePaymentMethodInput,
-  "quote_uid": 4
+  "quote_uid": "4"
 }
 
     
                   
@@ -81148,7 +82840,7 @@ 
    Example
    
                   
                   
    {
   "customer_address_id": 4,
-  "quote_uid": 4,
+  "quote_uid": "4",
   "shipping_addresses": [
     NegotiableQuoteShippingAddressInput
   ]
@@ -81644,7 +83336,7 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "shipping_methods": [ShippingMethodInput]
 }
 
     
@@ -81753,7 +83445,7 @@ 
    Example
    
                   
                   
    {
   "email": "abc123",
-  "name": "xyz789"
+  "name": "abc123"
 }
 
     
                   
@@ -81861,7 +83553,7 @@ 
    Example
    
                   
                   
    {
   "message": "xyz789",
-  "name": "abc123"
+  "name": "xyz789"
 }
 
     
                   
@@ -82001,10 +83693,10 @@ 
    Example
    
                   
    {
   "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_shipped": 123.45
+  "product_sku": "xyz789",
+  "quantity_shipped": 987.65
 }
 
     
                   
@@ -82203,7 +83895,7 @@ 
    Example
    
                   
    {
   "carrier": "abc123",
   "number": "xyz789",
-  "title": "xyz789"
+  "title": "abc123"
 }
 
     
                   
@@ -82287,9 +83979,9 @@ 
    Example
    
                   
                   
    {
   "address": CartAddressInput,
-  "customer_address_id": 987,
-  "customer_notes": "abc123",
-  "pickup_location_code": "abc123"
+  "customer_address_id": 123,
+  "customer_notes": "xyz789",
+  "pickup_location_code": "xyz789"
 }
 
     
                   
@@ -82542,14 +84234,14 @@ 
    Example
    
   "available_shipping_methods": [AvailableShippingMethod],
   "cart_items": [CartItemQuantity],
   "cart_items_v2": [CartItemInterface],
-  "city": "xyz789",
+  "city": "abc123",
   "company": "abc123",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
   "customer_notes": "xyz789",
   "fax": "abc123",
   "firstname": "xyz789",
-  "items_weight": 987.65,
+  "items_weight": 123.45,
   "lastname": "xyz789",
   "middlename": "xyz789",
   "pickup_location_code": "abc123",
@@ -82558,7 +84250,7 @@ 
    Example
    
   "region": CartAddressRegion,
   "selected_shipping_method": SelectedShippingMethod,
   "street": ["xyz789"],
-  "suffix": "xyz789",
+  "suffix": "abc123",
   "telephone": "xyz789",
   "uid": "abc123",
   "vat_id": "xyz789"
@@ -82757,7 +84449,7 @@ 
    Example
    
                   
                   
    {
   "carrier_code": "abc123",
-  "method_code": "xyz789"
+  "method_code": "abc123"
 }
 
     
                   
@@ -82930,13 +84622,13 @@ 
    Example
    
   "errors": [CartItemError],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "abc123",
+  "id": "xyz789",
   "is_available": true,
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "uid": "4"
 }
 
     
@@ -83801,26 +85493,26 @@ 
    Example
    
                   
                   
                   
    {
-  "activity": "xyz789",
-  "attribute_set_id": 987,
+  "activity": "abc123",
+  "attribute_set_id": 123,
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "abc123",
+  "category_gear": "xyz789",
+  "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": 123,
-  "features_bags": "abc123",
-  "format": 987,
+  "features_bags": "xyz789",
+  "format": 123,
   "gender": "xyz789",
   "gift_message_available": "xyz789",
-  "id": 123,
+  "id": 987,
   "image": ProductImage,
   "is_returnable": "xyz789",
   "manufacturer": 987,
@@ -83830,56 +85522,56 @@ 
    Example
    
   "meta_description": "abc123",
   "meta_keyword": "xyz789",
   "meta_title": "xyz789",
-  "name": "abc123",
+  "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",
+  "options_container": "abc123",
   "pattern": "xyz789",
-  "performance_fabric": 123,
+  "performance_fabric": 987,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 123,
+  "purpose": 987,
   "rating_summary": 123.45,
-  "redirect_code": 987,
+  "redirect_code": 123,
   "related_products": [ProductInterface],
   "relative_url": "xyz789",
-  "review_count": 987,
+  "review_count": 123,
   "reviews": ProductReviews,
-  "sale": 123,
+  "sale": 987,
   "short_description": ComplexTextValue,
-  "size": 987,
+  "size": 123,
   "sku": "xyz789",
   "sleeve": "xyz789",
   "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",
   "strap_bags": "abc123",
-  "style_bags": "xyz789",
-  "style_bottom": "abc123",
+  "style_bags": "abc123",
+  "style_bottom": "xyz789",
   "style_general": "xyz789",
-  "swatch_image": "xyz789",
+  "swatch_image": "abc123",
   "thumbnail": ProductImage,
-  "tier_price": 123.45,
+  "tier_price": 987.65,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "abc123",
-  "uid": 4,
-  "updated_at": "abc123",
+  "type_id": "xyz789",
+  "uid": "4",
+  "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
-  "url_key": "xyz789",
-  "url_path": "abc123",
+  "url_key": "abc123",
+  "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
   "url_suffix": "abc123",
   "websites": [Website],
-  "weight": 123.45
+  "weight": 987.65
 }
 
     
                   
@@ -84018,8 +85710,8 @@ 
    Example
    
                   
    {
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 987.65,
-  "uid": "4"
+  "quantity": 123.45,
+  "uid": 4
 }
 
     
                   
@@ -84115,9 +85807,9 @@ 
    Example
    
   "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
-  "id": 4,
+  "id": "4",
   "product": ProductInterface,
-  "quantity": 987.65
+  "quantity": 123.45
 }
 
     
                   
@@ -84190,8 +85882,8 @@ 
    Example
    
                   
                   
    {
   "payment_source": "xyz789",
-  "payments_order_id": "abc123",
-  "paypal_order_id": "xyz789"
+  "payments_order_id": "xyz789",
+  "paypal_order_id": "abc123"
 }
 
     
                   
@@ -84317,15 +86009,15 @@ 
    Example
    
                   
                   
    {
   "button_styles": ButtonStyles,
-  "code": "abc123",
-  "display_message": false,
+  "code": "xyz789",
+  "display_message": true,
   "display_venmo": true,
   "is_visible": true,
   "message_styles": MessageStyles,
-  "payment_intent": "xyz789",
+  "payment_intent": "abc123",
   "sdk_params": [SDKParams],
-  "sort_order": "abc123",
-  "title": "abc123"
+  "sort_order": "xyz789",
+  "title": "xyz789"
 }
 
     
                   
@@ -84431,8 +86123,8 @@ 
    Example
    
                   
                   
                   
    {
-  "label": "xyz789",
-  "value": "xyz789"
+  "label": "abc123",
+  "value": "abc123"
 }
 
     
                   
@@ -84492,6 +86184,241 @@ 
    Example
    
   "default": "abc123",
   "options": [SortField]
 }
+
     
+                  
+                
+              
+            
+          
+          
    
+            
    
+              Types
+            
    
+            
    SortQuoteItemsEnum
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Specifies the field to use for sorting quote items
    
+                
    
+                
    
+                  
    Values
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                    
+                  
    Enum ValueDescription
    
+                          
    ITEM_ID
    
+                            		 
    
+                          
    CREATED_AT
    
+                            		 
    
+                          
    UPDATED_AT
    
+                            		 
    
+                          
    PRODUCT_ID
    
+                            		 
    
+                          
    SKU
    
+                            		 
    
+                          
    NAME
    
+                            		 
    
+                          
    DESCRIPTION
    
+                            		 
    
+                          
    WEIGHT
    
+                            		 
    
+                          
    QTY
    
+                            		 
    
+                          
    PRICE
    
+                            		 
    
+                          
    BASE_PRICE
    
+                            		 
    
+                          
    CUSTOM_PRICE
    
+                            		 
    
+                          
    DISCOUNT_PERCENT
    
+                            		 
    
+                          
    DISCOUNT_AMOUNT
    
+                            		 
    
+                          
    BASE_DISCOUNT_AMOUNT
    
+                            		 
    
+                          
    TAX_PERCENT
    
+                            		 
    
+                          
    TAX_AMOUNT
    
+                            		 
    
+                          
    BASE_TAX_AMOUNT
    
+                            		 
    
+                          
    ROW_TOTAL
    
+                            		 
    
+                          
    BASE_ROW_TOTAL
    
+                            		 
    
+                          
    ROW_TOTAL_WITH_DISCOUNT
    
+                            		 
    
+                          
    ROW_WEIGHT
    
+                            		 
    
+                          
    PRODUCT_TYPE
    
+                            		 
    
+                          
    BASE_TAX_BEFORE_DISCOUNT
    
+                            		 
    
+                          
    TAX_BEFORE_DISCOUNT
    
+                            		 
    
+                          
    ORIGINAL_CUSTOM_PRICE
    
+                            		 
    
+                          
    PRICE_INC_TAX
    
+                            		 
    
+                          
    BASE_PRICE_INC_TAX
    
+                            		 
    
+                          
    ROW_TOTAL_INC_TAX
    
+                            		 
    
+                          
    BASE_ROW_TOTAL_INC_TAX
    
+                            		 
    
+                          
    DISCOUNT_TAX_COMPENSATION_AMOUNT
    
+                            		 
    
+                          
    BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT
    
+                            		 
    
+                          
    FREE_SHIPPING
    
+                            		 
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    "ITEM_ID"
 
     
                   
                 
    
@@ -85338,6 +87265,15 @@ 
    Fields
    
                         
                          Braintree PayPal vault status. 
                       
+                      
+                        
+                          cart_expires_in_days -
+                          
+                            Int
+                          
+                        
+                         Extended Config Data - checkout/cart/delete_quote_after 
+                      
                       
                         
                           cart_gift_wrapping -
@@ -85356,6 +87292,15 @@ 
    Fields
    
                         
                          Indicates if printed card prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). 
                       
+                      
+                        
+                          cart_summary_display_quantity -
+                          
+                            Int
+                          
+                        
+                         Extended Config Data - checkout/cart_link/use_qty 
+                      
                       
                         
                           catalog_default_sort_by -
@@ -85547,6 +87492,24 @@ 
    Fields
    
                         
                          Extended Config Data - general/region/state_required 
                       
+                      
+                        
+                          create_account_confirmation -
+                          
+                            Boolean
+                          
+                        
+                         Indicates if the new accounts need confirmation. 
+                      
+                      
+                        
+                          customer_access_token_lifetime -
+                          
+                            Float
+                          
+                        
+                         Customer access token lifetime. 
+                      
                       
                         
                           default_country -
@@ -85945,6 +87908,24 @@ 
    Fields
    
                         
                          If multiple wish lists are enabled, the maximum number of wish lists the customer can have. 
                       
+                      
+                        
+                          minicart_display -
+                          
+                            Boolean
+                          
+                        
+                         Extended Config Data - checkout/sidebar/display 
+                      
+                      
+                        
+                          minicart_max_items -
+                          
+                            Int
+                          
+                        
+                         Extended Config Data - checkout/sidebar/count 
+                      
                       
                         
                           minimum_password_length -
@@ -86208,6 +88189,15 @@ 
    Fields
    
                         
                          Extended Config Data - tax/cart_display/subtotal 
                       
+                      
+                        
+                          shopping_cart_display_tax_gift_wrapping -
+                          
+                            TaxWrappingEnum
+                          
+                        
+                         Extended Config Data - tax/cart_display/gift_wrapping 
+                      
                       
                         
                           shopping_cart_display_zero_tax -
@@ -86437,11 +88427,11 @@ 
    Example
    
                   
                   
    {
   "absolute_footer": "abc123",
-  "allow_gift_receipt": "abc123",
+  "allow_gift_receipt": "xyz789",
   "allow_gift_wrapping_on_order": "xyz789",
   "allow_gift_wrapping_on_order_items": "abc123",
   "allow_guests_to_write_product_reviews": "xyz789",
-  "allow_items": "abc123",
+  "allow_items": "xyz789",
   "allow_order": "xyz789",
   "allow_printed_card": "abc123",
   "autocomplete_on_storefront": false,
@@ -86453,20 +88443,20 @@ 
    Example
    
   "braintree_3dsecure_allowspecific": true,
   "braintree_3dsecure_always_request_3ds": false,
   "braintree_3dsecure_specificcountry": "xyz789",
-  "braintree_3dsecure_threshold_amount": "abc123",
-  "braintree_3dsecure_verify_3dsecure": true,
+  "braintree_3dsecure_threshold_amount": "xyz789",
+  "braintree_3dsecure_verify_3dsecure": false,
   "braintree_ach_direct_debit_vault_active": true,
-  "braintree_applepay_merchant_name": "xyz789",
-  "braintree_applepay_vault_active": 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_cc_vault_cvv": true,
+  "braintree_environment": "xyz789",
   "braintree_googlepay_btn_color": "abc123",
-  "braintree_googlepay_cctypes": "xyz789",
-  "braintree_googlepay_merchant_id": "xyz789",
+  "braintree_googlepay_cctypes": "abc123",
+  "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_allowed_methods": "xyz789",
+  "braintree_local_payment_fallback_button_text": "xyz789",
   "braintree_local_payment_redirect_on_fail": "abc123",
   "braintree_merchant_account_id": "xyz789",
   "braintree_paypal_button_location_cart_type_credit_color": "xyz789",
@@ -86474,177 +88464,184 @@ 
    Example
    
   "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_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_messaging_show": true,
+  "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
   "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
   "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
-  "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
+  "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789",
   "braintree_paypal_button_location_cart_type_paylater_show": false,
   "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
   "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
-  "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789",
-  "braintree_paypal_button_location_cart_type_paypal_show": false,
-  "braintree_paypal_button_location_checkout_type_credit_color": "xyz789",
-  "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
+  "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
+  "braintree_paypal_button_location_cart_type_paypal_show": true,
+  "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
+  "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
   "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
-  "braintree_paypal_button_location_checkout_type_credit_show": false,
+  "braintree_paypal_button_location_checkout_type_credit_show": true,
   "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
   "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
   "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123",
-  "braintree_paypal_button_location_checkout_type_messaging_show": true,
-  "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789",
-  "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
-  "braintree_paypal_button_location_checkout_type_paylater_label": "abc123",
+  "braintree_paypal_button_location_checkout_type_messaging_show": false,
+  "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
+  "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
+  "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
   "braintree_paypal_button_location_checkout_type_paylater_shape": "abc123",
   "braintree_paypal_button_location_checkout_type_paylater_show": true,
-  "braintree_paypal_button_location_checkout_type_paypal_color": "xyz789",
-  "braintree_paypal_button_location_checkout_type_paypal_label": "abc123",
+  "braintree_paypal_button_location_checkout_type_paypal_color": "abc123",
+  "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
   "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
   "braintree_paypal_button_location_checkout_type_paypal_show": true,
-  "braintree_paypal_button_location_productpage_type_credit_color": "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_color": "abc123",
+  "braintree_paypal_button_location_productpage_type_credit_label": "xyz789",
+  "braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
   "braintree_paypal_button_location_productpage_type_credit_show": true,
-  "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123",
+  "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
   "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
-  "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
+  "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123",
   "braintree_paypal_button_location_productpage_type_messaging_show": false,
   "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
-  "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
-  "braintree_paypal_button_location_productpage_type_paylater_label": "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_color": "xyz789",
+  "braintree_paypal_button_location_productpage_type_paylater_label": "abc123",
+  "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
+  "braintree_paypal_button_location_productpage_type_paylater_show": true,
   "braintree_paypal_button_location_productpage_type_paypal_color": "abc123",
-  "braintree_paypal_button_location_productpage_type_paypal_label": "xyz789",
-  "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789",
-  "braintree_paypal_button_location_productpage_type_paypal_show": false,
-  "braintree_paypal_credit_uk_merchant_name": "abc123",
-  "braintree_paypal_display_on_shopping_cart": true,
+  "braintree_paypal_button_location_productpage_type_paypal_label": "abc123",
+  "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123",
+  "braintree_paypal_button_location_productpage_type_paypal_show": true,
+  "braintree_paypal_credit_uk_merchant_name": "xyz789",
+  "braintree_paypal_display_on_shopping_cart": 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": true,
-  "braintree_paypal_vault_active": true,
+  "braintree_paypal_send_cart_line_items": false,
+  "braintree_paypal_vault_active": false,
+  "cart_expires_in_days": 987,
   "cart_gift_wrapping": "xyz789",
   "cart_printed_card": "abc123",
-  "catalog_default_sort_by": "abc123",
+  "cart_summary_display_quantity": 987,
+  "catalog_default_sort_by": "xyz789",
   "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-  "category_url_suffix": "xyz789",
-  "check_money_order_enable_for_specific_countries": false,
+  "category_url_suffix": "abc123",
+  "check_money_order_enable_for_specific_countries": true,
   "check_money_order_enabled": false,
-  "check_money_order_make_check_payable_to": "xyz789",
+  "check_money_order_make_check_payable_to": "abc123",
   "check_money_order_max_order_total": "xyz789",
   "check_money_order_min_order_total": "xyz789",
   "check_money_order_new_order_status": "abc123",
-  "check_money_order_payment_from_specific_countries": "abc123",
-  "check_money_order_send_check_to": "abc123",
-  "check_money_order_sort_order": 123,
+  "check_money_order_payment_from_specific_countries": "xyz789",
+  "check_money_order_send_check_to": "xyz789",
+  "check_money_order_sort_order": 987,
   "check_money_order_title": "abc123",
   "cms_home_page": "xyz789",
-  "cms_no_cookies": "xyz789",
+  "cms_no_cookies": "abc123",
   "cms_no_route": "xyz789",
   "code": "xyz789",
-  "configurable_thumbnail_source": "abc123",
-  "contact_enabled": false,
-  "copyright": "xyz789",
-  "countries_with_required_region": "xyz789",
-  "default_country": "abc123",
-  "default_description": "abc123",
+  "configurable_thumbnail_source": "xyz789",
+  "contact_enabled": true,
+  "copyright": "abc123",
+  "countries_with_required_region": "abc123",
+  "create_account_confirmation": true,
+  "customer_access_token_lifetime": 987.65,
+  "default_country": "xyz789",
+  "default_description": "xyz789",
   "default_display_currency_code": "abc123",
   "default_keywords": "xyz789",
   "default_title": "xyz789",
   "demonotice": 123,
   "display_state_if_optional": true,
-  "enable_multiple_wishlists": "abc123",
+  "enable_multiple_wishlists": "xyz789",
   "front": "xyz789",
   "grid_per_page": 123,
-  "grid_per_page_values": "abc123",
+  "grid_per_page_values": "xyz789",
   "head_includes": "abc123",
-  "head_shortcut_icon": "abc123",
-  "header_logo_src": "xyz789",
+  "head_shortcut_icon": "xyz789",
+  "header_logo_src": "abc123",
   "id": 987,
-  "is_default_store": false,
-  "is_default_store_group": false,
+  "is_default_store": true,
+  "is_default_store_group": true,
   "is_guest_checkout_enabled": false,
   "is_negotiable_quote_active": true,
   "is_one_page_checkout_enabled": false,
-  "is_requisition_list_active": "abc123",
-  "list_mode": "xyz789",
-  "list_per_page": 123,
-  "list_per_page_values": "xyz789",
+  "is_requisition_list_active": "xyz789",
+  "list_mode": "abc123",
+  "list_per_page": 987,
+  "list_per_page_values": "abc123",
   "locale": "xyz789",
-  "logo_alt": "xyz789",
-  "logo_height": 987,
-  "logo_width": 987,
+  "logo_alt": "abc123",
+  "logo_height": 123,
+  "logo_width": 123,
   "magento_reward_general_is_enabled": "xyz789",
   "magento_reward_general_is_enabled_on_front": "xyz789",
   "magento_reward_general_min_points_balance": "xyz789",
-  "magento_reward_general_publish_history": "abc123",
+  "magento_reward_general_publish_history": "xyz789",
   "magento_reward_points_invitation_customer": "abc123",
-  "magento_reward_points_invitation_customer_limit": "xyz789",
-  "magento_reward_points_invitation_order": "abc123",
-  "magento_reward_points_invitation_order_limit": "xyz789",
+  "magento_reward_points_invitation_customer_limit": "abc123",
+  "magento_reward_points_invitation_order": "xyz789",
+  "magento_reward_points_invitation_order_limit": "abc123",
   "magento_reward_points_newsletter": "abc123",
-  "magento_reward_points_order": "abc123",
+  "magento_reward_points_order": "xyz789",
   "magento_reward_points_register": "xyz789",
   "magento_reward_points_review": "abc123",
   "magento_reward_points_review_limit": "abc123",
-  "magento_wishlist_general_is_enabled": "xyz789",
+  "magento_wishlist_general_is_enabled": "abc123",
   "max_items_in_order_summary": 123,
-  "maximum_number_of_wishlists": "xyz789",
+  "maximum_number_of_wishlists": "abc123",
+  "minicart_display": true,
+  "minicart_max_items": 987,
   "minimum_password_length": "xyz789",
   "newsletter_enabled": false,
-  "no_route": "abc123",
-  "optional_zip_countries": "xyz789",
-  "order_cancellation_enabled": false,
+  "no_route": "xyz789",
+  "optional_zip_countries": "abc123",
+  "order_cancellation_enabled": true,
   "order_cancellation_reasons": [CancellationReason],
   "payment_payflowpro_cc_vault_active": "abc123",
   "printed_card_price": "abc123",
   "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-  "product_reviews_enabled": "xyz789",
+  "product_reviews_enabled": "abc123",
   "product_url_suffix": "xyz789",
-  "quickorder_active": false,
+  "quickorder_active": true,
   "required_character_classes_number": "abc123",
-  "returns_enabled": "abc123",
-  "root_category_id": 987,
+  "returns_enabled": "xyz789",
+  "root_category_id": 123,
   "root_category_uid": "4",
   "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
   "sales_gift_wrapping": "abc123",
   "sales_printed_card": "abc123",
   "secure_base_link_url": "xyz789",
-  "secure_base_media_url": "abc123",
+  "secure_base_media_url": "xyz789",
   "secure_base_static_url": "xyz789",
-  "secure_base_url": "xyz789",
+  "secure_base_url": "abc123",
   "send_friend": SendFriendConfiguration,
-  "shopping_cart_display_full_summary": true,
-  "shopping_cart_display_grand_total": true,
+  "shopping_cart_display_full_summary": false,
+  "shopping_cart_display_grand_total": false,
   "shopping_cart_display_price": 987,
-  "shopping_cart_display_shipping": 987,
-  "shopping_cart_display_subtotal": 123,
-  "shopping_cart_display_zero_tax": false,
+  "shopping_cart_display_shipping": 123,
+  "shopping_cart_display_subtotal": 987,
+  "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
+  "shopping_cart_display_zero_tax": true,
   "show_cms_breadcrumbs": 987,
   "store_code": "4",
   "store_group_code": 4,
   "store_group_name": "abc123",
   "store_name": "xyz789",
-  "store_sort_order": 123,
+  "store_sort_order": 987,
   "timezone": "xyz789",
-  "title_prefix": "abc123",
+  "title_prefix": "xyz789",
   "title_separator": "abc123",
   "title_suffix": "abc123",
-  "use_store_in_url": true,
+  "use_store_in_url": false,
   "website_code": "4",
   "website_id": 987,
-  "website_name": "xyz789",
+  "website_name": "abc123",
   "weight_unit": "xyz789",
   "welcome": "xyz789",
   "zero_subtotal_enable_for_specific_countries": true,
-  "zero_subtotal_enabled": false,
+  "zero_subtotal_enabled": true,
   "zero_subtotal_new_order_status": "xyz789",
   "zero_subtotal_payment_action": "abc123",
-  "zero_subtotal_payment_from_specific_countries": "xyz789",
+  "zero_subtotal_payment_from_specific_countries": "abc123",
   "zero_subtotal_sort_order": 123,
   "zero_subtotal_title": "abc123"
 }
@@ -86732,7 +88729,7 @@ 
    Example
    
                   
    {
   "position": 123,
   "use_in_layered_navigation": "NO",
-  "use_in_product_listing": true,
+  "use_in_product_listing": false,
   "use_in_search_results_layered_navigation": true,
   "visible_on_catalog_pages": false
 }
@@ -86923,7 +88920,7 @@ 
    Example
    
                   
                   
    {
   "type": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
     
                   
@@ -86999,7 +88996,7 @@ 
    Possible Types
    
                   
    Example
    
                   
                   
-                  
    {"value": "abc123"}
+                  
    {"value": "xyz789"}
 
     
                   
                 
    
@@ -87220,7 +89217,7 @@ 
    Example
    
                   
                   
                   
    {
-  "items_count": 987,
+  "items_count": 123,
   "label": "abc123",
   "swatch_data": SwatchData,
   "value_string": "abc123"
@@ -87416,6 +89413,57 @@ 
    Example
    
   "rate": 123.45,
   "title": "abc123"
 }
+
     
+                  
+                
    
+              
+            
+          
    
+          
    
+            
    
+              Types
+            
    
+            
    TaxWrappingEnum
    
+            
    
+              
    
+                
    
+                  
    Values
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                    
+                  
    Enum ValueDescription
    
+                          
    DISPLAY_EXCLUDING_TAX
    
+                            		 
    
+                          
    DISPLAY_INCLUDING_TAX
    
+                            		 
    
+                          
    DISPLAY_TYPE_BOTH
    
+                            		 
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    "DISPLAY_EXCLUDING_TAX"
 
     
                   
                 
    
@@ -87457,7 +89505,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"value": "abc123"}
+                  
    {"value": "xyz789"}
 
     
                   
                 
    
@@ -87971,7 +90019,7 @@ 
    Example
    
     GiftRegistryDynamicAttributeInput
   ],
   "event_name": "abc123",
-  "message": "xyz789",
+  "message": "abc123",
   "privacy_settings": "PRIVATE",
   "shipping_address": GiftRegistryShippingAddressInput,
   "status": "ACTIVE"
@@ -88048,7 +90096,7 @@ 
    Example
    
                   
    {
   "gift_registry_item_uid": "4",
   "note": "abc123",
-  "quantity": 123.45
+  "quantity": 987.65
 }
 
     
                   
@@ -88238,7 +90286,7 @@ 
    Example
    
     GiftRegistryDynamicAttributeInput
   ],
   "email": "xyz789",
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "gift_registry_registrant_uid": "4",
   "lastname": "xyz789"
 }
@@ -88394,7 +90442,7 @@ 
    Example
    
                   
                   
    {
   "items": [NegotiableQuoteItemQuantityInput],
-  "quote_uid": "4"
+  "quote_uid": 4
 }
 
     
                   
@@ -88568,13 +90616,13 @@ 
    Example
    
                   
                   
                   
    {
-  "applies_to": ["4"],
+  "applies_to": [4],
   "approvers": [4],
   "condition": CreatePurchaseOrderApprovalRuleConditionInput,
-  "description": "xyz789",
-  "name": "abc123",
+  "description": "abc123",
+  "name": "xyz789",
   "status": "ENABLED",
-  "uid": "4"
+  "uid": 4
 }
 
     
                   
@@ -88635,8 +90683,8 @@ 
    Example
    
                   
                   
                   
    {
-  "description": "xyz789",
-  "name": "abc123"
+  "description": "abc123",
+  "name": "xyz789"
 }
 
     
                   
@@ -88721,8 +90769,8 @@ 
    Example
    
                   
    {
   "entered_options": [EnteredOptionInput],
   "item_id": 4,
-  "quantity": 123.45,
-  "selected_options": ["xyz789"]
+  "quantity": 987.65,
+  "selected_options": ["abc123"]
 }
 
     
                   
@@ -88881,7 +90929,7 @@ 
    Example
    
                   
                   
    {
   "name": "xyz789",
-  "uid": "4",
+  "uid": 4,
   "visibility": "PUBLIC"
 }
 
     
@@ -89217,7 +91265,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"purchase_order_uids": [4]}
+                  
    {"purchase_order_uids": ["4"]}
 
     
                   
                 
    
@@ -89506,10 +91554,10 @@ 
    Example
    
                   
                   
                   
    {
-  "payment_source": "abc123",
-  "payments_order_id": "abc123",
-  "paypal_order_id": "xyz789",
-  "public_hash": "xyz789"
+  "payment_source": "xyz789",
+  "payments_order_id": "xyz789",
+  "paypal_order_id": "abc123",
+  "public_hash": "abc123"
 }
 
     
                   
@@ -89700,8 +91748,8 @@ 
    Example
    
   "customizable_options": [SelectedCustomizableOption],
   "discount": [Discount],
   "errors": [CartItemError],
-  "id": "xyz789",
-  "is_available": false,
+  "id": "abc123",
+  "is_available": true,
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
@@ -90562,53 +92610,53 @@ 
    Example
    
                   
                   
                   
    {
-  "activity": "xyz789",
-  "attribute_set_id": 123,
-  "canonical_url": "abc123",
+  "activity": "abc123",
+  "attribute_set_id": 987,
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "xyz789",
-  "collar": "abc123",
+  "category_gear": "xyz789",
+  "climate": "abc123",
+  "collar": "xyz789",
   "color": 123,
   "country_of_manufacture": "abc123",
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "eco_collection": 123,
   "erin_recommends": 123,
-  "features_bags": "abc123",
+  "features_bags": "xyz789",
   "format": 987,
-  "gender": "xyz789",
-  "gift_message_available": "abc123",
+  "gender": "abc123",
+  "gift_message_available": "xyz789",
   "id": 987,
   "image": ProductImage,
   "is_returnable": "abc123",
-  "manufacturer": 123,
-  "material": "xyz789",
+  "manufacturer": 987,
+  "material": "abc123",
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "xyz789",
-  "meta_keyword": "xyz789",
+  "meta_description": "abc123",
+  "meta_keyword": "abc123",
   "meta_title": "abc123",
-  "name": "xyz789",
-  "new": 987,
-  "new_from_date": "abc123",
-  "new_to_date": "abc123",
+  "name": "abc123",
+  "new": 123,
+  "new_from_date": "xyz789",
+  "new_to_date": "xyz789",
   "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
   "options_container": "abc123",
-  "pattern": "abc123",
-  "performance_fabric": 123,
+  "pattern": "xyz789",
+  "performance_fabric": 987,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
   "purpose": 123,
-  "rating_summary": 123.45,
+  "rating_summary": 987.65,
   "redirect_code": 987,
   "related_products": [ProductInterface],
-  "relative_url": "xyz789",
+  "relative_url": "abc123",
   "review_count": 123,
   "reviews": ProductReviews,
   "sale": 123,
@@ -90617,10 +92665,10 @@ 
    Example
    
   "sku": "abc123",
   "sleeve": "xyz789",
   "small_image": ProductImage,
-  "special_from_date": "xyz789",
+  "special_from_date": "abc123",
   "special_price": 987.65,
-  "special_to_date": "abc123",
-  "staged": true,
+  "special_to_date": "xyz789",
+  "staged": false,
   "stock_status": "IN_STOCK",
   "strap_bags": "abc123",
   "style_bags": "xyz789",
@@ -90628,17 +92676,17 @@ 
    Example
    
   "style_general": "xyz789",
   "swatch_image": "xyz789",
   "thumbnail": ProductImage,
-  "tier_price": 987.65,
+  "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "abc123",
-  "uid": 4,
-  "updated_at": "abc123",
+  "type_id": "xyz789",
+  "uid": "4",
+  "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
   "url_key": "xyz789",
-  "url_path": "abc123",
+  "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "abc123",
+  "url_suffix": "xyz789",
   "websites": [Website]
 }
 
     
@@ -90778,7 +92826,7 @@ 
    Example
    
                   
    {
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": "4"
 }
 
     
@@ -90872,10 +92920,10 @@ 
    Example
    
                   
                   
                   
    {
-  "added_at": "xyz789",
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
-  "id": 4,
+  "description": "xyz789",
+  "id": "4",
   "product": ProductInterface,
   "quantity": 987.65
 }
@@ -90982,12 +93030,12 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "xyz789",
-  "default_group_id": "abc123",
-  "id": 987,
-  "is_default": false,
-  "name": "xyz789",
-  "sort_order": 987
+  "code": "abc123",
+  "default_group_id": "xyz789",
+  "id": 123,
+  "is_default": true,
+  "name": "abc123",
+  "sort_order": 123
 }
 
     
                   
@@ -91234,11 +93282,11 @@ 
    Example
    
                   
    {
   "id": 4,
   "items": [WishlistItem],
-  "items_count": 123,
+  "items_count": 987,
   "items_v2": WishlistItems,
   "name": "abc123",
   "sharing_code": "abc123",
-  "updated_at": "abc123",
+  "updated_at": "xyz789",
   "visibility": "PUBLIC"
 }
 
     
@@ -91317,7 +93365,7 @@ 
    Example
    
   "code": "PRODUCT_NOT_FOUND",
   "message": "xyz789",
   "wishlistId": "4",
-  "wishlistItemId": 4
+  "wishlistItemId": "4"
 }
 
     
                   
@@ -91462,9 +93510,9 @@ 
    Example
    
                   
                   
                   
    {
-  "added_at": "abc123",
-  "description": "xyz789",
-  "id": 123,
+  "added_at": "xyz789",
+  "description": "abc123",
+  "id": 987,
   "product": ProductInterface,
   "qty": 123.45
 }
@@ -91526,10 +93574,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {
-  "quantity": 987.65,
-  "wishlist_item_id": "4"
-}
+                  
    {"quantity": 123.45, "wishlist_item_id": 4}
 
     
                   
                 
@@ -91625,8 +93670,8 @@ 
    Example
    
   "entered_options": [EnteredOptionInput],
   "parent_sku": "xyz789",
   "quantity": 987.65,
-  "selected_options": ["4"],
-  "sku": "xyz789"
+  "selected_options": [4],
+  "sku": "abc123"
 }
 
     
                   
@@ -91780,10 +93825,10 @@ 
    Example
    
                   
                   
                   
    {
-  "added_at": "abc123",
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
-  "id": 4,
+  "id": "4",
   "product": ProductInterface,
   "quantity": 987.65
 }
@@ -91938,11 +93983,11 @@ 
    Example
    
                   
                   
                   
    {
-  "description": "abc123",
+  "description": "xyz789",
   "entered_options": [EnteredOptionInput],
-  "quantity": 123.45,
+  "quantity": 987.65,
   "selected_options": [4],
-  "wishlist_item_id": "4"
+  "wishlist_item_id": 4
 }
 
     
                   
@@ -92096,9 +94141,9 @@ 
    Example
    
                   
    {
   "items": [WishlistItem],
   "items_count": 987,
-  "name": "xyz789",
+  "name": "abc123",
   "sharing_code": "xyz789",
-  "updated_at": "xyz789"
+  "updated_at": "abc123"
 }
 
     
                   

From e671fb06f8be9be1e8cb3ce1335b3ab085dd1035 Mon Sep 17 00:00:00 2001
From: jhadobe 
Date: Tue, 9 Apr 2024 11:09:02 -0500
Subject: [PATCH 2/6] update beta links

---
 .../schema/attributes/interfaces/index.md        |  8 ++++----
 .../schema/attributes/queries/attributes-form.md |  2 +-
 .../schema/attributes/queries/attributes-list.md |  2 +-
 .../queries/custom-attribute-metadata-v2.md      |  2 +-
 .../b2b/purchase-order-rule/interfaces/index.md  |  6 +++---
 .../b2b/requisition-list/interfaces/index.md     | 14 +++++++-------
 .../b2b/requisition-list/interfaces/item.md      | 14 +++++++-------
 .../graphql/schema/cart/interfaces/index.md      | 14 +++++++-------
 src/pages/graphql/schema/customer/index.md       |  2 +-
 .../schema/products/interfaces/attributes.md     |  2 +-
 .../schema/products/interfaces/category.md       |  2 +-
 .../products/interfaces/customizable-option.md   |  2 +-
 .../graphql/schema/products/interfaces/index.md  |  2 +-
 .../schema/products/interfaces/routable.md       |  2 +-
 .../schema/products/interfaces/types/bundle.md   | 10 +++++-----
 .../products/interfaces/types/configurable.md    |  8 ++++----
 .../products/interfaces/types/downloadable.md    |  2 +-
 .../products/interfaces/types/gift-card.md       |  8 ++++----
 .../schema/products/interfaces/types/grouped.md  |  2 +-
 .../schema/products/interfaces/types/index.md    | 16 ++++++++--------
 .../schema/products/interfaces/types/simple.md   |  8 ++++----
 .../schema/products/interfaces/types/virtual.md  |  6 +++---
 .../graphql/schema/store/mutations/contact-us.md |  2 +-
 .../schema/store/queries/recaptcha-v3-config.md  |  2 +-
 24 files changed, 69 insertions(+), 69 deletions(-)

diff --git a/src/pages/graphql/schema/attributes/interfaces/index.md b/src/pages/graphql/schema/attributes/interfaces/index.md
index 28dd8667d..0cb4be9c9 100644
--- a/src/pages/graphql/schema/attributes/interfaces/index.md
+++ b/src/pages/graphql/schema/attributes/interfaces/index.md
@@ -11,10 +11,10 @@ Adobe Commerce provides the following interfaces to access system attributes and
 
 Interface | Implementations
 --- | ---
-[`AttributeSelectedOptionInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-AttributeSelectedOptionInterface) | [`AttributeSelectedOption`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-AttributeSelectedOption)
-[`AttributeValueInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-AttributeValueInterface) | [`AttributeValue`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-AttributeValue) 
    [`AttributeSelectedOptions`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-AttributeSelectedOptions)
-[`CustomAttributeMetadataInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-CustomerAttributeMetadata) | [`AttributeMetadata`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-AttributeMetadata)
-[`CustomAttributeOptionInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-CustomAttributeOptionInterface) | [`AttributeOptionMetadata`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-AttributeOptionMetadata).
+[`AttributeSelectedOptionInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeSelectedOptionInterface) | [`AttributeSelectedOption`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeSelectedOption)
+[`AttributeValueInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeValueInterface) | [`AttributeValue`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeValue) 
    [`AttributeSelectedOptions`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeSelectedOptions)
+[`CustomAttributeMetadataInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-CustomerAttributeMetadata) | [`AttributeMetadata`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeMetadata)
+[`CustomAttributeOptionInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-CustomAttributeOptionInterface) | [`AttributeOptionMetadata`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeOptionMetadata).
 
 ## Example usage
 
diff --git a/src/pages/graphql/schema/attributes/queries/attributes-form.md b/src/pages/graphql/schema/attributes/queries/attributes-form.md
index 963c97d49..a79a10dfe 100644
--- a/src/pages/graphql/schema/attributes/queries/attributes-form.md
+++ b/src/pages/graphql/schema/attributes/queries/attributes-form.md
@@ -31,7 +31,7 @@ You cannot query on the Admin Checkout form.
 
 ## Reference
 
-The [`attributesForm`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#query-attributesForm) reference provides detailed information about the types and fields defined in this query.
+The [`attributesForm`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#query-attributesForm) reference provides detailed information about the types and fields defined in this query.
 
 ## Example usage
 
diff --git a/src/pages/graphql/schema/attributes/queries/attributes-list.md b/src/pages/graphql/schema/attributes/queries/attributes-list.md
index 8571693f8..50a631e63 100644
--- a/src/pages/graphql/schema/attributes/queries/attributes-list.md
+++ b/src/pages/graphql/schema/attributes/queries/attributes-list.md
@@ -14,7 +14,7 @@ The possible values for this attribute are populated by the modules introducing
 
 ## Reference
 
-The [`attributesList`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#query-attributesList) reference provides detailed information about the types and fields defined in this query.
+The [`attributesList`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#query-attributesList) reference provides detailed information about the types and fields defined in this query.
 
 ## Example usage
 
diff --git a/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata-v2.md b/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata-v2.md
index 8ea5badbe..27591fb70 100644
--- a/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata-v2.md
+++ b/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata-v2.md
@@ -19,7 +19,7 @@ This new query has several features that were not available in the deprecated qu
 
 ## Reference
 
-The [`customAttributeMetadataV2`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#query-customAttributeMetadataV2) reference provides detailed information about the types and fields defined in this query.
+The [`customAttributeMetadataV2`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#query-customAttributeMetadataV2) reference provides detailed information about the types and fields defined in this query.
 
 ## Example usage
 
diff --git a/src/pages/graphql/schema/b2b/purchase-order-rule/interfaces/index.md b/src/pages/graphql/schema/b2b/purchase-order-rule/interfaces/index.md
index 011209578..b4c20958e 100644
--- a/src/pages/graphql/schema/b2b/purchase-order-rule/interfaces/index.md
+++ b/src/pages/graphql/schema/b2b/purchase-order-rule/interfaces/index.md
@@ -5,10 +5,10 @@ edition: b2b
 
 # PurchaseOrderApprovalRuleConditionInterface attributes and implementations
 
-[`PurchaseOrderApprovalRuleConditionInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-PurchaseOrderApprovalRuleConditionInterface) provides details about the approval rule conditions. It has the following implementations:
+[`PurchaseOrderApprovalRuleConditionInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-PurchaseOrderApprovalRuleConditionInterface) provides details about the approval rule conditions. It has the following implementations:
 
-*  [`PurchaseOrderApprovalRuleConditionAmount`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-PurchaseOrderApprovalRuleConditionAmount)
-*  [`PurchaseOrderApprovalRuleConditionQuantity`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-PurchaseOrderApprovalRuleConditionQuantity)
+*  [`PurchaseOrderApprovalRuleConditionAmount`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-PurchaseOrderApprovalRuleConditionAmount)
+*  [`PurchaseOrderApprovalRuleConditionQuantity`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-PurchaseOrderApprovalRuleConditionQuantity)
 
 ## Example usage
 
diff --git a/src/pages/graphql/schema/b2b/requisition-list/interfaces/index.md b/src/pages/graphql/schema/b2b/requisition-list/interfaces/index.md
index d2e0d73e9..a6d4fa144 100644
--- a/src/pages/graphql/schema/b2b/requisition-list/interfaces/index.md
+++ b/src/pages/graphql/schema/b2b/requisition-list/interfaces/index.md
@@ -5,14 +5,14 @@ edition: b2b
 
 # RequisitionListItemInterface attributes and implementations
 
-[`RequisitionListItemInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-RequisitionListItemInterface) provides details about items in a requisition list. It has the following implementations:
+[`RequisitionListItemInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-RequisitionListItemInterface) provides details about items in a requisition list. It has the following implementations:
 
-*  [`BundleRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-BundleRequisitionListItem)
-*  [`ConfigurableRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ConfigurableRequisitionListItem)
-*  [`DownloadableRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-DownloadableRequisitionListItem)
-*  [`GiftCardRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-GiftCardRequisitionListItem)
-*  [`SimpleRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-SimpleRequisitionListItem)
-*  [`VirtualRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-VirtualRequisitionListItem)
+*  [`BundleRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-BundleRequisitionListItem)
+*  [`ConfigurableRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ConfigurableRequisitionListItem)
+*  [`DownloadableRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-DownloadableRequisitionListItem)
+*  [`GiftCardRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-GiftCardRequisitionListItem)
+*  [`SimpleRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-SimpleRequisitionListItem)
+*  [`VirtualRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-VirtualRequisitionListItem)
 
 
 
diff --git a/src/pages/graphql/schema/b2b/requisition-list/interfaces/item.md b/src/pages/graphql/schema/b2b/requisition-list/interfaces/item.md
index d2e0d73e9..a6d4fa144 100644
--- a/src/pages/graphql/schema/b2b/requisition-list/interfaces/item.md
+++ b/src/pages/graphql/schema/b2b/requisition-list/interfaces/item.md
@@ -5,14 +5,14 @@ edition: b2b
 
 # RequisitionListItemInterface attributes and implementations
 
-[`RequisitionListItemInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-RequisitionListItemInterface) provides details about items in a requisition list. It has the following implementations:
+[`RequisitionListItemInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-RequisitionListItemInterface) provides details about items in a requisition list. It has the following implementations:
 
-*  [`BundleRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-BundleRequisitionListItem)
-*  [`ConfigurableRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ConfigurableRequisitionListItem)
-*  [`DownloadableRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-DownloadableRequisitionListItem)
-*  [`GiftCardRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-GiftCardRequisitionListItem)
-*  [`SimpleRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-SimpleRequisitionListItem)
-*  [`VirtualRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-VirtualRequisitionListItem)
+*  [`BundleRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-BundleRequisitionListItem)
+*  [`ConfigurableRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ConfigurableRequisitionListItem)
+*  [`DownloadableRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-DownloadableRequisitionListItem)
+*  [`GiftCardRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-GiftCardRequisitionListItem)
+*  [`SimpleRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-SimpleRequisitionListItem)
+*  [`VirtualRequisitionListItem`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-VirtualRequisitionListItem)
 
 
 
diff --git a/src/pages/graphql/schema/cart/interfaces/index.md b/src/pages/graphql/schema/cart/interfaces/index.md
index fac3dd665..7b3f3c388 100644
--- a/src/pages/graphql/schema/cart/interfaces/index.md
+++ b/src/pages/graphql/schema/cart/interfaces/index.md
@@ -4,14 +4,14 @@ title: CartItemInterface attributes and implementations
 
 # CartItemInterface attributes and implementations
 
-The [`CartItemInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-CartItemInterface) has the following implementations:
+The [`CartItemInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-CartItemInterface) has the following implementations:
 
-*  [BundleCartItem]https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-BundleCartItem
-*  [ConfigurableCartItem](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ConfigurableCartItem)
-*  [DownloadableCartItem](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-DownloadableCartItem)
-*  [GiftCardCartItem](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-GiftCardCartItem)
-*  [SimpleCartItem](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-SimpleCartItem)
-*  [VirtualCartItem](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-VirtualCartItem)
+*  [BundleCartItem]https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-BundleCartItem
+*  [ConfigurableCartItem](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ConfigurableCartItem)
+*  [DownloadableCartItem](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-DownloadableCartItem)
+*  [GiftCardCartItem](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-GiftCardCartItem)
+*  [SimpleCartItem](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-SimpleCartItem)
+*  [VirtualCartItem](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-VirtualCartItem)
 
 ## Example usage
 
diff --git a/src/pages/graphql/schema/customer/index.md b/src/pages/graphql/schema/customer/index.md
index 0e53977c8..595fb2a49 100644
--- a/src/pages/graphql/schema/customer/index.md
+++ b/src/pages/graphql/schema/customer/index.md
@@ -8,7 +8,7 @@ A customer is a shopper who has created an account for the store.
 
 To return or modify information about a customer, we recommend you use [customer tokens](../../usage/authorization-tokens.md) in the header of your GraphQL calls. However, you also can use [session authentication](https://developer.adobe.com/commerce/webapi/get-started/authentication/gs-authentication-session).
 
-B2B for Adobe Commerce adds the following top-level fields to the [`Customer`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-Customer) object for company administrators and users.
+B2B for Adobe Commerce adds the following top-level fields to the [`Customer`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-Customer) object for company administrators and users.
 
 * `job_title`
 * `requisition_lists`
diff --git a/src/pages/graphql/schema/products/interfaces/attributes.md b/src/pages/graphql/schema/products/interfaces/attributes.md
index cf8273b4f..aa2db8b7e 100644
--- a/src/pages/graphql/schema/products/interfaces/attributes.md
+++ b/src/pages/graphql/schema/products/interfaces/attributes.md
@@ -4,7 +4,7 @@ title: ProductInterface attributes
 
 # ProductInterface attributes
 
-Any type that implements [`ProductInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface) contains all the base attributes necessary for the frontend of the product model.
+Any type that implements [`ProductInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface) contains all the base attributes necessary for the frontend of the product model.
 The `items` that are returned in a `ProductInterface` array can also contain attributes from resources external to the `CatalogGraphQl` module:
 
 -  Custom and extension attributes defined in any attribute set
diff --git a/src/pages/graphql/schema/products/interfaces/category.md b/src/pages/graphql/schema/products/interfaces/category.md
index 80bd29822..bb72a1acb 100644
--- a/src/pages/graphql/schema/products/interfaces/category.md
+++ b/src/pages/graphql/schema/products/interfaces/category.md
@@ -4,4 +4,4 @@ title: CategoryInterface attributes
 
 # CategoryInterface attributes
 
-[`CategoryInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-CategoryInterface) defines attributes that can be returned in the [`categoryList` query](../queries/category-list.md), [`categories` query](../queries/categories.md), and the [`products` query](../queries/products.md).
+[`CategoryInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-CategoryInterface) defines attributes that can be returned in the [`categoryList` query](../queries/category-list.md), [`categories` query](../queries/categories.md), and the [`products` query](../queries/products.md).
diff --git a/src/pages/graphql/schema/products/interfaces/customizable-option.md b/src/pages/graphql/schema/products/interfaces/customizable-option.md
index 9d57c9299..07f9843a0 100644
--- a/src/pages/graphql/schema/products/interfaces/customizable-option.md
+++ b/src/pages/graphql/schema/products/interfaces/customizable-option.md
@@ -6,7 +6,7 @@ title: CustomizableOptionInterface
 
 Customizable options for a product provide a way to offer customers a selection of options with a variety of text, selection, and date input types. All product types can contain customizable options.
 
-[`CustomizableOptionInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-CustomizableOptionInterface) is defined in the `CatalogGraphQl` module, and its attributes can be used in any `products` query. This interface returns basic information about a customizable option and can be implemented by several types of configurable options:
+[`CustomizableOptionInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-CustomizableOptionInterface) is defined in the `CatalogGraphQl` module, and its attributes can be used in any `products` query. This interface returns basic information about a customizable option and can be implemented by several types of configurable options:
 
 *  Text area
 *  Checkbox
diff --git a/src/pages/graphql/schema/products/interfaces/index.md b/src/pages/graphql/schema/products/interfaces/index.md
index baea06fea..30650a02a 100644
--- a/src/pages/graphql/schema/products/interfaces/index.md
+++ b/src/pages/graphql/schema/products/interfaces/index.md
@@ -4,7 +4,7 @@ title: Product interfaces and attributes
 
 # Product interfaces and attributes
 
-Any type that implements [`ProductInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface) contains all the base attributes necessary for the frontend of the product model.
+Any type that implements [`ProductInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface) contains all the base attributes necessary for the frontend of the product model.
 The `items` that are returned in a `ProductInterface` array can also contain attributes from resources external to the `CatalogGraphQl` module:
 
 -  Custom and extension attributes defined in any attribute set
diff --git a/src/pages/graphql/schema/products/interfaces/routable.md b/src/pages/graphql/schema/products/interfaces/routable.md
index 233be881a..0c95eb48b 100644
--- a/src/pages/graphql/schema/products/interfaces/routable.md
+++ b/src/pages/graphql/schema/products/interfaces/routable.md
@@ -4,7 +4,7 @@ title: RoutableInterface attributes
 
 # RoutableInterface attributes
 
-Some entities are "routable", meaning that they have URLs and can serve as the model for a rendered page. The following implementations of the [`RoutableInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-RoutableInterface) allow you to return details in the [`route` query](../queries/route.md). `RoutableUrl` is returned when the URL is not linked to an entity.
+Some entities are "routable", meaning that they have URLs and can serve as the model for a rendered page. The following implementations of the [`RoutableInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-RoutableInterface) allow you to return details in the [`route` query](../queries/route.md). `RoutableUrl` is returned when the URL is not linked to an entity.
 
 *  [BundleProduct](types/bundle.md)
 *  [CategoryTree](../queries/category-list.md#return-the-category-tree-of-a-top-level-category)
diff --git a/src/pages/graphql/schema/products/interfaces/types/bundle.md b/src/pages/graphql/schema/products/interfaces/types/bundle.md
index 9d9092b07..aff7f0acd 100644
--- a/src/pages/graphql/schema/products/interfaces/types/bundle.md
+++ b/src/pages/graphql/schema/products/interfaces/types/bundle.md
@@ -4,12 +4,12 @@ title: Bundle product data types
 
 # Bundle product data types
 
-The [`BundleProduct`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-BundleProduct) data type implements the following interfaces:
+The [`BundleProduct`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-BundleProduct) data type implements the following interfaces:
 
--  [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface)
--  [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-PhysicalProductInterface)
--  [CustomizableProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-CustomizableProductInterface)
--  [RoutableInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-RoutableInterface)
+-  [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface)
+-  [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-PhysicalProductInterface)
+-  [CustomizableProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-CustomizableProductInterface)
+-  [RoutableInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-RoutableInterface)
 
 Attributes that are specific to bundle products can be used when performing a [`products`](../../queries/products.md) query.
 
diff --git a/src/pages/graphql/schema/products/interfaces/types/configurable.md b/src/pages/graphql/schema/products/interfaces/types/configurable.md
index b7cf0320b..9e4e3b15f 100644
--- a/src/pages/graphql/schema/products/interfaces/types/configurable.md
+++ b/src/pages/graphql/schema/products/interfaces/types/configurable.md
@@ -6,10 +6,10 @@ title: Configurable product data types
 
 The `ConfigurableProduct` data type implements the following interfaces:
 
--  [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface)
--  [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-PhysicalProductInterface)
--  [CustomizableProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-CustomizableProductInterface)
--  [RoutableInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-RoutableInterface)
+-  [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface)
+-  [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-PhysicalProductInterface)
+-  [CustomizableProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-CustomizableProductInterface)
+-  [RoutableInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-RoutableInterface)
 
 Attributes that are specific to configurable products can be used when performing a [`products`](../../queries/products.md) query.
 
diff --git a/src/pages/graphql/schema/products/interfaces/types/downloadable.md b/src/pages/graphql/schema/products/interfaces/types/downloadable.md
index 7e97c44a0..23ba110d7 100644
--- a/src/pages/graphql/schema/products/interfaces/types/downloadable.md
+++ b/src/pages/graphql/schema/products/interfaces/types/downloadable.md
@@ -4,7 +4,7 @@ title: Downloadable product data types
 
 # Downloadable product data types
 
-The `DownloadableProduct` data type implements [`ProductInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface) and [`CustomizableProductInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-CustomizableProductInterface). As a result, attributes that are specific to downloadable products can be used when performing a [`products`](../../queries/products.md) query. It also implements [RoutableInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-RoutableInterface).
+The `DownloadableProduct` data type implements [`ProductInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface) and [`CustomizableProductInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-CustomizableProductInterface). As a result, attributes that are specific to downloadable products can be used when performing a [`products`](../../queries/products.md) query. It also implements [RoutableInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-RoutableInterface).
 
 ## Sample query
 
diff --git a/src/pages/graphql/schema/products/interfaces/types/gift-card.md b/src/pages/graphql/schema/products/interfaces/types/gift-card.md
index 9a7062447..9759f4fd5 100644
--- a/src/pages/graphql/schema/products/interfaces/types/gift-card.md
+++ b/src/pages/graphql/schema/products/interfaces/types/gift-card.md
@@ -9,10 +9,10 @@ The `GiftCardProduct` data type defines properties of a gift card, including the
 
 It implements the following interfaces:
 
--  [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface)
--  [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-PhysicalProductInterface)
--  [CustomizableProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-CustomizableProductInterface)
--  [RoutableInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-RoutableInterface)
+-  [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface)
+-  [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-PhysicalProductInterface)
+-  [CustomizableProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-CustomizableProductInterface)
+-  [RoutableInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-RoutableInterface)
 
 ## Sample query
 
diff --git a/src/pages/graphql/schema/products/interfaces/types/grouped.md b/src/pages/graphql/schema/products/interfaces/types/grouped.md
index b44442fb2..6d3d77b2a 100644
--- a/src/pages/graphql/schema/products/interfaces/types/grouped.md
+++ b/src/pages/graphql/schema/products/interfaces/types/grouped.md
@@ -4,7 +4,7 @@ title: Grouped product data types
 
 # Grouped product data types
 
-The `GroupedProduct` data type implements [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface) and [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-PhysicalProductInterface). As a result, attributes that are specific to grouped products can be used when performing a [products](../../queries/products.md) query. It also implements [RoutableInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-RoutableInterface).
+The `GroupedProduct` data type implements [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface) and [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-PhysicalProductInterface). As a result, attributes that are specific to grouped products can be used when performing a [products](../../queries/products.md) query. It also implements [RoutableInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-RoutableInterface).
 
 ## Sample query
 
diff --git a/src/pages/graphql/schema/products/interfaces/types/index.md b/src/pages/graphql/schema/products/interfaces/types/index.md
index bfb6e8fc8..55ed4735a 100644
--- a/src/pages/graphql/schema/products/interfaces/types/index.md
+++ b/src/pages/graphql/schema/products/interfaces/types/index.md
@@ -4,17 +4,17 @@ title: Product interface implementations
 
 # Product interface implementations
 
-Adobe Commerce and Magento Open Source provides multiple product types, and most of these product types have specialized attributes that are not defined in the [`ProductInterface`(https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface)].
+Adobe Commerce and Magento Open Source provides multiple product types, and most of these product types have specialized attributes that are not defined in the [`ProductInterface`(https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface)].
 
 Product type | Implements | Has product-specific attributes?
 --- | --- | ---
-[BundleProduct](bundle.md) | ProductInterface, [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes
-[ConfigurableProduct](configurable.md) | [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface), [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes
-[DownloadableProduct](downloadable.md) | [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface),  [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md)  | Yes
-[GiftCardProduct](gift-card.md) | [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface),  [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md)| Yes
-[GroupedProduct](grouped.md) | [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface), [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes
-[SimpleProduct](simple.md) | [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface), [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | No
-[VirtualProduct](virtual.md) | [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface),  [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | No
+[BundleProduct](bundle.md) | ProductInterface, [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes
+[ConfigurableProduct](configurable.md) | [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface), [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes
+[DownloadableProduct](downloadable.md) | [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface),  [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md)  | Yes
+[GiftCardProduct](gift-card.md) | [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface),  [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md)| Yes
+[GroupedProduct](grouped.md) | [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface), [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes
+[SimpleProduct](simple.md) | [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface), [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | No
+[VirtualProduct](virtual.md) | [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface),  [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | No
 
 ## Query for product-specific attributes
 
diff --git a/src/pages/graphql/schema/products/interfaces/types/simple.md b/src/pages/graphql/schema/products/interfaces/types/simple.md
index de1af62d2..f8f42261c 100644
--- a/src/pages/graphql/schema/products/interfaces/types/simple.md
+++ b/src/pages/graphql/schema/products/interfaces/types/simple.md
@@ -8,10 +8,10 @@ contributor_link: https://www.atwix.com/
 
 The `SimpleProduct` data type implements the following interfaces:
 
--  [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface)
--  [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-PhysicalProductInterface)
--  [CustomizableProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-CustomizableProductInterface)
--  [RoutableInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-RoutableInterface)
+-  [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface)
+-  [PhysicalProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-PhysicalProductInterface)
+-  [CustomizableProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-CustomizableProductInterface)
+-  [RoutableInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-RoutableInterface)
 
 Attributes that are specific to the simple products can be used when performing a [`products`](../../queries/products.md) query.
 
diff --git a/src/pages/graphql/schema/products/interfaces/types/virtual.md b/src/pages/graphql/schema/products/interfaces/types/virtual.md
index c4f899f32..57f863c2a 100644
--- a/src/pages/graphql/schema/products/interfaces/types/virtual.md
+++ b/src/pages/graphql/schema/products/interfaces/types/virtual.md
@@ -8,9 +8,9 @@ contributor_link: https://www.atwix.com/
 
 The `VirtualProduct` data type implements the following interfaces:
 
--  [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-ProductInterface)
--  [CustomizableProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-CustomizableProductInterface)
--  [RoutableInterface](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#definition-RoutableInterface)
+-  [ProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-ProductInterface)
+-  [CustomizableProductInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-CustomizableProductInterface)
+-  [RoutableInterface](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-RoutableInterface)
 
 Attributes that are specific to the virtual products can be used when performing a [`products`](../../queries/products.md) query.
 
diff --git a/src/pages/graphql/schema/store/mutations/contact-us.md b/src/pages/graphql/schema/store/mutations/contact-us.md
index c08093f43..cf53ae0c2 100644
--- a/src/pages/graphql/schema/store/mutations/contact-us.md
+++ b/src/pages/graphql/schema/store/mutations/contact-us.md
@@ -12,7 +12,7 @@ The `contactUs` mutation submits the contents of the Contact Us form.
 
 ## Reference
 
-The [`contactUs`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#mutation-contactUs) reference provides detailed information about the types and fields defined in this mutation.
+The [`contactUs`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#mutation-contactUs) reference provides detailed information about the types and fields defined in this mutation.
 
 ## Example usage
 
diff --git a/src/pages/graphql/schema/store/queries/recaptcha-v3-config.md b/src/pages/graphql/schema/store/queries/recaptcha-v3-config.md
index 18cb52db3..70c613e1b 100644
--- a/src/pages/graphql/schema/store/queries/recaptcha-v3-config.md
+++ b/src/pages/graphql/schema/store/queries/recaptcha-v3-config.md
@@ -12,7 +12,7 @@ The `recaptchaV3Config` query returns information about the reCaptcha V3 configu
 
 ## Reference
 
-The [`recaptchaV3Config`](https://developer.adobe.com/commerce/webapi/graphql-api/beta/index.html#query-recaptchaV3Config) reference provides detailed information about the types and fields defined in this query.
+The [`recaptchaV3Config`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#query-recaptchaV3Config) reference provides detailed information about the types and fields defined in this query.
 
 ## Example usage
 

From f62d4eb7ec3610e845bc6a9d84a11d2b81805fb6 Mon Sep 17 00:00:00 2001
From: jhadobe 
Date: Tue, 9 Apr 2024 11:33:31 -0500
Subject: [PATCH 3/6] update TOC

---
 src/data/navigation/sections/graphql.js |  2 +-
 src/openapi/.redocly.yaml               | 12 ++++++------
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/data/navigation/sections/graphql.js b/src/data/navigation/sections/graphql.js
index b5be2dec6..423dca271 100644
--- a/src/data/navigation/sections/graphql.js
+++ b/src/data/navigation/sections/graphql.js
@@ -1314,7 +1314,7 @@ module.exports = [
     ],
   },
   {
-    title: "Reference (2.4.6)",
+    title: "Reference (2.4.7)",
     path: "/graphql/reference",
   },
   {
diff --git a/src/openapi/.redocly.yaml b/src/openapi/.redocly.yaml
index 9394a1ada..a44752b5e 100644
--- a/src/openapi/.redocly.yaml
+++ b/src/openapi/.redocly.yaml
@@ -3,14 +3,14 @@ organization: adobe-developers
 extends:
     - minimal
 apis:
-  Commerce(Admin)@2.4.6:
-    root: src/openapi/admin-schema-2.4.6.yaml
+  Commerce(Admin)@2.4.7:
+    root: src/openapi/admin-schema-2.4.7.yaml
     labels:
       - main
-  Commerce(Customer)@2.4.6:
-    root: src/openapi/customer-schema-2.4.6.yaml
-  Commerce(Guest)@2.4.6:
-    root: src/openapi/guest-schema-2.4.6.yaml
+  Commerce(Customer)@2.4.7:
+    root: src/openapi/customer-schema-2.4.7.yaml
+  Commerce(Guest)@2.4.7:
+    root: src/openapi/guest-schema-2.4.7.yaml
 features.openapi:
   pagination: section
   hideHostname: true

From 46cf3853cf3eeef1e9c78a3aead444a259008506 Mon Sep 17 00:00:00 2001
From: jhadobe 
Date: Tue, 9 Apr 2024 14:06:58 -0500
Subject: [PATCH 4/6] version updates

---
 spectaql/config.yml           |    2 +-
 src/openapi/.redocly.yaml     |    6 +
 static/graphql-api/index.html | 3733 ++++++++++++++++-----------------
 3 files changed, 1869 insertions(+), 1872 deletions(-)

diff --git a/spectaql/config.yml b/spectaql/config.yml
index bf7710e55..28008576e 100644
--- a/spectaql/config.yml
+++ b/spectaql/config.yml
@@ -381,7 +381,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.6
+  version: 2.4.7
   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/src/openapi/.redocly.yaml b/src/openapi/.redocly.yaml
index a44752b5e..036b068de 100644
--- a/src/openapi/.redocly.yaml
+++ b/src/openapi/.redocly.yaml
@@ -11,6 +11,12 @@ apis:
     root: src/openapi/customer-schema-2.4.7.yaml
   Commerce(Guest)@2.4.7:
     root: src/openapi/guest-schema-2.4.7.yaml
+  Commerce(Admin)@2.4.6:
+    root: src/openapi/admin-schema-2.4.6.yaml
+  Commerce(Customer)@2.4.6:
+    root: src/openapi/customer-schema-2.4.6.yaml
+  Commerce(Guest)@2.4.6:
+    root: src/openapi/guest-schema-2.4.6.yaml
 features.openapi:
   pagination: section
   hideHostname: true
diff --git a/static/graphql-api/index.html b/static/graphql-api/index.html
index ff45daf26..82df71a8e 100644
--- a/static/graphql-api/index.html
+++ b/static/graphql-api/index.html
@@ -2874,7 +2874,7 @@ 
    Adobe Commerce GraphQL API
    
                   
    API Endpoints
     
    https://<your store>/graphql
     
                 
    
                   
    Version
    
-                  
    2.4.6
    
+                  
    2.4.7
    
                 
    
               
             
@@ -2944,7 +2944,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"formCode": "abc123"}
+                  
    {"formCode": "xyz789"}
 
     
                   
                 
@@ -3369,174 +3369,174 @@ 
    Response
    
     "availableStores": [
       {
         "absolute_footer": "abc123",
-        "allow_gift_receipt": "xyz789",
+        "allow_gift_receipt": "abc123",
         "allow_gift_wrapping_on_order": "abc123",
         "allow_gift_wrapping_on_order_items": "xyz789",
-        "allow_guests_to_write_product_reviews": "xyz789",
+        "allow_guests_to_write_product_reviews": "abc123",
         "allow_items": "abc123",
-        "allow_order": "abc123",
+        "allow_order": "xyz789",
         "allow_printed_card": "abc123",
-        "autocomplete_on_storefront": false,
+        "autocomplete_on_storefront": true,
         "base_currency_code": "abc123",
-        "base_link_url": "xyz789",
-        "base_media_url": "abc123",
+        "base_link_url": "abc123",
+        "base_media_url": "xyz789",
         "base_static_url": "abc123",
-        "base_url": "xyz789",
-        "braintree_3dsecure_allowspecific": true,
-        "braintree_3dsecure_always_request_3ds": false,
-        "braintree_3dsecure_specificcountry": "abc123",
+        "base_url": "abc123",
+        "braintree_3dsecure_allowspecific": false,
+        "braintree_3dsecure_always_request_3ds": true,
+        "braintree_3dsecure_specificcountry": "xyz789",
         "braintree_3dsecure_threshold_amount": "abc123",
-        "braintree_3dsecure_verify_3dsecure": false,
-        "braintree_ach_direct_debit_vault_active": false,
-        "braintree_applepay_merchant_name": "abc123",
-        "braintree_applepay_vault_active": true,
-        "braintree_cc_vault_active": "xyz789",
+        "braintree_3dsecure_verify_3dsecure": true,
+        "braintree_ach_direct_debit_vault_active": true,
+        "braintree_applepay_merchant_name": "xyz789",
+        "braintree_applepay_vault_active": false,
+        "braintree_cc_vault_active": "abc123",
         "braintree_cc_vault_cvv": true,
-        "braintree_environment": "abc123",
+        "braintree_environment": "xyz789",
         "braintree_googlepay_btn_color": "xyz789",
         "braintree_googlepay_cctypes": "abc123",
         "braintree_googlepay_merchant_id": "abc123",
         "braintree_googlepay_vault_active": false,
         "braintree_local_payment_allowed_methods": "xyz789",
         "braintree_local_payment_fallback_button_text": "xyz789",
-        "braintree_local_payment_redirect_on_fail": "abc123",
-        "braintree_merchant_account_id": "abc123",
-        "braintree_paypal_button_location_cart_type_credit_color": "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": "xyz789",
         "braintree_paypal_button_location_cart_type_credit_shape": "abc123",
-        "braintree_paypal_button_location_cart_type_credit_show": false,
+        "braintree_paypal_button_location_cart_type_credit_show": true,
         "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789",
-        "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789",
+        "braintree_paypal_button_location_cart_type_messaging_logo": "abc123",
         "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789",
-        "braintree_paypal_button_location_cart_type_messaging_show": true,
-        "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
-        "braintree_paypal_button_location_cart_type_paylater_color": "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_paylater_label": "xyz789",
-        "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
+        "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789",
         "braintree_paypal_button_location_cart_type_paylater_show": true,
         "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
-        "braintree_paypal_button_location_cart_type_paypal_label": "abc123",
+        "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
         "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789",
-        "braintree_paypal_button_location_cart_type_paypal_show": false,
+        "braintree_paypal_button_location_cart_type_paypal_show": true,
         "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
         "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
         "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
-        "braintree_paypal_button_location_checkout_type_credit_show": true,
+        "braintree_paypal_button_location_checkout_type_credit_show": false,
         "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
         "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
-        "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123",
+        "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
         "braintree_paypal_button_location_checkout_type_messaging_show": false,
-        "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
+        "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789",
         "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
         "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
         "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
-        "braintree_paypal_button_location_checkout_type_paylater_show": true,
+        "braintree_paypal_button_location_checkout_type_paylater_show": false,
         "braintree_paypal_button_location_checkout_type_paypal_color": "xyz789",
         "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
         "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
-        "braintree_paypal_button_location_checkout_type_paypal_show": false,
-        "braintree_paypal_button_location_productpage_type_credit_color": "xyz789",
-        "braintree_paypal_button_location_productpage_type_credit_label": "abc123",
+        "braintree_paypal_button_location_checkout_type_paypal_show": true,
+        "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
+        "braintree_paypal_button_location_productpage_type_credit_label": "xyz789",
         "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789",
         "braintree_paypal_button_location_productpage_type_credit_show": false,
         "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
         "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789",
-        "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
+        "braintree_paypal_button_location_productpage_type_messaging_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_text_color": "xyz789",
         "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789",
         "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
-        "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
+        "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789",
         "braintree_paypal_button_location_productpage_type_paylater_show": 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": "xyz789",
+        "braintree_paypal_button_location_productpage_type_paypal_show": false,
+        "braintree_paypal_credit_uk_merchant_name": "abc123",
         "braintree_paypal_display_on_shopping_cart": false,
         "braintree_paypal_merchant_country": "xyz789",
         "braintree_paypal_merchant_name_override": "xyz789",
         "braintree_paypal_require_billing_address": false,
-        "braintree_paypal_send_cart_line_items": false,
-        "braintree_paypal_vault_active": true,
-        "cart_expires_in_days": 987,
-        "cart_gift_wrapping": "xyz789",
-        "cart_printed_card": "abc123",
+        "braintree_paypal_send_cart_line_items": true,
+        "braintree_paypal_vault_active": false,
+        "cart_expires_in_days": 123,
+        "cart_gift_wrapping": "abc123",
+        "cart_printed_card": "xyz789",
         "cart_summary_display_quantity": 123,
         "catalog_default_sort_by": "abc123",
         "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-        "category_url_suffix": "abc123",
+        "category_url_suffix": "xyz789",
         "check_money_order_enable_for_specific_countries": true,
-        "check_money_order_enabled": true,
+        "check_money_order_enabled": false,
         "check_money_order_make_check_payable_to": "abc123",
-        "check_money_order_max_order_total": "xyz789",
-        "check_money_order_min_order_total": "abc123",
-        "check_money_order_new_order_status": "xyz789",
-        "check_money_order_payment_from_specific_countries": "abc123",
-        "check_money_order_send_check_to": "xyz789",
-        "check_money_order_sort_order": 123,
+        "check_money_order_max_order_total": "abc123",
+        "check_money_order_min_order_total": "xyz789",
+        "check_money_order_new_order_status": "abc123",
+        "check_money_order_payment_from_specific_countries": "xyz789",
+        "check_money_order_send_check_to": "abc123",
+        "check_money_order_sort_order": 987,
         "check_money_order_title": "xyz789",
         "cms_home_page": "xyz789",
         "cms_no_cookies": "xyz789",
-        "cms_no_route": "abc123",
+        "cms_no_route": "xyz789",
         "code": "xyz789",
         "configurable_thumbnail_source": "abc123",
         "contact_enabled": false,
         "copyright": "abc123",
-        "countries_with_required_region": "abc123",
-        "create_account_confirmation": true,
+        "countries_with_required_region": "xyz789",
+        "create_account_confirmation": false,
         "customer_access_token_lifetime": 123.45,
         "default_country": "abc123",
-        "default_description": "xyz789",
+        "default_description": "abc123",
         "default_display_currency_code": "xyz789",
-        "default_keywords": "xyz789",
-        "default_title": "abc123",
+        "default_keywords": "abc123",
+        "default_title": "xyz789",
         "demonotice": 123,
         "display_state_if_optional": false,
         "enable_multiple_wishlists": "xyz789",
-        "front": "abc123",
-        "grid_per_page": 987,
-        "grid_per_page_values": "abc123",
-        "head_includes": "abc123",
+        "front": "xyz789",
+        "grid_per_page": 123,
+        "grid_per_page_values": "xyz789",
+        "head_includes": "xyz789",
         "head_shortcut_icon": "xyz789",
-        "header_logo_src": "abc123",
+        "header_logo_src": "xyz789",
         "id": 123,
         "is_default_store": false,
         "is_default_store_group": true,
         "is_guest_checkout_enabled": true,
-        "is_negotiable_quote_active": true,
+        "is_negotiable_quote_active": false,
         "is_one_page_checkout_enabled": true,
         "is_requisition_list_active": "xyz789",
         "list_mode": "abc123",
         "list_per_page": 987,
-        "list_per_page_values": "abc123",
-        "locale": "abc123",
+        "list_per_page_values": "xyz789",
+        "locale": "xyz789",
         "logo_alt": "abc123",
-        "logo_height": 123,
-        "logo_width": 987,
-        "magento_reward_general_is_enabled": "abc123",
-        "magento_reward_general_is_enabled_on_front": "xyz789",
+        "logo_height": 987,
+        "logo_width": 123,
+        "magento_reward_general_is_enabled": "xyz789",
+        "magento_reward_general_is_enabled_on_front": "abc123",
         "magento_reward_general_min_points_balance": "abc123",
         "magento_reward_general_publish_history": "abc123",
-        "magento_reward_points_invitation_customer": "abc123",
+        "magento_reward_points_invitation_customer": "xyz789",
         "magento_reward_points_invitation_customer_limit": "xyz789",
         "magento_reward_points_invitation_order": "abc123",
         "magento_reward_points_invitation_order_limit": "abc123",
-        "magento_reward_points_newsletter": "xyz789",
-        "magento_reward_points_order": "abc123",
+        "magento_reward_points_newsletter": "abc123",
+        "magento_reward_points_order": "xyz789",
         "magento_reward_points_register": "abc123",
         "magento_reward_points_review": "abc123",
-        "magento_reward_points_review_limit": "xyz789",
+        "magento_reward_points_review_limit": "abc123",
         "magento_wishlist_general_is_enabled": "abc123",
         "max_items_in_order_summary": 123,
         "maximum_number_of_wishlists": "abc123",
         "minicart_display": false,
-        "minicart_max_items": 123,
-        "minimum_password_length": "xyz789",
+        "minicart_max_items": 987,
+        "minimum_password_length": "abc123",
         "newsletter_enabled": false,
-        "no_route": "abc123",
+        "no_route": "xyz789",
         "optional_zip_countries": "xyz789",
-        "order_cancellation_enabled": false,
+        "order_cancellation_enabled": true,
         "order_cancellation_reasons": [
           CancellationReason
         ],
@@ -3545,49 +3545,49 @@ 
    Response
    
         "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
         "product_reviews_enabled": "abc123",
         "product_url_suffix": "abc123",
-        "quickorder_active": false,
-        "required_character_classes_number": "xyz789",
-        "returns_enabled": "xyz789",
-        "root_category_id": 123,
+        "quickorder_active": true,
+        "required_character_classes_number": "abc123",
+        "returns_enabled": "abc123",
+        "root_category_id": 987,
         "root_category_uid": 4,
         "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-        "sales_gift_wrapping": "abc123",
+        "sales_gift_wrapping": "xyz789",
         "sales_printed_card": "abc123",
         "secure_base_link_url": "xyz789",
-        "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,
         "shopping_cart_display_full_summary": true,
-        "shopping_cart_display_grand_total": false,
-        "shopping_cart_display_price": 123,
+        "shopping_cart_display_grand_total": true,
+        "shopping_cart_display_price": 987,
         "shopping_cart_display_shipping": 987,
         "shopping_cart_display_subtotal": 987,
         "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
-        "shopping_cart_display_zero_tax": false,
+        "shopping_cart_display_zero_tax": true,
         "show_cms_breadcrumbs": 123,
-        "store_code": "4",
-        "store_group_code": "4",
+        "store_code": 4,
+        "store_group_code": 4,
         "store_group_name": "abc123",
-        "store_name": "abc123",
-        "store_sort_order": 987,
-        "timezone": "abc123",
-        "title_prefix": "abc123",
+        "store_name": "xyz789",
+        "store_sort_order": 123,
+        "timezone": "xyz789",
+        "title_prefix": "xyz789",
         "title_separator": "abc123",
         "title_suffix": "xyz789",
-        "use_store_in_url": false,
-        "website_code": 4,
-        "website_id": 987,
+        "use_store_in_url": true,
+        "website_code": "4",
+        "website_id": 123,
         "website_name": "abc123",
         "weight_unit": "abc123",
-        "welcome": "abc123",
+        "welcome": "xyz789",
         "zero_subtotal_enable_for_specific_countries": false,
         "zero_subtotal_enabled": false,
-        "zero_subtotal_new_order_status": "abc123",
-        "zero_subtotal_payment_action": "xyz789",
-        "zero_subtotal_payment_from_specific_countries": "abc123",
+        "zero_subtotal_new_order_status": "xyz789",
+        "zero_subtotal_payment_action": "abc123",
+        "zero_subtotal_payment_from_specific_countries": "xyz789",
         "zero_subtotal_sort_order": 123,
-        "zero_subtotal_title": "xyz789"
+        "zero_subtotal_title": "abc123"
       }
     ]
   }
@@ -3731,19 +3731,19 @@ 
    Response
    
         AvailablePaymentMethod
       ],
       "billing_address": BillingCartAddress,
-      "email": "abc123",
+      "email": "xyz789",
       "gift_message": GiftMessage,
       "gift_receipt_included": false,
       "gift_wrapping": GiftWrapping,
-      "id": 4,
-      "is_virtual": true,
+      "id": "4",
+      "is_virtual": false,
       "items": [CartItemInterface],
       "itemsV2": CartItems,
       "prices": CartPrices,
       "printed_card_included": true,
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
-      "total_quantity": 123.45
+      "total_quantity": 987.65
     }
   }
 }
@@ -3864,7 +3864,7 @@ 
    Response
    
     "categories": {
       "items": [CategoryTree],
       "page_info": SearchResultPageInfo,
-      "total_count": 123
+      "total_count": 987
     }
   }
 }
@@ -3998,43 +3998,43 @@ 
    Response
    
                   
    {
   "data": {
     "category": {
-      "automatic_sorting": "xyz789",
+      "automatic_sorting": "abc123",
       "available_sort_by": ["xyz789"],
       "breadcrumbs": [Breadcrumb],
       "canonical_url": "abc123",
       "children": [CategoryTree],
       "children_count": "xyz789",
       "cms_block": CmsBlock,
-      "created_at": "xyz789",
-      "custom_layout_update_file": "abc123",
-      "default_sort_by": "abc123",
-      "description": "xyz789",
-      "display_mode": "xyz789",
+      "created_at": "abc123",
+      "custom_layout_update_file": "xyz789",
+      "default_sort_by": "xyz789",
+      "description": "abc123",
+      "display_mode": "abc123",
       "filter_price_range": 123.45,
-      "id": 987,
+      "id": 123,
       "image": "abc123",
       "include_in_menu": 123,
-      "is_anchor": 987,
+      "is_anchor": 123,
       "landing_page": 987,
       "level": 123,
-      "meta_description": "xyz789",
+      "meta_description": "abc123",
       "meta_keywords": "abc123",
-      "meta_title": "abc123",
+      "meta_title": "xyz789",
       "name": "abc123",
       "path": "xyz789",
       "path_in_store": "abc123",
       "position": 987,
-      "product_count": 123,
+      "product_count": 987,
       "products": CategoryProducts,
-      "redirect_code": 123,
+      "redirect_code": 987,
       "relative_url": "xyz789",
-      "staged": true,
+      "staged": false,
       "type": "CMS_PAGE",
-      "uid": "4",
+      "uid": 4,
       "updated_at": "abc123",
       "url_key": "xyz789",
-      "url_path": "abc123",
-      "url_suffix": "xyz789"
+      "url_path": "xyz789",
+      "url_suffix": "abc123"
     }
   }
 }
@@ -4199,43 +4199,43 @@ 
    Response
    
   "data": {
     "categoryList": [
       {
-        "automatic_sorting": "abc123",
+        "automatic_sorting": "xyz789",
         "available_sort_by": ["abc123"],
         "breadcrumbs": [Breadcrumb],
-        "canonical_url": "abc123",
+        "canonical_url": "xyz789",
         "children": [CategoryTree],
-        "children_count": "xyz789",
+        "children_count": "abc123",
         "cms_block": CmsBlock,
-        "created_at": "xyz789",
+        "created_at": "abc123",
         "custom_layout_update_file": "xyz789",
-        "default_sort_by": "abc123",
+        "default_sort_by": "xyz789",
         "description": "xyz789",
-        "display_mode": "abc123",
+        "display_mode": "xyz789",
         "filter_price_range": 987.65,
-        "id": 123,
+        "id": 987,
         "image": "xyz789",
         "include_in_menu": 123,
-        "is_anchor": 123,
-        "landing_page": 123,
-        "level": 123,
-        "meta_description": "abc123",
+        "is_anchor": 987,
+        "landing_page": 987,
+        "level": 987,
+        "meta_description": "xyz789",
         "meta_keywords": "xyz789",
-        "meta_title": "abc123",
+        "meta_title": "xyz789",
         "name": "xyz789",
-        "path": "abc123",
+        "path": "xyz789",
         "path_in_store": "abc123",
-        "position": 123,
+        "position": 987,
         "product_count": 123,
         "products": CategoryProducts,
-        "redirect_code": 987,
+        "redirect_code": 123,
         "relative_url": "abc123",
         "staged": true,
         "type": "CMS_PAGE",
-        "uid": 4,
+        "uid": "4",
         "updated_at": "abc123",
-        "url_key": "xyz789",
+        "url_key": "abc123",
         "url_path": "xyz789",
-        "url_suffix": "abc123"
+        "url_suffix": "xyz789"
       }
     ]
   }
@@ -4296,8 +4296,8 @@ 
    Response
    
   "data": {
     "checkoutAgreements": [
       {
-        "agreement_id": 123,
-        "checkbox_text": "abc123",
+        "agreement_id": 987,
+        "checkbox_text": "xyz789",
         "content": "xyz789",
         "content_height": "xyz789",
         "is_html": false,
@@ -4480,7 +4480,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"id": 123, "identifier": "abc123"}
+                  
    {"id": 987, "identifier": "abc123"}
 
     
                   
                 
@@ -4493,12 +4493,12 @@ 
    Response
    
     "cmsPage": {
       "content": "xyz789",
       "content_heading": "xyz789",
-      "identifier": "abc123",
-      "meta_description": "abc123",
-      "meta_keywords": "xyz789",
+      "identifier": "xyz789",
+      "meta_description": "xyz789",
+      "meta_keywords": "abc123",
       "meta_title": "abc123",
-      "page_layout": "abc123",
-      "redirect_code": 987,
+      "page_layout": "xyz789",
+      "redirect_code": 123,
       "relative_url": "xyz789",
       "title": "abc123",
       "type": "CMS_PAGE",
@@ -4601,13 +4601,13 @@ 
    Response
    
       "company_admin": Customer,
       "credit": CompanyCredit,
       "credit_history": CompanyCreditHistory,
-      "email": "abc123",
-      "id": 4,
+      "email": "xyz789",
+      "id": "4",
       "legal_address": CompanyLegalAddress,
-      "legal_name": "abc123",
-      "name": "abc123",
-      "payment_methods": ["xyz789"],
-      "reseller_id": "xyz789",
+      "legal_name": "xyz789",
+      "name": "xyz789",
+      "payment_methods": ["abc123"],
+      "reseller_id": "abc123",
       "role": CompanyRole,
       "roles": CompanyRoles,
       "sales_representative": CompanySalesRepresentative,
@@ -4708,7 +4708,7 @@ 
    Response
    
       "attributes": [ComparableAttribute],
       "item_count": 123,
       "items": [ComparableItem],
-      "uid": "4"
+      "uid": 4
     }
   }
 }
@@ -4772,7 +4772,7 @@ 
    Response
    
         "available_regions": [Region],
         "full_name_english": "xyz789",
         "full_name_locale": "abc123",
-        "id": "abc123",
+        "id": "xyz789",
         "three_letter_abbreviation": "abc123",
         "two_letter_abbreviation": "abc123"
       }
@@ -4867,10 +4867,10 @@ 
    Response
    
     "country": {
       "available_regions": [Region],
       "full_name_english": "abc123",
-      "full_name_locale": "xyz789",
-      "id": "abc123",
+      "full_name_locale": "abc123",
+      "id": "xyz789",
       "three_letter_abbreviation": "xyz789",
-      "two_letter_abbreviation": "xyz789"
+      "two_letter_abbreviation": "abc123"
     }
   }
 }
@@ -4933,14 +4933,14 @@ 
    Response
    
   "data": {
     "currency": {
       "available_currency_codes": [
-        "abc123"
+        "xyz789"
       ],
       "base_currency_code": "xyz789",
       "base_currency_symbol": "abc123",
-      "default_display_currecy_code": "abc123",
+      "default_display_currecy_code": "xyz789",
       "default_display_currecy_symbol": "xyz789",
-      "default_display_currency_code": "xyz789",
-      "default_display_currency_symbol": "abc123",
+      "default_display_currency_code": "abc123",
+      "default_display_currency_symbol": "xyz789",
       "exchange_rates": [ExchangeRate]
     }
   }
@@ -5262,26 +5262,26 @@ 
    Response
    
   "data": {
     "customer": {
       "addresses": [CustomerAddress],
-      "allow_remote_shopping_assistance": false,
+      "allow_remote_shopping_assistance": true,
       "compare_list": CompareList,
       "confirmation_status": "ACCOUNT_CONFIRMED",
-      "created_at": "xyz789",
+      "created_at": "abc123",
       "custom_attributes": [AttributeValueInterface],
-      "date_of_birth": "xyz789",
-      "default_billing": "abc123",
+      "date_of_birth": "abc123",
+      "default_billing": "xyz789",
       "default_shipping": "xyz789",
-      "dob": "xyz789",
-      "email": "xyz789",
+      "dob": "abc123",
+      "email": "abc123",
       "firstname": "xyz789",
-      "gender": 987,
+      "gender": 123,
       "gift_registries": [GiftRegistry],
       "gift_registry": GiftRegistry,
-      "group_id": 987,
-      "id": 987,
+      "group_id": 123,
+      "id": 123,
       "is_subscribed": false,
-      "job_title": "xyz789",
+      "job_title": "abc123",
       "lastname": "xyz789",
-      "middlename": "abc123",
+      "middlename": "xyz789",
       "orders": CustomerOrders,
       "prefix": "xyz789",
       "purchase_order": PurchaseOrder,
@@ -5298,11 +5298,11 @@ 
    Response
    
       "role": CompanyRole,
       "status": "ACTIVE",
       "store_credit": CustomerStoreCredit,
-      "structure_id": 4,
-      "suffix": "xyz789",
-      "taxvat": "abc123",
+      "structure_id": "4",
+      "suffix": "abc123",
+      "taxvat": "xyz789",
       "team": CompanyTeam,
-      "telephone": "xyz789",
+      "telephone": "abc123",
       "wishlist": Wishlist,
       "wishlist_v2": Wishlist,
       "wishlists": [Wishlist]
@@ -5418,16 +5418,16 @@ 
    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,
       "items": [CartItemInterface],
       "itemsV2": CartItems,
       "prices": CartPrices,
-      "printed_card_included": false,
+      "printed_card_included": true,
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
       "total_quantity": 123.45
@@ -5890,7 +5890,7 @@ 
    Response
    
     "getPayflowLinkToken": {
       "mode": "TEST",
       "paypal_url": "abc123",
-      "secure_token": "xyz789",
+      "secure_token": "abc123",
       "secure_token_id": "xyz789"
     }
   }
@@ -6093,7 +6093,7 @@ 
    Response
    
       "id": "xyz789",
       "mp_order_id": "xyz789",
       "payment_source_details": PaymentSourceDetails,
-      "status": "abc123"
+      "status": "xyz789"
     }
   }
 }
@@ -6358,7 +6358,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"giftRegistryUid": "4"}
+                  
    {"giftRegistryUid": 4}
 
     
                   
                 
@@ -6369,7 +6369,7 @@ 
    Response
    
                   
    {
   "data": {
     "giftRegistry": {
-      "created_at": "xyz789",
+      "created_at": "abc123",
       "dynamic_attributes": [
         GiftRegistryDynamicAttribute
       ],
@@ -6459,7 +6459,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"email": "abc123"}
+                  
    {"email": "xyz789"}
 
     
                   
                 
@@ -6471,12 +6471,12 @@ 
    Response
    
   "data": {
     "giftRegistryEmailSearch": [
       {
-        "event_date": "xyz789",
-        "event_title": "xyz789",
+        "event_date": "abc123",
+        "event_title": "abc123",
         "gift_registry_uid": 4,
         "location": "abc123",
         "name": "abc123",
-        "type": "xyz789"
+        "type": "abc123"
       }
     ]
   }
@@ -6554,7 +6554,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"giftRegistryUid": 4}
+                  
    {"giftRegistryUid": "4"}
 
     
                   
                 
@@ -6566,8 +6566,8 @@ 
    Response
    
   "data": {
     "giftRegistryIdSearch": [
       {
-        "event_date": "abc123",
-        "event_title": "xyz789",
+        "event_date": "xyz789",
+        "event_title": "abc123",
         "gift_registry_uid": 4,
         "location": "abc123",
         "name": "xyz789",
@@ -6691,11 +6691,11 @@ 
    Response
    
   "data": {
     "giftRegistryTypeSearch": [
       {
-        "event_date": "xyz789",
+        "event_date": "abc123",
         "event_title": "xyz789",
-        "gift_registry_uid": "4",
+        "gift_registry_uid": 4,
         "location": "abc123",
-        "name": "xyz789",
+        "name": "abc123",
         "type": "abc123"
       }
     ]
@@ -6900,25 +6900,25 @@ 
    Response
    
     "guestOrder": {
       "applied_coupons": [AppliedCoupon],
       "billing_address": OrderAddress,
-      "carrier": "abc123",
+      "carrier": "xyz789",
       "comments": [SalesCommentItem],
       "created_at": "xyz789",
       "credit_memos": [CreditMemo],
-      "email": "xyz789",
+      "email": "abc123",
       "gift_message": GiftMessage,
       "gift_receipt_included": true,
       "gift_wrapping": GiftWrapping,
-      "grand_total": 123.45,
+      "grand_total": 987.65,
       "id": 4,
-      "increment_id": "xyz789",
+      "increment_id": "abc123",
       "invoices": [Invoice],
       "items": [OrderItemInterface],
       "items_eligible_for_return": [OrderItemInterface],
-      "number": "abc123",
-      "order_date": "abc123",
+      "number": "xyz789",
+      "order_date": "xyz789",
       "order_number": "xyz789",
       "payment_methods": [OrderPaymentMethod],
-      "printed_card_included": true,
+      "printed_card_included": false,
       "returns": Returns,
       "shipments": [OrderShipment],
       "shipping_address": OrderAddress,
@@ -7065,7 +7065,7 @@ 
    Response
    
     "guestOrderByToken": {
       "applied_coupons": [AppliedCoupon],
       "billing_address": OrderAddress,
-      "carrier": "abc123",
+      "carrier": "xyz789",
       "comments": [SalesCommentItem],
       "created_at": "abc123",
       "credit_memos": [CreditMemo],
@@ -7073,13 +7073,13 @@ 
    Response
    
       "gift_message": GiftMessage,
       "gift_receipt_included": true,
       "gift_wrapping": GiftWrapping,
-      "grand_total": 987.65,
+      "grand_total": 123.45,
       "id": 4,
       "increment_id": "xyz789",
       "invoices": [Invoice],
       "items": [OrderItemInterface],
       "items_eligible_for_return": [OrderItemInterface],
-      "number": "abc123",
+      "number": "xyz789",
       "order_date": "abc123",
       "order_number": "xyz789",
       "payment_methods": [OrderPaymentMethod],
@@ -7087,7 +7087,7 @@ 
    Response
    
       "returns": Returns,
       "shipments": [OrderShipment],
       "shipping_address": OrderAddress,
-      "shipping_method": "xyz789",
+      "shipping_method": "abc123",
       "status": "xyz789",
       "token": "abc123",
       "total": OrderTotal
@@ -7162,7 +7162,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
 
     
                   
                 
@@ -7239,7 +7239,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"email": "abc123"}
+                  
    {"email": "xyz789"}
 
     
                   
                 
@@ -7316,7 +7316,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"name": "abc123"}
+                  
    {"name": "xyz789"}
 
     
                   
                 
@@ -7401,7 +7401,7 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}}
+                  
    {"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}}
 
     
                   
                 
@@ -7470,7 +7470,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
 
     
                   
                 
@@ -7478,7 +7478,7 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"isEmailAvailable": {"is_email_available": false}}}
+                  
    {"data": {"isEmailAvailable": {"is_email_available": true}}}
 
     
                   
                 
@@ -7581,7 +7581,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"uid": 4}
+                  
    {"uid": "4"}
 
     
                   
                 
@@ -7599,7 +7599,7 @@ 
    Response
    
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
       "created_at": "abc123",
-      "email": "xyz789",
+      "email": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
       "is_virtual": false,
       "items": [CartItemInterface],
@@ -7610,7 +7610,7 @@ 
    Response
    
         NegotiableQuoteShippingAddress
       ],
       "status": "SUBMITTED",
-      "total_quantity": 123.45,
+      "total_quantity": 987.65,
       "uid": "4",
       "updated_at": "xyz789"
     }
@@ -7749,7 +7749,7 @@ 
    Response
    
       "items": [NegotiableQuote],
       "page_info": SearchResultPageInfo,
       "sort_fields": SortFields,
-      "total_count": 123
+      "total_count": 987
     }
   }
 }
@@ -7906,7 +7906,7 @@ 
    Response
    
     "pickupLocations": {
       "items": [PickupLocation],
       "page_info": SearchResultPageInfo,
-      "total_count": 987
+      "total_count": 123
     }
   }
 }
@@ -8100,7 +8100,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "search": "xyz789",
+  "search": "abc123",
   "filter": ProductAttributeFilterInput,
   "pageSize": 20,
   "currentPage": 1,
@@ -8181,12 +8181,12 @@ 
    Response
    
                   
    {
   "data": {
     "recaptchaV3Config": {
-      "badge_position": "abc123",
-      "failure_message": "xyz789",
+      "badge_position": "xyz789",
+      "failure_message": "abc123",
       "forms": ["PLACE_ORDER"],
-      "is_enabled": true,
-      "language_code": "xyz789",
-      "minimum_score": 987.65,
+      "is_enabled": false,
+      "language_code": "abc123",
+      "minimum_score": 123.45,
       "website_key": "xyz789"
     }
   }
@@ -8273,7 +8273,7 @@ 
    Response
    
   "data": {
     "route": {
       "redirect_code": 123,
-      "relative_url": "xyz789",
+      "relative_url": "abc123",
       "type": "CMS_PAGE"
     }
   }
@@ -8549,223 +8549,223 @@ 
    Response
    
   "data": {
     "storeConfig": {
       "absolute_footer": "abc123",
-      "allow_gift_receipt": "abc123",
-      "allow_gift_wrapping_on_order": "xyz789",
-      "allow_gift_wrapping_on_order_items": "xyz789",
+      "allow_gift_receipt": "xyz789",
+      "allow_gift_wrapping_on_order": "abc123",
+      "allow_gift_wrapping_on_order_items": "abc123",
       "allow_guests_to_write_product_reviews": "abc123",
-      "allow_items": "xyz789",
-      "allow_order": "abc123",
+      "allow_items": "abc123",
+      "allow_order": "xyz789",
       "allow_printed_card": "xyz789",
-      "autocomplete_on_storefront": false,
-      "base_currency_code": "abc123",
+      "autocomplete_on_storefront": true,
+      "base_currency_code": "xyz789",
       "base_link_url": "xyz789",
       "base_media_url": "xyz789",
       "base_static_url": "abc123",
-      "base_url": "xyz789",
-      "braintree_3dsecure_allowspecific": false,
+      "base_url": "abc123",
+      "braintree_3dsecure_allowspecific": true,
       "braintree_3dsecure_always_request_3ds": false,
-      "braintree_3dsecure_specificcountry": "xyz789",
+      "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": "xyz789",
-      "braintree_applepay_vault_active": false,
+      "braintree_applepay_vault_active": true,
       "braintree_cc_vault_active": "xyz789",
       "braintree_cc_vault_cvv": false,
       "braintree_environment": "abc123",
-      "braintree_googlepay_btn_color": "xyz789",
+      "braintree_googlepay_btn_color": "abc123",
       "braintree_googlepay_cctypes": "xyz789",
-      "braintree_googlepay_merchant_id": "xyz789",
+      "braintree_googlepay_merchant_id": "abc123",
       "braintree_googlepay_vault_active": false,
-      "braintree_local_payment_allowed_methods": "xyz789",
+      "braintree_local_payment_allowed_methods": "abc123",
       "braintree_local_payment_fallback_button_text": "abc123",
-      "braintree_local_payment_redirect_on_fail": "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": "xyz789",
+      "braintree_paypal_button_location_cart_type_credit_color": "abc123",
+      "braintree_paypal_button_location_cart_type_credit_label": "abc123",
       "braintree_paypal_button_location_cart_type_credit_shape": "abc123",
-      "braintree_paypal_button_location_cart_type_credit_show": false,
-      "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
-      "braintree_paypal_button_location_cart_type_messaging_logo": "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_logo_position": "abc123",
-      "braintree_paypal_button_location_cart_type_messaging_show": false,
+      "braintree_paypal_button_location_cart_type_messaging_show": true,
       "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
-      "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
-      "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
+      "braintree_paypal_button_location_cart_type_paylater_color": "xyz789",
+      "braintree_paypal_button_location_cart_type_paylater_label": "abc123",
       "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789",
-      "braintree_paypal_button_location_cart_type_paylater_show": true,
-      "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
-      "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
+      "braintree_paypal_button_location_cart_type_paylater_show": false,
+      "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
+      "braintree_paypal_button_location_cart_type_paypal_label": "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_color": "abc123",
       "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
-      "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
+      "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
       "braintree_paypal_button_location_checkout_type_credit_show": true,
       "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
-      "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
-      "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123",
+      "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
+      "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
       "braintree_paypal_button_location_checkout_type_messaging_show": false,
-      "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789",
-      "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
-      "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
+      "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
+      "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
+      "braintree_paypal_button_location_checkout_type_paylater_label": "abc123",
       "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
       "braintree_paypal_button_location_checkout_type_paylater_show": true,
-      "braintree_paypal_button_location_checkout_type_paypal_color": "abc123",
-      "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
+      "braintree_paypal_button_location_checkout_type_paypal_color": "xyz789",
+      "braintree_paypal_button_location_checkout_type_paypal_label": "abc123",
       "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
-      "braintree_paypal_button_location_checkout_type_paypal_show": false,
-      "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
+      "braintree_paypal_button_location_checkout_type_paypal_show": true,
+      "braintree_paypal_button_location_productpage_type_credit_color": "xyz789",
       "braintree_paypal_button_location_productpage_type_credit_label": "abc123",
-      "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789",
+      "braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
       "braintree_paypal_button_location_productpage_type_credit_show": true,
       "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123",
-      "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789",
-      "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123",
+      "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
+      "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
       "braintree_paypal_button_location_productpage_type_messaging_show": false,
       "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
-      "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
-      "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
-      "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789",
+      "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789",
+      "braintree_paypal_button_location_productpage_type_paylater_label": "abc123",
+      "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
       "braintree_paypal_button_location_productpage_type_paylater_show": false,
       "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789",
       "braintree_paypal_button_location_productpage_type_paypal_label": "xyz789",
-      "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123",
-      "braintree_paypal_button_location_productpage_type_paypal_show": false,
-      "braintree_paypal_credit_uk_merchant_name": "abc123",
-      "braintree_paypal_display_on_shopping_cart": true,
-      "braintree_paypal_merchant_country": "xyz789",
+      "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789",
+      "braintree_paypal_button_location_productpage_type_paypal_show": true,
+      "braintree_paypal_credit_uk_merchant_name": "xyz789",
+      "braintree_paypal_display_on_shopping_cart": false,
+      "braintree_paypal_merchant_country": "abc123",
       "braintree_paypal_merchant_name_override": "abc123",
       "braintree_paypal_require_billing_address": false,
-      "braintree_paypal_send_cart_line_items": true,
-      "braintree_paypal_vault_active": true,
+      "braintree_paypal_send_cart_line_items": false,
+      "braintree_paypal_vault_active": false,
       "cart_expires_in_days": 987,
       "cart_gift_wrapping": "abc123",
-      "cart_printed_card": "xyz789",
-      "cart_summary_display_quantity": 987,
+      "cart_printed_card": "abc123",
+      "cart_summary_display_quantity": 123,
       "catalog_default_sort_by": "abc123",
       "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-      "category_url_suffix": "abc123",
-      "check_money_order_enable_for_specific_countries": true,
+      "category_url_suffix": "xyz789",
+      "check_money_order_enable_for_specific_countries": false,
       "check_money_order_enabled": false,
-      "check_money_order_make_check_payable_to": "abc123",
-      "check_money_order_max_order_total": "abc123",
-      "check_money_order_min_order_total": "abc123",
-      "check_money_order_new_order_status": "xyz789",
-      "check_money_order_payment_from_specific_countries": "abc123",
+      "check_money_order_make_check_payable_to": "xyz789",
+      "check_money_order_max_order_total": "xyz789",
+      "check_money_order_min_order_total": "xyz789",
+      "check_money_order_new_order_status": "abc123",
+      "check_money_order_payment_from_specific_countries": "xyz789",
       "check_money_order_send_check_to": "xyz789",
-      "check_money_order_sort_order": 123,
-      "check_money_order_title": "abc123",
-      "cms_home_page": "abc123",
-      "cms_no_cookies": "xyz789",
+      "check_money_order_sort_order": 987,
+      "check_money_order_title": "xyz789",
+      "cms_home_page": "xyz789",
+      "cms_no_cookies": "abc123",
       "cms_no_route": "xyz789",
-      "code": "abc123",
-      "configurable_thumbnail_source": "abc123",
-      "contact_enabled": false,
-      "copyright": "abc123",
-      "countries_with_required_region": "xyz789",
-      "create_account_confirmation": false,
-      "customer_access_token_lifetime": 123.45,
+      "code": "xyz789",
+      "configurable_thumbnail_source": "xyz789",
+      "contact_enabled": true,
+      "copyright": "xyz789",
+      "countries_with_required_region": "abc123",
+      "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": "xyz789",
-      "default_title": "xyz789",
-      "demonotice": 987,
+      "default_title": "abc123",
+      "demonotice": 123,
       "display_state_if_optional": false,
       "enable_multiple_wishlists": "xyz789",
       "front": "abc123",
-      "grid_per_page": 987,
-      "grid_per_page_values": "xyz789",
-      "head_includes": "abc123",
+      "grid_per_page": 123,
+      "grid_per_page_values": "abc123",
+      "head_includes": "xyz789",
       "head_shortcut_icon": "abc123",
-      "header_logo_src": "abc123",
-      "id": 123,
+      "header_logo_src": "xyz789",
+      "id": 987,
       "is_default_store": true,
       "is_default_store_group": true,
       "is_guest_checkout_enabled": false,
-      "is_negotiable_quote_active": false,
-      "is_one_page_checkout_enabled": true,
-      "is_requisition_list_active": "xyz789",
+      "is_negotiable_quote_active": true,
+      "is_one_page_checkout_enabled": false,
+      "is_requisition_list_active": "abc123",
       "list_mode": "abc123",
-      "list_per_page": 123,
+      "list_per_page": 987,
       "list_per_page_values": "xyz789",
       "locale": "xyz789",
-      "logo_alt": "xyz789",
-      "logo_height": 987,
+      "logo_alt": "abc123",
+      "logo_height": 123,
       "logo_width": 987,
-      "magento_reward_general_is_enabled": "xyz789",
+      "magento_reward_general_is_enabled": "abc123",
       "magento_reward_general_is_enabled_on_front": "xyz789",
       "magento_reward_general_min_points_balance": "abc123",
-      "magento_reward_general_publish_history": "abc123",
+      "magento_reward_general_publish_history": "xyz789",
       "magento_reward_points_invitation_customer": "abc123",
       "magento_reward_points_invitation_customer_limit": "abc123",
-      "magento_reward_points_invitation_order": "xyz789",
+      "magento_reward_points_invitation_order": "abc123",
       "magento_reward_points_invitation_order_limit": "xyz789",
-      "magento_reward_points_newsletter": "abc123",
+      "magento_reward_points_newsletter": "xyz789",
       "magento_reward_points_order": "xyz789",
       "magento_reward_points_register": "xyz789",
-      "magento_reward_points_review": "xyz789",
-      "magento_reward_points_review_limit": "abc123",
-      "magento_wishlist_general_is_enabled": "xyz789",
+      "magento_reward_points_review": "abc123",
+      "magento_reward_points_review_limit": "xyz789",
+      "magento_wishlist_general_is_enabled": "abc123",
       "max_items_in_order_summary": 987,
       "maximum_number_of_wishlists": "abc123",
-      "minicart_display": true,
-      "minicart_max_items": 123,
-      "minimum_password_length": "xyz789",
-      "newsletter_enabled": false,
-      "no_route": "xyz789",
-      "optional_zip_countries": "xyz789",
+      "minicart_display": false,
+      "minicart_max_items": 987,
+      "minimum_password_length": "abc123",
+      "newsletter_enabled": true,
+      "no_route": "abc123",
+      "optional_zip_countries": "abc123",
       "order_cancellation_enabled": true,
       "order_cancellation_reasons": [CancellationReason],
-      "payment_payflowpro_cc_vault_active": "abc123",
+      "payment_payflowpro_cc_vault_active": "xyz789",
       "printed_card_price": "abc123",
       "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-      "product_reviews_enabled": "abc123",
+      "product_reviews_enabled": "xyz789",
       "product_url_suffix": "xyz789",
-      "quickorder_active": false,
+      "quickorder_active": true,
       "required_character_classes_number": "abc123",
-      "returns_enabled": "abc123",
-      "root_category_id": 123,
-      "root_category_uid": 4,
+      "returns_enabled": "xyz789",
+      "root_category_id": 987,
+      "root_category_uid": "4",
       "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
       "sales_gift_wrapping": "xyz789",
-      "sales_printed_card": "xyz789",
-      "secure_base_link_url": "abc123",
+      "sales_printed_card": "abc123",
+      "secure_base_link_url": "xyz789",
       "secure_base_media_url": "xyz789",
-      "secure_base_static_url": "abc123",
-      "secure_base_url": "xyz789",
+      "secure_base_static_url": "xyz789",
+      "secure_base_url": "abc123",
       "send_friend": SendFriendConfiguration,
       "shopping_cart_display_full_summary": true,
-      "shopping_cart_display_grand_total": false,
-      "shopping_cart_display_price": 123,
+      "shopping_cart_display_grand_total": true,
+      "shopping_cart_display_price": 987,
       "shopping_cart_display_shipping": 123,
       "shopping_cart_display_subtotal": 123,
       "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
       "shopping_cart_display_zero_tax": false,
       "show_cms_breadcrumbs": 123,
       "store_code": 4,
-      "store_group_code": "4",
-      "store_group_name": "abc123",
+      "store_group_code": 4,
+      "store_group_name": "xyz789",
       "store_name": "abc123",
-      "store_sort_order": 987,
+      "store_sort_order": 123,
       "timezone": "xyz789",
-      "title_prefix": "xyz789",
-      "title_separator": "xyz789",
-      "title_suffix": "abc123",
-      "use_store_in_url": true,
-      "website_code": 4,
-      "website_id": 123,
-      "website_name": "xyz789",
-      "weight_unit": "abc123",
-      "welcome": "abc123",
-      "zero_subtotal_enable_for_specific_countries": false,
+      "title_prefix": "abc123",
+      "title_separator": "abc123",
+      "title_suffix": "xyz789",
+      "use_store_in_url": false,
+      "website_code": "4",
+      "website_id": 987,
+      "website_name": "abc123",
+      "weight_unit": "xyz789",
+      "welcome": "xyz789",
+      "zero_subtotal_enable_for_specific_countries": true,
       "zero_subtotal_enabled": true,
-      "zero_subtotal_new_order_status": "xyz789",
-      "zero_subtotal_payment_action": "abc123",
-      "zero_subtotal_payment_from_specific_countries": "xyz789",
+      "zero_subtotal_new_order_status": "abc123",
+      "zero_subtotal_payment_action": "xyz789",
+      "zero_subtotal_payment_from_specific_countries": "abc123",
       "zero_subtotal_sort_order": 123,
-      "zero_subtotal_title": "abc123"
+      "zero_subtotal_title": "xyz789"
     }
   }
 }
@@ -8862,9 +8862,9 @@ 
    Response
    
     "urlResolver": {
       "canonical_url": "xyz789",
       "entity_uid": 4,
-      "id": 123,
-      "redirectCode": 123,
-      "relative_url": "xyz789",
+      "id": 987,
+      "redirectCode": 987,
+      "relative_url": "abc123",
       "type": "CMS_PAGE"
     }
   }
@@ -8933,9 +8933,9 @@ 
    Response
    
     "wishlist": {
       "items": [WishlistItem],
       "items_count": 987,
-      "name": "xyz789",
+      "name": "abc123",
       "sharing_code": "xyz789",
-      "updated_at": "xyz789"
+      "updated_at": "abc123"
     }
   }
 }
@@ -9268,7 +9268,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "giftRegistryUid": "4",
+  "giftRegistryUid": 4,
   "registrants": [AddGiftRegistryRegistrantInput]
 }
 
     
@@ -9479,7 +9479,7 @@ 
    Response
    
   "data": {
     "addProductsToCompareList": {
       "attributes": [ComparableAttribute],
-      "item_count": 987,
+      "item_count": 123,
       "items": [ComparableItem],
       "uid": "4"
     }
@@ -9571,7 +9571,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "requisitionListUid": 4,
+  "requisitionListUid": "4",
   "requisitionListItems": [RequisitionListItemsInput]
 }
 
     
@@ -9955,10 +9955,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {
-  "requisitionListUid": "4",
-  "requisitionListItemUids": [4]
-}
+                  
    {"requisitionListUid": 4, "requisitionListItemUids": [4]}
 
     
                   
                 
@@ -9973,7 +9970,7 @@ 
    Response
    
         AddRequisitionListItemToCartUserError
       ],
       "cart": Cart,
-      "status": true
+      "status": false
     }
   }
 }
@@ -10392,7 +10389,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"wishlistId": "4", "wishlistItemIds": [4]}
+                  
    {"wishlistId": 4, "wishlistItemIds": ["4"]}
 
     
                   
                 
@@ -10406,7 +10403,7 @@ 
    Response
    
       "add_wishlist_items_to_cart_user_errors": [
         WishlistCartUserInputError
       ],
-      "status": false,
+      "status": true,
       "wishlist": Wishlist
     }
   }
@@ -10718,7 +10715,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"cartId": 4}
+                  
    {"cartId": "4"}
 
     
                   
                 
@@ -10966,7 +10963,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"uid": "4"}
+                  
    {"uid": 4}
 
     
                   
                 
@@ -10978,7 +10975,7 @@ 
    Response
    
   "data": {
     "assignCompareListToCustomer": {
       "compare_list": CompareList,
-      "result": false
+      "result": true
     }
   }
 }
@@ -11125,7 +11122,7 @@ 
    Response
    
       "gift_message": GiftMessage,
       "gift_receipt_included": false,
       "gift_wrapping": GiftWrapping,
-      "id": 4,
+      "id": "4",
       "is_virtual": true,
       "items": [CartItemInterface],
       "itemsV2": CartItems,
@@ -11219,7 +11216,7 @@ 
    Response
    
                   
    {
   "data": {
     "cancelOrder": {
-      "error": "xyz789",
+      "error": "abc123",
       "order": CustomerOrder
     }
   }
@@ -11485,7 +11482,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "currentPassword": "xyz789",
+  "currentPassword": "abc123",
   "newPassword": "abc123"
 }
 
     
@@ -11506,7 +11503,7 @@ 
    Response
    
       "custom_attributes": [AttributeValueInterface],
       "date_of_birth": "abc123",
       "default_billing": "xyz789",
-      "default_shipping": "xyz789",
+      "default_shipping": "abc123",
       "dob": "xyz789",
       "email": "abc123",
       "firstname": "abc123",
@@ -11516,17 +11513,17 @@ 
    Response
    
       "group_id": 987,
       "id": 123,
       "is_subscribed": true,
-      "job_title": "xyz789",
-      "lastname": "abc123",
-      "middlename": "abc123",
+      "job_title": "abc123",
+      "lastname": "xyz789",
+      "middlename": "xyz789",
       "orders": CustomerOrders,
-      "prefix": "abc123",
+      "prefix": "xyz789",
       "purchase_order": PurchaseOrder,
       "purchase_order_approval_rule": PurchaseOrderApprovalRule,
       "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
       "purchase_order_approval_rules": PurchaseOrderApprovalRules,
       "purchase_orders": PurchaseOrders,
-      "purchase_orders_enabled": false,
+      "purchase_orders_enabled": true,
       "requisition_lists": RequisitionLists,
       "return": Return,
       "returns": Returns,
@@ -11536,7 +11533,7 @@ 
    Response
    
       "status": "ACTIVE",
       "store_credit": CustomerStoreCredit,
       "structure_id": 4,
-      "suffix": "xyz789",
+      "suffix": "abc123",
       "taxvat": "xyz789",
       "team": CompanyTeam,
       "telephone": "abc123",
@@ -11706,7 +11703,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"cartUid": "xyz789"}
+                  
    {"cartUid": "abc123"}
 
     
                   
                 
@@ -11716,7 +11713,7 @@ 
    Response
    
                   
                   
    {
   "data": {
-    "clearCustomerCart": {"cart": Cart, "status": true}
+    "clearCustomerCart": {"cart": Cart, "status": false}
   }
 }
 
     
@@ -12074,7 +12071,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "sourceRequisitionListUid": "4",
+  "sourceRequisitionListUid": 4,
   "destinationRequisitionListUid": "4",
   "requisitionListItem": CopyItemsBetweenRequisitionListsInput
 }
@@ -12261,7 +12258,7 @@ 
    Response
    
                   
                   
    {
   "data": {
-    "createBraintreeClientToken": "xyz789"
+    "createBraintreeClientToken": "abc123"
   }
 }
 
     
@@ -12310,7 +12307,7 @@ 
    Response
    
                   
                   
    {
   "data": {
-    "createBraintreePayPalClientToken": "xyz789"
+    "createBraintreePayPalClientToken": "abc123"
   }
 }
 
     
@@ -12797,7 +12794,7 @@ 
    Response
    
       "attributes": [ComparableAttribute],
       "item_count": 987,
       "items": [ComparableItem],
-      "uid": "4"
+      "uid": 4
     }
   }
 }
@@ -12989,29 +12986,29 @@ 
    Response
    
                   
    {
   "data": {
     "createCustomerAddress": {
-      "city": "abc123",
-      "company": "abc123",
+      "city": "xyz789",
+      "company": "xyz789",
       "country_code": "AF",
       "country_id": "xyz789",
       "custom_attributes": [CustomerAddressAttribute],
       "custom_attributesV2": [AttributeValueInterface],
       "customer_id": 123,
       "default_billing": true,
-      "default_shipping": false,
+      "default_shipping": true,
       "extension_attributes": [CustomerAddressAttribute],
-      "fax": "abc123",
+      "fax": "xyz789",
       "firstname": "abc123",
-      "id": 987,
-      "lastname": "xyz789",
+      "id": 123,
+      "lastname": "abc123",
       "middlename": "xyz789",
-      "postcode": "abc123",
+      "postcode": "xyz789",
       "prefix": "xyz789",
       "region": CustomerAddressRegion,
       "region_id": 987,
-      "street": ["abc123"],
-      "suffix": "abc123",
+      "street": ["xyz789"],
+      "suffix": "xyz789",
       "telephone": "xyz789",
-      "vat_id": "xyz789"
+      "vat_id": "abc123"
     }
   }
 }
@@ -13423,9 +13420,9 @@ 
    Response
    
     "createPayflowProToken": {
       "response_message": "abc123",
       "result": 987,
-      "result_code": 123,
+      "result_code": 987,
       "secure_token": "xyz789",
-      "secure_token_id": "xyz789"
+      "secure_token_id": "abc123"
     }
   }
 }
@@ -13511,8 +13508,8 @@ 
    Response
    
   "data": {
     "createPaymentOrder": {
       "id": "abc123",
-      "mp_order_id": "abc123",
-      "status": "abc123"
+      "mp_order_id": "xyz789",
+      "status": "xyz789"
     }
   }
 }
@@ -13599,7 +13596,7 @@ 
    Response
    
   "data": {
     "createPaypalExpressToken": {
       "paypal_urls": PaypalExpressUrlList,
-      "token": "abc123"
+      "token": "xyz789"
     }
   }
 }
@@ -13783,13 +13780,13 @@ 
    Response
    
       "applies_to_roles": [CompanyRole],
       "approver_roles": [CompanyRole],
       "condition": PurchaseOrderApprovalRuleConditionInterface,
-      "created_at": "abc123",
-      "created_by": "abc123",
-      "description": "abc123",
-      "name": "xyz789",
+      "created_at": "xyz789",
+      "created_by": "xyz789",
+      "description": "xyz789",
+      "name": "abc123",
       "status": "ENABLED",
       "uid": "4",
-      "updated_at": "abc123"
+      "updated_at": "xyz789"
     }
   }
 }
@@ -14025,7 +14022,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"id": 4}
+                  
    {"id": "4"}
 
     
                   
                 
@@ -14033,7 +14030,7 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"deleteCompanyRole": {"success": false}}}
+                  
    {"data": {"deleteCompanyRole": {"success": true}}}
 
     
                   
                 
@@ -14102,7 +14099,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"id": 4}
+                  
    {"id": "4"}
 
     
                   
                 
@@ -14264,7 +14261,7 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"deleteCompareList": {"result": true}}}
+                  
    {"data": {"deleteCompareList": {"result": false}}}
 
     
                   
                 
@@ -14376,7 +14373,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"id": 987}
+                  
    {"id": 123}
 
     
                   
                 
@@ -14554,7 +14551,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"public_hash": "xyz789"}
+                  
    {"public_hash": "abc123"}
 
     
                   
                 
@@ -14566,7 +14563,7 @@ 
    Response
    
   "data": {
     "deletePaymentToken": {
       "customerPaymentTokens": CustomerPaymentTokens,
-      "result": true
+      "result": false
     }
   }
 }
@@ -14726,7 +14723,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"requisitionListUid": "4"}
+                  
    {"requisitionListUid": 4}
 
     
                   
                 
@@ -14738,7 +14735,7 @@ 
    Response
    
   "data": {
     "deleteRequisitionList": {
       "requisition_lists": RequisitionLists,
-      "status": true
+      "status": false
     }
   }
 }
@@ -14828,7 +14825,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "requisitionListUid": "4",
+  "requisitionListUid": 4,
   "requisitionListItemUids": ["4"]
 }
 
     
@@ -15033,10 +15030,10 @@ 
    Response
    
         "available": true,
         "base_amount": Money,
         "carrier_code": "abc123",
-        "carrier_title": "xyz789",
+        "carrier_title": "abc123",
         "error_message": "abc123",
-        "method_code": "abc123",
-        "method_title": "xyz789",
+        "method_code": "xyz789",
+        "method_title": "abc123",
         "price_excl_tax": Money,
         "price_incl_tax": Money
       }
@@ -15207,7 +15204,7 @@ 
    Variables
    
                   
                   
    {
   "email": "xyz789",
-  "password": "xyz789"
+  "password": "abc123"
 }
 
     
                   
@@ -15302,7 +15299,7 @@ 
    Response
    
                   
    {
   "data": {
     "generateCustomerTokenAsAdmin": {
-      "customer_token": "xyz789"
+      "customer_token": "abc123"
     }
   }
 }
@@ -15520,7 +15517,7 @@ 
    Variables
    
                   
                   
    {
   "source_cart_id": "xyz789",
-  "destination_cart_id": "xyz789"
+  "destination_cart_id": "abc123"
 }
 
     
                   
@@ -15547,7 +15544,7 @@ 
    Response
    
       "gift_receipt_included": false,
       "gift_wrapping": GiftWrapping,
       "id": 4,
-      "is_virtual": false,
+      "is_virtual": true,
       "items": [CartItemInterface],
       "itemsV2": CartItems,
       "prices": CartPrices,
@@ -15647,10 +15644,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {
-  "cartUid": "4",
-  "giftRegistryUid": "4"
-}
+                  
    {"cartUid": "4", "giftRegistryUid": 4}
 
     
                   
                 
@@ -15767,7 +15761,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "sourceRequisitionListUid": "4",
+  "sourceRequisitionListUid": 4,
   "destinationRequisitionListUid": "4",
   "requisitionListItem": MoveItemsBetweenRequisitionListsInput
 }
@@ -16333,7 +16327,7 @@ 
    Response
    
   "data": {
     "redeemGiftCardBalanceAsStoreCredit": {
       "balance": Money,
-      "code": "xyz789",
+      "code": "abc123",
       "expiration_date": "xyz789"
     }
   }
@@ -16732,7 +16726,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"giftRegistryUid": "4"}
+                  
    {"giftRegistryUid": 4}
 
     
                   
                 
@@ -16740,7 +16734,7 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"removeGiftRegistry": {"success": false}}}
+                  
    {"data": {"removeGiftRegistry": {"success": true}}}
 
     
                   
                 
@@ -16826,10 +16820,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {
-  "giftRegistryUid": "4",
-  "itemsUid": ["4"]
-}
+                  
    {"giftRegistryUid": 4, "itemsUid": [4]}
 
     
                   
                 
@@ -17292,7 +17283,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"wishlistId": 4, "wishlistItemsIds": ["4"]}
+                  
    {"wishlistId": 4, "wishlistItemsIds": [4]}
 
     
                   
                 
@@ -17457,7 +17448,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"cartId": "4"}
+                  
    {"cartId": 4}
 
     
                   
                 
@@ -17618,7 +17609,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"orderNumber": "abc123"}
+                  
    {"orderNumber": "xyz789"}
 
     
                   
                 
@@ -17783,7 +17774,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
 
     
                   
                 
@@ -17791,7 +17782,7 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"requestPasswordResetEmail": true}}
+                  
    {"data": {"requestPasswordResetEmail": false}}
 
     
                   
                 
@@ -17974,9 +17965,9 @@ 
    Variables
    
                   
                   
                   
    {
-  "email": "abc123",
+  "email": "xyz789",
   "resetPasswordToken": "abc123",
-  "newPassword": "xyz789"
+  "newPassword": "abc123"
 }
 
     
                   
@@ -18032,7 +18023,7 @@ 
    Query
    
                   
    Response
    
                   
                   
-                  
    {"data": {"revokeCustomerToken": {"result": false}}}
+                  
    {"data": {"revokeCustomerToken": {"result": true}}}
 
     
                   
                 
@@ -19375,7 +19366,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
 
     
                   
                 
@@ -19458,7 +19449,7 @@ 
    Variables
    
                   
    Response
    
                   
                   
-                  
    {"data": {"syncPaymentOrder": false}}
+                  
    {"data": {"syncPaymentOrder": true}}
 
     
                   
                 
@@ -20125,7 +20116,7 @@ 
    Query
    
                   
    Variables
    
                   
                   
-                  
    {"id": 987, "input": CustomerAddressInput}
+                  
    {"id": 123, "input": CustomerAddressInput}
 
     
                   
                 
@@ -20136,29 +20127,29 @@ 
    Response
    
                   
    {
   "data": {
     "updateCustomerAddress": {
-      "city": "abc123",
-      "company": "abc123",
+      "city": "xyz789",
+      "company": "xyz789",
       "country_code": "AF",
       "country_id": "xyz789",
       "custom_attributes": [CustomerAddressAttribute],
       "custom_attributesV2": [AttributeValueInterface],
       "customer_id": 987,
-      "default_billing": true,
+      "default_billing": false,
       "default_shipping": true,
       "extension_attributes": [CustomerAddressAttribute],
       "fax": "xyz789",
       "firstname": "abc123",
       "id": 123,
       "lastname": "abc123",
-      "middlename": "abc123",
+      "middlename": "xyz789",
       "postcode": "xyz789",
       "prefix": "xyz789",
       "region": CustomerAddressRegion,
       "region_id": 987,
-      "street": ["abc123"],
-      "suffix": "abc123",
-      "telephone": "xyz789",
-      "vat_id": "abc123"
+      "street": ["xyz789"],
+      "suffix": "xyz789",
+      "telephone": "abc123",
+      "vat_id": "xyz789"
     }
   }
 }
@@ -20424,7 +20415,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "giftRegistryUid": "4",
+  "giftRegistryUid": 4,
   "giftRegistry": UpdateGiftRegistryInput
 }
 
     
@@ -20525,7 +20516,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "giftRegistryUid": 4,
+  "giftRegistryUid": "4",
   "items": [UpdateGiftRegistryItemInput]
 }
 
     
@@ -20819,7 +20810,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "wishlistId": 4,
+  "wishlistId": "4",
   "wishlistItems": [WishlistItemUpdateInput]
 }
 
     
@@ -20935,11 +20926,11 @@ 
    Response
    
       "approver_roles": [CompanyRole],
       "condition": PurchaseOrderApprovalRuleConditionInterface,
       "created_at": "xyz789",
-      "created_by": "abc123",
+      "created_by": "xyz789",
       "description": "xyz789",
       "name": "xyz789",
       "status": "ENABLED",
-      "uid": 4,
+      "uid": "4",
       "updated_at": "xyz789"
     }
   }
@@ -21030,7 +21021,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "requisitionListUid": "4",
+  "requisitionListUid": 4,
   "input": UpdateRequisitionListInput
 }
 
     
@@ -21249,7 +21240,7 @@ 
    Variables
    
                   
                   
                   
    {
-  "wishlistId": 4,
+  "wishlistId": "4",
   "name": "abc123",
   "visibility": "PUBLIC"
 }
@@ -21264,7 +21255,7 @@ 
    Response
    
   "data": {
     "updateWishlist": {
       "name": "xyz789",
-      "uid": 4,
+      "uid": "4",
       "visibility": "PUBLIC"
     }
   }
@@ -21761,8 +21752,8 @@ 
    Example
    
     GiftRegistryDynamicAttributeInput
   ],
   "email": "abc123",
-  "firstname": "abc123",
-  "lastname": "xyz789"
+  "firstname": "xyz789",
+  "lastname": "abc123"
 }
 
     
                   
@@ -21926,10 +21917,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {
-  "products": ["4"],
-  "uid": "4"
-}
+                  
    {"products": [4], "uid": 4}
 
     
                   
                 
@@ -22093,7 +22081,7 @@ 
    Example
    
                   
                   
                   
    {
-  "comment": "xyz789",
+  "comment": "abc123",
   "purchase_order_uid": "4"
 }
 
     
@@ -22212,8 +22200,8 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": "abc123",
-  "purchase_order_uid": "4",
+  "cart_id": "xyz789",
+  "purchase_order_uid": 4,
   "replace_existing_cart_items": true
 }
 
     
@@ -22459,7 +22447,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"comment_text": "abc123", "return_uid": 4}
+                  
    {"comment_text": "xyz789", "return_uid": 4}
 
     
                   
                 
@@ -22576,9 +22564,9 @@ 
    Example
    
                   
                   
                   
    {
-  "carrier_uid": 4,
-  "return_uid": 4,
-  "tracking_number": "abc123"
+  "carrier_uid": "4",
+  "return_uid": "4",
+  "tracking_number": "xyz789"
 }
 
     
                   
@@ -22805,7 +22793,7 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "cart_items": [VirtualProductCartItemInput]
 }
 
     
@@ -22921,7 +22909,7 @@ 
    Example
    
   "add_wishlist_items_to_cart_user_errors": [
     WishlistCartUserInputError
   ],
-  "status": false,
+  "status": true,
   "wishlist": Wishlist
 }
 
     
@@ -23006,11 +22994,11 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_code": "xyz789",
+  "attribute_code": "abc123",
   "count": 987,
   "label": "abc123",
   "options": [AggregationOption],
-  "position": 987
+  "position": 123
 }
 
     
                   
@@ -23164,7 +23152,7 @@ 
    Example
    
                   
                   
    {
   "count": 987,
-  "label": "xyz789",
+  "label": "abc123",
   "value": "xyz789"
 }
 
     
@@ -23214,7 +23202,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"includeDirectChildrenOnly": false}
+                  
    {"includeDirectChildrenOnly": true}
 
     
                   
                 
@@ -23370,8 +23358,8 @@ 
    Example
    
                   
    {
   "button_styles": ButtonStyles,
   "code": "xyz789",
-  "is_visible": false,
-  "payment_intent": "abc123",
+  "is_visible": true,
+  "payment_intent": "xyz789",
   "payment_source": "abc123",
   "sdk_params": [SDKParams],
   "sort_order": "xyz789",
@@ -23447,9 +23435,9 @@ 
    Example
    
                   
                   
                   
    {
-  "payment_source": "abc123",
+  "payment_source": "xyz789",
   "payments_order_id": "abc123",
-  "paypal_order_id": "xyz789"
+  "paypal_order_id": "abc123"
 }
 
     
                   
@@ -23496,7 +23484,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"code": "xyz789"}
+                  
    {"code": "abc123"}
 
     
                   
                 
@@ -23571,9 +23559,9 @@ 
    Example
    
                   
                   
    {
   "applied_balance": Money,
-  "code": "abc123",
+  "code": "xyz789",
   "current_balance": Money,
-  "expiration_date": "xyz789"
+  "expiration_date": "abc123"
 }
 
     
                   
@@ -23871,7 +23859,7 @@ 
    Example
    
                   
                   
    {
   "cart_id": "xyz789",
-  "coupon_codes": ["xyz789"],
+  "coupon_codes": ["abc123"],
   "type": "APPEND"
 }
 
     
@@ -24180,7 +24168,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"radius": 123, "search_term": "xyz789"}
+                  
    {"radius": 987, "search_term": "xyz789"}
 
     
                   
                 
@@ -24327,7 +24315,7 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_code": "abc123",
+  "attribute_code": "xyz789",
   "attribute_options": [AttributeOption],
   "attribute_type": "xyz789",
   "entity_type": "xyz789",
@@ -24570,17 +24558,17 @@ 
    Example
    
                   
                   
                   
    {
-  "is_comparable": true,
+  "is_comparable": false,
   "is_filterable": false,
   "is_filterable_in_search": true,
-  "is_html_allowed_on_front": true,
-  "is_searchable": true,
-  "is_used_for_customer_segment": true,
+  "is_html_allowed_on_front": false,
+  "is_searchable": false,
+  "is_used_for_customer_segment": false,
   "is_used_for_price_rules": false,
   "is_used_for_promo_rules": false,
   "is_visible_in_advanced_search": false,
   "is_visible_on_front": false,
-  "is_wysiwyg_enabled": false,
+  "is_wysiwyg_enabled": true,
   "used_in_product_listing": true
 }
 
     
@@ -24776,7 +24764,7 @@ 
    Example
    
                   
                   
    {
   "attribute_code": "abc123",
-  "entity_type": "abc123"
+  "entity_type": "xyz789"
 }
 
     
                   
@@ -24950,8 +24938,8 @@ 
    Example
    
   "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
   "is_required": false,
-  "is_unique": true,
-  "label": "xyz789",
+  "is_unique": false,
+  "label": "abc123",
   "options": [CustomAttributeOptionInterface]
 }
 
     
@@ -25197,7 +25185,7 @@ 
    Example
    
                   
    {
   "is_default": false,
   "label": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
     
                   
@@ -25251,7 +25239,7 @@ 
    Example
    
                   
                   
    {
   "label": "abc123",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
     
                   
@@ -25324,7 +25312,7 @@ 
    Example
    
                   
                   
    {
   "label": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
     
                   
@@ -25377,7 +25365,7 @@ 
    Example
    
                   
                   
                   
    {
-  "code": 4,
+  "code": "4",
   "selected_options": [AttributeSelectedOptionInterface]
 }
 
     
@@ -25430,10 +25418,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {
-  "code": "4",
-  "value": "abc123"
-}
+                  
    {"code": 4, "value": "xyz789"}
 
     
                   
                 
@@ -25575,7 +25560,7 @@ 
    Possible Types
    
                   
    Example
    
                   
                   
-                  
    {"code": 4}
+                  
    {"code": "4"}
 
     
                   
                 
@@ -25746,7 +25731,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"code": "AFN", "symbol": "abc123"}
+                  
    {"code": "AFN", "symbol": "xyz789"}
 
     
                   
                 
@@ -25811,8 +25796,8 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "xyz789",
-  "is_deferred": false,
+  "code": "abc123",
+  "is_deferred": true,
   "title": "xyz789"
 }
 
     
@@ -25945,13 +25930,13 @@ 
    Example
    
                   
                   
    {
   "amount": Money,
-  "available": false,
+  "available": true,
   "base_amount": Money,
   "carrier_code": "abc123",
-  "carrier_title": "xyz789",
-  "error_message": "abc123",
-  "method_code": "abc123",
-  "method_title": "xyz789",
+  "carrier_title": "abc123",
+  "error_message": "xyz789",
+  "method_code": "xyz789",
+  "method_title": "abc123",
   "price_excl_tax": Money,
   "price_incl_tax": Money
 }
@@ -26088,9 +26073,9 @@ 
    Example
    
                   
                   
    {
   "address": CartAddressInput,
-  "customer_address_id": 123,
+  "customer_address_id": 987,
   "same_as_shipping": false,
-  "use_for_shipping": false
+  "use_for_shipping": true
 }
 
     
                   
@@ -26288,19 +26273,19 @@ 
    Example
    
   "company": "xyz789",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "customer_notes": "xyz789",
-  "fax": "abc123",
+  "customer_notes": "abc123",
+  "fax": "xyz789",
   "firstname": "xyz789",
-  "lastname": "abc123",
-  "middlename": "abc123",
+  "lastname": "xyz789",
+  "middlename": "xyz789",
   "postcode": "xyz789",
   "prefix": "abc123",
   "region": CartAddressRegion,
-  "street": ["xyz789"],
-  "suffix": "abc123",
+  "street": ["abc123"],
+  "suffix": "xyz789",
   "telephone": "abc123",
   "uid": "xyz789",
-  "vat_id": "xyz789"
+  "vat_id": "abc123"
 }
 
     
                   
@@ -26438,7 +26423,7 @@ 
    Example
    
                   
                   
    {
   "device_data": "abc123",
-  "is_active_payment_token_enabler": true,
+  "is_active_payment_token_enabler": false,
   "payment_method_nonce": "xyz789"
 }
 
     
@@ -26588,12 +26573,12 @@ 
    Example
    
                   
                   
                   
    {
-  "category_id": 987,
+  "category_id": 123,
   "category_level": 987,
-  "category_name": "xyz789",
+  "category_name": "abc123",
   "category_uid": 4,
   "category_url_key": "xyz789",
-  "category_url_path": "abc123"
+  "category_url_path": "xyz789"
 }
 
     
                   
@@ -26776,13 +26761,13 @@ 
    Example
    
   "errors": [CartItemError],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "xyz789",
-  "is_available": false,
+  "id": "abc123",
+  "is_available": true,
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "uid": "4"
 }
 
     
@@ -26898,10 +26883,10 @@ 
    Example
    
   "discounts": [Discount],
   "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "quantity_refunded": 987.65
+  "product_sku": "abc123",
+  "quantity_refunded": 123.45
 }
 
     
                   
@@ -27018,8 +27003,8 @@ 
    Example
    
   "order_item": OrderItemInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "quantity_invoiced": 123.45
+  "product_sku": "abc123",
+  "quantity_invoiced": 987.65
 }
 
     
                   
@@ -27145,7 +27130,7 @@ 
    Example
    
   "options": [BundleItemOption],
   "position": 987,
   "price_range": PriceRange,
-  "required": true,
+  "required": false,
   "sku": "abc123",
   "title": "abc123",
   "type": "abc123",
@@ -27293,15 +27278,15 @@ 
    Example
    
                   
    {
   "can_change_quantity": true,
   "id": 123,
-  "is_default": true,
+  "is_default": false,
   "label": "xyz789",
-  "position": 123,
+  "position": 987,
   "price": 123.45,
   "price_type": "FIXED",
   "product": ProductInterface,
-  "qty": 123.45,
-  "quantity": 987.65,
-  "uid": 4
+  "qty": 987.65,
+  "quantity": 123.45,
+  "uid": "4"
 }
 
     
                   
@@ -27373,9 +27358,9 @@ 
    Example
    
                   
                   
                   
    {
-  "id": 123,
+  "id": 987,
   "quantity": 123.45,
-  "value": ["xyz789"]
+  "value": ["abc123"]
 }
 
     
                   
@@ -27605,25 +27590,25 @@ 
    Example
    
                   
    {
   "bundle_options": [ItemSelectedBundleOption],
   "discounts": [Discount],
-  "eligible_for_return": false,
+  "eligible_for_return": true,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
   "id": 4,
   "product": ProductInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "product_type": "abc123",
+  "product_type": "xyz789",
   "product_url_key": "abc123",
-  "quantity_canceled": 123.45,
-  "quantity_invoiced": 987.65,
+  "quantity_canceled": 987.65,
+  "quantity_invoiced": 123.45,
   "quantity_ordered": 123.45,
-  "quantity_refunded": 123.45,
+  "quantity_refunded": 987.65,
   "quantity_returned": 987.65,
   "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "abc123"
+  "status": "xyz789"
 }
 
     
                   
@@ -28557,85 +28542,85 @@ 
    Example
    
   "category_gear": "abc123",
   "climate": "abc123",
   "collar": "xyz789",
-  "color": 987,
-  "country_of_manufacture": "abc123",
-  "created_at": "xyz789",
+  "color": 123,
+  "country_of_manufacture": "xyz789",
+  "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "dynamic_price": true,
-  "dynamic_sku": false,
+  "dynamic_sku": true,
   "dynamic_weight": false,
   "eco_collection": 123,
-  "erin_recommends": 987,
-  "features_bags": "xyz789",
-  "format": 987,
+  "erin_recommends": 123,
+  "features_bags": "abc123",
+  "format": 123,
   "gender": "abc123",
-  "gift_message_available": "abc123",
+  "gift_message_available": "xyz789",
   "id": 123,
   "image": ProductImage,
-  "is_returnable": "xyz789",
+  "is_returnable": "abc123",
   "items": [BundleItem],
-  "manufacturer": 123,
+  "manufacturer": 987,
   "material": "xyz789",
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "xyz789",
-  "meta_keyword": "abc123",
+  "meta_description": "abc123",
+  "meta_keyword": "xyz789",
   "meta_title": "xyz789",
   "name": "abc123",
   "new": 123,
-  "new_from_date": "xyz789",
-  "new_to_date": "abc123",
-  "only_x_left_in_stock": 987.65,
+  "new_from_date": "abc123",
+  "new_to_date": "xyz789",
+  "only_x_left_in_stock": 123.45,
   "options": [CustomizableOptionInterface],
   "options_container": "xyz789",
   "pattern": "abc123",
-  "performance_fabric": 987,
+  "performance_fabric": 123,
   "price": ProductPrices,
   "price_details": PriceDetails,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "price_view": "PRICE_RANGE",
   "product_links": [ProductLinksInterface],
-  "purpose": 123,
+  "purpose": 987,
   "rating_summary": 123.45,
   "redirect_code": 123,
   "related_products": [ProductInterface],
   "relative_url": "xyz789",
   "review_count": 987,
   "reviews": ProductReviews,
-  "sale": 987,
+  "sale": 123,
   "ship_bundle_items": "TOGETHER",
   "short_description": ComplexTextValue,
   "size": 987,
-  "sku": "xyz789",
+  "sku": "abc123",
   "sleeve": "abc123",
   "small_image": ProductImage,
-  "special_from_date": "abc123",
+  "special_from_date": "xyz789",
   "special_price": 123.45,
-  "special_to_date": "abc123",
+  "special_to_date": "xyz789",
   "staged": false,
   "stock_status": "IN_STOCK",
-  "strap_bags": "xyz789",
-  "style_bags": "xyz789",
+  "strap_bags": "abc123",
+  "style_bags": "abc123",
   "style_bottom": "abc123",
-  "style_general": "abc123",
+  "style_general": "xyz789",
   "swatch_image": "xyz789",
   "thumbnail": ProductImage,
   "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "xyz789",
+  "type_id": "abc123",
   "uid": 4,
-  "updated_at": "abc123",
+  "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
-  "url_key": "xyz789",
-  "url_path": "abc123",
+  "url_key": "abc123",
+  "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
   "url_suffix": "abc123",
   "websites": [Website],
-  "weight": 987.65
+  "weight": 123.45
 }
 
     
                   
@@ -28797,7 +28782,7 @@ 
    Example
    
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
   "quantity": 123.45,
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -28902,7 +28887,7 @@ 
    Example
    
   "bundle_options": [ItemSelectedBundleOption],
   "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "abc123",
   "quantity_shipped": 987.65
@@ -29010,10 +28995,10 @@ 
    Example
    
   "added_at": "xyz789",
   "bundle_options": [SelectedBundleOption],
   "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
+  "description": "xyz789",
   "id": 4,
   "product": ProductInterface,
-  "quantity": 123.45
+  "quantity": 987.65
 }
 
     
                   
@@ -29114,8 +29099,8 @@ 
    Example
    
   "color": "abc123",
   "height": 987,
   "label": "xyz789",
-  "layout": "xyz789",
-  "shape": "abc123",
+  "layout": "abc123",
+  "shape": "xyz789",
   "tagline": true,
   "use_default_height": true
 }
@@ -29177,10 +29162,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {
-  "order_id": "4",
-  "reason": "abc123"
-}
+                  
    {"order_id": 4, "reason": "abc123"}
 
     
                   
                 
@@ -29236,7 +29218,7 @@ 
    Example
    
                   
                   
                   
    {
-  "error": "xyz789",
+  "error": "abc123",
   "order": CustomerOrder
 }
 
     
@@ -29280,7 +29262,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"description": "abc123"}
+                  
    {"description": "xyz789"}
 
     
                   
                 
@@ -29360,9 +29342,9 @@ 
    Example
    
                   
                   
    {
   "bin_details": CardBin,
-  "card_expiry_month": "abc123",
+  "card_expiry_month": "xyz789",
   "card_expiry_year": "xyz789",
-  "last_digits": "abc123",
+  "last_digits": "xyz789",
   "name": "xyz789"
 }
 
     
@@ -29406,7 +29388,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"bin": "abc123"}
+                  
    {"bin": "xyz789"}
 
     
                   
                 
@@ -29680,7 +29662,7 @@ 
    Example
    
   "billing_address": BillingCartAddress,
   "email": "abc123",
   "gift_message": GiftMessage,
-  "gift_receipt_included": false,
+  "gift_receipt_included": true,
   "gift_wrapping": GiftWrapping,
   "id": "4",
   "is_virtual": false,
@@ -29690,7 +29672,7 @@ 
    Example
    
   "printed_card_included": true,
   "selected_payment_method": SelectedPaymentMethod,
   "shipping_addresses": [ShippingCartAddress],
-  "total_quantity": 987.65
+  "total_quantity": 123.45
 }
 
     
                   
@@ -29748,7 +29730,7 @@ 
    Example
    
                   
                   
    {
   "code": "xyz789",
-  "label": "xyz789"
+  "label": "abc123"
 }
 
     
                   
@@ -29974,18 +29956,18 @@ 
    Example
    
                   
                   
                   
    {
-  "city": "abc123",
-  "company": "xyz789",
+  "city": "xyz789",
+  "company": "abc123",
   "country_code": "xyz789",
   "custom_attributes": [AttributeValueInput],
   "fax": "xyz789",
   "firstname": "xyz789",
-  "lastname": "abc123",
-  "middlename": "xyz789",
-  "postcode": "abc123",
-  "prefix": "abc123",
-  "region": "xyz789",
-  "region_id": 987,
+  "lastname": "xyz789",
+  "middlename": "abc123",
+  "postcode": "xyz789",
+  "prefix": "xyz789",
+  "region": "abc123",
+  "region_id": 123,
   "save_in_address_book": true,
   "street": ["abc123"],
   "suffix": "xyz789",
@@ -30199,18 +30181,18 @@ 
    Example
    
   "company": "abc123",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "fax": "abc123",
+  "fax": "xyz789",
   "firstname": "xyz789",
-  "lastname": "abc123",
-  "middlename": "xyz789",
+  "lastname": "xyz789",
+  "middlename": "abc123",
   "postcode": "abc123",
-  "prefix": "abc123",
+  "prefix": "xyz789",
   "region": CartAddressRegion,
   "street": ["xyz789"],
-  "suffix": "xyz789",
+  "suffix": "abc123",
   "telephone": "xyz789",
-  "uid": "xyz789",
-  "vat_id": "xyz789"
+  "uid": "abc123",
+  "vat_id": "abc123"
 }
 
     
                   
@@ -30276,8 +30258,8 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "xyz789",
-  "label": "abc123",
+  "code": "abc123",
+  "label": "xyz789",
   "region_id": 123
 }
 
     
@@ -30433,7 +30415,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"code": "UNDEFINED", "message": "xyz789"}
+                  
    {"code": "UNDEFINED", "message": "abc123"}
 
     
                   
                 
@@ -30579,9 +30561,9 @@ 
    Example
    
                   
    {
   "entered_options": [EnteredOptionInput],
   "parent_sku": "abc123",
-  "quantity": 123.45,
-  "selected_options": ["4"],
-  "sku": "xyz789"
+  "quantity": 987.65,
+  "selected_options": [4],
+  "sku": "abc123"
 }
 
     
                   
@@ -30768,14 +30750,14 @@ 
    Example
    
                   
    {
   "discount": [Discount],
   "errors": [CartItemError],
-  "id": "abc123",
+  "id": "xyz789",
   "is_available": true,
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 987.65,
-  "uid": 4
+  "quantity": 123.45,
+  "uid": "4"
 }
 
     
                   
@@ -30943,7 +30925,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"cart_item_id": 987, "quantity": 123.45}
+                  
    {"cart_item_id": 123, "quantity": 987.65}
 
     
                   
                 
@@ -31010,7 +30992,7 @@ 
    Example
    
                   
    {
   "type": "FIXED",
   "units": "xyz789",
-  "value": 987.65
+  "value": 123.45
 }
 
     
                   
@@ -31115,11 +31097,11 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_item_id": 123,
+  "cart_item_id": 987,
   "cart_item_uid": "4",
   "customizable_options": [CustomizableOptionInput],
   "gift_message": GiftMessageInput,
-  "gift_wrapping_id": "4",
+  "gift_wrapping_id": 4,
   "quantity": 987.65
 }
 
     
@@ -31814,24 +31796,24 @@ 
    Example
    
                   
                   
    {
   "apply_to": ["SIMPLE"],
-  "code": "4",
+  "code": 4,
   "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "abc123",
+  "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
-  "is_comparable": true,
+  "is_comparable": false,
   "is_filterable": true,
-  "is_filterable_in_search": false,
+  "is_filterable_in_search": true,
   "is_html_allowed_on_front": false,
   "is_required": true,
   "is_searchable": false,
   "is_unique": false,
-  "is_used_for_price_rules": false,
-  "is_used_for_promo_rules": false,
-  "is_visible_in_advanced_search": false,
+  "is_used_for_price_rules": true,
+  "is_used_for_promo_rules": true,
+  "is_visible_in_advanced_search": true,
   "is_visible_on_front": true,
-  "is_wysiwyg_enabled": true,
-  "label": "xyz789",
+  "is_wysiwyg_enabled": false,
+  "label": "abc123",
   "options": [CustomAttributeOptionInterface],
   "swatch_input_type": "BOOLEAN",
   "update_product_preview_image": false,
@@ -32356,38 +32338,38 @@ 
    Example
    
                   
                   
    {
   "automatic_sorting": "xyz789",
-  "available_sort_by": ["xyz789"],
+  "available_sort_by": ["abc123"],
   "breadcrumbs": [Breadcrumb],
   "canonical_url": "xyz789",
   "children_count": "xyz789",
   "cms_block": CmsBlock,
   "created_at": "abc123",
-  "custom_layout_update_file": "xyz789",
+  "custom_layout_update_file": "abc123",
   "default_sort_by": "abc123",
   "description": "abc123",
-  "display_mode": "abc123",
+  "display_mode": "xyz789",
   "filter_price_range": 987.65,
   "id": 987,
-  "image": "xyz789",
+  "image": "abc123",
   "include_in_menu": 987,
-  "is_anchor": 987,
-  "landing_page": 123,
-  "level": 987,
+  "is_anchor": 123,
+  "landing_page": 987,
+  "level": 123,
   "meta_description": "xyz789",
-  "meta_keywords": "abc123",
+  "meta_keywords": "xyz789",
   "meta_title": "abc123",
   "name": "abc123",
-  "path": "xyz789",
-  "path_in_store": "abc123",
+  "path": "abc123",
+  "path_in_store": "xyz789",
   "position": 123,
-  "product_count": 987,
+  "product_count": 123,
   "products": CategoryProducts,
-  "staged": false,
+  "staged": true,
   "uid": "4",
   "updated_at": "abc123",
   "url_key": "abc123",
-  "url_path": "abc123",
-  "url_suffix": "xyz789"
+  "url_path": "xyz789",
+  "url_suffix": "abc123"
 }
 
     
                   
@@ -32523,7 +32505,7 @@ 
    Example
    
                   
    {
   "items": [CategoryTree],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
     
                   
@@ -32937,26 +32919,26 @@ 
    Example
    
                   
                   
                   
    {
-  "automatic_sorting": "abc123",
+  "automatic_sorting": "xyz789",
   "available_sort_by": ["abc123"],
   "breadcrumbs": [Breadcrumb],
-  "canonical_url": "xyz789",
+  "canonical_url": "abc123",
   "children": [CategoryTree],
   "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": "abc123",
   "display_mode": "xyz789",
   "filter_price_range": 123.45,
   "id": 987,
-  "image": "xyz789",
-  "include_in_menu": 123,
-  "is_anchor": 987,
+  "image": "abc123",
+  "include_in_menu": 987,
+  "is_anchor": 123,
   "landing_page": 987,
   "level": 123,
-  "meta_description": "abc123",
+  "meta_description": "xyz789",
   "meta_keywords": "abc123",
   "meta_title": "abc123",
   "name": "abc123",
@@ -32965,9 +32947,9 @@ 
    Example
    
   "position": 123,
   "product_count": 987,
   "products": CategoryProducts,
-  "redirect_code": 987,
-  "relative_url": "abc123",
-  "staged": true,
+  "redirect_code": 123,
+  "relative_url": "xyz789",
+  "staged": false,
   "type": "CMS_PAGE",
   "uid": 4,
   "updated_at": "abc123",
@@ -33076,10 +33058,10 @@ 
    Example
    
                   
                   
    {
   "agreement_id": 987,
-  "checkbox_text": "abc123",
-  "content": "abc123",
-  "content_height": "abc123",
-  "is_html": true,
+  "checkbox_text": "xyz789",
+  "content": "xyz789",
+  "content_height": "xyz789",
+  "is_html": false,
   "mode": "AUTO",
   "name": "abc123"
 }
@@ -33199,8 +33181,8 @@ 
    Example
    
                   
                   
    {
   "code": "REORDER_NOT_AVAILABLE",
-  "message": "xyz789",
-  "path": ["xyz789"]
+  "message": "abc123",
+  "path": ["abc123"]
 }
 
     
                   
@@ -33647,7 +33629,7 @@ 
    Example
    
                   
                   
    {
   "errors": [NegotiableQuoteInvalidStateError],
-  "quote_uid": "4"
+  "quote_uid": 4
 }
 
     
                   
@@ -33934,8 +33916,8 @@ 
    Example
    
                   
                   
                   
    {
-  "content": "abc123",
-  "identifier": "xyz789",
+  "content": "xyz789",
+  "identifier": "abc123",
   "title": "xyz789"
 }
 
     
@@ -34129,18 +34111,18 @@ 
    Example
    
                   
                   
                   
    {
-  "content": "abc123",
+  "content": "xyz789",
   "content_heading": "abc123",
   "identifier": "abc123",
   "meta_description": "abc123",
   "meta_keywords": "abc123",
-  "meta_title": "abc123",
+  "meta_title": "xyz789",
   "page_layout": "xyz789",
-  "redirect_code": 123,
-  "relative_url": "xyz789",
+  "redirect_code": 987,
+  "relative_url": "abc123",
   "title": "abc123",
   "type": "CMS_PAGE",
-  "url_key": "abc123"
+  "url_key": "xyz789"
 }
 
     
                   
@@ -34183,7 +34165,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"value": "xyz789"}
+                  
    {"value": "abc123"}
 
     
                   
                 
@@ -34570,8 +34552,8 @@ 
    Example
    
   "company_admin": Customer,
   "credit": CompanyCredit,
   "credit_history": CompanyCreditHistory,
-  "email": "abc123",
-  "id": "4",
+  "email": "xyz789",
+  "id": 4,
   "legal_address": CompanyLegalAddress,
   "legal_name": "xyz789",
   "name": "abc123",
@@ -34584,7 +34566,7 @@ 
    Example
    
   "team": CompanyTeam,
   "user": Customer,
   "users": CompanyUsers,
-  "vat_tax_id": "abc123"
+  "vat_tax_id": "xyz789"
 }
 
     
                   
@@ -34661,7 +34643,7 @@ 
    Example
    
                   
    {
   "children": [CompanyAclResource],
   "id": "4",
-  "sort_order": 987,
+  "sort_order": 123,
   "text": "xyz789"
 }
 
     
@@ -34757,10 +34739,10 @@ 
    Example
    
                   
                   
    {
   "email": "xyz789",
-  "firstname": "xyz789",
-  "gender": 123,
+  "firstname": "abc123",
+  "gender": 987,
   "job_title": "abc123",
-  "lastname": "xyz789"
+  "lastname": "abc123"
 }
 
     
                   
@@ -34878,9 +34860,9 @@ 
    Example
    
                   
    {
   "company_admin": CompanyAdminInput,
   "company_email": "abc123",
-  "company_name": "abc123",
+  "company_name": "xyz789",
   "legal_address": CompanyLegalAddressCreateInput,
-  "legal_name": "abc123",
+  "legal_name": "xyz789",
   "reseller_id": "xyz789",
   "vat_tax_id": "xyz789"
 }
@@ -35018,7 +35000,7 @@ 
    Example
    
                   
    {
   "items": [CompanyCreditOperation],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
     
                   
@@ -35092,7 +35074,7 @@ 
    Example
    
                   
    {
   "custom_reference_number": "abc123",
   "operation_type": "ALLOCATION",
-  "updated_by": "abc123"
+  "updated_by": "xyz789"
 }
 
     
                   
@@ -35564,10 +35546,10 @@ 
    Example
    
                   
    {
   "city": "abc123",
   "country_id": "AF",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": CustomerAddressRegionInput,
-  "street": ["xyz789"],
-  "telephone": "abc123"
+  "street": ["abc123"],
+  "telephone": "xyz789"
 }
 
     
                   
@@ -35672,9 +35654,9 @@ 
    Example
    
                   
                   
                   
    {
-  "city": "abc123",
+  "city": "xyz789",
   "country_id": "AF",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "region": CustomerAddressRegionInput,
   "street": ["abc123"],
   "telephone": "xyz789"
@@ -35753,7 +35735,7 @@ 
    Example
    
                   
                   
    {
   "id": "4",
-  "name": "abc123",
+  "name": "xyz789",
   "permissions": [CompanyAclResource],
   "users_count": 987
 }
@@ -35891,7 +35873,7 @@ 
    Example
    
                   
    {
   "id": "4",
   "name": "xyz789",
-  "permissions": ["abc123"]
+  "permissions": ["xyz789"]
 }
 
     
                   
@@ -35959,7 +35941,7 @@ 
    Example
    
                   
    {
   "items": [CompanyRole],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
     
                   
@@ -36026,8 +36008,8 @@ 
    Example
    
                   
                   
    {
   "email": "abc123",
-  "firstname": "abc123",
-  "lastname": "xyz789"
+  "firstname": "xyz789",
+  "lastname": "abc123"
 }
 
     
                   
@@ -36186,7 +36168,7 @@ 
    Example
    
                   
                   
    {
   "entity": CompanyTeam,
-  "id": 4,
+  "id": "4",
   "parent_id": "4"
 }
 
     
@@ -36326,8 +36308,8 @@ 
    Example
    
                   
    {
   "description": "abc123",
   "id": 4,
-  "name": "xyz789",
-  "structure_id": 4
+  "name": "abc123",
+  "structure_id": "4"
 }
 
     
                   
@@ -36399,9 +36381,9 @@ 
    Example
    
                   
                   
                   
    {
-  "description": "xyz789",
-  "name": "abc123",
-  "target_id": 4
+  "description": "abc123",
+  "name": "xyz789",
+  "target_id": "4"
 }
 
     
                   
@@ -36473,7 +36455,7 @@ 
    Example
    
                   
                   
                   
    {
-  "description": "abc123",
+  "description": "xyz789",
   "id": 4,
   "name": "abc123"
 }
@@ -36581,9 +36563,9 @@ 
    Example
    
                   
                   
    {
   "company_email": "abc123",
-  "company_name": "xyz789",
+  "company_name": "abc123",
   "legal_address": CompanyLegalAddressUpdateInput,
-  "legal_name": "abc123",
+  "legal_name": "xyz789",
   "reseller_id": "xyz789",
   "vat_tax_id": "abc123"
 }
@@ -36713,12 +36695,12 @@ 
    Example
    
                   
                   
    {
   "email": "xyz789",
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "job_title": "abc123",
   "lastname": "xyz789",
-  "role_id": 4,
+  "role_id": "4",
   "status": "ACTIVE",
-  "target_id": "4",
+  "target_id": 4,
   "telephone": "abc123"
 }
 
     
@@ -36902,7 +36884,7 @@ 
    Example
    
   "lastname": "xyz789",
   "role_id": "4",
   "status": "ACTIVE",
-  "telephone": "xyz789"
+  "telephone": "abc123"
 }
 
     
                   
@@ -36970,7 +36952,7 @@ 
    Example
    
                   
    {
   "items": [Customer],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
     
                   
@@ -37220,9 +37202,9 @@ 
    Example
    
                   
                   
    {
   "attributes": [ComparableAttribute],
-  "item_count": 987,
+  "item_count": 123,
   "items": [ComparableItem],
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -37265,7 +37247,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"html": "abc123"}
+                  
    {"html": "xyz789"}
 
     
                   
                 
@@ -37340,9 +37322,9 @@ 
    Example
    
                   
                   
    {
   "code": "xyz789",
-  "label": "xyz789",
-  "uid": 4,
-  "value_index": 987
+  "label": "abc123",
+  "uid": "4",
+  "value_index": 123
 }
 
     
                   
@@ -37535,13 +37517,13 @@ 
    Example
    
   "errors": [CartItemError],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "abc123",
-  "is_available": true,
+  "id": "xyz789",
+  "is_available": false,
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "uid": "4"
 }
 
     
@@ -37599,7 +37581,7 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_code": "xyz789",
+  "attribute_code": "abc123",
   "option_value_uids": ["4"]
 }
 
     
@@ -38512,84 +38494,84 @@ 
    Example
    
   "attribute_set_id": 123,
   "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
+  "category_gear": "xyz789",
   "climate": "abc123",
   "collar": "abc123",
-  "color": 123,
+  "color": 987,
   "configurable_options": [ConfigurableProductOptions],
   "configurable_product_options_selection": ConfigurableProductOptionsSelection,
-  "country_of_manufacture": "abc123",
-  "created_at": "abc123",
+  "country_of_manufacture": "xyz789",
+  "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "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": "xyz789",
+  "gender": "abc123",
   "gift_message_available": "abc123",
-  "id": 987,
+  "id": 123,
   "image": ProductImage,
-  "is_returnable": "xyz789",
+  "is_returnable": "abc123",
   "manufacturer": 987,
   "material": "abc123",
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "xyz789",
-  "meta_keyword": "xyz789",
+  "meta_description": "abc123",
+  "meta_keyword": "abc123",
   "meta_title": "abc123",
   "name": "abc123",
   "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",
+  "options_container": "abc123",
+  "pattern": "abc123",
   "performance_fabric": 123,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 123,
-  "rating_summary": 123.45,
-  "redirect_code": 987,
+  "purpose": 987,
+  "rating_summary": 987.65,
+  "redirect_code": 123,
   "related_products": [ProductInterface],
-  "relative_url": "xyz789",
+  "relative_url": "abc123",
   "review_count": 123,
   "reviews": ProductReviews,
-  "sale": 987,
+  "sale": 123,
   "short_description": ComplexTextValue,
-  "size": 987,
-  "sku": "xyz789",
-  "sleeve": "xyz789",
+  "size": 123,
+  "sku": "abc123",
+  "sleeve": "abc123",
   "small_image": ProductImage,
   "special_from_date": "abc123",
-  "special_price": 123.45,
+  "special_price": 987.65,
   "special_to_date": "xyz789",
   "staged": false,
   "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
-  "style_bags": "xyz789",
-  "style_bottom": "abc123",
-  "style_general": "xyz789",
+  "strap_bags": "xyz789",
+  "style_bags": "abc123",
+  "style_bottom": "xyz789",
+  "style_general": "abc123",
   "swatch_image": "xyz789",
   "thumbnail": ProductImage,
-  "tier_price": 987.65,
+  "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "abc123",
-  "uid": "4",
+  "type_id": "xyz789",
+  "uid": 4,
   "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
   "url_key": "xyz789",
-  "url_path": "abc123",
+  "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
   "url_suffix": "abc123",
   "variants": [ConfigurableVariant],
   "websites": [Website],
-  "weight": 987.65
+  "weight": 123.45
 }
 
     
                   
@@ -38670,7 +38652,7 @@ 
    Example
    
                   
    {
   "customizable_options": [CustomizableOptionInput],
   "data": CartItemInput,
-  "parent_sku": "abc123",
+  "parent_sku": "xyz789",
   "variant_sku": "abc123"
 }
 
     
@@ -38746,8 +38728,8 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_code": "abc123",
-  "label": "xyz789",
+  "attribute_code": "xyz789",
+  "label": "abc123",
   "uid": 4,
   "values": [ConfigurableProductOptionValue]
 }
@@ -38985,14 +38967,14 @@ 
    Example
    
                   
    {
   "attribute_code": "abc123",
   "attribute_id": "xyz789",
-  "attribute_id_v2": 123,
+  "attribute_id_v2": 987,
   "attribute_uid": "4",
   "id": 123,
   "label": "xyz789",
   "position": 123,
   "product_id": 987,
-  "uid": "4",
-  "use_default": true,
+  "uid": 4,
+  "use_default": false,
   "values": [ConfigurableProductOptionsValues]
 }
 
     
@@ -39177,8 +39159,8 @@ 
    Example
    
                   
                   
                   
    {
-  "default_label": "abc123",
-  "label": "xyz789",
+  "default_label": "xyz789",
+  "label": "abc123",
   "store_label": "abc123",
   "swatch_data": SwatchDataInterface,
   "uid": "4",
@@ -39452,14 +39434,14 @@ 
    Example
    
                   
                   
    {
   "added_at": "xyz789",
-  "child_sku": "xyz789",
+  "child_sku": "abc123",
   "configurable_options": [SelectedConfigurableOption],
   "configured_variant": ProductInterface,
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
-  "id": "4",
+  "id": 4,
   "product": ProductInterface,
-  "quantity": 123.45
+  "quantity": 987.65
 }
 
     
                   
@@ -39520,8 +39502,8 @@ 
    Example
    
                   
                   
                   
    {
-  "confirmation_key": "abc123",
-  "email": "xyz789"
+  "confirmation_key": "xyz789",
+  "email": "abc123"
 }
 
     
                   
@@ -39650,7 +39632,7 @@ 
    Example
    
                   
                   
    {
   "comment": "abc123",
-  "email": "xyz789",
+  "email": "abc123",
   "name": "abc123",
   "telephone": "abc123"
 }
@@ -39699,7 +39681,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"status": true}
+                  
    {"status": false}
 
     
                   
                 
@@ -39747,7 +39729,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"requisitionListItemUids": [4]}
+                  
    {"requisitionListItemUids": ["4"]}
 
     
                   
                 
@@ -39951,8 +39933,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": "xyz789"
 }
@@ -41823,9 +41805,9 @@ 
    Example
    
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
-  "event_name": "xyz789",
+  "event_name": "abc123",
   "gift_registry_type_uid": 4,
-  "message": "xyz789",
+  "message": "abc123",
   "privacy_settings": "PRIVATE",
   "registrants": [AddGiftRegistryRegistrantInput],
   "shipping_address": GiftRegistryShippingAddressInput,
@@ -41920,7 +41902,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"cart_uid": "4"}
+                  
    {"cart_uid": 4}
 
     
                   
                 
@@ -42045,8 +42027,8 @@ 
    Example
    
                   
                   
                   
    {
-  "response_message": "xyz789",
-  "result": 987,
+  "response_message": "abc123",
+  "result": 123,
   "result_code": 987,
   "secure_token": "abc123",
   "secure_token_id": "abc123"
@@ -42146,8 +42128,8 @@ 
    Example
    
   "cartId": "xyz789",
   "location": "PRODUCT_DETAIL",
   "methodCode": "abc123",
-  "paymentSource": "abc123",
-  "vaultIntent": false
+  "paymentSource": "xyz789",
+  "vaultIntent": true
 }
 
     
                   
@@ -42214,7 +42196,7 @@ 
    Example
    
                   
                   
    {
   "id": "abc123",
-  "mp_order_id": "abc123",
+  "mp_order_id": "xyz789",
   "status": "xyz789"
 }
 
     
@@ -42312,8 +42294,8 @@ 
    Example
    
   "nickname": "xyz789",
   "ratings": [ProductReviewRatingInput],
   "sku": "abc123",
-  "summary": "abc123",
-  "text": "abc123"
+  "summary": "xyz789",
+  "text": "xyz789"
 }
 
     
                   
@@ -42419,7 +42401,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"currency": "AFN", "value": 123.45}
+                  
    {"currency": "AFN", "value": 987.65}
 
     
                   
                 
@@ -42504,7 +42486,7 @@ 
    Example
    
   "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput,
   "attribute": "GRAND_TOTAL",
   "operator": "MORE_THAN",
-  "quantity": 987
+  "quantity": 123
 }
 
     
                   
@@ -42565,8 +42547,8 @@ 
    Example
    
                   
                   
                   
    {
-  "description": "abc123",
-  "name": "abc123"
+  "description": "xyz789",
+  "name": "xyz789"
 }
 
     
                   
@@ -42802,7 +42784,7 @@ 
    Example
    
                   
    {
   "cc_exp_month": 123,
   "cc_exp_year": 123,
-  "cc_last_4": 987,
+  "cc_last_4": 123,
   "cc_type": "xyz789"
 }
 
     
@@ -42992,10 +42974,10 @@ 
    Example
    
   "discounts": [Discount],
   "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "quantity_refunded": 123.45
+  "quantity_refunded": 987.65
 }
 
     
                   
@@ -43138,12 +43120,12 @@ 
    Example
    
                   
                   
    {
   "discounts": [Discount],
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_refunded": 987.65
+  "product_sku": "xyz789",
+  "quantity_refunded": 123.45
 }
 
     
                   
@@ -43382,10 +43364,10 @@ 
    Example
    
                   
                   
                   
    {
-  "available_currency_codes": ["xyz789"],
+  "available_currency_codes": ["abc123"],
   "base_currency_code": "abc123",
   "base_currency_symbol": "xyz789",
-  "default_display_currecy_code": "xyz789",
+  "default_display_currecy_code": "abc123",
   "default_display_currecy_symbol": "abc123",
   "default_display_currency_code": "xyz789",
   "default_display_currency_symbol": "abc123",
@@ -44652,14 +44634,14 @@ 
    Example
    
                   
                   
                   
    {
-  "code": 4,
-  "default_value": "abc123",
+  "code": "4",
+  "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
-  "is_required": true,
+  "is_required": false,
   "is_unique": true,
-  "label": "xyz789",
+  "label": "abc123",
   "options": [CustomAttributeOptionInterface]
 }
 
     
@@ -44741,7 +44723,7 @@ 
    Example
    
                   
                   
                   
    {
-  "is_default": true,
+  "is_default": false,
   "label": "xyz789",
   "value": "xyz789"
 }
@@ -45530,25 +45512,25 @@ 
    Example
    
   "allow_remote_shopping_assistance": true,
   "compare_list": CompareList,
   "confirmation_status": "ACCOUNT_CONFIRMED",
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "custom_attributes": [AttributeValueInterface],
-  "date_of_birth": "abc123",
-  "default_billing": "xyz789",
+  "date_of_birth": "xyz789",
+  "default_billing": "abc123",
   "default_shipping": "xyz789",
   "dob": "abc123",
-  "email": "xyz789",
+  "email": "abc123",
   "firstname": "abc123",
-  "gender": 123,
+  "gender": 987,
   "gift_registries": [GiftRegistry],
   "gift_registry": GiftRegistry,
-  "group_id": 987,
-  "id": 123,
+  "group_id": 123,
+  "id": 987,
   "is_subscribed": false,
   "job_title": "abc123",
   "lastname": "xyz789",
   "middlename": "xyz789",
   "orders": CustomerOrders,
-  "prefix": "abc123",
+  "prefix": "xyz789",
   "purchase_order": PurchaseOrder,
   "purchase_order_approval_rule": PurchaseOrderApprovalRule,
   "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
@@ -45563,7 +45545,7 @@ 
    Example
    
   "role": CompanyRole,
   "status": "ACTIVE",
   "store_credit": CustomerStoreCredit,
-  "structure_id": "4",
+  "structure_id": 4,
   "suffix": "abc123",
   "taxvat": "xyz789",
   "team": CompanyTeam,
@@ -45839,29 +45821,29 @@ 
    Example
    
                   
                   
                   
    {
-  "city": "abc123",
-  "company": "xyz789",
+  "city": "xyz789",
+  "company": "abc123",
   "country_code": "AF",
-  "country_id": "abc123",
+  "country_id": "xyz789",
   "custom_attributes": [CustomerAddressAttribute],
   "custom_attributesV2": [AttributeValueInterface],
   "customer_id": 123,
-  "default_billing": true,
-  "default_shipping": false,
+  "default_billing": false,
+  "default_shipping": true,
   "extension_attributes": [CustomerAddressAttribute],
   "fax": "xyz789",
   "firstname": "xyz789",
   "id": 987,
   "lastname": "xyz789",
   "middlename": "abc123",
-  "postcode": "abc123",
-  "prefix": "xyz789",
+  "postcode": "xyz789",
+  "prefix": "abc123",
   "region": CustomerAddressRegion,
-  "region_id": 123,
-  "street": ["xyz789"],
-  "suffix": "xyz789",
+  "region_id": 987,
+  "street": ["abc123"],
+  "suffix": "abc123",
   "telephone": "xyz789",
-  "vat_id": "xyz789"
+  "vat_id": "abc123"
 }
 
     
                   
@@ -45918,7 +45900,7 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_code": "xyz789",
+  "attribute_code": "abc123",
   "value": "xyz789"
 }
 
     
@@ -45981,7 +45963,7 @@ 
    Example
    
                   
                   
    {
   "attribute_code": "abc123",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
     
                   
@@ -46236,18 +46218,18 @@ 
    Example
    
   "custom_attributes": [CustomerAddressAttributeInput],
   "custom_attributesV2": [AttributeValueInput],
   "default_billing": true,
-  "default_shipping": true,
-  "fax": "abc123",
-  "firstname": "abc123",
-  "lastname": "xyz789",
+  "default_shipping": false,
+  "fax": "xyz789",
+  "firstname": "xyz789",
+  "lastname": "abc123",
   "middlename": "abc123",
   "postcode": "xyz789",
   "prefix": "xyz789",
   "region": CustomerAddressRegionInput,
-  "street": ["xyz789"],
-  "suffix": "abc123",
+  "street": ["abc123"],
+  "suffix": "xyz789",
   "telephone": "xyz789",
-  "vat_id": "xyz789"
+  "vat_id": "abc123"
 }
 
     
                   
@@ -46313,9 +46295,9 @@ 
    Example
    
                   
                   
                   
    {
-  "region": "abc123",
-  "region_code": "xyz789",
-  "region_id": 987
+  "region": "xyz789",
+  "region_code": "abc123",
+  "region_id": 123
 }
 
     
                   
@@ -46387,8 +46369,8 @@ 
    Example
    
                   
                   
                   
    {
-  "region": "xyz789",
-  "region_code": "abc123",
+  "region": "abc123",
+  "region_code": "xyz789",
   "region_id": 987
 }
 
     
@@ -46546,15 +46528,15 @@ 
    Example
    
                   
                   
    {
   "code": 4,
-  "default_value": "abc123",
+  "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
   "input_filter": "NONE",
   "is_required": true,
-  "is_unique": false,
-  "label": "abc123",
-  "multiline_count": 987,
+  "is_unique": true,
+  "label": "xyz789",
+  "multiline_count": 123,
   "options": [CustomAttributeOptionInterface],
   "sort_order": 987,
   "validate_rules": [ValidationRule]
@@ -46753,16 +46735,16 @@ 
    Example
    
   "allow_remote_shopping_assistance": false,
   "custom_attributes": [AttributeValueInput],
   "date_of_birth": "abc123",
-  "dob": "abc123",
-  "email": "abc123",
+  "dob": "xyz789",
+  "email": "xyz789",
   "firstname": "abc123",
-  "gender": 123,
+  "gender": 987,
   "is_subscribed": true,
-  "lastname": "xyz789",
+  "lastname": "abc123",
   "middlename": "abc123",
-  "password": "abc123",
-  "prefix": "xyz789",
-  "suffix": "abc123",
+  "password": "xyz789",
+  "prefix": "abc123",
+  "suffix": "xyz789",
   "taxvat": "xyz789"
 }
 
     
@@ -46848,10 +46830,10 @@ 
    Example
    
                   
                   
    {
   "date": "xyz789",
-  "download_url": "abc123",
+  "download_url": "xyz789",
   "order_increment_id": "xyz789",
-  "remaining_downloads": "xyz789",
-  "status": "xyz789"
+  "remaining_downloads": "abc123",
+  "status": "abc123"
 }
 
     
                   
@@ -47071,14 +47053,14 @@ 
    Example
    
   "date_of_birth": "xyz789",
   "dob": "xyz789",
   "email": "abc123",
-  "firstname": "xyz789",
-  "gender": 123,
-  "is_subscribed": false,
-  "lastname": "xyz789",
-  "middlename": "xyz789",
+  "firstname": "abc123",
+  "gender": 987,
+  "is_subscribed": true,
+  "lastname": "abc123",
+  "middlename": "abc123",
   "password": "abc123",
   "prefix": "xyz789",
-  "suffix": "xyz789",
+  "suffix": "abc123",
   "taxvat": "xyz789"
 }
 
     
@@ -47409,29 +47391,29 @@ 
    Example
    
   "billing_address": OrderAddress,
   "carrier": "xyz789",
   "comments": [SalesCommentItem],
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "credit_memos": [CreditMemo],
-  "email": "abc123",
+  "email": "xyz789",
   "gift_message": GiftMessage,
   "gift_receipt_included": true,
   "gift_wrapping": GiftWrapping,
-  "grand_total": 987.65,
+  "grand_total": 123.45,
   "id": 4,
-  "increment_id": "xyz789",
+  "increment_id": "abc123",
   "invoices": [Invoice],
   "items": [OrderItemInterface],
   "items_eligible_for_return": [OrderItemInterface],
-  "number": "xyz789",
+  "number": "abc123",
   "order_date": "abc123",
-  "order_number": "xyz789",
+  "order_number": "abc123",
   "payment_methods": [OrderPaymentMethod],
   "printed_card_included": false,
   "returns": Returns,
   "shipments": [OrderShipment],
   "shipping_address": OrderAddress,
-  "shipping_method": "xyz789",
+  "shipping_method": "abc123",
   "status": "xyz789",
-  "token": "abc123",
+  "token": "xyz789",
   "total": OrderTotal
 }
 
     
@@ -47843,7 +47825,7 @@ 
    Example
    
                   
    {
   "balance_history": CustomerStoreCreditHistory,
   "current_balance": Money,
-  "enabled": true
+  "enabled": false
 }
 
     
                   
@@ -47911,7 +47893,7 @@ 
    Example
    
                   
    {
   "items": [CustomerStoreCreditHistoryItem],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
     
                   
@@ -47986,7 +47968,7 @@ 
    Example
    
                   
                   
                   
    {
-  "action": "abc123",
+  "action": "xyz789",
   "actual_balance": Money,
   "balance_change": Money,
   "date_time_changed": "xyz789"
@@ -48036,7 +48018,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"token": "xyz789"}
+                  
    {"token": "abc123"}
 
     
                   
                 
@@ -48208,16 +48190,16 @@ 
    Example
    
                   
    {
   "allow_remote_shopping_assistance": true,
   "custom_attributes": [AttributeValueInput],
-  "date_of_birth": "xyz789",
-  "dob": "abc123",
-  "firstname": "xyz789",
+  "date_of_birth": "abc123",
+  "dob": "xyz789",
+  "firstname": "abc123",
   "gender": 123,
-  "is_subscribed": true,
-  "lastname": "xyz789",
-  "middlename": "xyz789",
-  "prefix": "abc123",
+  "is_subscribed": false,
+  "lastname": "abc123",
+  "middlename": "abc123",
+  "prefix": "xyz789",
   "suffix": "xyz789",
-  "taxvat": "abc123"
+  "taxvat": "xyz789"
 }
 
     
                   
@@ -48321,11 +48303,11 @@ 
    Example
    
                   
                   
                   
    {
-  "option_id": 987,
-  "product_sku": "xyz789",
-  "required": false,
+  "option_id": 123,
+  "product_sku": "abc123",
+  "required": true,
   "sort_order": 123,
-  "title": "abc123",
+  "title": "xyz789",
   "uid": 4,
   "value": CustomizableAreaValue
 }
@@ -48414,7 +48396,7 @@ 
    Example
    
   "max_characters": 987,
   "price": 123.45,
   "price_type": "FIXED",
-  "sku": "xyz789",
+  "sku": "abc123",
   "uid": 4
 }
 
     
@@ -48514,7 +48496,7 @@ 
    Example
    
   "required": false,
   "sort_order": 123,
   "title": "abc123",
-  "uid": "4",
+  "uid": 4,
   "value": [CustomizableCheckboxValue]
 }
 
     
@@ -48618,10 +48600,10 @@ 
    Example
    
                   
                   
    {
   "option_type_id": 123,
-  "price": 987.65,
+  "price": 123.45,
   "price_type": "FIXED",
   "sku": "xyz789",
-  "sort_order": 987,
+  "sort_order": 123,
   "title": "xyz789",
   "uid": 4
 }
@@ -48731,7 +48713,7 @@ 
    Example
    
   "product_sku": "xyz789",
   "required": true,
   "sort_order": 123,
-  "title": "abc123",
+  "title": "xyz789",
   "uid": "4",
   "value": CustomizableDateValue
 }
@@ -48874,9 +48856,9 @@ 
    Example
    
                   
    {
   "price": 123.45,
   "price_type": "FIXED",
-  "sku": "xyz789",
+  "sku": "abc123",
   "type": "DATE",
-  "uid": "4"
+  "uid": 4
 }
 
     
                   
@@ -48974,7 +48956,7 @@ 
    Example
    
   "option_id": 987,
   "required": true,
   "sort_order": 987,
-  "title": "xyz789",
+  "title": "abc123",
   "uid": 4,
   "value": [CustomizableDropDownValue]
 }
@@ -49079,12 +49061,12 @@ 
    Example
    
                   
                   
    {
   "option_type_id": 123,
-  "price": 123.45,
+  "price": 987.65,
   "price_type": "FIXED",
-  "sku": "xyz789",
-  "sort_order": 987,
-  "title": "xyz789",
-  "uid": 4
+  "sku": "abc123",
+  "sort_order": 123,
+  "title": "abc123",
+  "uid": "4"
 }
 
     
                   
@@ -49188,11 +49170,11 @@ 
    Example
    
                   
                   
                   
    {
-  "option_id": 987,
-  "product_sku": "xyz789",
+  "option_id": 123,
+  "product_sku": "abc123",
   "required": true,
   "sort_order": 123,
-  "title": "xyz789",
+  "title": "abc123",
   "uid": 4,
   "value": CustomizableFieldValue
 }
@@ -49279,9 +49261,9 @@ 
    Example
    
                   
                   
    {
   "max_characters": 123,
-  "price": 987.65,
+  "price": 123.45,
   "price_type": "FIXED",
-  "sku": "abc123",
+  "sku": "xyz789",
   "uid": "4"
 }
 
     
@@ -49389,9 +49371,9 @@ 
    Example
    
   "option_id": 987,
   "product_sku": "abc123",
   "required": true,
-  "sort_order": 987,
-  "title": "abc123",
-  "uid": "4",
+  "sort_order": 123,
+  "title": "xyz789",
+  "uid": 4,
   "value": CustomizableFileValue
 }
 
     
@@ -49494,13 +49476,13 @@ 
    Example
    
                   
                   
                   
    {
-  "file_extension": "xyz789",
+  "file_extension": "abc123",
   "image_size_x": 987,
-  "image_size_y": 123,
+  "image_size_y": 987,
   "price": 123.45,
   "price_type": "FIXED",
   "sku": "abc123",
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -49596,7 +49578,7 @@ 
    Example
    
                   
                   
    {
   "option_id": 123,
-  "required": false,
+  "required": true,
   "sort_order": 987,
   "title": "abc123",
   "uid": 4,
@@ -49706,7 +49688,7 @@ 
    Example
    
   "price": 987.65,
   "price_type": "FIXED",
   "sku": "xyz789",
-  "sort_order": 123,
+  "sort_order": 987,
   "title": "abc123",
   "uid": "4"
 }
@@ -49781,8 +49763,8 @@ 
    Example
    
                   
                   
    {
   "id": 987,
-  "uid": 4,
-  "value_string": "abc123"
+  "uid": "4",
+  "value_string": "xyz789"
 }
 
     
                   
@@ -49936,10 +49918,10 @@ 
    Example
    
                   
                   
                   
    {
-  "option_id": 123,
-  "required": false,
+  "option_id": 987,
+  "required": true,
   "sort_order": 123,
-  "title": "xyz789",
+  "title": "abc123",
   "uid": "4"
 }
 
     
@@ -50136,7 +50118,7 @@ 
    Example
    
                   
                   
    {
   "option_id": 123,
-  "required": true,
+  "required": false,
   "sort_order": 123,
   "title": "xyz789",
   "uid": 4,
@@ -50243,12 +50225,12 @@ 
    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
 }
 
     
                   
@@ -50295,7 +50277,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"success": true}
+                  
    {"success": false}
 
     
                   
                 
@@ -50387,7 +50369,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"success": true}
+                  
    {"success": false}
 
     
                   
                 
@@ -50433,7 +50415,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"result": false}
+                  
    {"result": true}
 
     
                   
                 
@@ -50543,7 +50525,7 @@ 
    Example
    
                   
                   
    {
   "errors": [NegotiableQuoteInvalidStateError],
-  "quote_uid": 4
+  "quote_uid": "4"
 }
 
     
                   
@@ -50634,7 +50616,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"quote_uids": ["4"]}
+                  
    {"quote_uids": [4]}
 
     
                   
                 
@@ -50955,7 +50937,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"approval_rule_uids": ["4"]}
+                  
    {"approval_rule_uids": [4]}
 
     
                   
                 
@@ -51157,7 +51139,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"status": true, "wishlists": [Wishlist]}
+                  
    {"status": false, "wishlists": [Wishlist]}
 
     
                   
                 
@@ -51252,9 +51234,9 @@ 
    Example
    
   "amount": Money,
   "applied_to": "ITEM",
   "coupon": AppliedCoupon,
-  "label": "xyz789",
+  "label": "abc123",
   "type": "xyz789",
-  "value": 987.65
+  "value": 123.45
 }
 
     
                   
@@ -51415,8 +51397,8 @@ 
    Example
    
   "customizable_options": [SelectedCustomizableOption],
   "discount": [Discount],
   "errors": [CartItemError],
-  "id": "xyz789",
-  "is_available": true,
+  "id": "abc123",
+  "is_available": false,
   "links": [DownloadableProductLinks],
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
@@ -51537,11 +51519,11 @@ 
    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",
+  "product_sku": "xyz789",
   "quantity_refunded": 123.45
 }
 
     
@@ -51704,11 +51686,11 @@ 
    Example
    
                   
    {
   "discounts": [Discount],
   "downloadable_links": [DownloadableItemsLinks],
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
+  "product_sku": "abc123",
   "quantity_invoiced": 987.65
 }
 
     
@@ -51776,8 +51758,8 @@ 
    Example
    
                   
                   
    {
   "sort_order": 123,
-  "title": "abc123",
-  "uid": "4"
+  "title": "xyz789",
+  "uid": 4
 }
 
     
                   
@@ -52007,23 +51989,23 @@ 
    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",
   "product": ProductInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "xyz789",
   "product_type": "xyz789",
-  "product_url_key": "abc123",
+  "product_url_key": "xyz789",
   "quantity_canceled": 987.65,
   "quantity_invoiced": 123.45,
   "quantity_ordered": 123.45,
-  "quantity_refunded": 123.45,
-  "quantity_returned": 123.45,
-  "quantity_shipped": 123.45,
+  "quantity_refunded": 987.65,
+  "quantity_returned": 987.65,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
   "status": "abc123"
 }
@@ -52920,12 +52902,12 @@ 
    Example
    
   "attribute_set_id": 987,
   "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
+  "category_gear": "xyz789",
   "climate": "xyz789",
-  "collar": "xyz789",
+  "collar": "abc123",
   "color": 123,
-  "country_of_manufacture": "abc123",
-  "created_at": "xyz789",
+  "country_of_manufacture": "xyz789",
+  "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
@@ -52936,8 +52918,8 @@ 
    Example
    
     DownloadableProductSamples
   ],
   "eco_collection": 123,
-  "erin_recommends": 123,
-  "features_bags": "abc123",
+  "erin_recommends": 987,
+  "features_bags": "xyz789",
   "format": 987,
   "gender": "abc123",
   "gift_message_available": "xyz789",
@@ -52947,58 +52929,58 @@ 
    Example
    
   "links_purchased_separately": 123,
   "links_title": "xyz789",
   "manufacturer": 123,
-  "material": "abc123",
+  "material": "xyz789",
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
-  "meta_keyword": "abc123",
+  "meta_description": "xyz789",
+  "meta_keyword": "xyz789",
   "meta_title": "xyz789",
-  "name": "abc123",
+  "name": "xyz789",
   "new": 123,
-  "new_from_date": "xyz789",
-  "new_to_date": "abc123",
+  "new_from_date": "abc123",
+  "new_to_date": "xyz789",
   "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
   "options_container": "xyz789",
   "pattern": "abc123",
-  "performance_fabric": 987,
+  "performance_fabric": 123,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 987,
+  "purpose": 123,
   "rating_summary": 123.45,
-  "redirect_code": 123,
+  "redirect_code": 987,
   "related_products": [ProductInterface],
-  "relative_url": "abc123",
+  "relative_url": "xyz789",
   "review_count": 987,
   "reviews": ProductReviews,
-  "sale": 123,
+  "sale": 987,
   "short_description": ComplexTextValue,
-  "size": 987,
+  "size": 123,
   "sku": "abc123",
-  "sleeve": "xyz789",
+  "sleeve": "abc123",
   "small_image": ProductImage,
-  "special_from_date": "abc123",
+  "special_from_date": "xyz789",
   "special_price": 987.65,
-  "special_to_date": "xyz789",
+  "special_to_date": "abc123",
   "staged": false,
   "stock_status": "IN_STOCK",
   "strap_bags": "abc123",
   "style_bags": "abc123",
-  "style_bottom": "xyz789",
-  "style_general": "abc123",
-  "swatch_image": "xyz789",
+  "style_bottom": "abc123",
+  "style_general": "xyz789",
+  "swatch_image": "abc123",
   "thumbnail": ProductImage,
   "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "abc123",
+  "type_id": "xyz789",
   "uid": "4",
-  "updated_at": "xyz789",
+  "updated_at": "abc123",
   "upsell_products": [ProductInterface],
-  "url_key": "xyz789",
-  "url_path": "xyz789",
+  "url_key": "abc123",
+  "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
   "url_suffix": "abc123",
   "websites": [Website]
@@ -53227,7 +53209,7 @@ 
    Example
    
                   
                   
                   
    {
-  "id": 123,
+  "id": 987,
   "is_shareable": true,
   "link_type": "FILE",
   "number_of_downloads": 987,
@@ -53235,9 +53217,9 @@ 
    Example
    
   "sample_file": "abc123",
   "sample_type": "FILE",
   "sample_url": "xyz789",
-  "sort_order": 123,
+  "sort_order": 987,
   "title": "xyz789",
-  "uid": "4"
+  "uid": 4
 }
 
     
                   
@@ -53385,10 +53367,10 @@ 
    Example
    
                   
                   
    {
   "id": 123,
-  "sample_file": "xyz789",
+  "sample_file": "abc123",
   "sample_type": "FILE",
-  "sample_url": "abc123",
-  "sort_order": 123,
+  "sample_url": "xyz789",
+  "sort_order": 987,
   "title": "abc123"
 }
 
     
@@ -53485,7 +53467,7 @@ 
    Example
    
   "customizable_options": [SelectedCustomizableOption],
   "links": [DownloadableProductLinks],
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "samples": [DownloadableProductSamples],
   "uid": "4"
 }
@@ -53598,7 +53580,7 @@ 
    Example
    
                   
                   
                   
    {
-  "added_at": "abc123",
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
   "description": "abc123",
   "id": 4,
@@ -53988,8 +53970,8 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_code": "abc123",
-  "value": "xyz789"
+  "attribute_code": "xyz789",
+  "value": "abc123"
 }
 
     
                   
@@ -54145,11 +54127,11 @@ 
    Example
    
                   
                   
                   
    {
-  "canonical_url": "abc123",
+  "canonical_url": "xyz789",
   "entity_uid": 4,
   "id": 123,
-  "redirectCode": 987,
-  "relative_url": "abc123",
+  "redirectCode": 123,
+  "relative_url": "xyz789",
   "type": "CMS_PAGE"
 }
 
     
@@ -54226,7 +54208,7 @@ 
    Possible Types
    
                   
    Example
    
                   
                   
-                  
    {"message": "abc123"}
+                  
    {"message": "xyz789"}
 
     
                   
                 
@@ -54471,7 +54453,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"currency_to": "xyz789", "rate": 987.65}
+                  
    {"currency_to": "abc123", "rate": 987.65}
 
     
                   
                 
@@ -54637,7 +54619,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"match": "xyz789", "match_type": "FULL"}
+                  
    {"match": "abc123", "match_type": "FULL"}
 
     
                   
                 
@@ -54697,8 +54679,8 @@ 
    Example
    
                   
                   
                   
    {
-  "from": "xyz789",
-  "to": "abc123"
+  "from": "abc123",
+  "to": "xyz789"
 }
 
     
                   
@@ -54771,8 +54753,8 @@ 
    Example
    
                   
                   
    {
   "eq": "abc123",
-  "in": ["xyz789"],
-  "match": "abc123"
+  "in": ["abc123"],
+  "match": "xyz789"
 }
 
     
                   
@@ -54974,20 +54956,20 @@ 
    Example
    
                   
                   
                   
    {
-  "eq": "xyz789",
-  "finset": ["abc123"],
+  "eq": "abc123",
+  "finset": ["xyz789"],
   "from": "abc123",
-  "gt": "abc123",
-  "gteq": "xyz789",
+  "gt": "xyz789",
+  "gteq": "abc123",
   "in": ["xyz789"],
-  "like": "xyz789",
-  "lt": "xyz789",
-  "lteq": "abc123",
-  "moreq": "xyz789",
+  "like": "abc123",
+  "lt": "abc123",
+  "lteq": "xyz789",
+  "moreq": "abc123",
   "neq": "abc123",
   "nin": ["xyz789"],
   "notnull": "abc123",
-  "null": "xyz789",
+  "null": "abc123",
   "to": "xyz789"
 }
 
     
@@ -55046,7 +55028,7 @@ 
    Example
    
                   
                   
    {
   "amount": Money,
-  "label": "xyz789"
+  "label": "abc123"
 }
 
     
                   
@@ -55139,7 +55121,7 @@ 
    Description
    
                   
    Example
    
                   
                   
-                  
    123.45
+                  
    987.65
 
     
                   
                 
@@ -55187,7 +55169,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"customer_email": "xyz789"}
+                  
    {"customer_email": "abc123"}
 
     
                   
                 
@@ -55233,7 +55215,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"customer_token": "abc123"}
+                  
    {"customer_token": "xyz789"}
 
     
                   
                 
@@ -55346,7 +55328,7 @@ 
    Example
    
                   
    {
   "balance": Money,
   "code": "abc123",
-  "expiration_date": "xyz789"
+  "expiration_date": "abc123"
 }
 
     
                   
@@ -55489,10 +55471,10 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_id": 987,
+  "attribute_id": 123,
   "uid": 4,
-  "value": 987.65,
-  "value_id": 123,
+  "value": 123.45,
+  "value_id": 987,
   "website_id": 987,
   "website_value": 987.65
 }
@@ -55692,17 +55674,17 @@ 
    Example
    
   "customizable_options": [SelectedCustomizableOption],
   "discount": [Discount],
   "errors": [CartItemError],
-  "id": "xyz789",
-  "is_available": false,
+  "id": "abc123",
+  "is_available": true,
   "message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 123.45,
-  "recipient_email": "xyz789",
-  "recipient_name": "abc123",
-  "sender_email": "xyz789",
+  "quantity": 987.65,
+  "recipient_email": "abc123",
+  "recipient_name": "xyz789",
+  "sender_email": "abc123",
   "sender_name": "abc123",
   "uid": 4
 }
@@ -55813,12 +55795,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
+  "quantity_refunded": 987.65
 }
 
     
                   
@@ -55929,10 +55911,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
 }
 
     
                   
@@ -56016,11 +55998,11 @@ 
    Example
    
                   
                   
                   
    {
-  "message": "xyz789",
-  "recipient_email": "abc123",
+  "message": "abc123",
+  "recipient_email": "xyz789",
   "recipient_name": "abc123",
   "sender_email": "abc123",
-  "sender_name": "abc123"
+  "sender_name": "xyz789"
 }
 
     
                   
@@ -56124,10 +56106,10 @@ 
    Example
    
                   
    {
   "amount": Money,
   "custom_giftcard_amount": Money,
-  "message": "abc123",
-  "recipient_email": "xyz789",
+  "message": "xyz789",
+  "recipient_email": "abc123",
   "recipient_name": "xyz789",
-  "sender_email": "abc123",
+  "sender_email": "xyz789",
   "sender_name": "xyz789"
 }
 
     
@@ -56353,26 +56335,26 @@ 
    Example
    
                   
                   
    {
   "discounts": [Discount],
-  "eligible_for_return": true,
+  "eligible_for_return": false,
   "entered_options": [OrderItemOption],
   "gift_card": GiftCardItem,
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "4",
+  "id": 4,
   "product": ProductInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "product_type": "xyz789",
+  "product_sku": "abc123",
+  "product_type": "abc123",
   "product_url_key": "abc123",
   "quantity_canceled": 987.65,
-  "quantity_invoiced": 123.45,
+  "quantity_invoiced": 987.65,
   "quantity_ordered": 123.45,
-  "quantity_refunded": 987.65,
+  "quantity_refunded": 123.45,
   "quantity_returned": 987.65,
-  "quantity_shipped": 987.65,
+  "quantity_shipped": 123.45,
   "selected_options": [OrderItemOption],
-  "status": "xyz789"
+  "status": "abc123"
 }
 
     
                   
@@ -57328,29 +57310,29 @@ 
    Example
    
                   
    {
   "activity": "xyz789",
   "allow_message": true,
-  "allow_open_amount": true,
-  "attribute_set_id": 123,
-  "canonical_url": "abc123",
+  "allow_open_amount": false,
+  "attribute_set_id": 987,
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "category_gear": "xyz789",
+  "category_gear": "abc123",
   "climate": "xyz789",
-  "collar": "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": 987,
-  "features_bags": "abc123",
-  "format": 987,
-  "gender": "xyz789",
+  "features_bags": "xyz789",
+  "format": 123,
+  "gender": "abc123",
   "gift_card_options": [CustomizableOptionInterface],
   "gift_message_available": "abc123",
   "giftcard_amounts": [GiftCardAmounts],
   "giftcard_type": "VIRTUAL",
-  "id": 123,
+  "id": 987,
   "image": ProductImage,
   "is_redeemable": true,
   "is_returnable": "abc123",
@@ -57359,62 +57341,62 @@ 
    Example
    
   "material": "abc123",
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "message_max_length": 123,
+  "message_max_length": 987,
   "meta_description": "abc123",
   "meta_keyword": "xyz789",
   "meta_title": "xyz789",
   "name": "xyz789",
-  "new": 987,
+  "new": 123,
   "new_from_date": "abc123",
   "new_to_date": "xyz789",
-  "only_x_left_in_stock": 123.45,
-  "open_amount_max": 123.45,
+  "only_x_left_in_stock": 987.65,
+  "open_amount_max": 987.65,
   "open_amount_min": 123.45,
   "options": [CustomizableOptionInterface],
-  "options_container": "xyz789",
-  "pattern": "xyz789",
-  "performance_fabric": 987,
+  "options_container": "abc123",
+  "pattern": "abc123",
+  "performance_fabric": 123,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
   "purpose": 123,
-  "rating_summary": 987.65,
+  "rating_summary": 123.45,
   "redirect_code": 987,
   "related_products": [ProductInterface],
-  "relative_url": "xyz789",
+  "relative_url": "abc123",
   "review_count": 987,
   "reviews": ProductReviews,
   "sale": 987,
   "short_description": ComplexTextValue,
   "size": 123,
-  "sku": "abc123",
-  "sleeve": "xyz789",
+  "sku": "xyz789",
+  "sleeve": "abc123",
   "small_image": ProductImage,
-  "special_from_date": "abc123",
-  "special_price": 987.65,
+  "special_from_date": "xyz789",
+  "special_price": 123.45,
   "special_to_date": "xyz789",
   "staged": false,
   "stock_status": "IN_STOCK",
   "strap_bags": "abc123",
   "style_bags": "abc123",
   "style_bottom": "xyz789",
-  "style_general": "xyz789",
+  "style_general": "abc123",
   "swatch_image": "abc123",
   "thumbnail": ProductImage,
-  "tier_price": 987.65,
+  "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
   "type_id": "abc123",
-  "uid": 4,
+  "uid": "4",
   "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
-  "url_key": "abc123",
-  "url_path": "abc123",
+  "url_key": "xyz789",
+  "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
   "url_suffix": "abc123",
   "websites": [Website],
-  "weight": 123.45
+  "weight": 987.65
 }
 
     
                   
@@ -57601,12 +57583,12 @@ 
    Example
    
                   
                   
    {
   "gift_card": GiftCardItem,
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "quantity_shipped": 123.45
+  "product_sku": "abc123",
+  "quantity_shipped": 987.65
 }
 
     
                   
@@ -57763,13 +57745,13 @@ 
    Example
    
                   
                   
                   
    {
-  "added_at": "xyz789",
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
   "description": "abc123",
   "gift_card_options": GiftCardOptions,
   "id": 4,
   "product": ProductInterface,
-  "quantity": 123.45
+  "quantity": 987.65
 }
 
     
                   
@@ -57909,9 +57891,9 @@ 
    Example
    
                   
                   
                   
    {
-  "from": "xyz789",
-  "message": "xyz789",
-  "to": "abc123"
+  "from": "abc123",
+  "message": "abc123",
+  "to": "xyz789"
 }
 
     
                   
@@ -58126,11 +58108,11 @@ 
    Example
    
                   
                   
                   
    {
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "dynamic_attributes": [GiftRegistryDynamicAttribute],
   "event_name": "xyz789",
   "items": [GiftRegistryItemInterface],
-  "message": "abc123",
+  "message": "xyz789",
   "owner_name": "xyz789",
   "privacy_settings": "PRIVATE",
   "registrants": [GiftRegistryRegistrant],
@@ -58210,8 +58192,8 @@ 
    Example
    
                   
    {
   "code": "4",
   "group": "EVENT_INFORMATION",
-  "label": "abc123",
-  "value": "abc123"
+  "label": "xyz789",
+  "value": "xyz789"
 }
 
     
                   
@@ -58344,10 +58326,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {
-  "code": "4",
-  "value": "xyz789"
-}
+                  
    {"code": 4, "value": "abc123"}
 
     
                   
                 
@@ -58525,12 +58504,12 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_group": "xyz789",
+  "attribute_group": "abc123",
   "code": "4",
   "input_type": "xyz789",
   "is_required": true,
-  "label": "xyz789",
-  "sort_order": 123
+  "label": "abc123",
+  "sort_order": 987
 }
 
     
                   
@@ -58638,10 +58617,10 @@ 
    Example
    
                   
                   
                   
    {
-  "attribute_group": "xyz789",
-  "code": 4,
-  "input_type": "xyz789",
-  "is_required": false,
+  "attribute_group": "abc123",
+  "code": "4",
+  "input_type": "abc123",
+  "is_required": true,
   "label": "xyz789",
   "sort_order": 987
 }
@@ -58736,8 +58715,8 @@ 
    Example
    
   "note": "xyz789",
   "product": ProductInterface,
   "quantity": 987.65,
-  "quantity_fulfilled": 123.45,
-  "uid": 4
+  "quantity_fulfilled": 987.65,
+  "uid": "4"
 }
 
     
                   
@@ -58846,7 +58825,7 @@ 
    Example
    
                   
                   
    {
   "created_at": "xyz789",
-  "note": "xyz789",
+  "note": "abc123",
   "product": ProductInterface,
   "quantity": 987.65,
   "quantity_fulfilled": 123.45,
@@ -58926,7 +58905,7 @@ 
    Example
    
                   
                   
                   
    {
-  "status": false,
+  "status": true,
   "user_errors": [GiftRegistryItemsUserError]
 }
 
     
@@ -59012,9 +58991,9 @@ 
    Example
    
                   
                   
    {
   "code": "OUT_OF_STOCK",
-  "gift_registry_item_uid": 4,
-  "gift_registry_uid": "4",
-  "message": "xyz789",
+  "gift_registry_item_uid": "4",
+  "gift_registry_uid": 4,
+  "message": "abc123",
   "product_uid": "4"
 }
 
     
@@ -59271,10 +59250,10 @@ 
    Example
    
   "dynamic_attributes": [
     GiftRegistryRegistrantDynamicAttribute
   ],
-  "email": "abc123",
+  "email": "xyz789",
   "firstname": "xyz789",
-  "lastname": "abc123",
-  "uid": 4
+  "lastname": "xyz789",
+  "uid": "4"
 }
 
     
                   
@@ -59338,7 +59317,7 @@ 
    Example
    
                   
    {
   "code": "4",
   "label": "abc123",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
     
                   
@@ -59432,10 +59411,10 @@ 
    Example
    
                   
                   
    {
   "event_date": "abc123",
-  "event_title": "abc123",
+  "event_title": "xyz789",
   "gift_registry_uid": "4",
-  "location": "abc123",
-  "name": "xyz789",
+  "location": "xyz789",
+  "name": "abc123",
   "type": "abc123"
 }
 
     
@@ -59496,7 +59475,10 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"address_data": CustomerAddressInput, "address_id": 4}
+                  
    {
+  "address_data": CustomerAddressInput,
+  "address_id": "4"
+}
 
     
                   
                 
@@ -59613,7 +59595,7 @@ 
    Example
    
   "dynamic_attributes_metadata": [
     GiftRegistryDynamicAttributeMetadataInterface
   ],
-  "label": "abc123",
+  "label": "xyz789",
   "uid": "4"
 }
 
     
@@ -59761,7 +59743,7 @@ 
    Example
    
                   
                   
                   
    {
-  "label": "xyz789",
+  "label": "abc123",
   "url": "xyz789"
 }
 
     
@@ -60626,28 +60608,28 @@ 
    Example
    
                   
                   
                   
    {
-  "activity": "abc123",
-  "attribute_set_id": 123,
-  "canonical_url": "abc123",
+  "activity": "xyz789",
+  "attribute_set_id": 987,
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
+  "category_gear": "xyz789",
   "climate": "xyz789",
-  "collar": "abc123",
-  "color": 987,
+  "collar": "xyz789",
+  "color": 123,
   "country_of_manufacture": "abc123",
   "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 123,
-  "erin_recommends": 123,
-  "features_bags": "xyz789",
+  "eco_collection": 987,
+  "erin_recommends": 987,
+  "features_bags": "abc123",
   "format": 123,
   "gender": "xyz789",
-  "gift_message_available": "xyz789",
-  "id": 123,
+  "gift_message_available": "abc123",
+  "id": 987,
   "image": ProductImage,
-  "is_returnable": "abc123",
+  "is_returnable": "xyz789",
   "items": [GroupedProductItem],
   "manufacturer": 123,
   "material": "abc123",
@@ -60655,51 +60637,51 @@ 
    Example
    
   "media_gallery_entries": [MediaGalleryEntry],
   "meta_description": "abc123",
   "meta_keyword": "abc123",
-  "meta_title": "abc123",
-  "name": "xyz789",
+  "meta_title": "xyz789",
+  "name": "abc123",
   "new": 123,
   "new_from_date": "xyz789",
   "new_to_date": "abc123",
-  "only_x_left_in_stock": 987.65,
+  "only_x_left_in_stock": 123.45,
   "options_container": "abc123",
   "pattern": "xyz789",
-  "performance_fabric": 123,
+  "performance_fabric": 987,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 123,
-  "rating_summary": 987.65,
-  "redirect_code": 123,
+  "purpose": 987,
+  "rating_summary": 123.45,
+  "redirect_code": 987,
   "related_products": [ProductInterface],
-  "relative_url": "xyz789",
+  "relative_url": "abc123",
   "review_count": 123,
   "reviews": ProductReviews,
-  "sale": 123,
+  "sale": 987,
   "short_description": ComplexTextValue,
-  "size": 123,
-  "sku": "abc123",
-  "sleeve": "abc123",
+  "size": 987,
+  "sku": "xyz789",
+  "sleeve": "xyz789",
   "small_image": ProductImage,
   "special_from_date": "abc123",
-  "special_price": 987.65,
+  "special_price": 123.45,
   "special_to_date": "xyz789",
-  "staged": true,
+  "staged": false,
   "stock_status": "IN_STOCK",
-  "strap_bags": "xyz789",
+  "strap_bags": "abc123",
   "style_bags": "abc123",
-  "style_bottom": "abc123",
+  "style_bottom": "xyz789",
   "style_general": "xyz789",
-  "swatch_image": "xyz789",
+  "swatch_image": "abc123",
   "thumbnail": ProductImage,
-  "tier_price": 123.45,
+  "tier_price": 987.65,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "abc123",
+  "type_id": "xyz789",
   "uid": "4",
   "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
-  "url_key": "abc123",
+  "url_key": "xyz789",
   "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
   "url_suffix": "abc123",
@@ -60772,7 +60754,7 @@ 
    Example
    
                   
    {
   "position": 123,
   "product": ProductInterface,
-  "qty": 123.45
+  "qty": 987.65
 }
 
     
                   
@@ -60865,12 +60847,12 @@ 
    Example
    
                   
                   
                   
    {
-  "added_at": "abc123",
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
   "id": 4,
   "product": ProductInterface,
-  "quantity": 987.65
+  "quantity": 123.45
 }
 
     
                   
@@ -61004,17 +60986,17 @@ 
    Example
    
                   
                   
                   
    {
-  "cc_vault_code": "xyz789",
+  "cc_vault_code": "abc123",
   "code": "xyz789",
-  "is_vault_enabled": true,
-  "is_visible": true,
+  "is_vault_enabled": false,
+  "is_visible": false,
   "payment_intent": "abc123",
   "payment_source": "xyz789",
   "requires_card_details": true,
   "sdk_params": [SDKParams],
   "sort_order": "abc123",
-  "three_ds": false,
-  "title": "abc123"
+  "three_ds": true,
+  "title": "xyz789"
 }
 
     
                   
@@ -61153,12 +61135,12 @@ 
    Example
    
                   
                   
    {
   "cardBin": "xyz789",
-  "cardExpiryMonth": "xyz789",
-  "cardExpiryYear": "abc123",
+  "cardExpiryMonth": "abc123",
+  "cardExpiryYear": "xyz789",
   "cardLast4": "abc123",
-  "holderName": "abc123",
+  "holderName": "xyz789",
   "is_active_payment_token_enabler": true,
-  "payment_source": "xyz789",
+  "payment_source": "abc123",
   "payments_order_id": "abc123",
   "paypal_order_id": "xyz789"
 }
@@ -61224,7 +61206,7 @@ 
    Example
    
                   
                   
                   
    {
-  "cancel_url": "xyz789",
+  "cancel_url": "abc123",
   "return_url": "abc123"
 }
 
     
@@ -61320,7 +61302,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
 
     
                   
                 
@@ -61376,7 +61358,7 @@ 
    Example
    
                   
                   
                   
    {
-  "name": "abc123",
+  "name": "xyz789",
   "value": "xyz789"
 }
 
     
@@ -61402,7 +61384,7 @@ 
    Description
    
                   
    Example
    
                   
                   
-                  
    "4"
+                  
    4
 
     
                   
                 
@@ -61547,7 +61529,7 @@ 
    Description
    
                   
    Example
    
                   
                   
-                  
    123
+                  
    987
 
     
                   
                 
@@ -61593,7 +61575,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"message": "xyz789"}
+                  
    {"message": "abc123"}
 
     
                   
                 
@@ -61677,7 +61659,7 @@ 
    Example
    
                   
                   
    {
   "comments": [SalesCommentItem],
-  "id": 4,
+  "id": "4",
   "items": [InvoiceItemInterface],
   "number": "xyz789",
   "total": InvoiceTotal
@@ -61779,9 +61761,9 @@ 
    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
@@ -61927,12 +61909,12 @@ 
    Example
    
                   
                   
    {
   "discounts": [Discount],
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "xyz789",
-  "quantity_invoiced": 123.45
+  "quantity_invoiced": 987.65
 }
 
     
                   
@@ -62235,7 +62217,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"is_email_available": false}
+                  
    {"is_email_available": true}
 
     
                   
                 
@@ -62281,7 +62263,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"is_email_available": false}
+                  
    {"is_email_available": true}
 
     
                   
                 
@@ -62374,10 +62356,10 @@ 
    Example
    
                   
                   
    {
   "created_at": "abc123",
-  "creator_id": 987,
-  "creator_type": 987,
+  "creator_id": 123,
+  "creator_type": 123,
   "negotiable_quote_item_uid": "4",
-  "note": "abc123",
+  "note": "xyz789",
   "note_uid": "4"
 }
 
     
@@ -62555,9 +62537,9 @@ 
    Example
    
                   
    {
   "id": "4",
   "price": Money,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sku": "xyz789",
-  "quantity": 123.45,
+  "quantity": 987.65,
   "uid": "4"
 }
 
     
@@ -62616,7 +62598,7 @@ 
    Example
    
                   
                   
    {
   "name": "abc123",
-  "value": "xyz789"
+  "value": "abc123"
 }
 
     
                   
@@ -62701,8 +62683,8 @@ 
    Example
    
                   
    {
   "filter_items": [LayerFilterItemInterface],
   "filter_items_count": 987,
-  "name": "xyz789",
-  "request_var": "xyz789"
+  "name": "abc123",
+  "request_var": "abc123"
 }
 
     
                   
@@ -62770,8 +62752,8 @@ 
    Example
    
                   
                   
                   
    {
-  "items_count": 987,
-  "label": "xyz789",
+  "items_count": 123,
+  "label": "abc123",
   "value_string": "abc123"
 }
 
     
@@ -62867,8 +62849,8 @@ 
    Example
    
                   
                   
    {
   "items_count": 987,
-  "label": "xyz789",
-  "value_string": "abc123"
+  "label": "abc123",
+  "value_string": "xyz789"
 }
 
     
                   
@@ -63079,7 +63061,7 @@ 
    Example
    
   "id": 987,
   "label": "xyz789",
   "media_type": "xyz789",
-  "position": 987,
+  "position": 123,
   "types": ["abc123"],
   "uid": 4,
   "video_content": ProductMediaGalleryEntriesVideoContent
@@ -63184,8 +63166,8 @@ 
    Example
    
                   
                   
    {
   "disabled": false,
-  "label": "xyz789",
-  "position": 123,
+  "label": "abc123",
+  "position": 987,
   "url": "xyz789"
 }
 
     
@@ -63281,7 +63263,7 @@ 
    Example
    
                   
                   
                   
    {
-  "layout": "xyz789",
+  "layout": "abc123",
   "logo": MessageStyleLogo
 }
 
     
@@ -63338,7 +63320,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"currency": "AFN", "value": 123.45}
+                  
    {"currency": "AFN", "value": 987.65}
 
     
                   
                 
@@ -63776,18 +63758,18 @@ 
    Example
    
   "buyer": NegotiableQuoteUser,
   "comments": [NegotiableQuoteComment],
   "created_at": "xyz789",
-  "email": "abc123",
+  "email": "xyz789",
   "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,
-  "uid": "4",
-  "updated_at": "abc123"
+  "uid": 4,
+  "updated_at": "xyz789"
 }
 
     
                   
@@ -63844,8 +63826,8 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "xyz789",
-  "label": "abc123"
+  "code": "abc123",
+  "label": "xyz789"
 }
 
     
                   
@@ -64006,13 +63988,13 @@ 
    Example
    
                   
                   
    {
   "city": "abc123",
-  "company": "xyz789",
-  "country_code": "xyz789",
-  "firstname": "xyz789",
-  "lastname": "abc123",
+  "company": "abc123",
+  "country_code": "abc123",
+  "firstname": "abc123",
+  "lastname": "xyz789",
   "postcode": "abc123",
   "region": "xyz789",
-  "region_id": 987,
+  "region_id": 123,
   "save_in_address_book": true,
   "street": ["xyz789"],
   "telephone": "abc123"
@@ -64124,32 +64106,224 @@ 
    Fields
    
                     
                   
                 
-                
    
-                  
    Possible Types
    
-                  
-                    
-                      
-                        
-                      
-                    
-                    
-                      
-                        
-                      
-                      
-                        
-                      
-                    
-                  
    NegotiableQuoteAddressInterface Types
    
-                          
    
-                            NegotiableQuoteShippingAddress
-                          
    
-                        
    
-                          
    
-                            NegotiableQuoteBillingAddress
-                          
    
-                        
    
-                
    
+                
    
+                  
    Possible Types
    
+                  
+                    
+                      
+                        
+                      
+                    
+                    
+                      
+                        
+                      
+                      
+                        
+                      
+                    
+                  
    NegotiableQuoteAddressInterface Types
    
+                          
    
+                            NegotiableQuoteShippingAddress
+                          
    
+                        
    
+                          
    
+                            NegotiableQuoteBillingAddress
+                          
    
+                        
    
+                
    
+              
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {
+  "city": "abc123",
+  "company": "abc123",
+  "country": NegotiableQuoteAddressCountry,
+  "firstname": "xyz789",
+  "lastname": "xyz789",
+  "postcode": "xyz789",
+  "region": NegotiableQuoteAddressRegion,
+  "street": ["xyz789"],
+  "telephone": "abc123"
+}
+
     
+                  
+                
    
+              
    
+            
+          
    
+          
    
+            
    
+              Types
+            
    
+            
    NegotiableQuoteAddressRegion
    
+            
    
+              
    
+                
    
+                  
    Description
    
+                  
    Defines the company's state or province.
    
+                
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                    
+                  
    Field NameDescription
    
+                          code -
+                          
+                            String
+                          
+                         The address region code. 
    
+                          label -
+                          
+                            String
+                          
+                         The display name of the region. 
    
+                          region_id -
+                          
+                            Int
+                          
+                         The unique ID for a pre-defined region. 
    
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
+                  
+                  
    {
+  "code": "xyz789",
+  "label": "abc123",
+  "region_id": 987
+}
+
     
+                  
+                
    
+              
    
+            
    
+          
    
+          
    
+            
    
+              Types
+            
    
+            
    NegotiableQuoteBillingAddress
    
+            
    
+              
    
+                
    
+                  
    Fields
    
+                  
+                    
+                      
+                        
+                        
+                      
+                    
+                    
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                      
+                        
+                        
+                      
+                    
+                  
    Field NameDescription
    
+                          city -
+                          
+                            String!
+                          
+                         The company's city or town. 
    
+                          company -
+                          
+                            String
+                          
+                         The company name associated with the shipping/billing address. 
    
+                          country -
+                          
+                            NegotiableQuoteAddressCountry!
+                          
+                         The company's country. 
    
+                          firstname -
+                          
+                            String!
+                          
+                         The first name of the company user. 
    
+                          lastname -
+                          
+                            String!
+                          
+                         The last name of the company user. 
    
+                          postcode -
+                          
+                            String
+                          
+                         The company's ZIP or postal code. 
    
+                          region -
+                          
+                            NegotiableQuoteAddressRegion
+                          
+                         An object containing the region name, region code, and region ID. 
    
+                          street -
+                          
+                            [String]!
+                          
+                         An array of strings that define the street number and name. 
    
+                          telephone -
+                          
+                            String
+                          
+                         The customer's telephone number. 
    
+                
    
               
    
               
    
                 
    
@@ -64160,198 +64334,6 @@ 
    Example
    
   "city": "abc123",
   "company": "abc123",
   "country": NegotiableQuoteAddressCountry,
-  "firstname": "abc123",
-  "lastname": "xyz789",
-  "postcode": "xyz789",
-  "region": NegotiableQuoteAddressRegion,
-  "street": ["xyz789"],
-  "telephone": "abc123"
-}
-
     
-                  
-                
-              
-            
-          
-          
    
-            
    
-              Types
-            
    
-            
    NegotiableQuoteAddressRegion
    
-            
    
-              
    
-                
    
-                  
    Description
    
-                  
    Defines the company's state or province.
    
-                
    
-                
    
-                  
    Fields
    
-                  
-                    
-                      
-                        
-                        
-                      
-                    
-                    
-                      
-                        
-                        
-                      
-                      
-                        
-                        
-                      
-                      
-                        
-                        
-                      
-                    
-                  
    Field NameDescription
    
-                          code -
-                          
-                            String
-                          
-                         The address region code. 
    
-                          label -
-                          
-                            String
-                          
-                         The display name of the region. 
    
-                          region_id -
-                          
-                            Int
-                          
-                         The unique ID for a pre-defined region. 
    
-                
    
-              
    
-              
    
-                
    
-                  
    Example
    
-                  
-                  
-                  
    {
-  "code": "abc123",
-  "label": "xyz789",
-  "region_id": 987
-}
-
     
-                  
-                
    
-              
    
-            
    
-          
    
-          
    
-            
    
-              Types
-            
    
-            
    NegotiableQuoteBillingAddress
    
-            
    
-              
    
-                
    
-                  
    Fields
    
-                  
-                    
-                      
-                        
-                        
-                      
-                    
-                    
-                      
-                        
-                        
-                      
-                      
-                        
-                        
-                      
-                      
-                        
-                        
-                      
-                      
-                        
-                        
-                      
-                      
-                        
-                        
-                      
-                      
-                        
-                        
-                      
-                      
-                        
-                        
-                      
-                      
-                        
-                        
-                      
-                      
-                        
-                        
-                      
-                    
-                  
    Field NameDescription
    
-                          city -
-                          
-                            String!
-                          
-                         The company's city or town. 
    
-                          company -
-                          
-                            String
-                          
-                         The company name associated with the shipping/billing address. 
    
-                          country -
-                          
-                            NegotiableQuoteAddressCountry!
-                          
-                         The company's country. 
    
-                          firstname -
-                          
-                            String!
-                          
-                         The first name of the company user. 
    
-                          lastname -
-                          
-                            String!
-                          
-                         The last name of the company user. 
    
-                          postcode -
-                          
-                            String
-                          
-                         The company's ZIP or postal code. 
    
-                          region -
-                          
-                            NegotiableQuoteAddressRegion
-                          
-                         An object containing the region name, region code, and region ID. 
    
-                          street -
-                          
-                            [String]!
-                          
-                         An array of strings that define the street number and name. 
    
-                          telephone -
-                          
-                            String
-                          
-                         The customer's telephone number. 
    
-                
    
-              
    
-              
    
-                
    
-                  
    Example
    
-                  
-                  
-                  
    {
-  "city": "abc123",
-  "company": "xyz789",
-  "country": NegotiableQuoteAddressCountry,
   "firstname": "xyz789",
   "lastname": "abc123",
   "postcode": "abc123",
@@ -64441,8 +64423,8 @@ 
    Example
    
                   
                   
    {
   "address": NegotiableQuoteAddressInput,
-  "customer_address_uid": "4",
-  "same_as_shipping": false,
+  "customer_address_uid": 4,
+  "same_as_shipping": true,
   "use_for_shipping": false
 }
 
     
@@ -64625,7 +64607,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"comment": "xyz789"}
+                  
    {"comment": "abc123"}
 
     
                   
                 
    
@@ -64690,9 +64672,9 @@ 
    Example
    
                   
                   
                   
    {
-  "new_value": "abc123",
-  "old_value": "xyz789",
-  "title": "xyz789"
+  "new_value": "xyz789",
+  "old_value": "abc123",
+  "title": "abc123"
 }
 
     
                   
@@ -64986,7 +64968,7 @@ 
    Example
    
   "change_type": "CREATED",
   "changes": NegotiableQuoteHistoryChanges,
   "created_at": "abc123",
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -65158,7 +65140,7 @@ 
    Example
    
                   
                   
                   
    {
-  "products_removed_from_catalog": [4],
+  "products_removed_from_catalog": ["4"],
   "products_removed_from_quote": [ProductInterface]
 }
 
     
@@ -65365,7 +65347,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"message": "abc123"}
+                  
    {"message": "xyz789"}
 
     
                   
                 
@@ -65424,7 +65406,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"quantity": 123.45, "quote_item_uid": 4}
+                  
    {"quantity": 987.65, "quote_item_uid": "4"}
 
     
                   
                 
@@ -65484,7 +65466,7 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "abc123",
+  "code": "xyz789",
   "purchase_order_number": "abc123"
 }
 
     
@@ -65621,14 +65603,14 @@ 
    Example
    
                   
    {
   "available_shipping_methods": [AvailableShippingMethod],
   "city": "xyz789",
-  "company": "xyz789",
+  "company": "abc123",
   "country": NegotiableQuoteAddressCountry,
   "firstname": "abc123",
-  "lastname": "abc123",
-  "postcode": "abc123",
+  "lastname": "xyz789",
+  "postcode": "xyz789",
   "region": NegotiableQuoteAddressRegion,
   "selected_shipping_method": SelectedShippingMethod,
-  "street": ["abc123"],
+  "street": ["xyz789"],
   "telephone": "xyz789"
 }
 
     
@@ -65702,7 +65684,7 @@ 
    Example
    
                   
                   
    {
   "address": NegotiableQuoteAddressInput,
-  "customer_address_uid": "4",
+  "customer_address_uid": 4,
   "customer_notes": "abc123"
 }
 
     
@@ -66002,7 +65984,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"quote_uid": "4"}
+                  
    {"quote_uid": 4}
 
     
                   
                 
@@ -66058,8 +66040,8 @@ 
    Example
    
                   
                   
                   
    {
-  "firstname": "abc123",
-  "lastname": "abc123"
+  "firstname": "xyz789",
+  "lastname": "xyz789"
 }
 
     
                   
@@ -66137,7 +66119,7 @@ 
    Example
    
   "items": [NegotiableQuote],
   "page_info": SearchResultPageInfo,
   "sort_fields": SortFields,
-  "total_count": 123
+  "total_count": 987
 }
 
     
                   
@@ -66193,10 +66175,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {
-  "message": "xyz789",
-  "uid": "4"
-}
+                  
    {"message": "xyz789", "uid": 4}
 
     
                   
                 
@@ -66254,7 +66233,7 @@ 
    Example
    
                   
                   
                   
    {
-  "order_id": "abc123",
+  "order_id": "xyz789",
   "order_number": "abc123"
 }
 
     
@@ -66432,17 +66411,17 @@ 
    Example
    
   "city": "xyz789",
   "company": "abc123",
   "country_code": "AF",
-  "fax": "xyz789",
-  "firstname": "abc123",
-  "lastname": "abc123",
+  "fax": "abc123",
+  "firstname": "xyz789",
+  "lastname": "xyz789",
   "middlename": "abc123",
   "postcode": "xyz789",
-  "prefix": "xyz789",
+  "prefix": "abc123",
   "region": "abc123",
-  "region_id": "4",
+  "region_id": 4,
   "street": ["xyz789"],
-  "suffix": "xyz789",
-  "telephone": "abc123",
+  "suffix": "abc123",
+  "telephone": "xyz789",
   "vat_id": "abc123"
 }
 
     
@@ -66515,9 +66494,9 @@ 
    Example
    
                   
                   
                   
    {
-  "email": "abc123",
-  "number": "xyz789",
-  "postcode": "xyz789"
+  "email": "xyz789",
+  "number": "abc123",
+  "postcode": "abc123"
 }
 
     
                   
@@ -66733,22 +66712,22 @@ 
    Example
    
                   
                   
    {
   "discounts": [Discount],
-  "eligible_for_return": true,
+  "eligible_for_return": false,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": 4,
+  "id": "4",
   "product": ProductInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "xyz789",
   "product_type": "xyz789",
   "product_url_key": "abc123",
   "quantity_canceled": 123.45,
   "quantity_invoiced": 123.45,
-  "quantity_ordered": 123.45,
-  "quantity_refunded": 987.65,
-  "quantity_returned": 987.65,
+  "quantity_ordered": 987.65,
+  "quantity_refunded": 123.45,
+  "quantity_returned": 123.45,
   "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
   "status": "xyz789"
@@ -67011,25 +66990,25 @@ 
    Example
    
                   
                   
    {
   "discounts": [Discount],
-  "eligible_for_return": true,
+  "eligible_for_return": false,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "4",
+  "id": 4,
   "product": ProductInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "xyz789",
   "product_type": "abc123",
-  "product_url_key": "abc123",
-  "quantity_canceled": 123.45,
-  "quantity_invoiced": 123.45,
-  "quantity_ordered": 123.45,
-  "quantity_refunded": 123.45,
+  "product_url_key": "xyz789",
+  "quantity_canceled": 987.65,
+  "quantity_invoiced": 987.65,
+  "quantity_ordered": 987.65,
+  "quantity_refunded": 987.65,
   "quantity_returned": 123.45,
-  "quantity_shipped": 123.45,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "xyz789"
+  "status": "abc123"
 }
 
     
                   
@@ -67557,7 +67536,7 @@ 
    Example
    
                   
                   
                   
    {
-  "cancel_url": "abc123",
+  "cancel_url": "xyz789",
   "error_url": "xyz789",
   "return_url": "xyz789"
 }
@@ -67684,8 +67663,8 @@ 
    Example
    
                   
                   
    {
   "mode": "TEST",
-  "paypal_url": "xyz789",
-  "secure_token": "xyz789",
+  "paypal_url": "abc123",
+  "secure_token": "abc123",
   "secure_token_id": "abc123"
 }
 
     
@@ -67735,7 +67714,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
 
     
                   
                 
@@ -67796,7 +67775,7 @@ 
    Example
    
                   
                   
    {
   "cc_details": CreditCardDetailsInput,
-  "is_active_payment_token_enabler": false
+  "is_active_payment_token_enabler": true
 }
 
     
                   
@@ -67857,7 +67836,7 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "paypal_payload": "abc123"
 }
 
     
@@ -68040,7 +68019,7 @@ 
    Example
    
                   
    {
   "cancel_url": "abc123",
   "error_url": "xyz789",
-  "return_url": "xyz789"
+  "return_url": "abc123"
 }
 
     
                   
@@ -68166,11 +68145,11 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "xyz789",
-  "is_visible": false,
-  "payment_intent": "abc123",
+  "code": "abc123",
+  "is_visible": true,
+  "payment_intent": "xyz789",
   "sdk_params": [SDKParams],
-  "sort_order": "abc123",
+  "sort_order": "xyz789",
   "title": "xyz789"
 }
 
     
@@ -68557,7 +68536,7 @@ 
    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,
@@ -68568,7 +68547,7 @@ 
    Example
    
   "payment_services_paypal_smart_buttons": SmartButtonMethodInput,
   "payment_services_paypal_vault": VaultMethodInput,
   "paypal_express": PaypalExpressInput,
-  "purchase_order_number": "abc123"
+  "purchase_order_number": "xyz789"
 }
 
     
                   
@@ -68699,7 +68678,7 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "abc123",
+  "code": "xyz789",
   "params": [SDKParams]
 }
 
     
@@ -69027,9 +69006,9 @@ 
    Example
    
                   
    {
   "cart_id": "xyz789",
   "code": "xyz789",
-  "express_button": false,
+  "express_button": true,
   "urls": PaypalExpressUrlsInput,
-  "use_paypal_credit": true
+  "use_paypal_credit": false
 }
 
     
                   
@@ -69087,7 +69066,7 @@ 
    Example
    
                   
                   
    {
   "paypal_urls": PaypalExpressUrlList,
-  "token": "abc123"
+  "token": "xyz789"
 }
 
     
                   
@@ -69144,7 +69123,7 @@ 
    Example
    
                   
                   
                   
    {
-  "edit": "abc123",
+  "edit": "xyz789",
   "start": "xyz789"
 }
 
     
@@ -69233,10 +69212,10 @@ 
    Example
    
                   
                   
                   
    {
-  "cancel_url": "abc123",
+  "cancel_url": "xyz789",
   "pending_url": "abc123",
   "return_url": "xyz789",
-  "success_url": "xyz789"
+  "success_url": "abc123"
 }
 
     
                   
@@ -69504,19 +69483,19 @@ 
    Example
    
                   
                   
    {
   "city": "xyz789",
-  "contact_name": "xyz789",
-  "country_id": "abc123",
+  "contact_name": "abc123",
+  "country_id": "xyz789",
   "description": "xyz789",
-  "email": "abc123",
-  "fax": "abc123",
-  "latitude": 987.65,
+  "email": "xyz789",
+  "fax": "xyz789",
+  "latitude": 123.45,
   "longitude": 987.65,
   "name": "xyz789",
   "phone": "xyz789",
-  "pickup_location_code": "xyz789",
-  "postcode": "abc123",
-  "region": "xyz789",
-  "region_id": 123,
+  "pickup_location_code": "abc123",
+  "postcode": "xyz789",
+  "region": "abc123",
+  "region_id": 987,
   "street": "xyz789"
 }
 
     
@@ -69998,7 +69977,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"quote_uid": 4}
+                  
    {"quote_uid": "4"}
 
     
                   
                 
@@ -70101,7 +70080,7 @@ 
    Example
    
                   
                   
    {
   "code": "CART_NOT_FOUND",
-  "message": "xyz789"
+  "message": "abc123"
 }
 
     
                   
@@ -70782,7 +70761,7 @@ 
    Example
    
                   
    {
   "discount_percentage": 987.65,
   "main_final_price": 987.65,
-  "main_price": 123.45
+  "main_price": 987.65
 }
 
     
                   
@@ -71607,7 +71586,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"amount_off": 123.45, "percent_off": 123.45}
+                  
    {"amount_off": 123.45, "percent_off": 987.65}
 
     
                   
                 
@@ -72237,7 +72216,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"sku": "abc123"}
+                  
    {"sku": "xyz789"}
 
     
                   
                 
@@ -73116,79 +73095,79 @@ 
    Example
    
                   
                   
                   
    {
-  "activity": "xyz789",
+  "activity": "abc123",
   "attribute_set_id": 123,
-  "canonical_url": "abc123",
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
   "category_gear": "abc123",
-  "climate": "abc123",
+  "climate": "xyz789",
   "collar": "xyz789",
-  "color": 987,
+  "color": 123,
   "country_of_manufacture": "xyz789",
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 987,
+  "eco_collection": 123,
   "erin_recommends": 123,
-  "features_bags": "xyz789",
-  "format": 987,
+  "features_bags": "abc123",
+  "format": 123,
   "gender": "abc123",
-  "gift_message_available": "abc123",
-  "id": 123,
+  "gift_message_available": "xyz789",
+  "id": 987,
   "image": ProductImage,
-  "is_returnable": "xyz789",
+  "is_returnable": "abc123",
   "manufacturer": 123,
   "material": "abc123",
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
   "meta_description": "abc123",
-  "meta_keyword": "abc123",
-  "meta_title": "xyz789",
-  "name": "abc123",
-  "new": 987,
+  "meta_keyword": "xyz789",
+  "meta_title": "abc123",
+  "name": "xyz789",
+  "new": 123,
   "new_from_date": "abc123",
-  "new_to_date": "abc123",
-  "only_x_left_in_stock": 123.45,
+  "new_to_date": "xyz789",
+  "only_x_left_in_stock": 987.65,
   "options_container": "abc123",
   "pattern": "abc123",
-  "performance_fabric": 123,
+  "performance_fabric": 987,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 123,
+  "purpose": 987,
   "rating_summary": 123.45,
   "related_products": [ProductInterface],
   "review_count": 123,
   "reviews": ProductReviews,
-  "sale": 987,
+  "sale": 123,
   "short_description": ComplexTextValue,
   "size": 123,
-  "sku": "xyz789",
+  "sku": "abc123",
   "sleeve": "abc123",
   "small_image": ProductImage,
   "special_from_date": "abc123",
-  "special_price": 123.45,
-  "special_to_date": "xyz789",
+  "special_price": 987.65,
+  "special_to_date": "abc123",
   "staged": false,
   "stock_status": "IN_STOCK",
   "strap_bags": "abc123",
-  "style_bags": "xyz789",
-  "style_bottom": "abc123",
-  "style_general": "abc123",
-  "swatch_image": "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_id": "abc123",
-  "uid": "4",
-  "updated_at": "xyz789",
+  "type_id": "xyz789",
+  "uid": 4,
+  "updated_at": "abc123",
   "upsell_products": [ProductInterface],
-  "url_key": "abc123",
+  "url_key": "xyz789",
   "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "xyz789",
+  "url_suffix": "abc123",
   "websites": [Website]
 }
 
     
@@ -73273,11 +73252,11 @@ 
    Example
    
                   
                   
                   
    {
-  "link_type": "abc123",
-  "linked_product_sku": "abc123",
+  "link_type": "xyz789",
+  "linked_product_sku": "xyz789",
   "linked_product_type": "xyz789",
-  "position": 987,
-  "sku": "xyz789"
+  "position": 123,
+  "sku": "abc123"
 }
 
     
                   
@@ -73380,10 +73359,10 @@ 
    Example
    
                   
                   
                   
    {
-  "link_type": "xyz789",
-  "linked_product_sku": "abc123",
+  "link_type": "abc123",
+  "linked_product_sku": "xyz789",
   "linked_product_type": "xyz789",
-  "position": 987,
+  "position": 123,
   "sku": "abc123"
 }
 
     
@@ -73452,7 +73431,7 @@ 
    Example
    
                   
    {
   "base64_encoded_data": "xyz789",
   "name": "abc123",
-  "type": "xyz789"
+  "type": "abc123"
 }
 
     
                   
@@ -73547,8 +73526,8 @@ 
    Example
    
                   
    {
   "media_type": "xyz789",
   "video_description": "abc123",
-  "video_metadata": "abc123",
-  "video_provider": "xyz789",
+  "video_metadata": "xyz789",
+  "video_provider": "abc123",
   "video_title": "xyz789",
   "video_url": "abc123"
 }
@@ -73804,12 +73783,12 @@ 
    Example
    
                   
                   
                   
    {
-  "average_rating": 123.45,
-  "created_at": "xyz789",
+  "average_rating": 987.65,
+  "created_at": "abc123",
   "nickname": "xyz789",
   "product": ProductInterface,
   "ratings_breakdown": [ProductReviewRating],
-  "summary": "xyz789",
+  "summary": "abc123",
   "text": "abc123"
 }
 
     
@@ -73867,8 +73846,8 @@ 
    Example
    
                   
                   
                   
    {
-  "name": "xyz789",
-  "value": "xyz789"
+  "name": "abc123",
+  "value": "abc123"
 }
 
     
                   
@@ -73929,8 +73908,8 @@ 
    Example
    
                   
                   
                   
    {
-  "id": "xyz789",
-  "value_id": "xyz789"
+  "id": "abc123",
+  "value_id": "abc123"
 }
 
     
                   
@@ -73996,7 +73975,7 @@ 
    Example
    
                   
                   
                   
    {
-  "id": "xyz789",
+  "id": "abc123",
   "name": "xyz789",
   "values": [ProductReviewRatingValueMetadata]
 }
@@ -74055,8 +74034,8 @@ 
    Example
    
                   
                   
                   
    {
-  "value": "abc123",
-  "value_id": "xyz789"
+  "value": "xyz789",
+  "value_id": "abc123"
 }
 
     
                   
@@ -74307,7 +74286,7 @@ 
    Example
    
   "percentage_value": 987.65,
   "qty": 123.45,
   "value": 123.45,
-  "website_id": 123.45
+  "website_id": 987.65
 }
 
     
                   
@@ -74391,10 +74370,10 @@ 
    Example
    
                   
                   
                   
    {
-  "disabled": true,
+  "disabled": false,
   "label": "abc123",
-  "position": 987,
-  "url": "abc123",
+  "position": 123,
+  "url": "xyz789",
   "video_content": ProductMediaGalleryEntriesVideoContent
 }
 
     
@@ -74522,7 +74501,7 @@ 
    Example
    
   "page_info": SearchResultPageInfo,
   "sort_fields": SortFields,
   "suggestions": [SearchSuggestion],
-  "total_count": 123
+  "total_count": 987
 }
 
     
                   
@@ -74680,7 +74659,7 @@ 
    Example
    
   "quote": Cart,
   "status": "PENDING",
   "uid": 4,
-  "updated_at": "abc123"
+  "updated_at": "xyz789"
 }
 
     
                   
@@ -74799,7 +74778,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"message": "abc123", "type": "NOT_FOUND"}
+                  
    {"message": "xyz789", "type": "NOT_FOUND"}
 
     
                   
                 
@@ -74882,11 +74861,11 @@ 
    Example
    
                   
                   
                   
    {
-  "message": "abc123",
-  "name": "abc123",
+  "message": "xyz789",
+  "name": "xyz789",
   "role": "abc123",
   "status": "PENDING",
-  "updated_at": "abc123"
+  "updated_at": "xyz789"
 }
 
     
                   
@@ -75072,10 +75051,10 @@ 
    Example
    
   "created_at": "abc123",
   "created_by": "xyz789",
   "description": "xyz789",
-  "name": "abc123",
+  "name": "xyz789",
   "status": "ENABLED",
-  "uid": "4",
-  "updated_at": "abc123"
+  "uid": 4,
+  "updated_at": "xyz789"
 }
 
     
                   
@@ -75346,7 +75325,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}
+                  
    {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123}
 
     
                   
                 
@@ -75450,11 +75429,11 @@ 
    Example
    
                   
                   
                   
    {
-  "applies_to": ["4"],
-  "approvers": [4],
+  "applies_to": [4],
+  "approvers": ["4"],
   "condition": CreatePurchaseOrderApprovalRuleConditionInput,
   "description": "xyz789",
-  "name": "xyz789",
+  "name": "abc123",
   "status": "ENABLED"
 }
 
     
@@ -75687,7 +75666,7 @@ 
    Example
    
                   
    {
   "items": [PurchaseOrderApprovalRule],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
     
                   
@@ -75763,8 +75742,8 @@ 
    Example
    
                   
                   
    {
   "author": Customer,
-  "created_at": "abc123",
-  "text": "abc123",
+  "created_at": "xyz789",
+  "text": "xyz789",
   "uid": "4"
 }
 
     
@@ -75904,9 +75883,9 @@ 
    Example
    
                   
                   
    {
   "activity": "abc123",
-  "created_at": "xyz789",
-  "message": "abc123",
-  "uid": "4"
+  "created_at": "abc123",
+  "message": "xyz789",
+  "uid": 4
 }
 
     
                   
@@ -75964,7 +75943,7 @@ 
    Example
    
                   
                   
    {
   "events": [PurchaseOrderApprovalFlowEvent],
-  "rule_name": "abc123"
+  "rule_name": "xyz789"
 }
 
     
                   
@@ -76119,7 +76098,7 @@ 
    Example
    
                   
    {
   "items": [PurchaseOrder],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
     
                   
@@ -76308,9 +76287,9 @@ 
    Example
    
                   
                   
                   
    {
-  "company_purchase_orders": false,
+  "company_purchase_orders": true,
   "created_date": FilterRangeTypeInput,
-  "require_my_approval": true,
+  "require_my_approval": false,
   "status": "PENDING"
 }
 
     
@@ -76472,11 +76451,11 @@ 
    Example
    
                   
                   
                   
    {
-  "badge_position": "abc123",
+  "badge_position": "xyz789",
   "failure_message": "xyz789",
   "forms": ["PLACE_ORDER"],
   "is_enabled": false,
-  "language_code": "abc123",
+  "language_code": "xyz789",
   "minimum_score": 123.45,
   "website_key": "abc123"
 }
@@ -76633,9 +76612,9 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "abc123",
-  "id": 123,
-  "name": "abc123"
+  "code": "xyz789",
+  "id": 987,
+  "name": "xyz789"
 }
 
     
                   
@@ -76790,7 +76769,7 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "coupon_codes": ["abc123"]
 }
 
     
@@ -76992,7 +76971,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"success": false}
+                  
    {"success": true}
 
     
                   
                 
@@ -77109,9 +77088,9 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": "xyz789",
-  "cart_item_id": 123,
-  "cart_item_uid": "4"
+  "cart_id": "abc123",
+  "cart_item_id": 987,
+  "cart_item_uid": 4
 }
 
     
                   
@@ -77217,7 +77196,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"quote_item_uids": [4], "quote_uid": "4"}
+                  
    {"quote_item_uids": [4], "quote_uid": 4}
 
     
                   
                 
@@ -77743,7 +77722,7 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": 4,
+  "cart_id": "4",
   "comment": NegotiableQuoteCommentInput,
   "quote_name": "xyz789"
 }
@@ -77877,7 +77856,7 @@ 
    Example
    
   "comment_text": "xyz789",
   "contact_email": "abc123",
   "items": [RequestReturnItemInput],
-  "order_uid": "4"
+  "order_uid": 4
 }
 
     
                   
@@ -78177,7 +78156,7 @@ 
    Example
    
   "items_count": 123,
   "name": "abc123",
   "uid": 4,
-  "updated_at": "xyz789"
+  "updated_at": "abc123"
 }
 
     
                   
@@ -78371,7 +78350,7 @@ 
    Example
    
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
   "quantity": 987.65,
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -78466,9 +78445,9 @@ 
    Example
    
                   
                   
    {
   "entered_options": [EnteredOptionInput],
-  "parent_sku": "xyz789",
-  "quantity": 987.65,
-  "selected_options": ["xyz789"],
+  "parent_sku": "abc123",
+  "quantity": 123.45,
+  "selected_options": ["abc123"],
   "sku": "xyz789"
 }
 
     
@@ -78537,7 +78516,7 @@ 
    Example
    
                   
    {
   "items": [RequisitionList],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
     
                   
@@ -78736,10 +78715,10 @@ 
    Example
    
                   
    {
   "available_shipping_carriers": [ReturnShippingCarrier],
   "comments": [ReturnComment],
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "customer": ReturnCustomer,
   "items": [ReturnItem],
-  "number": "xyz789",
+  "number": "abc123",
   "order": CustomerOrder,
   "shipping": ReturnShipping,
   "status": "PENDING",
@@ -78819,8 +78798,8 @@ 
    Example
    
                   
                   
    {
   "author_name": "abc123",
-  "created_at": "xyz789",
-  "text": "xyz789",
+  "created_at": "abc123",
+  "text": "abc123",
   "uid": "4"
 }
 
     
@@ -78887,7 +78866,7 @@ 
    Example
    
                   
                   
                   
    {
-  "label": "xyz789",
+  "label": "abc123",
   "uid": 4,
   "value": "xyz789"
 }
@@ -78955,7 +78934,7 @@ 
    Example
    
                   
                   
                   
    {
-  "email": "abc123",
+  "email": "xyz789",
   "firstname": "xyz789",
   "lastname": "xyz789"
 }
@@ -79067,7 +79046,7 @@ 
    Example
    
   "quantity": 987.65,
   "request_quantity": 123.45,
   "status": "PENDING",
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -79224,15 +79203,15 @@ 
    Example
    
                   
                   
    {
   "code": "4",
-  "default_value": "abc123",
+  "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "xyz789",
+  "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
   "input_filter": "NONE",
   "is_required": true,
-  "is_unique": false,
-  "label": "xyz789",
-  "multiline_count": 987,
+  "is_unique": true,
+  "label": "abc123",
+  "multiline_count": 123,
   "options": [CustomAttributeOptionInterface],
   "sort_order": 987,
   "validate_rules": [ValidationRule]
@@ -79481,13 +79460,13 @@ 
    Example
    
                   
                   
                   
    {
-  "city": "abc123",
+  "city": "xyz789",
   "contact_name": "abc123",
   "country": Country,
   "postcode": "abc123",
   "region": Region,
   "street": ["xyz789"],
-  "telephone": "xyz789"
+  "telephone": "abc123"
 }
 
     
                   
@@ -79543,7 +79522,10 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"label": "xyz789", "uid": 4}
+                  
    {
+  "label": "abc123",
+  "uid": "4"
+}
 
     
                   
                 
@@ -79619,7 +79601,7 @@ 
    Example
    
                   
    {
   "carrier": ReturnShippingCarrier,
   "status": ReturnShippingTrackingStatus,
-  "tracking_number": "xyz789",
+  "tracking_number": "abc123",
   "uid": "4"
 }
 
     
@@ -79676,7 +79658,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"text": "abc123", "type": "INFORMATION"}
+                  
    {"text": "xyz789", "type": "INFORMATION"}
 
     
                   
                 
@@ -80144,7 +80126,7 @@ 
    Example
    
                   
                   
    {
   "balance": RewardPointsAmount,
-  "change_reason": "abc123",
+  "change_reason": "xyz789",
   "date": "abc123",
   "points_change": 987.65
 }
@@ -80260,7 +80242,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"currency_amount": 123.45, "points": 123.45}
+                  
    {"currency_amount": 987.65, "points": 987.65}
 
     
                   
                 
@@ -80578,7 +80560,7 @@ 
    Example
    
                   
                   
                   
    {
-  "redirect_code": 123,
+  "redirect_code": 987,
   "relative_url": "abc123",
   "type": "CMS_PAGE"
 }
@@ -80947,10 +80929,10 @@ 
    Example
    
                   
                   
                   
    {
-  "id": 123,
+  "id": 987,
   "label": "abc123",
   "type": "abc123",
-  "uid": 4,
+  "uid": "4",
   "values": [SelectedBundleOptionValue]
 }
 
     
@@ -81136,12 +81118,12 @@ 
    Example
    
                   
                   
                   
    {
-  "configurable_product_option_uid": 4,
-  "configurable_product_option_value_uid": 4,
+  "configurable_product_option_uid": "4",
+  "configurable_product_option_value_uid": "4",
   "id": 987,
   "option_label": "xyz789",
   "value_id": 123,
-  "value_label": "xyz789"
+  "value_label": "abc123"
 }
 
     
                   
@@ -81310,8 +81292,8 @@ 
    Example
    
   "customizable_option_uid": 4,
   "id": 123,
   "is_required": false,
-  "label": "xyz789",
-  "sort_order": 987,
+  "label": "abc123",
+  "sort_order": 123,
   "type": "abc123",
   "values": [SelectedCustomizableOptionValue]
 }
@@ -81469,9 +81451,9 @@ 
    Example
    
                   
                   
                   
    {
-  "code": "abc123",
+  "code": "xyz789",
   "purchase_order_number": "abc123",
-  "title": "abc123"
+  "title": "xyz789"
 }
 
     
                   
@@ -81587,9 +81569,9 @@ 
    Example
    
   "amount": Money,
   "base_amount": Money,
   "carrier_code": "xyz789",
-  "carrier_title": "abc123",
-  "method_code": "abc123",
-  "method_title": "xyz789",
+  "carrier_title": "xyz789",
+  "method_code": "xyz789",
+  "method_title": "abc123",
   "price_excl_tax": Money,
   "price_incl_tax": Money
 }
@@ -81781,7 +81763,7 @@ 
    Example
    
                   
                   
    {
   "email": "abc123",
-  "name": "abc123"
+  "name": "xyz789"
 }
 
     
                   
@@ -81842,7 +81824,7 @@ 
    Example
    
                   
                   
                   
    {
-  "email": "xyz789",
+  "email": "abc123",
   "name": "abc123"
 }
 
     
@@ -81910,7 +81892,7 @@ 
    Example
    
                   
                   
    {
   "email": "abc123",
-  "message": "abc123",
+  "message": "xyz789",
   "name": "abc123"
 }
 
     
@@ -81984,8 +81966,8 @@ 
    Example
    
                   
                   
    {
   "email": "abc123",
-  "message": "xyz789",
-  "name": "xyz789"
+  "message": "abc123",
+  "name": "abc123"
 }
 
     
                   
@@ -82100,7 +82082,10 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"comment": NegotiableQuoteCommentInput, "quote_uid": 4}
+                  
    {
+  "comment": NegotiableQuoteCommentInput,
+  "quote_uid": "4"
+}
 
     
                   
                 
@@ -82350,7 +82335,7 @@ 
    Example
    
   "cart_id": "abc123",
   "gift_message": GiftMessageInput,
   "gift_receipt_included": false,
-  "gift_wrapping_id": "4",
+  "gift_wrapping_id": 4,
   "printed_card_included": false
 }
 
     
@@ -82613,7 +82598,7 @@ 
    Example
    
                   
                   
    {
   "billing_address": NegotiableQuoteBillingAddressInput,
-  "quote_uid": "4"
+  "quote_uid": 4
 }
 
     
                   
@@ -82721,7 +82706,7 @@ 
    Example
    
                   
                   
    {
   "payment_method": NegotiableQuotePaymentMethodInput,
-  "quote_uid": "4"
+  "quote_uid": 4
 }
 
     
                   
@@ -82839,7 +82824,7 @@ 
    Example
    
                   
                   
                   
    {
-  "customer_address_id": 4,
+  "customer_address_id": "4",
   "quote_uid": "4",
   "shipping_addresses": [
     NegotiableQuoteShippingAddressInput
@@ -83058,7 +83043,7 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "payment_method": PaymentMethodInput
 }
 
     
@@ -83120,7 +83105,7 @@ 
    Example
    
                   
                   
                   
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "payment_method": PaymentMethodInput
 }
 
     
@@ -83445,7 +83430,7 @@ 
    Example
    
                   
                   
    {
   "email": "abc123",
-  "name": "abc123"
+  "name": "xyz789"
 }
 
     
                   
@@ -83492,7 +83477,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"is_shared": true}
+                  
    {"is_shared": false}
 
     
                   
                 
@@ -83693,9 +83678,9 @@ 
    Example
    
                   
    {
   "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
+  "product_sku": "abc123",
   "quantity_shipped": 987.65
 }
 
     
@@ -83822,11 +83807,11 @@ 
    Example
    
                   
                   
                   
    {
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "abc123",
+  "product_sku": "xyz789",
   "quantity_shipped": 123.45
 }
 
     
@@ -83979,8 +83964,8 @@ 
    Example
    
                   
                   
    {
   "address": CartAddressInput,
-  "customer_address_id": 123,
-  "customer_notes": "xyz789",
+  "customer_address_id": 987,
+  "customer_notes": "abc123",
   "pickup_location_code": "xyz789"
 }
 
     
@@ -84234,26 +84219,26 @@ 
    Example
    
   "available_shipping_methods": [AvailableShippingMethod],
   "cart_items": [CartItemQuantity],
   "cart_items_v2": [CartItemInterface],
-  "city": "abc123",
-  "company": "abc123",
+  "city": "xyz789",
+  "company": "xyz789",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "customer_notes": "xyz789",
-  "fax": "abc123",
+  "customer_notes": "abc123",
+  "fax": "xyz789",
   "firstname": "xyz789",
-  "items_weight": 123.45,
+  "items_weight": 987.65,
   "lastname": "xyz789",
-  "middlename": "xyz789",
+  "middlename": "abc123",
   "pickup_location_code": "abc123",
   "postcode": "xyz789",
-  "prefix": "abc123",
+  "prefix": "xyz789",
   "region": CartAddressRegion,
   "selected_shipping_method": SelectedShippingMethod,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "suffix": "abc123",
   "telephone": "xyz789",
   "uid": "abc123",
-  "vat_id": "xyz789"
+  "vat_id": "abc123"
 }
 
     
                   
@@ -84448,7 +84433,7 @@ 
    Example
    
                   
                   
                   
    {
-  "carrier_code": "abc123",
+  "carrier_code": "xyz789",
   "method_code": "abc123"
 }
 
     
@@ -84622,14 +84607,14 @@ 
    Example
    
   "errors": [CartItemError],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "xyz789",
-  "is_available": true,
+  "id": "abc123",
+  "is_available": false,
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 987.65,
-  "uid": "4"
+  "quantity": 123.45,
+  "uid": 4
 }
 
     
                   
@@ -85493,43 +85478,43 @@ 
    Example
    
                   
                   
                   
    {
-  "activity": "abc123",
+  "activity": "xyz789",
   "attribute_set_id": 123,
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
   "category_gear": "xyz789",
-  "climate": "xyz789",
-  "collar": "abc123",
+  "climate": "abc123",
+  "collar": "xyz789",
   "color": 987,
-  "country_of_manufacture": "abc123",
-  "created_at": "xyz789",
+  "country_of_manufacture": "xyz789",
+  "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "eco_collection": 987,
   "erin_recommends": 123,
-  "features_bags": "xyz789",
-  "format": 123,
+  "features_bags": "abc123",
+  "format": 987,
   "gender": "xyz789",
-  "gift_message_available": "xyz789",
+  "gift_message_available": "abc123",
   "id": 987,
   "image": ProductImage,
   "is_returnable": "xyz789",
-  "manufacturer": 987,
+  "manufacturer": 123,
   "material": "xyz789",
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
+  "meta_description": "xyz789",
   "meta_keyword": "xyz789",
-  "meta_title": "xyz789",
-  "name": "xyz789",
-  "new": 987,
+  "meta_title": "abc123",
+  "name": "abc123",
+  "new": 123,
   "new_from_date": "abc123",
   "new_to_date": "abc123",
-  "only_x_left_in_stock": 123.45,
+  "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
-  "options_container": "abc123",
-  "pattern": "xyz789",
+  "options_container": "xyz789",
+  "pattern": "abc123",
   "performance_fabric": 987,
   "price": ProductPrices,
   "price_range": PriceRange,
@@ -85539,39 +85524,39 @@ 
    Example
    
   "rating_summary": 123.45,
   "redirect_code": 123,
   "related_products": [ProductInterface],
-  "relative_url": "xyz789",
-  "review_count": 123,
+  "relative_url": "abc123",
+  "review_count": 987,
   "reviews": ProductReviews,
   "sale": 987,
   "short_description": ComplexTextValue,
-  "size": 123,
+  "size": 987,
   "sku": "xyz789",
   "sleeve": "xyz789",
   "small_image": ProductImage,
-  "special_from_date": "abc123",
-  "special_price": 987.65,
-  "special_to_date": "xyz789",
-  "staged": true,
+  "special_from_date": "xyz789",
+  "special_price": 123.45,
+  "special_to_date": "abc123",
+  "staged": false,
   "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
+  "strap_bags": "xyz789",
   "style_bags": "abc123",
-  "style_bottom": "xyz789",
-  "style_general": "xyz789",
+  "style_bottom": "abc123",
+  "style_general": "abc123",
   "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": "abc123",
   "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
   "url_suffix": "abc123",
   "websites": [Website],
-  "weight": 987.65
+  "weight": 123.45
 }
 
     
                   
@@ -85710,8 +85695,8 @@ 
    Example
    
                   
    {
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": 4
+  "quantity": 987.65,
+  "uid": "4"
 }
 
     
                   
@@ -85807,7 +85792,7 @@ 
    Example
    
   "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
-  "id": "4",
+  "id": 4,
   "product": ProductInterface,
   "quantity": 123.45
 }
@@ -85882,7 +85867,7 @@ 
    Example
    
                   
                   
    {
   "payment_source": "xyz789",
-  "payments_order_id": "xyz789",
+  "payments_order_id": "abc123",
   "paypal_order_id": "abc123"
 }
 
     
@@ -86010,14 +85995,14 @@ 
    Example
    
                   
    {
   "button_styles": ButtonStyles,
   "code": "xyz789",
-  "display_message": true,
+  "display_message": false,
   "display_venmo": true,
   "is_visible": true,
   "message_styles": MessageStyles,
   "payment_intent": "abc123",
   "sdk_params": [SDKParams],
   "sort_order": "xyz789",
-  "title": "xyz789"
+  "title": "abc123"
 }
 
     
                   
@@ -86123,7 +86108,7 @@ 
    Example
    
                   
                   
                   
    {
-  "label": "abc123",
+  "label": "xyz789",
   "value": "abc123"
 }
 
     
@@ -86181,7 +86166,7 @@ 
    Example
    
                   
                   
                   
    {
-  "default": "abc123",
+  "default": "xyz789",
   "options": [SortField]
 }
 
     
@@ -88426,70 +88411,70 @@ 
    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_guests_to_write_product_reviews": "abc123",
   "allow_items": "xyz789",
-  "allow_order": "xyz789",
+  "allow_order": "abc123",
   "allow_printed_card": "abc123",
   "autocomplete_on_storefront": false,
   "base_currency_code": "xyz789",
-  "base_link_url": "abc123",
+  "base_link_url": "xyz789",
   "base_media_url": "xyz789",
-  "base_static_url": "xyz789",
+  "base_static_url": "abc123",
   "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_ach_direct_debit_vault_active": true,
+  "braintree_3dsecure_allowspecific": false,
+  "braintree_3dsecure_always_request_3ds": true,
+  "braintree_3dsecure_specificcountry": "abc123",
+  "braintree_3dsecure_threshold_amount": "abc123",
+  "braintree_3dsecure_verify_3dsecure": true,
+  "braintree_ach_direct_debit_vault_active": false,
   "braintree_applepay_merchant_name": "abc123",
-  "braintree_applepay_vault_active": true,
+  "braintree_applepay_vault_active": false,
   "braintree_cc_vault_active": "abc123",
-  "braintree_cc_vault_cvv": true,
-  "braintree_environment": "xyz789",
-  "braintree_googlepay_btn_color": "abc123",
+  "braintree_cc_vault_cvv": false,
+  "braintree_environment": "abc123",
+  "braintree_googlepay_btn_color": "xyz789",
   "braintree_googlepay_cctypes": "abc123",
-  "braintree_googlepay_merchant_id": "abc123",
-  "braintree_googlepay_vault_active": true,
+  "braintree_googlepay_merchant_id": "xyz789",
+  "braintree_googlepay_vault_active": false,
   "braintree_local_payment_allowed_methods": "xyz789",
-  "braintree_local_payment_fallback_button_text": "xyz789",
+  "braintree_local_payment_fallback_button_text": "abc123",
   "braintree_local_payment_redirect_on_fail": "abc123",
-  "braintree_merchant_account_id": "xyz789",
+  "braintree_merchant_account_id": "abc123",
   "braintree_paypal_button_location_cart_type_credit_color": "xyz789",
   "braintree_paypal_button_location_cart_type_credit_label": "abc123",
-  "braintree_paypal_button_location_cart_type_credit_shape": "abc123",
+  "braintree_paypal_button_location_cart_type_credit_shape": "xyz789",
   "braintree_paypal_button_location_cart_type_credit_show": true,
-  "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789",
-  "braintree_paypal_button_location_cart_type_messaging_logo": "abc123",
-  "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789",
+  "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
+  "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789",
+  "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
   "braintree_paypal_button_location_cart_type_messaging_show": true,
-  "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
+  "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789",
   "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
   "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
-  "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789",
-  "braintree_paypal_button_location_cart_type_paylater_show": false,
-  "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
+  "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
+  "braintree_paypal_button_location_cart_type_paylater_show": true,
+  "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
   "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
   "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
-  "braintree_paypal_button_location_cart_type_paypal_show": true,
+  "braintree_paypal_button_location_cart_type_paypal_show": false,
   "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
   "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
   "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
-  "braintree_paypal_button_location_checkout_type_credit_show": true,
-  "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
-  "braintree_paypal_button_location_checkout_type_messaging_logo": "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": "abc123",
-  "braintree_paypal_button_location_checkout_type_messaging_show": false,
+  "braintree_paypal_button_location_checkout_type_messaging_show": true,
   "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
   "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
-  "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
-  "braintree_paypal_button_location_checkout_type_paylater_shape": "abc123",
+  "braintree_paypal_button_location_checkout_type_paylater_label": "abc123",
+  "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
   "braintree_paypal_button_location_checkout_type_paylater_show": true,
-  "braintree_paypal_button_location_checkout_type_paypal_color": "abc123",
+  "braintree_paypal_button_location_checkout_type_paypal_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,
@@ -88498,70 +88483,70 @@ 
    Example
    
   "braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
   "braintree_paypal_button_location_productpage_type_credit_show": true,
   "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
-  "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
-  "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123",
+  "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789",
+  "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
   "braintree_paypal_button_location_productpage_type_messaging_show": false,
-  "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
-  "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789",
+  "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789",
+  "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
   "braintree_paypal_button_location_productpage_type_paylater_label": "abc123",
   "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
-  "braintree_paypal_button_location_productpage_type_paylater_show": true,
-  "braintree_paypal_button_location_productpage_type_paypal_color": "abc123",
+  "braintree_paypal_button_location_productpage_type_paylater_show": false,
+  "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789",
   "braintree_paypal_button_location_productpage_type_paypal_label": "abc123",
   "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123",
-  "braintree_paypal_button_location_productpage_type_paypal_show": true,
-  "braintree_paypal_credit_uk_merchant_name": "xyz789",
-  "braintree_paypal_display_on_shopping_cart": false,
-  "braintree_paypal_merchant_country": "abc123",
-  "braintree_paypal_merchant_name_override": "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_merchant_country": "xyz789",
+  "braintree_paypal_merchant_name_override": "abc123",
   "braintree_paypal_require_billing_address": false,
-  "braintree_paypal_send_cart_line_items": false,
-  "braintree_paypal_vault_active": false,
+  "braintree_paypal_send_cart_line_items": true,
+  "braintree_paypal_vault_active": true,
   "cart_expires_in_days": 987,
-  "cart_gift_wrapping": "xyz789",
-  "cart_printed_card": "abc123",
-  "cart_summary_display_quantity": 987,
-  "catalog_default_sort_by": "xyz789",
+  "cart_gift_wrapping": "abc123",
+  "cart_printed_card": "xyz789",
+  "cart_summary_display_quantity": 123,
+  "catalog_default_sort_by": "abc123",
   "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-  "category_url_suffix": "abc123",
+  "category_url_suffix": "xyz789",
   "check_money_order_enable_for_specific_countries": true,
   "check_money_order_enabled": false,
-  "check_money_order_make_check_payable_to": "abc123",
-  "check_money_order_max_order_total": "xyz789",
-  "check_money_order_min_order_total": "xyz789",
-  "check_money_order_new_order_status": "abc123",
-  "check_money_order_payment_from_specific_countries": "xyz789",
+  "check_money_order_make_check_payable_to": "xyz789",
+  "check_money_order_max_order_total": "abc123",
+  "check_money_order_min_order_total": "abc123",
+  "check_money_order_new_order_status": "xyz789",
+  "check_money_order_payment_from_specific_countries": "abc123",
   "check_money_order_send_check_to": "xyz789",
-  "check_money_order_sort_order": 987,
+  "check_money_order_sort_order": 123,
   "check_money_order_title": "abc123",
-  "cms_home_page": "xyz789",
+  "cms_home_page": "abc123",
   "cms_no_cookies": "abc123",
-  "cms_no_route": "xyz789",
-  "code": "xyz789",
-  "configurable_thumbnail_source": "xyz789",
-  "contact_enabled": true,
-  "copyright": "abc123",
+  "cms_no_route": "abc123",
+  "code": "abc123",
+  "configurable_thumbnail_source": "abc123",
+  "contact_enabled": false,
+  "copyright": "xyz789",
   "countries_with_required_region": "abc123",
-  "create_account_confirmation": true,
-  "customer_access_token_lifetime": 987.65,
-  "default_country": "xyz789",
+  "create_account_confirmation": false,
+  "customer_access_token_lifetime": 123.45,
+  "default_country": "abc123",
   "default_description": "xyz789",
-  "default_display_currency_code": "abc123",
-  "default_keywords": "xyz789",
+  "default_display_currency_code": "xyz789",
+  "default_keywords": "abc123",
   "default_title": "xyz789",
-  "demonotice": 123,
-  "display_state_if_optional": true,
-  "enable_multiple_wishlists": "xyz789",
-  "front": "xyz789",
+  "demonotice": 987,
+  "display_state_if_optional": false,
+  "enable_multiple_wishlists": "abc123",
+  "front": "abc123",
   "grid_per_page": 123,
   "grid_per_page_values": "xyz789",
   "head_includes": "abc123",
-  "head_shortcut_icon": "xyz789",
+  "head_shortcut_icon": "abc123",
   "header_logo_src": "abc123",
-  "id": 987,
-  "is_default_store": true,
+  "id": 123,
+  "is_default_store": false,
   "is_default_store_group": true,
-  "is_guest_checkout_enabled": false,
+  "is_guest_checkout_enabled": true,
   "is_negotiable_quote_active": true,
   "is_one_page_checkout_enabled": false,
   "is_requisition_list_active": "xyz789",
@@ -88569,7 +88554,7 @@ 
    Example
    
   "list_per_page": 987,
   "list_per_page_values": "abc123",
   "locale": "xyz789",
-  "logo_alt": "abc123",
+  "logo_alt": "xyz789",
   "logo_height": 123,
   "logo_width": 123,
   "magento_reward_general_is_enabled": "xyz789",
@@ -88578,26 +88563,26 @@ 
    Example
    
   "magento_reward_general_publish_history": "xyz789",
   "magento_reward_points_invitation_customer": "abc123",
   "magento_reward_points_invitation_customer_limit": "abc123",
-  "magento_reward_points_invitation_order": "xyz789",
-  "magento_reward_points_invitation_order_limit": "abc123",
+  "magento_reward_points_invitation_order": "abc123",
+  "magento_reward_points_invitation_order_limit": "xyz789",
   "magento_reward_points_newsletter": "abc123",
-  "magento_reward_points_order": "xyz789",
-  "magento_reward_points_register": "xyz789",
+  "magento_reward_points_order": "abc123",
+  "magento_reward_points_register": "abc123",
   "magento_reward_points_review": "abc123",
-  "magento_reward_points_review_limit": "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": "abc123",
-  "minicart_display": true,
-  "minicart_max_items": 987,
+  "minicart_display": false,
+  "minicart_max_items": 123,
   "minimum_password_length": "xyz789",
   "newsletter_enabled": false,
   "no_route": "xyz789",
   "optional_zip_countries": "abc123",
   "order_cancellation_enabled": true,
   "order_cancellation_reasons": [CancellationReason],
-  "payment_payflowpro_cc_vault_active": "abc123",
-  "printed_card_price": "abc123",
+  "payment_payflowpro_cc_vault_active": "xyz789",
+  "printed_card_price": "xyz789",
   "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
   "product_reviews_enabled": "abc123",
   "product_url_suffix": "xyz789",
@@ -88607,43 +88592,43 @@ 
    Example
    
   "root_category_id": 123,
   "root_category_uid": "4",
   "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-  "sales_gift_wrapping": "abc123",
+  "sales_gift_wrapping": "xyz789",
   "sales_printed_card": "abc123",
-  "secure_base_link_url": "xyz789",
-  "secure_base_media_url": "xyz789",
-  "secure_base_static_url": "xyz789",
+  "secure_base_link_url": "abc123",
+  "secure_base_media_url": "abc123",
+  "secure_base_static_url": "abc123",
   "secure_base_url": "abc123",
   "send_friend": SendFriendConfiguration,
-  "shopping_cart_display_full_summary": false,
+  "shopping_cart_display_full_summary": true,
   "shopping_cart_display_grand_total": false,
-  "shopping_cart_display_price": 987,
+  "shopping_cart_display_price": 123,
   "shopping_cart_display_shipping": 123,
   "shopping_cart_display_subtotal": 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": "abc123",
   "store_name": "xyz789",
-  "store_sort_order": 987,
+  "store_sort_order": 123,
   "timezone": "xyz789",
-  "title_prefix": "xyz789",
+  "title_prefix": "abc123",
   "title_separator": "abc123",
-  "title_suffix": "abc123",
-  "use_store_in_url": false,
+  "title_suffix": "xyz789",
+  "use_store_in_url": true,
   "website_code": "4",
-  "website_id": 987,
+  "website_id": 123,
   "website_name": "abc123",
-  "weight_unit": "xyz789",
+  "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_from_specific_countries": "abc123",
+  "zero_subtotal_payment_action": "xyz789",
+  "zero_subtotal_payment_from_specific_countries": "xyz789",
   "zero_subtotal_sort_order": 123,
-  "zero_subtotal_title": "abc123"
+  "zero_subtotal_title": "xyz789"
 }
 
     
                   
@@ -88729,9 +88714,9 @@ 
    Example
    
                   
    {
   "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": false
+  "visible_on_catalog_pages": true
 }
 
     
                   
@@ -88919,7 +88904,7 @@ 
    Example
    
                   
                   
                   
    {
-  "type": "xyz789",
+  "type": "abc123",
   "value": "xyz789"
 }
 
     
@@ -89218,7 +89203,7 @@ 
    Example
    
                   
                   
    {
   "items_count": 123,
-  "label": "abc123",
+  "label": "xyz789",
   "swatch_data": SwatchData,
   "value_string": "abc123"
 }
@@ -89342,7 +89327,7 @@ 
    Example
    
                   
                   
                   
    {
-  "cartId": "abc123",
+  "cartId": "xyz789",
   "id": "xyz789"
 }
 
     
@@ -89410,8 +89395,8 @@ 
    Example
    
                   
                   
    {
   "amount": Money,
-  "rate": 123.45,
-  "title": "abc123"
+  "rate": 987.65,
+  "title": "xyz789"
 }
 
     
                   
@@ -89505,7 +89490,7 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"value": "xyz789"}
+                  
    {"value": "abc123"}
 
     
                   
                 
@@ -89572,7 +89557,7 @@ 
    Example
    
                   
    {
   "discount": ProductDiscount,
   "final_price": Money,
-  "quantity": 123.45
+  "quantity": 987.65
 }
 
     
                   
@@ -90019,7 +90004,7 @@ 
    Example
    
     GiftRegistryDynamicAttributeInput
   ],
   "event_name": "abc123",
-  "message": "abc123",
+  "message": "xyz789",
   "privacy_settings": "PRIVATE",
   "shipping_address": GiftRegistryShippingAddressInput,
   "status": "ACTIVE"
@@ -90095,7 +90080,7 @@ 
    Example
    
                   
                   
    {
   "gift_registry_item_uid": "4",
-  "note": "abc123",
+  "note": "xyz789",
   "quantity": 987.65
 }
 
     
@@ -90288,7 +90273,7 @@ 
    Example
    
   "email": "xyz789",
   "firstname": "xyz789",
   "gift_registry_registrant_uid": "4",
-  "lastname": "xyz789"
+  "lastname": "abc123"
 }
 
     
                   
@@ -90442,7 +90427,7 @@ 
    Example
    
                   
                   
    {
   "items": [NegotiableQuoteItemQuantityInput],
-  "quote_uid": 4
+  "quote_uid": "4"
 }
 
     
                   
@@ -90622,7 +90607,7 @@ 
    Example
    
   "description": "abc123",
   "name": "xyz789",
   "status": "ENABLED",
-  "uid": 4
+  "uid": "4"
 }
 
     
                   
@@ -90683,7 +90668,7 @@ 
    Example
    
                   
                   
                   
    {
-  "description": "abc123",
+  "description": "xyz789",
   "name": "xyz789"
 }
 
     
@@ -90769,8 +90754,8 @@ 
    Example
    
                   
    {
   "entered_options": [EnteredOptionInput],
   "item_id": 4,
-  "quantity": 987.65,
-  "selected_options": ["abc123"]
+  "quantity": 123.45,
+  "selected_options": ["xyz789"]
 }
 
     
                   
@@ -91554,9 +91539,9 @@ 
    Example
    
                   
                   
                   
    {
-  "payment_source": "xyz789",
-  "payments_order_id": "xyz789",
-  "paypal_order_id": "abc123",
+  "payment_source": "abc123",
+  "payments_order_id": "abc123",
+  "paypal_order_id": "xyz789",
   "public_hash": "abc123"
 }
 
     
@@ -91748,14 +91733,14 @@ 
    Example
    
   "customizable_options": [SelectedCustomizableOption],
   "discount": [Discount],
   "errors": [CartItemError],
-  "id": "abc123",
+  "id": "xyz789",
   "is_available": true,
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 987.65,
-  "uid": 4
+  "quantity": 123.45,
+  "uid": "4"
 }
 
     
                   
@@ -92612,42 +92597,42 @@ 
    Example
    
                   
    {
   "activity": "abc123",
   "attribute_set_id": 987,
-  "canonical_url": "xyz789",
+  "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "xyz789",
+  "category_gear": "abc123",
   "climate": "abc123",
-  "collar": "xyz789",
+  "collar": "abc123",
   "color": 123,
   "country_of_manufacture": "abc123",
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 123,
+  "eco_collection": 987,
   "erin_recommends": 123,
   "features_bags": "xyz789",
   "format": 987,
-  "gender": "abc123",
-  "gift_message_available": "xyz789",
+  "gender": "xyz789",
+  "gift_message_available": "abc123",
   "id": 987,
   "image": ProductImage,
-  "is_returnable": "abc123",
-  "manufacturer": 987,
+  "is_returnable": "xyz789",
+  "manufacturer": 123,
   "material": "abc123",
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
   "meta_description": "abc123",
-  "meta_keyword": "abc123",
-  "meta_title": "abc123",
-  "name": "abc123",
-  "new": 123,
-  "new_from_date": "xyz789",
+  "meta_keyword": "xyz789",
+  "meta_title": "xyz789",
+  "name": "xyz789",
+  "new": 987,
+  "new_from_date": "abc123",
   "new_to_date": "xyz789",
   "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
   "options_container": "abc123",
   "pattern": "xyz789",
-  "performance_fabric": 987,
+  "performance_fabric": 123,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
@@ -92656,22 +92641,22 @@ 
    Example
    
   "rating_summary": 987.65,
   "redirect_code": 987,
   "related_products": [ProductInterface],
-  "relative_url": "abc123",
+  "relative_url": "xyz789",
   "review_count": 123,
   "reviews": ProductReviews,
-  "sale": 123,
+  "sale": 987,
   "short_description": ComplexTextValue,
   "size": 987,
-  "sku": "abc123",
+  "sku": "xyz789",
   "sleeve": "xyz789",
   "small_image": ProductImage,
-  "special_from_date": "abc123",
+  "special_from_date": "xyz789",
   "special_price": 987.65,
-  "special_to_date": "xyz789",
-  "staged": false,
+  "special_to_date": "abc123",
+  "staged": true,
   "stock_status": "IN_STOCK",
   "strap_bags": "abc123",
-  "style_bags": "xyz789",
+  "style_bags": "abc123",
   "style_bottom": "abc123",
   "style_general": "xyz789",
   "swatch_image": "xyz789",
@@ -92680,13 +92665,13 @@ 
    Example
    
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
   "type_id": "xyz789",
-  "uid": "4",
+  "uid": 4,
   "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
   "url_key": "xyz789",
-  "url_path": "xyz789",
+  "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "xyz789",
+  "url_suffix": "abc123",
   "websites": [Website]
 }
 
     
@@ -92920,10 +92905,10 @@ 
    Example
    
                   
                   
                   
    {
-  "added_at": "abc123",
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
-  "id": "4",
+  "description": "abc123",
+  "id": 4,
   "product": ProductInterface,
   "quantity": 987.65
 }
@@ -93034,8 +93019,8 @@ 
    Example
    
   "default_group_id": "xyz789",
   "id": 123,
   "is_default": true,
-  "name": "abc123",
-  "sort_order": 123
+  "name": "xyz789",
+  "sort_order": 987
 }
 
     
                   
@@ -93280,13 +93265,13 @@ 
    Example
    
                   
                   
                   
    {
-  "id": 4,
+  "id": "4",
   "items": [WishlistItem],
-  "items_count": 987,
+  "items_count": 123,
   "items_v2": WishlistItems,
   "name": "abc123",
-  "sharing_code": "abc123",
-  "updated_at": "xyz789",
+  "sharing_code": "xyz789",
+  "updated_at": "abc123",
   "visibility": "PUBLIC"
 }
 
     
@@ -93365,7 +93350,7 @@ 
    Example
    
   "code": "PRODUCT_NOT_FOUND",
   "message": "xyz789",
   "wishlistId": "4",
-  "wishlistItemId": "4"
+  "wishlistItemId": 4
 }
 
     
                   
@@ -93510,11 +93495,11 @@ 
    Example
    
                   
                   
                   
    {
-  "added_at": "xyz789",
-  "description": "abc123",
-  "id": 987,
+  "added_at": "abc123",
+  "description": "xyz789",
+  "id": 123,
   "product": ProductInterface,
-  "qty": 123.45
+  "qty": 987.65
 }
 
     
                   
@@ -93574,7 +93559,10 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"quantity": 123.45, "wishlist_item_id": 4}
+                  
    {
+  "quantity": 987.65,
+  "wishlist_item_id": "4"
+}
 
     
                   
                 
@@ -93670,8 +93658,8 @@ 
    Example
    
   "entered_options": [EnteredOptionInput],
   "parent_sku": "xyz789",
   "quantity": 987.65,
-  "selected_options": [4],
-  "sku": "abc123"
+  "selected_options": ["4"],
+  "sku": "xyz789"
 }
 
     
                   
@@ -93828,9 +93816,9 @@ 
    Example
    
   "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
-  "id": "4",
+  "id": 4,
   "product": ProductInterface,
-  "quantity": 987.65
+  "quantity": 123.45
 }
 
     
                   
@@ -93890,7 +93878,10 @@ 
    Fields
    
                   
    Example
    
                   
                   
-                  
    {"quantity": 987.65, "wishlist_item_id": 4}
+                  
    {
+  "quantity": 123.45,
+  "wishlist_item_id": "4"
+}
 
     
                   
                 
@@ -93986,8 +93977,8 @@ 
    Example
    
   "description": "xyz789",
   "entered_options": [EnteredOptionInput],
   "quantity": 987.65,
-  "selected_options": [4],
-  "wishlist_item_id": 4
+  "selected_options": ["4"],
+  "wishlist_item_id": "4"
 }
 
     
                   
@@ -94141,7 +94132,7 @@ 
    Example
    
                   
    {
   "items": [WishlistItem],
   "items_count": 987,
-  "name": "abc123",
+  "name": "xyz789",
   "sharing_code": "xyz789",
   "updated_at": "abc123"
 }

From 957b9723639f5e223c3bcfa87363642282fc5397 Mon Sep 17 00:00:00 2001
From: jhadobe 
Date: Tue, 9 Apr 2024 14:30:32 -0500
Subject: [PATCH 5/6] Redoc intro

---
 src/openapi/admin-schema-2.4.7.yaml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/openapi/admin-schema-2.4.7.yaml b/src/openapi/admin-schema-2.4.7.yaml
index d5c6b35dd..dbd36c865 100644
--- a/src/openapi/admin-schema-2.4.7.yaml
+++ b/src/openapi/admin-schema-2.4.7.yaml
@@ -8,8 +8,8 @@ swagger: '2.0'
 info:
   version: 2.4.7
   title: Commerce Admin REST endpoints - All inclusive
-  description:
-    "$ref": "../_includes/redocly-intro.md"
+  description: 
+    $ref: https://raw.githubusercontent.com/AdobeDocs/commerce-webapi/main/src/_includes/redocly-intro.md
 host: example.com
 basePath: "/rest/default"
 schemes:

From 3dfd3651b0a0d45d2f43d230bce9c7dbae9b3c1d Mon Sep 17 00:00:00 2001
From: jhadobe 
Date: Tue, 9 Apr 2024 14:32:22 -0500
Subject: [PATCH 6/6] intros

---
 src/openapi/customer-schema-2.4.7.yaml | 4 ++--
 src/openapi/guest-schema-2.4.7.yaml    | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/openapi/customer-schema-2.4.7.yaml b/src/openapi/customer-schema-2.4.7.yaml
index cc3ba706c..43eba1f67 100644
--- a/src/openapi/customer-schema-2.4.7.yaml
+++ b/src/openapi/customer-schema-2.4.7.yaml
@@ -8,8 +8,8 @@ swagger: '2.0'
 info:
   version: 2.4.7
   title: Commerce Customer REST endpoints - All inclusive
-  description:
-    "$ref": "../_includes/redocly-intro.md"
+  description: 
+    $ref: https://raw.githubusercontent.com/AdobeDocs/commerce-webapi/main/src/_includes/redocly-intro.md
 host: example.com
 basePath: "/rest/default"
 schemes:
diff --git a/src/openapi/guest-schema-2.4.7.yaml b/src/openapi/guest-schema-2.4.7.yaml
index fc3b76c99..4bb156b1b 100644
--- a/src/openapi/guest-schema-2.4.7.yaml
+++ b/src/openapi/guest-schema-2.4.7.yaml
@@ -8,8 +8,8 @@ swagger: '2.0'
 info:
   version: 2.4.7
   title: Commerce Guest REST endpoints - All inclusive
-  description:
-    "$ref": "../_includes/redocly-intro.md"
+  description: 
+    $ref: https://raw.githubusercontent.com/AdobeDocs/commerce-webapi/main/src/_includes/redocly-intro.md
 host: example.com
 basePath: "/rest/default"
 schemes: