From 194d5412be095e6e56f712839c6212aed949769d Mon Sep 17 00:00:00 2001 From: Jared Hoover Date: Wed, 21 Jan 2026 11:00:44 -0600 Subject: [PATCH] Updating schemas for January Prod release --- spectaql/schema_saas.json | 2679 +++++++++++- src/openapi/accs-schema.yaml | 1061 +++-- static/graphql-api/saas/index.html | 6276 +++++++++++++++++++++------- 3 files changed, 7948 insertions(+), 2068 deletions(-) diff --git a/spectaql/schema_saas.json b/spectaql/schema_saas.json index c4cbc770e..8cab8d361 100644 --- a/spectaql/schema_saas.json +++ b/spectaql/schema_saas.json @@ -3202,6 +3202,18 @@ "name": "AttributeFile", "description": "", "fields": [ + { + "name": "attribute_type", + "description": "Attribute type code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "code", "description": "The attribute code.", @@ -3220,12 +3232,32 @@ }, { "name": "url", - "description": "File URL to download the file", + "description": "File URL to download the file.", "args": [], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "File code. For file download use `url` field.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } }, "isDeprecated": false, "deprecationReason": null @@ -3480,6 +3512,83 @@ ], "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "AttributeImage", + "description": "", + "fields": [ + { + "name": "attribute_type", + "description": "Attribute type code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The attribute code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "Image URL to download the image.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Image code. For image download use `url` field.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "AttributeInput", @@ -4017,6 +4126,18 @@ "name": "AttributeSelectedOptions", "description": "", "fields": [ + { + "name": "attribute_type", + "description": "Attribute type code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "code", "description": "The attribute code.", @@ -4172,6 +4293,18 @@ "name": "AttributeValue", "description": "", "fields": [ + { + "name": "attribute_type", + "description": "Attribute type code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "code", "description": "The attribute code.", @@ -4270,6 +4403,18 @@ "name": "AttributeValueInterface", "description": "", "fields": [ + { + "name": "attribute_type", + "description": "Attribute type code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "code", "description": "The attribute code.", @@ -4296,6 +4441,11 @@ "name": "AttributeFile", "ofType": null }, + { + "kind": "OBJECT", + "name": "AttributeImage", + "ofType": null + }, { "kind": "OBJECT", "name": "AttributeSelectedOptions", @@ -4636,6 +4786,16 @@ }, "defaultValue": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address to be used for billing.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, { "name": "same_as_shipping", "description": "Indicates whether to set the billing address to be the same as the existing shipping address on the cart.", @@ -4805,6 +4965,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "fax", "description": "The customer's fax number.", @@ -4842,8 +5014,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `customer_address_uid` instead." }, { "name": "lastname", @@ -4955,14 +5127,14 @@ }, { "name": "uid", - "description": "The unique id of the customer address.", + "description": "The unique id of the customer cart address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -8557,6 +8729,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "fax", "description": "The customer's fax number.", @@ -8594,8 +8778,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `customer_address_uid` instead." }, { "name": "lastname", @@ -8707,14 +8891,14 @@ }, { "name": "uid", - "description": "The unique id of the customer address.", + "description": "The unique id of the customer cart address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -10780,6 +10964,71 @@ } ] }, + { + "kind": "OBJECT", + "name": "CategoryNavigationView", + "description": null, + "fields": [ + { + "name": "slug", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "children", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryNavigationView", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CategoryViewV2", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "CategoryTree", @@ -11109,6 +11358,95 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "CategoryTreeView", + "description": null, + "fields": [ + { + "name": "slug", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "level", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parentSlug", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "childrenSlugs", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CategoryViewV2", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "CategoryView", @@ -11464,6 +11802,60 @@ } ] }, + { + "kind": "INTERFACE", + "name": "CategoryViewV2", + "description": null, + "fields": [ + { + "name": "slug", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "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": [ + { + "kind": "OBJECT", + "name": "CategoryNavigationView", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CategoryTreeView", + "ofType": null + } + ] + }, { "kind": "OBJECT", "name": "CheckoutAgreement", @@ -12369,6 +12761,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "status", + "description": "The current status of the company.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CompanyStatusEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "structure", "description": "The company structure of teams and customers in depth-first order.", @@ -12855,6 +13259,18 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "status", + "description": "The current status of the company.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CompanyStatusEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -12996,6 +13412,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "exceed_limit", + "description": "Indicates whether company credit functionality is allowed to exceed current company credit limit.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "outstanding_balance", "description": "The amount reimbursed, less the total due from all orders placed using the Payment on Account payment method. The amount can be a positive or negative value.", @@ -13823,16 +14255,12 @@ "name": "permissions", "description": "A list of resources the role can access.", "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null } }, "defaultValue": null @@ -13997,6 +14425,41 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "ENUM", + "name": "CompanyStatusEnum", + "description": "Defines the list of company status values.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PENDING", + "description": "Company is pending approval.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPROVED", + "description": "Company is approved.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REJECTED", + "description": "Company is rejected.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLOCKED", + "description": "Company is blocked.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "OBJECT", "name": "CompanyStructure", @@ -14157,13 +14620,9 @@ "description": "The unique ID for a `CompanyTeam` object.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "ID", + "ofType": null }, "isDeprecated": false, "deprecationReason": null @@ -14943,7 +15402,7 @@ }, { "name": "attributes", - "description": "A list of merchant-defined attributes designated for the storefront.", + "description": "A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names.", "args": [ { "name": "roles", @@ -14958,6 +15417,20 @@ } }, "defaultValue": null + }, + { + "name": "names", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null } ], "type": { @@ -15309,6 +15782,47 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "ConditionInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "field", + "description": null, + "type": { + "kind": "ENUM", + "name": "Field", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "operator", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "OperatorInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "enabled", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "ConfigurableAttributeOption", @@ -22559,6 +23073,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "id", + "description": "The unique ID assigned to the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "`id` is not needed as part of `Customer`, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side." + }, { "name": "is_subscribed", "description": "Indicates whether the customer is subscribed to the company's newsletter.", @@ -22840,6 +23370,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "quote_enabled", + "description": "Indicates whether negotiable quote functionality is enabled for the current customer. Global and company-level settings are factored into the result.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "requisition_lists", "description": "An object that contains the customer's requisition lists.", @@ -22873,6 +23419,16 @@ "ofType": null }, "defaultValue": null + }, + { + "name": "sort", + "description": "The field to use for sorting results.", + "type": { + "kind": "INPUT_OBJECT", + "name": "RequisitionListSortInput", + "ofType": null + }, + "defaultValue": null } ], "type": { @@ -23298,8 +23854,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." }, { "name": "lastname", @@ -23418,13 +23974,9 @@ "description": "The unique ID for a `CustomerAddress` object.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "ID", + "ofType": null }, "isDeprecated": false, "deprecationReason": null @@ -24738,6 +25290,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "negotiable_quote", + "description": "The negotiable quote associated with this order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "number", "description": "The order number.", @@ -27190,6 +27754,64 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "CustomOperatorInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "type", + "description": null, + "type": { + "kind": "ENUM", + "name": "CustomOperatorType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomOperatorType", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN_CUSTOMOPERATOR_TYPE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOM", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "SCALAR", "name": "DateTime", @@ -30532,6 +31154,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "three_ds_mode", + "description": "3DS mode", + "args": [], + "type": { + "kind": "ENUM", + "name": "ThreeDSMode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "title", "description": "The name displayed for the payment method", @@ -30587,6 +31221,65 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "ENUM", + "name": "Field", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN_FIELD", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATEGORY", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OUT_OF_STOCK", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOW_STOCK", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TYPE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VISIBILITY", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "OBJECT", "name": "FilterableInSearchAttribute", @@ -30770,6 +31463,80 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "FilterRuleInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "name", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "type", + "description": null, + "type": { + "kind": "ENUM", + "name": "FilterRuleType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "conditions", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ConditionInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FilterRuleType", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN_FILTER_RULE_TYPE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUSION", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXCLUSION", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "FilterStringTypeInput", @@ -35298,6 +36065,16 @@ "ofType": null }, "defaultValue": null + }, + { + "name": "customer_address_uid", + "description": "The unique ID assigned to this customer address.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null } ], "interfaces": null, @@ -36609,6 +37386,113 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "HistoryItemNoteData", + "description": "Item note data that is added to the negotiable quote history object.", + "fields": [ + { + "name": "created_at", + "description": "Datetime of the note added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "creator_name", + "description": "Name of the creator.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "creator_type", + "description": "Creator type: Buyer or Seller.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "item_id", + "description": "Id of the quote item for which the note has been added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "The note added by the creator for the item", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "Name of the quote item product for which note has been added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "HostedFieldsConfig", @@ -37906,6 +38790,60 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "IsOperatorInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "type", + "description": null, + "type": { + "kind": "ENUM", + "name": "IsOperatorType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "IsOperatorType", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN_ISOPERATOR_TYPE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IS", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "OBJECT", "name": "ItemNote", @@ -37935,6 +38873,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "creator_name", + "description": "Name of the creator.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "creator_type", "description": "Type of teh user who submitted a note.", @@ -38448,11 +39398,35 @@ "inputFields": null, "interfaces": null, "enumValues": [ + { + "name": "NEGOTIABLE_QUOTE_ATTACHMENT", + "description": "Negotiable quote comment file attachment", + "isDeprecated": false, + "deprecationReason": null + }, { "name": "CUSTOMER_ATTRIBUTE_FILE", "description": "Customer file resource type", "isDeprecated": false, "deprecationReason": null + }, + { + "name": "CUSTOMER_ATTRIBUTE_IMAGE", + "description": "Customer image resource type", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_ATTRIBUTE_ADDRESS_FILE", + "description": "Customer file resource type for customer address", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_ATTRIBUTE_ADDRESS_IMAGE", + "description": "Customer image resource type for customer address", + "isDeprecated": false, + "deprecationReason": null } ], "possibleTypes": null @@ -40546,6 +41520,33 @@ "name": "Boolean", "ofType": null }, + "isDeprecated": true, + "deprecationReason": "Use `deleteCustomerAddressV2` instead." + }, + { + "name": "deleteCustomerAddressV2", + "description": "Delete the billing or shipping address of a customer.", + "args": [ + { + "name": "uid", + "description": "The unique ID of the customer address to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, @@ -40876,6 +41877,47 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "exchangeOtpForCustomerToken", + "description": "Exchange a customer's one time password for a customer token.", + "args": [ + { + "name": "email", + "description": "The customer's email address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "otp", + "description": "The customer's OTP.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "finishUpload", "description": null, @@ -41295,6 +42337,33 @@ "name": "PlaceNegotiableQuoteOrderOutput", "ofType": null }, + "isDeprecated": true, + "deprecationReason": "Use placeNegotiableQuoteOrderV2 instead." + }, + { + "name": "placeNegotiableQuoteOrderV2", + "description": "Convert a negotiable quote into an order.", + "args": [ + { + "name": "input", + "description": "An input object that specifies the negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PlaceNegotiableQuoteOrderInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PlaceNegotiableQuoteOrderOutputV2", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, @@ -42663,6 +43732,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "setQuoteTemplateExpirationDate", + "description": "Set expiration date to a negotiable quote template.", + "args": [ + { + "name": "input", + "description": "An input object that defines the quote template expiration date.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "QuoteTemplateExpirationDateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "setQuoteTemplateLineItemNote", "description": "Add buyer's note to a negotiable quote template item.", @@ -43068,6 +44164,43 @@ "name": "CustomerAddress", "ofType": null }, + "isDeprecated": true, + "deprecationReason": "Use `updateCustomerAddressV2` instead." + }, + { + "name": "updateCustomerAddressV2", + "description": "Update the billing or shipping address of a customer or guest.", + "args": [ + { + "name": "uid", + "description": "The unique ID of the customer address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "An input object that contains changes to the customer address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAddress", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, @@ -43679,6 +44812,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "expiration_date", + "description": "The expiration period of the negotiable quote.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "history", "description": "A list of status and price changes for the negotiable quote.", @@ -43743,6 +44892,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "order", + "description": "The order created from the negotiable quote.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "prices", "description": "A set of subtotals and totals applied to the negotiable quote.", @@ -43755,6 +44916,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "sales_rep_name", + "description": "The first and last name of the sales representative.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "selected_payment_method", "description": "The payment method that was applied to the negotiable quote.", @@ -43803,6 +44980,30 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "template_name", + "description": "The title assigned to the negotiable quote template.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "total_quantity", "description": "The total number of items in the negotiable quote.", @@ -44170,6 +45371,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "fax", "description": "The fax number of the customer.", @@ -44308,7 +45521,7 @@ }, { "name": "uid", - "description": "The unique identifier of the address.", + "description": "The unique identifier of the negotiable quote address.", "args": [], "type": { "kind": "NON_NULL", @@ -44463,6 +45676,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "fax", "description": "The fax number of the customer.", @@ -44601,7 +45826,7 @@ }, { "name": "uid", - "description": "The unique identifier of the address.", + "description": "The unique identifier of the negotiable quote address.", "args": [], "type": { "kind": "NON_NULL", @@ -44695,6 +45920,26 @@ "name": "NegotiableQuoteComment", "description": "Contains a single plain text comment from either the buyer or seller.", "fields": [ + { + "name": "attachments", + "description": "Negotiable quote comment file attachments.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteCommentAttachment", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "author", "description": "The first and last name of the commenter.", @@ -44781,6 +46026,74 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteCommentAttachment", + "description": "Negotiable quote comment file attachment.", + "fields": [ + { + "name": "name", + "description": "Negotiable quote comment attachment file name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "Negotiable quote comment attachment file url.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteCommentAttachmentInput", + "description": "Negotiable quote comment file attachment.", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "Negotiable quote comment attachment file key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "ENUM", "name": "NegotiableQuoteCommentCreatorType", @@ -44810,6 +46123,20 @@ "description": "Contains the commend provided by the buyer.", "fields": null, "inputFields": [ + { + "name": "attachments", + "description": "Negotiable quote comment file attachments.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteCommentAttachmentInput", + "ofType": null + } + }, + "defaultValue": null + }, { "name": "comment", "description": "The comment provided by the buyer.", @@ -45086,6 +46413,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "item_note", + "description": "Item note data that is added to the negotiable quote history object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "HistoryItemNoteData", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "uid", "description": "The unique ID of a `NegotiableQuoteHistoryEntry` object.", @@ -45585,6 +46924,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "fax", "description": "The fax number of the customer.", @@ -45735,7 +47086,7 @@ }, { "name": "uid", - "description": "The unique identifier of the address.", + "description": "The unique identifier of the negotiable quote address.", "args": [], "type": { "kind": "NON_NULL", @@ -46059,6 +47410,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "created_at", + "description": "Timestamp indicating when the negotiable quote template was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "expiration_date", "description": "The expiration period of the negotiable quote template.", @@ -46091,6 +47458,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "historyV2", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryEntry", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "is_min_max_qty_used", "description": "Indicates whether the minimum and maximum quantity settings are used.", @@ -46231,6 +47614,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "sales_rep_name", + "description": "The first and last name of the sales representative.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "shipping_addresses", "description": "A list of shipping addresses applied to the negotiable quote template.", @@ -46298,6 +47697,38 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "Timestamp indicating when the negotiable quote template was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -46373,6 +47804,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "created_at", + "description": "Timestamp indicating when the negotiable quote template was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "expiration_date", "description": "The expiration period of the negotiable quote template.", @@ -46405,6 +47852,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "last_ordered_at", + "description": "Timestamp indicating when the last negotiable quote template order was placed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "last_shared_at", "description": "The date and time the negotiable quote template was last shared.", @@ -46501,6 +47964,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "prices", + "description": "A set of subtotals and totals applied to the negotiable quote template.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "sales_rep_name", "description": "The first and last name of the sales representative.", @@ -46580,6 +48055,278 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "Timestamp indicating when the negotiable quote template was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryChanges", + "description": "Contains a list of changes to a negotiable quote template.", + "fields": [ + { + "name": "comment_added", + "description": "The comment provided with a change in the negotiable quote history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryCommentChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_changes", + "description": "Lists log entries added by third-party extensions.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteCustomLogChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiration", + "description": "The expiration date of the negotiable quote before and after a change in the quote history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryExpirationChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products_removed", + "description": "Lists products that were removed as a result of a change in the quote history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryProductsRemovedChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "statuses", + "description": "The status before and after a change in the negotiable quote template history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryStatusesChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total", + "description": "The total amount of the negotiable quote before and after a change in the quote history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryTotalChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryEntry", + "description": "Contains details about a change for a negotiable quote template.", + "fields": [ + { + "name": "author", + "description": "The person who made a change in the status of the negotiable quote.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteUser", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "change_type", + "description": "An enum that specifies the reason for a status change in the negotiable quote history entry.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "NegotiableQuoteHistoryEntryChangeType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "changes", + "description": "The set of changes in the negotiable quote template.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryChanges", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the negotiable quote entry was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of a `NegotiableQuoteHistoryEntry` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryStatusChange", + "description": "Lists a new status change applied to a negotiable quote template and the previous status.", + "fields": [ + { + "name": "new_status", + "description": "The updated status.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "old_status", + "description": "The previous status. The value will be null for the first history entry in a negotiable quote.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryStatusesChange", + "description": "Contains a list of status changes that occurred for the negotiable quote template.", + "fields": [ + { + "name": "changes", + "description": "A list of status changes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryStatusChange", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -47041,6 +48788,56 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "NumericOperatorInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "type", + "description": null, + "type": { + "kind": "ENUM", + "name": "NumericOperatorType", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "NumericOperatorType", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN_NUMERIC_OPERATOR", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN_CURRENT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN_CURRENT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "OBJECT", "name": "OopePaymentMethodConfig", @@ -47113,6 +48910,67 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "OperatorInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "rangeOperator", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "RangeOperatorInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customOperator", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomOperatorInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "isOperator", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "IsOperatorInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "numericOperator", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "NumericOperatorInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "stringOperator", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "StringOperatorInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "Order", @@ -50218,9 +52076,36 @@ }, "isDeprecated": false, "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PlaceNegotiableQuoteOrderOutputV2", + "description": "An output object that returns the generated order.", + "fields": [ + { + "name": "errors", + "description": "An array of place negotiable quote order errors.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PlaceOrderError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null }, { - "name": "orderV2", + "name": "order", "description": "Full order information.", "args": [], "type": { @@ -52109,6 +53994,22 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "warnings", + "description": "An array of warning messages for validation issues (e.g., sort parameter ignored due to missing categoryPath)", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductSearchWarning", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -52155,6 +54056,49 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "ProductSearchWarning", + "description": "Structured warning with code and message for easier client handling", + "fields": [ + { + "name": "code", + "description": "Error code for programmatic handling (e.g., EMPTY_CATEGORY_PATH)", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "Human-readable message describing the warning", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "ENUM", "name": "ProductStockStatus", @@ -52298,7 +54242,7 @@ }, { "name": "attributes", - "description": "A list of merchant-defined attributes designated for the storefront.", + "description": "A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names.", "args": [ { "name": "roles", @@ -52313,6 +54257,20 @@ } }, "defaultValue": null + }, + { + "name": "names", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null } ], "type": { @@ -54845,16 +56803,12 @@ "description": "The approval flows for each applied rules.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PurchaseOrderRuleApprovalFlow", - "ofType": null - } + "kind": "OBJECT", + "name": "PurchaseOrderRuleApprovalFlow", + "ofType": null } }, "isDeprecated": false, @@ -56260,6 +58214,16 @@ }, "defaultValue": null }, + { + "name": "my_approvals", + "description": "Include purchase orders that are pending approval by the customer or eligible for their approval but have already been dealt with.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, { "name": "require_my_approval", "description": "Include only purchase orders that are waiting for the customer’s approval.", @@ -56563,6 +58527,96 @@ "isDeprecated": true, "deprecationReason": "This field is deprecated and will be removed." }, + { + "name": "navigation", + "description": null, + "args": [ + { + "name": "family", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryNavigationView", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categoryTree", + "description": null, + "args": [ + { + "name": "family", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "slugs", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "depth", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryTreeView", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "attributesForm", "description": "Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options.", @@ -57779,6 +59833,16 @@ } }, "defaultValue": null + }, + { + "name": "config", + "description": "Optional unit configuration", + "type": { + "kind": "INPUT_OBJECT", + "name": "UnitConfigInput", + "ofType": null + }, + "defaultValue": null } ], "type": { @@ -58079,13 +60143,27 @@ }, { "kind": "INPUT_OBJECT", - "name": "QuoteTemplateLineItemNoteInput", - "description": "Sets quote item note.", + "name": "QuoteTemplateExpirationDateInput", + "description": "Sets quote template expiration date.", "fields": null, "inputFields": [ { - "name": "item_id", - "description": "The unique ID of a `CartLineItem` object.", + "name": "expiration_date", + "description": "The expiration period of the negotiable quote template.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", "type": { "kind": "NON_NULL", "name": null, @@ -58096,6 +60174,37 @@ } }, "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "QuoteTemplateLineItemNoteInput", + "description": "Sets quote item note.", + "fields": null, + "inputFields": [ + { + "name": "item_id", + "description": "The unique ID of a `CartLineItem` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "item_uid", + "description": "The unique ID of a `CartLineItem` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null }, { "name": "note", @@ -58246,6 +60355,103 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "RangeOperatorInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "type", + "description": null, + "type": { + "kind": "ENUM", + "name": "RangeType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "RangeValueInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "RangeType", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN_RANGE_TYPE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STATIC", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PERCENTAGE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DYNAMIC", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RangeValueInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "from", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "to", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "ReCaptchaConfigOutput", @@ -58653,6 +60859,12 @@ "description": "", "isDeprecated": false, "deprecationReason": null + }, + { + "name": "RECAPTCHA_ENTERPRISE", + "description": "", + "isDeprecated": false, + "deprecationReason": null } ], "possibleTypes": null @@ -60314,6 +62526,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "sort_fields", + "description": "Contains the default sort field and all available sort fields.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SortFields", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "total_count", "description": "The number of returned requisition lists.", @@ -60332,6 +62556,64 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "ENUM", + "name": "RequisitionListSortableField", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NAME", + "description": "Sorts requisition lists by requisition list name.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sorts requisition lists by the date they were last updated.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RequisitionListSortInput", + "description": "Defines the field to use to sort a list of requisition lists.", + "fields": null, + "inputFields": [ + { + "name": "sort_direction", + "description": "Whether to return results in ascending or descending order.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sort_field", + "description": "The specified sort field.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "RequisitionListSortableField", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "RequistionListItems", @@ -64458,6 +66740,16 @@ }, "defaultValue": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address to be used for shipping.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, { "name": "customer_notes", "description": "Text provided by the shopper.", @@ -64584,6 +66876,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "customer_notes", "description": "Text provided by the shopper.", @@ -64633,8 +66937,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `customer_address_uid` instead." }, { "name": "lastname", @@ -64786,14 +67090,14 @@ }, { "name": "uid", - "description": "The unique id of the customer address.", + "description": "The unique id of the customer cart address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -65867,7 +68171,7 @@ }, { "name": "attributes", - "description": "A list of merchant-defined attributes designated for the storefront.", + "description": "A list of merchant-defined attributes designated for the storefront. They can be filtered by names and roles.", "args": [ { "name": "roles", @@ -65882,6 +68186,20 @@ } }, "defaultValue": null + }, + { + "name": "names", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null } ], "type": { @@ -66434,6 +68752,18 @@ "name": "SmartButtonsConfig", "description": "", "fields": [ + { + "name": "app_switch_when_available", + "description": "Indicated whether to use App Switch on enabled mobile devices", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "button_styles", "description": "The styles for the PayPal Smart Button configuration", @@ -67009,6 +69339,22 @@ "name": "StoreConfig", "description": "Contains information about a store's configuration.", "fields": [ + { + "name": "allow_company_registration", + "description": "Indicates if company registration is allowed", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "allow_gift_receipt", "description": "Indicates if the gift sender has the option to send a gift receipt. Possible values: 1 (Yes) and 0 (No).", @@ -67373,6 +69719,38 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "company_credit_enabled", + "description": "Indicates if company credit is enabled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company_enabled", + "description": "Indicates if B2B company functionality is enabled", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "configurable_product_image", "description": "checkout/cart/configurable_product_image: which image to use for configurable products.", @@ -68277,6 +70655,30 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "quote_minimum_amount", + "description": "Minimum order total for quote request.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quote_minimum_amount_message", + "description": "A message that will be shown in the cart when the subtotal (after discount) is lower than the minimum allowed amount.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "required_character_classes_number", "description": "The number of different character classes (lowercase, uppercase, digits, special characters) required in a password.", @@ -68810,12 +71212,76 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "StringOperatorInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "type", + "description": null, + "type": { + "kind": "ENUM", + "name": "StringOperatorType", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "StringOperatorType", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN_STRING_OPERATOR", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SAME_AS_CURRENT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALL_EXCEPT_CURRENT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "SubmitNegotiableQuoteTemplateForReviewInput", "description": "Specifies the quote template properties to update.", "fields": null, "inputFields": [ + { + "name": "attachments", + "description": "Negotiable quote template comment file attachments.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteCommentAttachmentInput", + "ofType": null + } + }, + "defaultValue": null + }, { "name": "comment", "description": "A comment for the seller to review.", @@ -69446,6 +71912,101 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "UnitConfigInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "unitName", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "storefrontLabel", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pagePlacement", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "displayNumber", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageType", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "unitStatus", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "typeId", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "filterRules", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FilterRuleInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "UpdateCartItemsInput", diff --git a/src/openapi/accs-schema.yaml b/src/openapi/accs-schema.yaml index 4536b6468..b6f7d1ded 100644 --- a/src/openapi/accs-schema.yaml +++ b/src/openapi/accs-schema.yaml @@ -6,11 +6,11 @@ securityDefinitions: in: header swagger: '2.0' info: - version: 'Production' + version: '1.0' title: Adobe Commerce SaaS - description: - $ref: https://raw.githubusercontent.com/AdobeDocs/commerce-webapi/refs/heads/main/src/_includes/accs-intro.md -host: https://.api.commerce.adobe.com/ + description: The schemas documented here are autogenerated from an instance of Adobe + Commerce as a Cloud Service. +host: https://.api.commerce.adobe.com/ basePath: "/" schemes: - https @@ -23,7 +23,6 @@ tags: - name: adobestock/asset/list - name: adobestock/asset/search - name: adobestock/search -- name: analytics/link - name: attributeMetadata/customer - name: attributeMetadata/customer/attribute/{attributeCode} - name: attributeMetadata/customer/custom @@ -51,6 +50,7 @@ tags: - name: carts/{cartId}/coupons - name: carts/{cartId}/coupons/{couponCode} - name: carts/{cartId}/coupons/deleteByCodes +- name: carts/{cartId}/customAttributes - name: carts/{cartId}/estimate-shipping-methods - name: carts/{cartId}/estimate-shipping-methods-by-address-id - name: carts/{cartId}/gift-message @@ -126,6 +126,7 @@ tags: - name: customerGroups/default/{id} - name: customerGroups/default/{storeId} - name: customerGroups/search +- name: customers - name: customers/{customerId} - name: customers/{customerId}/billingAddress - name: customers/{customerId}/carts @@ -141,6 +142,7 @@ tags: - name: customers/confirm - name: customers/search - name: customers/validate +- name: customerSegments/search - name: eav/attribute-sets - name: eav/attribute-sets/{attributeSetId} - name: eav/attribute-sets/list @@ -758,32 +760,6 @@ paths: schema: "$ref": "#/definitions/error-response" summary: adobestock/search - "/V1/analytics/link": - get: - tags: - - analytics/link - description: '' - operationId: GetV1AnalyticsLink - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/analytics-data-link-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: analytics/link "/V1/attributeMetadata/customer": get: tags: @@ -2111,6 +2087,54 @@ paths: schema: "$ref": "#/definitions/error-response" summary: carts/{cartId}/coupons/{couponCode} + "/V1/carts/{cartId}/customAttributes": + post: + tags: + - carts/{cartId}/customAttributes + description: Save custom attributes for quote by cart id + operationId: PostV1CartsCartIdCustomAttributes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1CartsCartIdCustomAttributesBody + in: body + schema: + required: + - customAttributes + properties: + customAttributes: + type: array + items: + "$ref": "#/definitions/framework-attribute-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/customAttributes "/V1/carts/{cartId}/estimate-shipping-methods": post: tags: @@ -6148,6 +6172,112 @@ paths: schema: "$ref": "#/definitions/error-response" summary: customerGroups/{id}/permissions + "/V1/customerSegments/search": + get: + tags: + - customerSegments/search + description: Retrieve customer segments that match a specified criteria. + operationId: GetV1CustomerSegmentsSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-segment-storefront-compatibility-data-customer-segment-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customerSegments/search + "/V1/customers": + post: + tags: + - customers + description: Create customer account. Perform necessary business operations + like sending email. + operationId: PostV1Customers + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersBody + in: body + schema: + required: + - customer + properties: + customer: + "$ref": "#/definitions/customer-data-customer-interface" + password: + type: string + redirectUrl: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-customer-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers "/V1/customers/addresses/{addressId}": get: tags: @@ -19040,7 +19170,7 @@ paths: schema: type: array items: - "$ref": "#/definitions/adobe-commerce-webhooks-core-saas-data-webhook-data-interface" + "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface" '401': description: 401 Unauthorized schema: @@ -19074,7 +19204,7 @@ paths: - webhook properties: webhook: - "$ref": "#/definitions/adobe-commerce-webhooks-core-saas-data-webhook-data-interface" + "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface" type: object xml: name: request @@ -19140,7 +19270,7 @@ paths: - webhook properties: webhook: - "$ref": "#/definitions/adobe-commerce-webhooks-core-saas-data-webhook-data-interface" + "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface" type: object xml: name: request @@ -19664,6 +19794,8 @@ definitions: type: array items: type: integer + uid: + type: string customer-data-group-search-results-interface: type: object description: Interface for customer groups search results. @@ -20216,12 +20348,10 @@ definitions: - label - description - workspace_configuration - adobe-commerce-webhooks-core-saas-data-webhook-data-interface: + adobe-commerce-webhooks-data-webhook-data-interface: type: object - description: Interface for webhook data from Core SaaS webapi requests + description: Interface for webhook data from webapi requests properties: - developer_console_oauth: - "$ref": "#/definitions/adobe-commerce-webhooks-core-saas-data-developer-console-oauth-interface" webhook_method: type: string description: Webhook method name @@ -20276,6 +20406,8 @@ definitions: description: Webhook headers items: "$ref": "#/definitions/adobe-commerce-webhooks-data-hook-header-interface" + developer_console_oauth: + "$ref": "#/definitions/adobe-commerce-webhooks-data-developer-console-oauth-interface" required: - webhook_method - webhook_type @@ -20293,27 +20425,6 @@ definitions: - fields - rules - headers - adobe-commerce-webhooks-core-saas-data-developer-console-oauth-interface: - type: object - description: Interface for Developer Console OAuth data from webapi requests. - properties: - client_id: - type: string - description: The Developer Console OAuth client ID. - client_secret: - type: string - description: The Developer Console OAuth client secret. - org_id: - type: string - description: The Developer Console OAuth org ID. - environment: - type: string - description: The Developer Console OAuth environment. - required: - - client_id - - client_secret - - org_id - - environment adobe-commerce-webhooks-data-hook-field-interface: type: object description: Interface for hook field data from webapi requests @@ -20357,6 +20468,27 @@ definitions: required: - name - value + adobe-commerce-webhooks-data-developer-console-oauth-interface: + type: object + description: Interface for Developer Console OAuth data from webapi requests. + properties: + client_id: + type: string + description: The Developer Console OAuth client ID. + client_secret: + type: string + description: The Developer Console OAuth client secret. + org_id: + type: string + description: The Developer Console OAuth org ID. + environment: + type: string + description: The Developer Console OAuth environment. + required: + - client_id + - client_secret + - org_id + - environment framework-search-search-result-interface: type: object description: Interface SearchResultInterface @@ -20540,8 +20672,6 @@ definitions: type: array items: "$ref": "#/definitions/catalog-data-category-link-interface" - stock_item: - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" discounts: type: array items: @@ -20550,6 +20680,8 @@ definitions: type: array items: "$ref": "#/definitions/bundle-data-option-interface" + stock_item: + "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" configurable_product_options: type: array items: @@ -20586,132 +20718,36 @@ definitions: catalog-data-category-link-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryLinkInterface - catalog-inventory-data-stock-item-interface: + sales-rule-data-rule-discount-interface: type: object - description: Interface StockItem + description: Rule discount Interface properties: - item_id: - type: integer - product_id: - type: integer - stock_id: + discount_data: + "$ref": "#/definitions/sales-rule-data-discount-data-interface" + rule_label: + type: string + description: Rule Label + rule_i_d: type: integer - description: Stock identifier - qty: + 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 - 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: + description: Amount + base_amount: type: number - description: Minimal quantity available for item status in stock - use_config_min_sale_qty: - type: integer - min_sale_qty: + description: Base Amount + original_amount: type: number - description: Minimum Qty Allowed in Shopping Cart or NULL when there is no - limitation - use_config_max_sale_qty: - type: boolean - max_sale_qty: - type: number - description: Maximum Qty Allowed in Shopping Cart data wrapper - use_config_backorders: - type: boolean - backorders: - type: integer - description: Backorders status - use_config_notify_stock_qty: - type: boolean - notify_stock_qty: - type: number - description: Notify for Quantity Below data wrapper - use_config_qty_increments: - type: boolean - qty_increments: - type: number - description: Quantity Increments data wrapper - use_config_enable_qty_inc: - type: boolean - enable_qty_increments: - type: boolean - description: Whether Quantity Increments is enabled - use_config_manage_stock: - type: boolean - manage_stock: - type: boolean - description: Can Manage Stock - low_stock_date: - type: string - is_decimal_divided: - type: boolean - stock_status_changed_auto: - type: integer - extension_attributes: - "$ref": "#/definitions/catalog-inventory-data-stock-item-extension-interface" - required: - - qty - - is_in_stock - - is_qty_decimal - - show_default_notification_message - - use_config_min_qty - - min_qty - - use_config_min_sale_qty - - min_sale_qty - - use_config_max_sale_qty - - max_sale_qty - - use_config_backorders - - backorders - - use_config_notify_stock_qty - - notify_stock_qty - - use_config_qty_increments - - qty_increments - - use_config_enable_qty_inc - - enable_qty_increments - - use_config_manage_stock - - manage_stock - - low_stock_date - - is_decimal_divided - - stock_status_changed_auto - catalog-inventory-data-stock-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockItemInterface - sales-rule-data-rule-discount-interface: - type: object - description: Rule discount Interface - properties: - discount_data: - "$ref": "#/definitions/sales-rule-data-discount-data-interface" - rule_label: - type: string - description: Rule Label - rule_i_d: - type: integer - description: Rule ID - required: - - discount_data - - rule_label - - rule_i_d - sales-rule-data-discount-data-interface: - type: object - description: Discount Data Interface - properties: - amount: - type: number - description: Amount - base_amount: - type: number - description: Base Amount - original_amount: - type: number - description: Original Amount - base_original_amount: + description: Original Amount + base_original_amount: type: number description: Base Original Amount required: @@ -20791,6 +20827,102 @@ definitions: bundle-data-option-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\OptionInterface + catalog-inventory-data-stock-item-interface: + type: object + description: Interface StockItem + properties: + item_id: + type: integer + product_id: + type: integer + stock_id: + type: integer + description: Stock identifier + qty: + type: number + is_in_stock: + type: boolean + description: Stock Availability + is_qty_decimal: + type: boolean + show_default_notification_message: + type: boolean + use_config_min_qty: + type: boolean + min_qty: + type: number + description: Minimal quantity available for item status in stock + use_config_min_sale_qty: + type: integer + min_sale_qty: + type: number + description: Minimum Qty Allowed in Shopping Cart or NULL when there is no + limitation + use_config_max_sale_qty: + type: boolean + max_sale_qty: + type: number + description: Maximum Qty Allowed in Shopping Cart data wrapper + use_config_backorders: + type: boolean + backorders: + type: integer + description: Backorders status + use_config_notify_stock_qty: + type: boolean + notify_stock_qty: + type: number + description: Notify for Quantity Below data wrapper + use_config_qty_increments: + type: boolean + qty_increments: + type: number + description: Quantity Increments data wrapper + use_config_enable_qty_inc: + type: boolean + enable_qty_increments: + type: boolean + description: Whether Quantity Increments is enabled + use_config_manage_stock: + type: boolean + manage_stock: + type: boolean + description: Can Manage Stock + low_stock_date: + type: string + is_decimal_divided: + type: boolean + stock_status_changed_auto: + type: integer + extension_attributes: + "$ref": "#/definitions/catalog-inventory-data-stock-item-extension-interface" + required: + - qty + - is_in_stock + - is_qty_decimal + - show_default_notification_message + - use_config_min_qty + - min_qty + - use_config_min_sale_qty + - min_sale_qty + - use_config_max_sale_qty + - max_sale_qty + - use_config_backorders + - backorders + - use_config_notify_stock_qty + - notify_stock_qty + - use_config_qty_increments + - qty_increments + - use_config_enable_qty_inc + - enable_qty_increments + - use_config_manage_stock + - manage_stock + - low_stock_date + - is_decimal_divided + - stock_status_changed_auto + catalog-inventory-data-stock-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockItemInterface configurable-product-data-option-interface: type: object description: Interface OptionInterface @@ -23176,129 +23308,20 @@ definitions: - base_original_price_incl_tax - negotiated_price_type - negotiated_price_value - catalog-inventory-data-stock-item-collection-interface: - type: object - description: Interface StockItemCollectionInterface - properties: - items: - type: array - description: Items - items: - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - search_criteria: - "$ref": "#/definitions/catalog-inventory-stock-item-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - catalog-inventory-stock-item-criteria-interface: - 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: + sales-data-order-interface: type: object - description: Interface CriteriaInterface + description: Order interface. An order is a document that a web store issues to + a customer. Magento generates a sales order that lists the product items, billing + and shipping addresses, and shipping and payment methods. A corresponding external + document, known as a purchase order, is emailed to the customer. properties: - mapper_interface_name: - type: string - description: Associated Mapper Interface name - criteria_list: - type: array - description: Criteria objects added to current Composite Criteria - items: - "$ref": "#/definitions/framework-criteria-interface" - filters: - type: array - description: List of filters - items: - type: string - orders: - type: array - description: Ordering criteria - items: - type: string - limit: - type: array - description: Limit - items: - type: string - required: - - mapper_interface_name - - criteria_list - - filters - - orders - - limit - catalog-inventory-data-stock-status-interface: - type: object - description: Interface StockStatusInterface - properties: - product_id: - type: integer - stock_id: - type: integer - qty: - type: integer - stock_status: - type: integer - stock_item: - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - extension_attributes: - "$ref": "#/definitions/catalog-inventory-data-stock-status-extension-interface" - required: - - product_id - - stock_id - - qty - - stock_status - - stock_item - catalog-inventory-data-stock-status-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockStatusInterface - sales-data-order-interface: - type: object - description: Order interface. An order is a document that a web store issues to - a customer. Magento generates a sales order that lists the product items, billing - and shipping addresses, and shipping and payment methods. A corresponding external - document, known as a purchase order, is emailed to the customer. - properties: - adjustment_negative: - type: number - description: Negative adjustment value. - adjustment_positive: - type: number - description: Positive adjustment value. - applied_rule_ids: + adjustment_negative: + type: number + description: Negative adjustment value. + adjustment_positive: + type: number + description: Positive adjustment value. + applied_rule_ids: type: string description: Applied rule IDs. base_adjustment_negative: @@ -26719,6 +26742,115 @@ definitions: bundle-data-option-type-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\OptionTypeInterface + catalog-inventory-data-stock-item-collection-interface: + type: object + description: Interface StockItemCollectionInterface + properties: + items: + type: array + description: Items + items: + "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" + search_criteria: + "$ref": "#/definitions/catalog-inventory-stock-item-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + catalog-inventory-stock-item-criteria-interface: + type: object + description: Interface StockItemCriteriaInterface + properties: + mapper_interface_name: + type: string + description: Associated Mapper Interface name + criteria_list: + type: array + description: Criteria objects added to current Composite Criteria + items: + "$ref": "#/definitions/framework-criteria-interface" + filters: + type: array + description: List of filters + items: + type: string + orders: + type: array + description: Ordering criteria + items: + type: string + limit: + type: array + description: Limit + items: + type: string + required: + - mapper_interface_name + - criteria_list + - filters + - orders + - limit + framework-criteria-interface: + type: object + description: Interface CriteriaInterface + properties: + mapper_interface_name: + type: string + description: Associated Mapper Interface name + criteria_list: + type: array + description: Criteria objects added to current Composite Criteria + items: + "$ref": "#/definitions/framework-criteria-interface" + filters: + type: array + description: List of filters + items: + type: string + orders: + type: array + description: Ordering criteria + items: + type: string + limit: + type: array + description: Limit + items: + type: string + required: + - mapper_interface_name + - criteria_list + - filters + - orders + - limit + catalog-inventory-data-stock-status-interface: + type: object + description: Interface StockStatusInterface + properties: + product_id: + type: integer + stock_id: + type: integer + qty: + type: integer + stock_status: + type: integer + stock_item: + "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" + extension_attributes: + "$ref": "#/definitions/catalog-inventory-data-stock-status-extension-interface" + required: + - product_id + - stock_id + - qty + - stock_status + - stock_item + catalog-inventory-data-stock-status-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockStatusInterface checkout-data-shipping-information-interface: type: object description: Interface ShippingInformationInterface @@ -27357,62 +27489,6 @@ definitions: checkout-agreements-data-agreement-extension-interface: type: object description: ExtensionInterface class for @see \Magento\CheckoutAgreements\Api\Data\AgreementInterface - adobe-assets-integration-data-video-item-interface: - type: object - description: Video item Interface. Dto to receive an import video asset. - properties: - sku: - type: string - description: Sku - asset_id: - type: string - description: Asset ID - roles: - type: array - description: Roles - items: - type: string - position: - type: integer - description: Position - url: - type: string - description: Video URL - video_thumbnail_url: - type: string - description: VideoThumbnailUrl - required: - - sku - - asset_id - - roles - - url - - video_thumbnail_url - adobe-assets-integration-data-image-item-interface: - type: object - description: Image item Interface. Dto to receive an import image asset. - properties: - sku: - type: string - description: Sku - asset_id: - type: string - description: Asset ID - roles: - type: array - description: Roles - items: - type: string - position: - type: integer - description: Position - url: - type: string - description: Image URL - required: - - sku - - asset_id - - roles - - url negotiable-quote-data-attachment-content-interface: type: object description: Attachment files content interface. @@ -27871,6 +27947,37 @@ definitions: required: - company_id - parent_id + gift-card-account-data-gift-card-account-interface: + type: object + description: Gift Card Account data + properties: + gift_cards: + type: array + description: Cards codes. + items: + type: string + gift_cards_amount: + type: number + description: Cards amount in quote currency. + base_gift_cards_amount: + type: number + description: Cards amount in base currency. + gift_cards_amount_used: + type: number + description: Cards amount used in quote currency. + base_gift_cards_amount_used: + type: number + description: Cards amount used in base currency. + extension_attributes: + "$ref": "#/definitions/gift-card-account-data-gift-card-account-extension-interface" + required: + - gift_cards_amount + - base_gift_cards_amount + - gift_cards_amount_used + - base_gift_cards_amount_used + gift-card-account-data-gift-card-account-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface shared-catalog-data-shared-catalog-interface: type: object description: SharedCatalogInterface interface. @@ -27929,48 +28036,62 @@ definitions: - items - search_criteria - total_count - analytics-data-link-interface: + adobe-assets-integration-data-video-item-interface: type: object - description: Represents link with collected data and initialized vector for decryption. + description: Video item Interface. Dto to receive an import video asset. properties: + sku: + type: string + description: Sku + asset_id: + type: string + description: Asset ID + roles: + type: array + description: Roles + items: + type: string + position: + type: integer + description: Position url: type: string - initialization_vector: + description: Video URL + video_thumbnail_url: type: string + description: VideoThumbnailUrl required: + - sku + - asset_id + - roles - url - - initialization_vector - gift-card-account-data-gift-card-account-interface: + - video_thumbnail_url + adobe-assets-integration-data-image-item-interface: type: object - description: Gift Card Account data + description: Image item Interface. Dto to receive an import image asset. properties: - gift_cards: + sku: + type: string + description: Sku + asset_id: + type: string + description: Asset ID + roles: type: array - description: Cards codes. + description: Roles items: type: string - gift_cards_amount: - type: number - description: Cards amount in quote currency. - base_gift_cards_amount: - type: number - description: Cards amount in base currency. - gift_cards_amount_used: - type: number - description: Cards amount used in quote currency. - base_gift_cards_amount_used: - type: number - description: Cards amount used in base currency. - extension_attributes: - "$ref": "#/definitions/gift-card-account-data-gift-card-account-extension-interface" + position: + type: integer + description: Position + url: + type: string + description: Image URL required: - - gift_cards_amount - - base_gift_cards_amount - - gift_cards_amount_used - - base_gift_cards_amount_used - gift-card-account-data-gift-card-account-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface + - sku + - asset_id + - roles + - url out-of-process-payment-methods-data-out-of-process-payment-method-interface: type: object description: '' @@ -28393,54 +28514,6 @@ definitions: required: - sku - qty - inventory-distance-based-source-selection-api-data-lat-lng-interface: - type: object - description: DTO for latitude and longitude request - properties: - lat: - type: number - description: Latitude - lng: - type: number - description: Longitude - required: - - lat - - lng - inventory-export-stock-api-data-export-stock-salable-qty-search-result-interface: - type: object - description: Interface for ExportStockSalableQtySearchResult - properties: - items: - type: array - items: - "$ref": "#/definitions/framework-extensible-data-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - inventory-export-stock-api-data-product-stock-index-data-interface: - type: object - description: Class ExportStockIndexDataResultInterface for result Inventory stock - index dump export - properties: - sku: - type: string - description: Product SKU - qty: - type: number - description: Product QTY - is_salable: - type: boolean - description: Product is salable flag - required: - - sku - - qty - - is_salable inventory-sales-api-data-is-product-salable-result-interface: type: object description: Represents "is product salable" result interface. @@ -28525,6 +28598,54 @@ definitions: inventory-sales-api-data-is-product-salable-for-requested-qty-result-extension-interface: type: object description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\IsProductSalableForRequestedQtyResultInterface + inventory-distance-based-source-selection-api-data-lat-lng-interface: + type: object + description: DTO for latitude and longitude request + properties: + lat: + type: number + description: Latitude + lng: + type: number + description: Longitude + required: + - lat + - lng + inventory-export-stock-api-data-export-stock-salable-qty-search-result-interface: + type: object + description: Interface for ExportStockSalableQtySearchResult + properties: + items: + type: array + items: + "$ref": "#/definitions/framework-extensible-data-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + inventory-export-stock-api-data-product-stock-index-data-interface: + type: object + description: Class ExportStockIndexDataResultInterface for result Inventory stock + index dump export + properties: + sku: + type: string + description: Product SKU + qty: + type: number + description: Product QTY + is_salable: + type: boolean + description: Product is salable flag + required: + - sku + - qty + - is_salable inventory-source-selection-api-data-source-selection-algorithm-interface: type: object description: Data Interface representing particular Source Selection Algorithm @@ -28967,15 +29088,9 @@ definitions: type: type: string description: A subscription type, (logs, metrics) - destination: - type: string - description: A destination for the subscription destination_endpoint: type: string description: A destination endpoint for the subscription - destination_api_key: - type: string - description: Subscription destination api key component: type: array description: The component type for the subscription (eq. "event", "webhook", @@ -28999,9 +29114,7 @@ definitions: items: type: string required: - - destination - destination_endpoint - - destination_api_key - component - headers - service_name @@ -29086,11 +29199,15 @@ definitions: description: list of store codes items: type: string + credit_memo_tax_enabled: + type: boolean + description: If credit memo tax calculation is enabled required: - code - title - active - stores + - credit_memo_tax_enabled rma-data-track-interface: type: object description: Interface TrackInterface @@ -29405,6 +29522,56 @@ definitions: description: The supported webhook name required: - name + customer-segment-storefront-compatibility-data-customer-segment-search-results-interface: + type: object + description: '' + properties: + items: + type: array + description: Customer segments list. + items: + "$ref": "#/definitions/customer-segment-storefront-compatibility-data-customer-segment-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + customer-segment-storefront-compatibility-data-customer-segment-interface: + type: object + description: '' + properties: + id: + type: integer + description: Segment ID. + uid: + type: string + description: Segment UID. + name: + type: string + description: Segment name. + description: + type: string + description: Segment description. + is_active: + type: integer + description: Segment active status. + apply_to: + type: integer + description: Apply-to value. + number_of_customers: + type: integer + description: Number of customers the segment applies to. + associated_websites: + type: array + description: Associated websites for the segments + items: + "$ref": "#/definitions/store-data-website-interface" + required: + - associated_websites x-tagGroups: - name: addresses tags: @@ -29422,9 +29589,6 @@ x-tagGroups: - adobestock/asset/search - adobestock/asset/{id} - adobestock/search -- name: analytics - tags: - - analytics/link - name: attributeMetadata tags: - attributeMetadata/customer @@ -29463,6 +29627,7 @@ x-tagGroups: - carts/{cartId}/coupons - carts/{cartId}/coupons/deleteByCodes - carts/{cartId}/coupons/{couponCode} + - carts/{cartId}/customAttributes - carts/{cartId}/estimate-shipping-methods - carts/{cartId}/estimate-shipping-methods-by-address-id - carts/{cartId}/gift-message @@ -29551,8 +29716,12 @@ x-tagGroups: - customerGroups/search - customerGroups/{id} - customerGroups/{id}/permissions +- name: customerSegments + tags: + - customerSegments/search - name: customers tags: + - customers - customers/addresses/{addressId} - customers/companies - customers/confirm diff --git a/static/graphql-api/saas/index.html b/static/graphql-api/saas/index.html index 5686fa2ab..c209fc351 100644 --- a/static/graphql-api/saas/index.html +++ b/static/graphql-api/saas/index.html @@ -6,7 +6,7 @@ GraphQL API - +
@@ -44,6 +44,7 @@
  • availableStores
  • cart
  • categories
    • +
  • categoryTree
  • checkoutAgreements
  • company
  • compareList
    • @@ -74,6 +75,7 @@
  • isCompanyRoleNameAvailable
  • isCompanyUserEmailAvailable
  • isEmailAvailable
    • +
  • navigation
  • negotiableQuote
  • negotiableQuoteTemplate
  • negotiableQuoteTemplates
    • @@ -153,6 +155,7 @@
  • deleteCompareList
  • deleteCustomer
  • deleteCustomerAddress
    • +
  • deleteCustomerAddressV2
  • deleteNegotiableQuoteTemplate
  • deleteNegotiableQuotes
  • deletePaymentToken
    • @@ -164,6 +167,7 @@
  • estimateShippingMethods
  • estimateTotals
  • exchangeExternalCustomerToken
    • +
  • exchangeOtpForCustomerToken
  • finishUpload
  • generateCustomerToken
  • generateCustomerTokenAsAdmin
    • @@ -176,6 +180,7 @@
  • moveProductsBetweenWishlists
  • openNegotiableQuoteTemplate
  • placeNegotiableQuoteOrder
    • +
  • placeNegotiableQuoteOrderV2
  • placeOrder
  • placeOrderForPurchaseOrder
  • placePurchaseOrder
    • @@ -226,6 +231,7 @@
  • setNegotiableQuoteShippingMethods
  • setNegotiableQuoteTemplateShippingAddress
  • setPaymentMethodOnCart
    • +
  • setQuoteTemplateExpirationDate
  • setQuoteTemplateLineItemNote
  • setShippingAddressesOnCart
  • setShippingMethodsOnCart
    • @@ -240,6 +246,7 @@
  • updateCompanyTeam
  • updateCompanyUser
  • updateCustomerAddress
    • +
  • updateCustomerAddressV2
  • updateCustomerEmail
  • updateCustomerV2
  • updateGiftRegistry
    • @@ -310,6 +317,7 @@

    Types

  • AttributeFile
  • AttributeFilterInput
  • AttributeFrontendInputEnum
    • +
  • AttributeImage
  • AttributeInput
  • AttributeInputSelectedOption
  • AttributeMetadata
    • @@ -382,9 +390,12 @@

    Types

  • CategoryBucket
  • CategoryBucketInterface
  • CategoryInterface
    • +
  • CategoryNavigationView
  • CategoryTree
    • +
  • CategoryTreeView
  • CategoryView
  • CategoryViewInterface
    • +
  • CategoryViewV2
  • CheckoutAgreement
  • CheckoutAgreementMode
  • CheckoutUserInputError
    • @@ -422,6 +433,7 @@

    Types

  • CompanyRoleUpdateInput
  • CompanyRoles
  • CompanySalesRepresentative
    • +
  • CompanyStatusEnum
  • CompanyStructure
  • CompanyStructureEntity
  • CompanyStructureItem
    • @@ -441,6 +453,7 @@

    Types

  • CompleteOrderInput
  • ComplexProductView
  • ComplexTextValue
    • +
  • ConditionInput
  • ConfigurableAttributeOption
  • ConfigurableCartItem
  • ConfigurableOptionAvailableForSelection
    • @@ -500,6 +513,8 @@

    Types

  • CustomAttributeMetadataInterface
  • CustomAttributeOptionInterface
  • CustomConfigKeyValue
    • +
  • CustomOperatorInput
    • +
  • CustomOperatorType
  • Customer
  • CustomerAddress
  • CustomerAddressAttribute
    • @@ -591,10 +606,13 @@

    Types

  • ExchangeRate
  • FastlaneConfig
  • FastlaneMethodInput
    • +
  • Field
  • FilterEqualTypeInput
  • FilterMatchTypeEnum
  • FilterMatchTypeInput
  • FilterRangeTypeInput
    • +
  • FilterRuleInput
    • +
  • FilterRuleType
  • FilterStringTypeInput
  • FilterTypeInput
  • FilterableInSearchAttribute
    • @@ -654,6 +672,7 @@

    Types

  • GuestOrderCancelInput
  • GuestOrderInformationInput
  • Highlight
    • +
  • HistoryItemNoteData
  • HostedFieldsConfig
  • HostedFieldsInput
  • ID
    • @@ -674,6 +693,8 @@

    Types

  • IsCompanyRoleNameAvailableOutput
  • IsCompanyUserEmailAvailableOutput
  • IsEmailAvailableOutput
    • +
  • IsOperatorInput
    • +
  • IsOperatorType
  • ItemNote
  • ItemSelectedBundleOption
  • ItemSelectedBundleOptionValue
    • @@ -699,6 +720,8 @@

    Types

  • NegotiableQuoteBillingAddress
  • NegotiableQuoteBillingAddressInput
  • NegotiableQuoteComment
    • +
  • NegotiableQuoteCommentAttachment
    • +
  • NegotiableQuoteCommentAttachmentInput
  • NegotiableQuoteCommentCreatorType
  • NegotiableQuoteCommentInput
  • NegotiableQuoteCustomLogChange
    • @@ -724,6 +747,10 @@

    Types

  • NegotiableQuoteTemplate
  • NegotiableQuoteTemplateFilterInput
  • NegotiableQuoteTemplateGridItem
    • +
  • NegotiableQuoteTemplateHistoryChanges
    • +
  • NegotiableQuoteTemplateHistoryEntry
    • +
  • NegotiableQuoteTemplateHistoryStatusChange
    • +
  • NegotiableQuoteTemplateHistoryStatusesChange
  • NegotiableQuoteTemplateItemQuantityInput
  • NegotiableQuoteTemplateReferenceDocumentLinkInput
  • NegotiableQuoteTemplateShippingAddressInput
    • @@ -735,8 +762,11 @@

    Types

  • NegotiableQuoteUser
  • NegotiableQuotesOutput
  • NoSuchEntityUidError
    • +
  • NumericOperatorInput
    • +
  • NumericOperatorType
  • OopePaymentMethodConfig
  • OpenNegotiableQuoteTemplateInput
    • +
  • OperatorInput
  • Order
  • OrderActionType
  • OrderAddress
    • @@ -769,6 +799,7 @@

    Types

  • PickupLocations
  • PlaceNegotiableQuoteOrderInput
  • PlaceNegotiableQuoteOrderOutput
    • +
  • PlaceNegotiableQuoteOrderOutputV2
  • PlaceOrderError
  • PlaceOrderErrorCodes
  • PlaceOrderForPurchaseOrderInput
    • @@ -799,6 +830,7 @@

    Types

  • ProductSearchItem
  • ProductSearchResponse
  • ProductSearchSortInput
    • +
  • ProductSearchWarning
  • ProductStockStatus
  • ProductVideo
  • ProductView
    • @@ -851,9 +883,13 @@

    Types

  • PurchaseOrdersFilterInput
  • QueryContextInput
  • QuoteItemsSortInput
    • +
  • QuoteTemplateExpirationDateInput
  • QuoteTemplateLineItemNoteInput
  • QuoteTemplateNotificationMessage
  • RangeBucket
    • +
  • RangeOperatorInput
    • +
  • RangeType
    • +
  • RangeValueInput
  • ReCaptchaConfigOutput
  • ReCaptchaConfiguration
  • ReCaptchaConfigurationV3
    • @@ -896,6 +932,8 @@

    Types

  • RequisitionListFilterInput
  • RequisitionListItemInterface
  • RequisitionListItemsInput
    • +
  • RequisitionListSortInput
    • +
  • RequisitionListSortableField
  • RequisitionLists
  • RequistionListItems
  • Return
    • @@ -992,6 +1030,8 @@

    Types

  • StatsBucket
  • StoreConfig
  • String
    • +
  • StringOperatorInput
    • +
  • StringOperatorType
  • SubmitNegotiableQuoteTemplateForReviewInput
  • SubscribeEmailToNewsletterOutput
  • SubscriptionStatusesEnum
    • @@ -1005,6 +1045,7 @@

    Types

  • TextSwatchData
  • ThreeDSMode
  • TierPrice
    • +
  • UnitConfigInput
  • UpdateCartItemsInput
  • UpdateCartItemsOutput
  • UpdateCompanyOutput
    • @@ -1210,7 +1251,7 @@
    Query
    Variables
    - 
    {"formCode": "xyz789"}
+                  
    {"formCode": "abc123"}
    @@ -1371,6 +1412,7 @@

    Example

    Query
    query availableStores($useCurrentGroup: Boolean) {
   availableStores(useCurrentGroup: $useCurrentGroup) {
+    allow_company_registration
     allow_gift_receipt
     allow_gift_wrapping_on_order
     allow_gift_wrapping_on_order_items
@@ -1401,6 +1443,8 @@ 
    Query
    
     check_money_order_send_check_to
     check_money_order_sort_order
     check_money_order_title
+    company_credit_enabled
+    company_enabled
     configurable_product_image
     configurable_thumbnail_source
     contact_enabled
@@ -1472,6 +1516,8 @@ 
    Query
    
     product_fixed_product_tax_display_setting
     product_url_suffix
     quickorder_active
+    quote_minimum_amount
+    quote_minimum_amount_message
     required_character_classes_number
     returns_enabled
     root_category_uid
@@ -1524,142 +1570,147 @@ 
    Response
    
   "data": {
     "availableStores": [
       {
+        "allow_company_registration": false,
         "allow_gift_receipt": "abc123",
         "allow_gift_wrapping_on_order": "abc123",
         "allow_gift_wrapping_on_order_items": "xyz789",
-        "allow_items": "abc123",
+        "allow_items": "xyz789",
         "allow_order": "xyz789",
         "allow_printed_card": "abc123",
-        "autocomplete_on_storefront": true,
+        "autocomplete_on_storefront": false,
         "base_currency_code": "abc123",
         "base_link_url": "abc123",
-        "base_media_url": "xyz789",
+        "base_media_url": "abc123",
         "base_static_url": "xyz789",
         "base_url": "abc123",
         "cart_expires_in_days": 123,
-        "cart_gift_wrapping": "abc123",
+        "cart_gift_wrapping": "xyz789",
         "cart_merge_preference": "xyz789",
-        "cart_printed_card": "abc123",
+        "cart_printed_card": "xyz789",
         "cart_summary_display_quantity": 123,
-        "catalog_default_sort_by": "xyz789",
+        "catalog_default_sort_by": "abc123",
         "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
         "category_url_suffix": "abc123",
-        "check_money_order_enable_for_specific_countries": false,
+        "check_money_order_enable_for_specific_countries": true,
         "check_money_order_enabled": true,
         "check_money_order_make_check_payable_to": "xyz789",
         "check_money_order_max_order_total": "xyz789",
-        "check_money_order_min_order_total": "xyz789",
-        "check_money_order_new_order_status": "xyz789",
-        "check_money_order_payment_from_specific_countries": "abc123",
-        "check_money_order_send_check_to": "xyz789",
-        "check_money_order_sort_order": 123,
-        "check_money_order_title": "xyz789",
+        "check_money_order_min_order_total": "abc123",
+        "check_money_order_new_order_status": "abc123",
+        "check_money_order_payment_from_specific_countries": "xyz789",
+        "check_money_order_send_check_to": "abc123",
+        "check_money_order_sort_order": 987,
+        "check_money_order_title": "abc123",
+        "company_credit_enabled": true,
+        "company_enabled": true,
         "configurable_product_image": "ITSELF",
-        "configurable_thumbnail_source": "xyz789",
+        "configurable_thumbnail_source": "abc123",
         "contact_enabled": true,
         "countries_with_required_region": "abc123",
-        "create_account_confirmation": false,
-        "customer_access_token_lifetime": 123.45,
+        "create_account_confirmation": true,
+        "customer_access_token_lifetime": 987.65,
         "default_country": "abc123",
         "default_display_currency_code": "xyz789",
-        "display_product_prices_in_catalog": 987,
-        "display_shipping_prices": 123,
-        "display_state_if_optional": false,
-        "enable_multiple_wishlists": "abc123",
-        "fixed_product_taxes_apply_tax_to_fpt": true,
-        "fixed_product_taxes_display_prices_in_emails": 123,
-        "fixed_product_taxes_display_prices_in_product_lists": 987,
-        "fixed_product_taxes_display_prices_in_sales_modules": 123,
+        "display_product_prices_in_catalog": 123,
+        "display_shipping_prices": 987,
+        "display_state_if_optional": true,
+        "enable_multiple_wishlists": "xyz789",
+        "fixed_product_taxes_apply_tax_to_fpt": false,
+        "fixed_product_taxes_display_prices_in_emails": 987,
+        "fixed_product_taxes_display_prices_in_product_lists": 123,
+        "fixed_product_taxes_display_prices_in_sales_modules": 987,
         "fixed_product_taxes_display_prices_on_product_view_page": 123,
         "fixed_product_taxes_enable": false,
         "fixed_product_taxes_include_fpt_in_subtotal": false,
-        "graphql_share_customer_group": false,
-        "grid_per_page": 123,
+        "graphql_share_customer_group": true,
+        "grid_per_page": 987,
         "grid_per_page_values": "abc123",
         "grouped_product_image": "ITSELF",
-        "is_checkout_agreements_enabled": true,
-        "is_default_store": true,
-        "is_default_store_group": true,
+        "is_checkout_agreements_enabled": false,
+        "is_default_store": false,
+        "is_default_store_group": false,
         "is_guest_checkout_enabled": true,
-        "is_negotiable_quote_active": true,
+        "is_negotiable_quote_active": false,
         "is_one_page_checkout_enabled": false,
-        "is_requisition_list_active": "abc123",
+        "is_requisition_list_active": "xyz789",
         "list_mode": "xyz789",
         "list_per_page": 123,
         "list_per_page_values": "xyz789",
         "locale": "xyz789",
-        "magento_reward_general_is_enabled": "abc123",
+        "magento_reward_general_is_enabled": "xyz789",
         "magento_reward_general_is_enabled_on_front": "xyz789",
-        "magento_reward_general_min_points_balance": "abc123",
-        "magento_reward_general_publish_history": "abc123",
-        "magento_reward_points_invitation_customer": "abc123",
-        "magento_reward_points_invitation_customer_limit": "xyz789",
+        "magento_reward_general_min_points_balance": "xyz789",
+        "magento_reward_general_publish_history": "xyz789",
+        "magento_reward_points_invitation_customer": "xyz789",
+        "magento_reward_points_invitation_customer_limit": "abc123",
         "magento_reward_points_invitation_order": "abc123",
         "magento_reward_points_invitation_order_limit": "xyz789",
         "magento_reward_points_newsletter": "abc123",
-        "magento_reward_points_order": "abc123",
-        "magento_reward_points_register": "xyz789",
-        "magento_reward_points_review": "xyz789",
-        "magento_reward_points_review_limit": "abc123",
+        "magento_reward_points_order": "xyz789",
+        "magento_reward_points_register": "abc123",
+        "magento_reward_points_review": "abc123",
+        "magento_reward_points_review_limit": "xyz789",
         "magento_wishlist_general_is_enabled": "abc123",
         "max_items_in_order_summary": 123,
-        "maximum_number_of_wishlists": "xyz789",
+        "maximum_number_of_wishlists": "abc123",
         "minicart_display": false,
-        "minicart_max_items": 123,
+        "minicart_max_items": 987,
         "minimum_password_length": "abc123",
-        "newsletter_enabled": false,
+        "newsletter_enabled": true,
         "optional_zip_countries": "xyz789",
         "order_cancellation_enabled": true,
         "order_cancellation_reasons": [
           CancellationReason
         ],
-        "orders_invoices_credit_memos_display_full_summary": true,
-        "orders_invoices_credit_memos_display_grandtotal": false,
-        "orders_invoices_credit_memos_display_price": 987,
-        "orders_invoices_credit_memos_display_shipping_amount": 987,
-        "orders_invoices_credit_memos_display_subtotal": 123,
-        "orders_invoices_credit_memos_display_zero_tax": false,
+        "orders_invoices_credit_memos_display_full_summary": false,
+        "orders_invoices_credit_memos_display_grandtotal": true,
+        "orders_invoices_credit_memos_display_price": 123,
+        "orders_invoices_credit_memos_display_shipping_amount": 123,
+        "orders_invoices_credit_memos_display_subtotal": 987,
+        "orders_invoices_credit_memos_display_zero_tax": true,
         "printed_card_priceV2": Money,
         "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
         "product_url_suffix": "abc123",
-        "quickorder_active": false,
-        "required_character_classes_number": "abc123",
+        "quickorder_active": true,
+        "quote_minimum_amount": 987.65,
+        "quote_minimum_amount_message": "xyz789",
+        "required_character_classes_number": "xyz789",
         "returns_enabled": "xyz789",
-        "root_category_uid": 4,
+        "root_category_uid": "4",
         "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-        "sales_gift_wrapping": "abc123",
-        "sales_printed_card": "xyz789",
+        "sales_gift_wrapping": "xyz789",
+        "sales_printed_card": "abc123",
         "secure_base_link_url": "abc123",
         "secure_base_media_url": "xyz789",
-        "secure_base_static_url": "xyz789",
-        "secure_base_url": "abc123",
+        "secure_base_static_url": "abc123",
+        "secure_base_url": "xyz789",
         "share_active_segments": false,
-        "share_applied_cart_rule": false,
-        "shopping_cart_display_full_summary": true,
+        "share_applied_cart_rule": true,
+        "shopping_cart_display_full_summary": false,
         "shopping_cart_display_grand_total": true,
-        "shopping_cart_display_price": 987,
+        "shopping_cart_display_price": 123,
         "shopping_cart_display_shipping": 987,
         "shopping_cart_display_subtotal": 987,
         "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
-        "shopping_cart_display_zero_tax": false,
+        "shopping_cart_display_zero_tax": true,
         "store_code": 4,
         "store_group_code": "4",
         "store_group_name": "xyz789",
-        "store_name": "abc123",
+        "store_name": "xyz789",
         "store_sort_order": 123,
         "timezone": "xyz789",
         "title_separator": "xyz789",
-        "use_store_in_url": true,
-        "website_code": "4",
+        "use_store_in_url": false,
+        "website_code": 4,
         "website_name": "abc123",
         "weight_unit": "abc123",
         "zero_subtotal_enable_for_specific_countries": false,
-        "zero_subtotal_enabled": true,
+        "zero_subtotal_enabled": false,
         "zero_subtotal_new_order_status": "abc123",
-        "zero_subtotal_payment_action": "xyz789",
+        "zero_subtotal_payment_action": "abc123",
         "zero_subtotal_payment_from_specific_countries": "abc123",
-        "zero_subtotal_sort_order": 123,
-        "zero_subtotal_title": "abc123"
+        "zero_subtotal_sort_order": 987,
+        "zero_subtotal_title": "xyz789"
       }
     ]
   }
@@ -1775,7 +1826,7 @@ 
    Query
    Variables
    - 
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}
    @@ -1793,7 +1844,7 @@
    Response
    ], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, @@ -1805,7 +1856,7 @@
    Response
    "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -1918,22 +1969,124 @@
    Response
    "categories": [ { "availableSortBy": ["abc123"], - "children": ["xyz789"], + "children": ["abc123"], "defaultSortBy": "xyz789", "id": 4, - "level": 987, + "level": 123, "name": "xyz789", "parentId": "xyz789", - "path": "xyz789", - "roles": ["abc123"], + "path": "abc123", + "roles": ["xyz789"], "urlKey": "abc123", "urlPath": "xyz789", - "count": 123, + "count": 987, "title": "xyz789" } ] } } +     +
    + + back to top + + +
    +
    + Queries +
    +

    + categoryTree +

    +
    +
    +
    +
    Response
    +

    Returns [CategoryTreeView] +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + + + + + + + + + +
    NameDescription
    + family - String! + +
    + slugs - [String!] + +
    + depth - Int + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    query categoryTree(
+  $family: String!,
+  $slugs: [String!],
+  $depth: Int
+) {
+  categoryTree(
+    family: $family,
+    slugs: $slugs,
+    depth: $depth
+  ) {
+    slug
+    name
+    level
+    parentSlug
+    childrenSlugs
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {
+  "family": "abc123",
+  "slugs": ["xyz789"],
+  "depth": 123
+}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "categoryTree": [
+      {
+        "slug": "abc123",
+        "name": "xyz789",
+        "level": 987,
+        "parentSlug": "xyz789",
+        "childrenSlugs": ["abc123"]
+      }
+    ]
+  }
+}
    @@ -1987,10 +2140,10 @@
    Response
    "checkoutAgreements": [ { "agreement_id": 987, - "checkbox_text": "abc123", + "checkbox_text": "xyz789", "content": "abc123", "content_height": "abc123", - "is_html": true, + "is_html": false, "mode": "AUTO", "name": "xyz789" } @@ -2071,6 +2224,7 @@
    Query
    sales_representative { ...CompanySalesRepresentativeFragment } + status structure { ...CompanyStructureFragment } @@ -2104,16 +2258,17 @@
    Response
    "credit": CompanyCredit, "credit_history": CompanyCreditHistory, "custom_attributes": [CustomAttribute], - "email": "xyz789", + "email": "abc123", "id": "4", "legal_address": CompanyLegalAddress, - "legal_name": "abc123", + "legal_name": "xyz789", "name": "abc123", "payment_methods": ["xyz789"], "reseller_id": "xyz789", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, + "status": "PENDING", "structure": CompanyStructure, "team": CompanyTeam, "user": Customer, @@ -2199,9 +2354,9 @@
    Response
    "data": { "compareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -2261,9 +2416,9 @@
    Response
    "available_regions": [Region], "full_name_english": "abc123", "full_name_locale": "abc123", - "id": "xyz789", - "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" + "id": "abc123", + "three_letter_abbreviation": "xyz789", + "two_letter_abbreviation": "abc123" } ] } @@ -2347,10 +2502,10 @@
    Response
    "country": { "available_regions": [Region], "full_name_english": "abc123", - "full_name_locale": "xyz789", + "full_name_locale": "abc123", "id": "xyz789", "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" + "two_letter_abbreviation": "abc123" } } } @@ -2407,10 +2562,10 @@
    Response
    "data": { "currency": { "available_currency_codes": [ - "abc123" + "xyz789" ], "base_currency_code": "xyz789", - "base_currency_symbol": "xyz789", + "base_currency_symbol": "abc123", "default_display_currency_code": "xyz789", "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] @@ -2565,6 +2720,7 @@
    Query
    group { ...CustomerGroupStorefrontFragment } + id is_subscribed job_title lastname @@ -2589,6 +2745,7 @@
    Query
    ...PurchaseOrdersFragment } purchase_orders_enabled + quote_enabled requisition_lists { ...RequisitionListsFragment } @@ -2641,27 +2798,29 @@
    Response
    "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", - "default_billing": "xyz789", - "default_shipping": "abc123", + "date_of_birth": "abc123", + "default_billing": "abc123", + "default_shipping": "xyz789", "email": "abc123", "firstname": "xyz789", - "gender": 987, + "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "is_subscribed": false, + "id": 4, + "is_subscribed": true, "job_title": "xyz789", "lastname": "abc123", "middlename": "abc123", "orders": CustomerOrders, - "prefix": "abc123", + "prefix": "xyz789", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": false, + "purchase_orders_enabled": true, + "quote_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -2670,8 +2829,8 @@
    Response
    "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", - "suffix": "abc123", + "structure_id": 4, + "suffix": "xyz789", "taxvat": "xyz789", "team": CompanyTeam, "telephone": "abc123", @@ -2785,11 +2944,11 @@
    Response
    ], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "is_virtual": true, "itemsV2": CartItems, "prices": CartPrices, @@ -2797,7 +2956,7 @@
    Response
    "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -3005,12 +3164,16 @@
    Query
    Variables
    - 
    {"cartId": "xyz789"}
+                  
    {"cartId": "abc123"}
    Response
    - 
    {"data": {"customerSegments": [{"uid": 4}]}}
+                  
    {
+  "data": {
+    "customerSegments": [{"uid": "4"}]
+  }
+}
    @@ -3181,7 +3344,7 @@
    Query
    Variables
    {
-  "cartId": "xyz789",
+  "cartId": "abc123",
   "id": "abc123"
 }
    @@ -3192,9 +3355,9 @@
    Response
    "data": { "getPaymentOrder": { "id": "abc123", - "mp_order_id": "abc123", + "mp_order_id": "xyz789", "payment_source_details": PaymentSourceDetails, - "status": "abc123" + "status": "xyz789" } } } @@ -3498,13 +3661,13 @@
    Response
    "event_name": "abc123", "items": [GiftRegistryItemInterface], "message": "xyz789", - "owner_name": "abc123", + "owner_name": "xyz789", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": 4 + "uid": "4" } } } @@ -3583,11 +3746,11 @@
    Response
    "data": { "giftRegistryEmailSearch": [ { - "event_date": "xyz789", + "event_date": "abc123", "event_title": "xyz789", "gift_registry_uid": 4, "location": "abc123", - "name": "abc123", + "name": "xyz789", "type": "abc123" } ] @@ -3673,7 +3836,7 @@
    Response
    "gift_registry_uid": "4", "location": "xyz789", "name": "abc123", - "type": "abc123" + "type": "xyz789" } ] } @@ -3777,12 +3940,12 @@
    Response
    "data": { "giftRegistryTypeSearch": [ { - "event_date": "xyz789", + "event_date": "abc123", "event_title": "xyz789", "gift_registry_uid": 4, - "location": "abc123", + "location": "xyz789", "name": "xyz789", - "type": "xyz789" + "type": "abc123" } ] } @@ -3841,7 +4004,7 @@
    Response
    GiftRegistryDynamicAttributeMetadataInterface ], "label": "abc123", - "uid": "4" + "uid": 4 } ] } @@ -3943,6 +4106,9 @@
    Query
    items_eligible_for_return { ...OrderItemInterfaceFragment } + negotiable_quote { + ...NegotiableQuoteFragment + } number order_date order_status_change_date @@ -3983,7 +4149,7 @@
    Response
    "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "xyz789", + "carrier": "abc123", "comments": [SalesCommentItem], "credit_memos": [CreditMemo], "custom_attributes": [CustomAttribute], @@ -3994,10 +4160,11 @@
    Response
    "gift_wrapping": GiftWrapping, "id": "4", "invoices": [Invoice], - "is_virtual": true, + "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "abc123", + "negotiable_quote": NegotiableQuote, + "number": "xyz789", "order_date": "xyz789", "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], @@ -4109,6 +4276,9 @@
    Query
    items_eligible_for_return { ...OrderItemInterfaceFragment } + negotiable_quote { + ...NegotiableQuoteFragment + } number order_date order_status_change_date @@ -4163,17 +4333,18 @@
    Response
    "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "xyz789", + "negotiable_quote": NegotiableQuote, + "number": "abc123", "order_date": "abc123", - "order_status_change_date": "xyz789", + "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], - "printed_card_included": true, + "printed_card_included": false, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "xyz789", - "status": "abc123", - "token": "xyz789", + "status": "xyz789", + "token": "abc123", "total": OrderTotal } } @@ -4240,7 +4411,7 @@
    Query
    Variables
    - 
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
    @@ -4308,12 +4479,12 @@
    Query
    Variables
    - 
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
    Response
    - 
    {"data": {"isCompanyEmailAvailable": {"is_email_available": true}}}
+                  
    {"data": {"isCompanyEmailAvailable": {"is_email_available": false}}}
    @@ -4376,7 +4547,7 @@
    Query
    Variables
    - 
    {"name": "abc123"}
+                  
    {"name": "xyz789"}
    @@ -4449,7 +4620,7 @@
    Variables
    Response
    - 
    {"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}}
+                  
    {"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}}
    @@ -4511,12 +4682,86 @@
    Query
    Variables
    - 
    {"email": "abc123"}
+                  
    {"email": "xyz789"}
    Response
    {"data": {"isEmailAvailable": {"is_email_available": true}}}
+
    +
    + + back to top + +
    +
    +
    + Queries +
    +

    + navigation +

    +
    +
    +
    +
    Response
    +

    Returns [CategoryNavigationView] +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + family - String! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    query navigation($family: String!) {
+  navigation(family: $family) {
+    slug
+    name
+    children {
+      ...CategoryNavigationViewFragment
+    }
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"family": "xyz789"}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "navigation": [
+      {
+        "slug": "abc123",
+        "name": "abc123",
+        "children": [CategoryNavigationView]
+      }
+    ]
+  }
+}
    @@ -4589,6 +4834,7 @@
    Query
    ...CustomAttributeFragment } email + expiration_date history { ...NegotiableQuoteHistoryEntryFragment } @@ -4597,9 +4843,13 @@
    Query
    ...CartItemInterfaceFragment } name + order { + ...CustomerOrderFragment + } prices { ...CartPricesFragment } + sales_rep_name selected_payment_method { ...SelectedPaymentMethodFragment } @@ -4607,6 +4857,8 @@
    Query
    ...NegotiableQuoteShippingAddressFragment } status + template_id + template_name total_quantity uid updated_at @@ -4616,7 +4868,7 @@
    Query
    Variables
    - 
    {"uid": "4"}
+                  
    {"uid": 4}
    @@ -4630,21 +4882,26 @@
    Response
    "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", + "created_at": "abc123", "custom_attributes": [CustomAttribute], - "email": "xyz789", + "email": "abc123", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_virtual": true, "items": [CartItemInterface], - "name": "xyz789", + "name": "abc123", + "order": CustomerOrder, "prices": CartPrices, + "sales_rep_name": "abc123", "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "SUBMITTED", + "template_id": 4, + "template_name": "xyz789", "total_quantity": 987.65, - "uid": "4", + "uid": 4, "updated_at": "abc123" } } @@ -4710,10 +4967,14 @@
    Query
    comments { ...NegotiableQuoteCommentFragment } + created_at expiration_date history { ...NegotiableQuoteHistoryEntryFragment } + historyV2 { + ...NegotiableQuoteTemplateHistoryEntryFragment + } is_min_max_qty_used is_virtual items { @@ -4731,19 +4992,22 @@
    Query
    reference_document_links { ...NegotiableQuoteReferenceDocumentLinkFragment } + sales_rep_name shipping_addresses { ...NegotiableQuoteShippingAddressFragment } status template_id total_quantity + uid + updated_at }     }
    Variables
    - 
    {"templateId": 4}
+                  
    {"templateId": "4"}
    @@ -4753,25 +5017,30 @@
    Response
    "negotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "created_at": "abc123", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], + "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 123, + "max_order_commitment": 123, + "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "abc123", "template_id": "4", - "total_quantity": 987.65 + "total_quantity": 123.45, + "uid": 4, + "updated_at": "xyz789" } } } @@ -4889,7 +5158,7 @@
    Response
    "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } } } @@ -5253,6 +5522,9 @@
    Query
    related_terms suggestions total_count + warnings { + ...ProductSearchWarningFragment + } } }     @@ -5264,7 +5536,7 @@
    Variables
    "current_page": 1, "filter": [SearchClauseInput], "page_size": 20, - "phrase": "xyz789", + "phrase": "abc123", "sort": [ProductSearchSortInput] }     @@ -5277,9 +5549,10 @@
    Response
    "facets": [Aggregation], "items": [ProductSearchItem], "page_info": SearchResultPageInfo, - "related_terms": ["abc123"], - "suggestions": ["abc123"], - "total_count": 987 + "related_terms": ["xyz789"], + "suggestions": ["xyz789"], + "total_count": 123, + "warnings": [ProductSearchWarning] } } } @@ -5376,7 +5649,7 @@
    Query
    Variables
    - 
    {"skus": ["xyz789"]}
+                  
    {"skus": ["abc123"]}
    @@ -5387,7 +5660,7 @@
    Response
    { "addToCartAllowed": true, "inStock": true, - "lowStock": false, + "lowStock": true, "attributes": [ProductViewAttribute], "description": "xyz789", "id": 4, @@ -5396,16 +5669,16 @@
    Response
    "lastModifiedAt": "2007-12-03T10:15:30Z", "metaDescription": "xyz789", "metaKeyword": "abc123", - "metaTitle": "xyz789", - "name": "abc123", - "shortDescription": "abc123", + "metaTitle": "abc123", + "name": "xyz789", + "shortDescription": "xyz789", "inputOptions": [ProductViewInputOption], "sku": "abc123", "externalId": "xyz789", "url": "abc123", - "urlKey": "xyz789", + "urlKey": "abc123", "links": [ProductViewLink], - "queryType": "abc123", + "queryType": "xyz789", "visibility": "abc123" } ] @@ -5533,14 +5806,14 @@
    Response
    {
   "data": {
     "recaptchaV3Config": {
-      "badge_position": "abc123",
-      "failure_message": "xyz789",
+      "badge_position": "xyz789",
+      "failure_message": "abc123",
       "forms": ["PLACE_ORDER"],
       "is_enabled": true,
       "language_code": "abc123",
-      "minimum_score": 987.65,
-      "theme": "xyz789",
-      "website_key": "abc123"
+      "minimum_score": 123.45,
+      "theme": "abc123",
+      "website_key": "xyz789"
     }
   }
 }
@@ -5618,6 +5891,12 @@ 
    Arguments
    
                         
                          User view history with timestamp 
                       
+                      
+                        
+                          config - UnitConfigInput
+                        
+                         Optional unit configuration 
+
    @@ -5632,15 +5911,17 @@
    Query
    $currentSku: String, $pageType: PageType, $userPurchaseHistory: [PurchaseHistory], - $userViewHistory: [ViewHistory] -) { + $userViewHistory: [ViewHistory], + $config: UnitConfigInput +) { recommendations( cartSkus: $cartSkus, category: $category, currentSku: $currentSku, pageType: $pageType, userPurchaseHistory: $userPurchaseHistory, - userViewHistory: $userViewHistory + userViewHistory: $userViewHistory, + config: $config ) { results { ...RecommendationUnitFragment @@ -5653,12 +5934,13 @@
    Query
    Variables
    {
-  "cartSkus": ["abc123"],
+  "cartSkus": ["xyz789"],
   "category": "xyz789",
   "currentSku": "xyz789",
   "pageType": "CMS",
   "userPurchaseHistory": [PurchaseHistory],
-  "userViewHistory": [ViewHistory]
+  "userViewHistory": [ViewHistory],
+  "config": UnitConfigInput
 }
    @@ -5765,11 +6047,11 @@
    Query
    Variables
    {
-  "unitIds": ["abc123"],
-  "currentSku": "xyz789",
+  "unitIds": ["xyz789"],
+  "currentSku": "abc123",
   "userPurchaseHistory": [PurchaseHistory],
   "userViewHistory": [ViewHistory],
-  "cartSkus": ["abc123"]
+  "cartSkus": ["xyz789"]
 }
    @@ -5882,8 +6164,8 @@
    Query
    Variables
    {
-  "optionIds": ["xyz789"],
-  "sku": "xyz789"
+  "optionIds": ["abc123"],
+  "sku": "abc123"
 }
    @@ -5893,24 +6175,24 @@
    Response
    "data": { "refineProduct": { "addToCartAllowed": true, - "inStock": false, + "inStock": true, "lowStock": true, "attributes": [ProductViewAttribute], - "description": "abc123", + "description": "xyz789", "id": "4", "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", "metaDescription": "xyz789", "metaKeyword": "abc123", - "metaTitle": "abc123", - "name": "xyz789", - "shortDescription": "abc123", + "metaTitle": "xyz789", + "name": "abc123", + "shortDescription": "xyz789", "inputOptions": [ProductViewInputOption], - "sku": "xyz789", + "sku": "abc123", "externalId": "abc123", "url": "xyz789", - "urlKey": "xyz789", + "urlKey": "abc123", "links": [ProductViewLink], "queryType": "abc123", "visibility": "xyz789" @@ -5952,6 +6234,7 @@

    Example

    Query
    query storeConfig {
   storeConfig {
+    allow_company_registration
     allow_gift_receipt
     allow_gift_wrapping_on_order
     allow_gift_wrapping_on_order_items
@@ -5982,6 +6265,8 @@ 
    Query
    
     check_money_order_send_check_to
     check_money_order_sort_order
     check_money_order_title
+    company_credit_enabled
+    company_enabled
     configurable_product_image
     configurable_thumbnail_source
     contact_enabled
@@ -6053,6 +6338,8 @@ 
    Query
    
     product_fixed_product_tax_display_setting
     product_url_suffix
     quickorder_active
+    quote_minimum_amount
+    quote_minimum_amount_message
     required_character_classes_number
     returns_enabled
     root_category_uid
@@ -6099,140 +6386,145 @@ 
    Response
    
                   
    {
   "data": {
     "storeConfig": {
+      "allow_company_registration": false,
       "allow_gift_receipt": "abc123",
-      "allow_gift_wrapping_on_order": "xyz789",
-      "allow_gift_wrapping_on_order_items": "xyz789",
+      "allow_gift_wrapping_on_order": "abc123",
+      "allow_gift_wrapping_on_order_items": "abc123",
       "allow_items": "xyz789",
-      "allow_order": "abc123",
-      "allow_printed_card": "abc123",
-      "autocomplete_on_storefront": true,
-      "base_currency_code": "abc123",
+      "allow_order": "xyz789",
+      "allow_printed_card": "xyz789",
+      "autocomplete_on_storefront": false,
+      "base_currency_code": "xyz789",
       "base_link_url": "xyz789",
       "base_media_url": "abc123",
       "base_static_url": "abc123",
-      "base_url": "xyz789",
-      "cart_expires_in_days": 987,
-      "cart_gift_wrapping": "xyz789",
-      "cart_merge_preference": "xyz789",
-      "cart_printed_card": "abc123",
+      "base_url": "abc123",
+      "cart_expires_in_days": 123,
+      "cart_gift_wrapping": "abc123",
+      "cart_merge_preference": "abc123",
+      "cart_printed_card": "xyz789",
       "cart_summary_display_quantity": 987,
-      "catalog_default_sort_by": "abc123",
+      "catalog_default_sort_by": "xyz789",
       "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
       "category_url_suffix": "abc123",
       "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": "xyz789",
       "check_money_order_max_order_total": "xyz789",
-      "check_money_order_min_order_total": "xyz789",
-      "check_money_order_new_order_status": "xyz789",
-      "check_money_order_payment_from_specific_countries": "xyz789",
+      "check_money_order_min_order_total": "abc123",
+      "check_money_order_new_order_status": "abc123",
+      "check_money_order_payment_from_specific_countries": "abc123",
       "check_money_order_send_check_to": "abc123",
-      "check_money_order_sort_order": 123,
-      "check_money_order_title": "abc123",
+      "check_money_order_sort_order": 987,
+      "check_money_order_title": "xyz789",
+      "company_credit_enabled": true,
+      "company_enabled": false,
       "configurable_product_image": "ITSELF",
-      "configurable_thumbnail_source": "abc123",
+      "configurable_thumbnail_source": "xyz789",
       "contact_enabled": true,
       "countries_with_required_region": "abc123",
-      "create_account_confirmation": false,
-      "customer_access_token_lifetime": 123.45,
-      "default_country": "abc123",
-      "default_display_currency_code": "xyz789",
-      "display_product_prices_in_catalog": 987,
+      "create_account_confirmation": true,
+      "customer_access_token_lifetime": 987.65,
+      "default_country": "xyz789",
+      "default_display_currency_code": "abc123",
+      "display_product_prices_in_catalog": 123,
       "display_shipping_prices": 123,
       "display_state_if_optional": false,
       "enable_multiple_wishlists": "abc123",
       "fixed_product_taxes_apply_tax_to_fpt": false,
-      "fixed_product_taxes_display_prices_in_emails": 123,
-      "fixed_product_taxes_display_prices_in_product_lists": 123,
-      "fixed_product_taxes_display_prices_in_sales_modules": 987,
+      "fixed_product_taxes_display_prices_in_emails": 987,
+      "fixed_product_taxes_display_prices_in_product_lists": 987,
+      "fixed_product_taxes_display_prices_in_sales_modules": 123,
       "fixed_product_taxes_display_prices_on_product_view_page": 987,
-      "fixed_product_taxes_enable": true,
-      "fixed_product_taxes_include_fpt_in_subtotal": false,
-      "graphql_share_customer_group": false,
-      "grid_per_page": 987,
-      "grid_per_page_values": "xyz789",
+      "fixed_product_taxes_enable": false,
+      "fixed_product_taxes_include_fpt_in_subtotal": true,
+      "graphql_share_customer_group": true,
+      "grid_per_page": 123,
+      "grid_per_page_values": "abc123",
       "grouped_product_image": "ITSELF",
-      "is_checkout_agreements_enabled": true,
+      "is_checkout_agreements_enabled": false,
       "is_default_store": false,
-      "is_default_store_group": false,
-      "is_guest_checkout_enabled": true,
-      "is_negotiable_quote_active": false,
-      "is_one_page_checkout_enabled": false,
-      "is_requisition_list_active": "xyz789",
-      "list_mode": "abc123",
+      "is_default_store_group": true,
+      "is_guest_checkout_enabled": false,
+      "is_negotiable_quote_active": true,
+      "is_one_page_checkout_enabled": true,
+      "is_requisition_list_active": "abc123",
+      "list_mode": "xyz789",
       "list_per_page": 987,
       "list_per_page_values": "abc123",
-      "locale": "abc123",
-      "magento_reward_general_is_enabled": "abc123",
+      "locale": "xyz789",
+      "magento_reward_general_is_enabled": "xyz789",
       "magento_reward_general_is_enabled_on_front": "xyz789",
       "magento_reward_general_min_points_balance": "xyz789",
       "magento_reward_general_publish_history": "xyz789",
-      "magento_reward_points_invitation_customer": "abc123",
+      "magento_reward_points_invitation_customer": "xyz789",
       "magento_reward_points_invitation_customer_limit": "abc123",
       "magento_reward_points_invitation_order": "xyz789",
       "magento_reward_points_invitation_order_limit": "xyz789",
-      "magento_reward_points_newsletter": "xyz789",
-      "magento_reward_points_order": "abc123",
+      "magento_reward_points_newsletter": "abc123",
+      "magento_reward_points_order": "xyz789",
       "magento_reward_points_register": "abc123",
       "magento_reward_points_review": "xyz789",
-      "magento_reward_points_review_limit": "xyz789",
+      "magento_reward_points_review_limit": "abc123",
       "magento_wishlist_general_is_enabled": "xyz789",
       "max_items_in_order_summary": 987,
       "maximum_number_of_wishlists": "abc123",
-      "minicart_display": false,
-      "minicart_max_items": 123,
+      "minicart_display": true,
+      "minicart_max_items": 987,
       "minimum_password_length": "abc123",
       "newsletter_enabled": true,
       "optional_zip_countries": "xyz789",
       "order_cancellation_enabled": false,
       "order_cancellation_reasons": [CancellationReason],
-      "orders_invoices_credit_memos_display_full_summary": true,
+      "orders_invoices_credit_memos_display_full_summary": false,
       "orders_invoices_credit_memos_display_grandtotal": false,
-      "orders_invoices_credit_memos_display_price": 987,
+      "orders_invoices_credit_memos_display_price": 123,
       "orders_invoices_credit_memos_display_shipping_amount": 987,
-      "orders_invoices_credit_memos_display_subtotal": 987,
+      "orders_invoices_credit_memos_display_subtotal": 123,
       "orders_invoices_credit_memos_display_zero_tax": false,
       "printed_card_priceV2": Money,
       "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-      "product_url_suffix": "xyz789",
-      "quickorder_active": false,
-      "required_character_classes_number": "abc123",
-      "returns_enabled": "abc123",
+      "product_url_suffix": "abc123",
+      "quickorder_active": true,
+      "quote_minimum_amount": 987.65,
+      "quote_minimum_amount_message": "abc123",
+      "required_character_classes_number": "xyz789",
+      "returns_enabled": "xyz789",
       "root_category_uid": "4",
       "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-      "sales_gift_wrapping": "abc123",
-      "sales_printed_card": "abc123",
+      "sales_gift_wrapping": "xyz789",
+      "sales_printed_card": "xyz789",
       "secure_base_link_url": "xyz789",
-      "secure_base_media_url": "abc123",
+      "secure_base_media_url": "xyz789",
       "secure_base_static_url": "xyz789",
       "secure_base_url": "abc123",
       "share_active_segments": false,
-      "share_applied_cart_rule": true,
-      "shopping_cart_display_full_summary": true,
+      "share_applied_cart_rule": false,
+      "shopping_cart_display_full_summary": false,
       "shopping_cart_display_grand_total": false,
       "shopping_cart_display_price": 123,
-      "shopping_cart_display_shipping": 123,
+      "shopping_cart_display_shipping": 987,
       "shopping_cart_display_subtotal": 123,
       "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
       "shopping_cart_display_zero_tax": true,
       "store_code": 4,
-      "store_group_code": 4,
+      "store_group_code": "4",
       "store_group_name": "abc123",
       "store_name": "xyz789",
       "store_sort_order": 123,
-      "timezone": "xyz789",
-      "title_separator": "abc123",
+      "timezone": "abc123",
+      "title_separator": "xyz789",
       "use_store_in_url": false,
-      "website_code": "4",
-      "website_name": "xyz789",
-      "weight_unit": "abc123",
+      "website_code": 4,
+      "website_name": "abc123",
+      "weight_unit": "xyz789",
       "zero_subtotal_enable_for_specific_countries": false,
       "zero_subtotal_enabled": true,
       "zero_subtotal_new_order_status": "xyz789",
-      "zero_subtotal_payment_action": "xyz789",
+      "zero_subtotal_payment_action": "abc123",
       "zero_subtotal_payment_from_specific_countries": "abc123",
       "zero_subtotal_sort_order": 123,
-      "zero_subtotal_title": "abc123"
+      "zero_subtotal_title": "xyz789"
     }
   }
 }
@@ -6326,7 +6618,7 @@ 
    Query
    
                   
    Variables
    
                   
    {
   "sku": "xyz789",
-  "optionIds": ["xyz789"],
+  "optionIds": ["abc123"],
   "pageSize": 123,
   "cursor": "xyz789"
 }
@@ -6338,7 +6630,7 @@ 
    Response
    
   "data": {
     "variants": {
       "variants": [ProductViewVariant],
-      "cursor": "xyz789"
+      "cursor": "abc123"
     }
   }
 }
@@ -6407,7 +6699,7 @@ 
    Variables
    
                 
                 
    
                   
    Response
    
-                  
    {"data": {"acceptCompanyInvitation": {"success": true}}}
+                  
    {"data": {"acceptCompanyInvitation": {"success": false}}}
 
    
                 
    
               
@@ -6468,10 +6760,14 @@ 
    Query
    
     comments {
       ...NegotiableQuoteCommentFragment
     }
+    created_at
     expiration_date
     history {
       ...NegotiableQuoteHistoryEntryFragment
     }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
     is_min_max_qty_used
     is_virtual
     items {
@@ -6489,12 +6785,15 @@ 
    Query
    
     reference_document_links {
       ...NegotiableQuoteReferenceDocumentLinkFragment
     }
+    sales_rep_name
     shipping_addresses {
       ...NegotiableQuoteShippingAddressFragment
     }
     status
     template_id
     total_quantity
+    uid
+    updated_at
   }    
 }
 
    
@@ -6511,25 +6810,30 @@ 
    Response
    
     "acceptNegotiableQuoteTemplate": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "abc123",
+      "created_at": "xyz789",
+      "expiration_date": "xyz789",
       "history": [NegotiableQuoteHistoryEntry],
+      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
       "is_min_max_qty_used": false,
       "is_virtual": true,
       "items": [CartItemInterface],
       "max_order_commitment": 987,
-      "min_order_commitment": 987,
-      "name": "xyz789",
+      "min_order_commitment": 123,
+      "name": "abc123",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
         NegotiableQuoteReferenceDocumentLink
       ],
+      "sales_rep_name": "abc123",
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "abc123",
-      "template_id": 4,
-      "total_quantity": 123.45
+      "status": "xyz789",
+      "template_id": "4",
+      "total_quantity": 123.45,
+      "uid": 4,
+      "updated_at": "abc123"
     }
   }
 }
@@ -6775,7 +7079,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "cartId": "xyz789",
+  "cartId": "abc123",
   "cartItems": [CartItemInput]
 }
 
    
@@ -7617,7 +7921,10 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"wishlistId": 4, "wishlistItemIds": ["4"]}
+                  
    {
+  "wishlistId": "4",
+  "wishlistItemIds": ["4"]
+}
 
    
                 
    
                 
    
@@ -7628,7 +7935,7 @@ 
    Response
    
       "add_wishlist_items_to_cart_user_errors": [
         WishlistCartUserInputError
       ],
-      "status": true,
+      "status": false,
       "wishlist": Wishlist
     }
   }
@@ -8123,7 +8430,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"uid": "4"}
+                  
    {"uid": 4}
 
    
                 
    
                 
    
@@ -8271,7 +8578,7 @@ 
    Response
    
       "gift_receipt_included": true,
       "gift_wrapping": GiftWrapping,
       "id": 4,
-      "is_virtual": false,
+      "is_virtual": true,
       "itemsV2": CartItems,
       "prices": CartPrices,
       "printed_card_included": true,
@@ -8342,10 +8649,14 @@ 
    Query
    
     comments {
       ...NegotiableQuoteCommentFragment
     }
+    created_at
     expiration_date
     history {
       ...NegotiableQuoteHistoryEntryFragment
     }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
     is_min_max_qty_used
     is_virtual
     items {
@@ -8363,12 +8674,15 @@ 
    Query
    
     reference_document_links {
       ...NegotiableQuoteReferenceDocumentLinkFragment
     }
+    sales_rep_name
     shipping_addresses {
       ...NegotiableQuoteShippingAddressFragment
     }
     status
     template_id
     total_quantity
+    uid
+    updated_at
   }    
 }
 
    
@@ -8385,10 +8699,12 @@ 
    Response
    
     "cancelNegotiableQuoteTemplate": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "xyz789",
+      "created_at": "xyz789",
+      "expiration_date": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
+      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
       "is_min_max_qty_used": true,
-      "is_virtual": false,
+      "is_virtual": true,
       "items": [CartItemInterface],
       "max_order_commitment": 987,
       "min_order_commitment": 987,
@@ -8398,12 +8714,15 @@ 
    Response
    
       "reference_document_links": [
         NegotiableQuoteReferenceDocumentLink
       ],
+      "sales_rep_name": "xyz789",
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
       "status": "xyz789",
-      "template_id": 4,
-      "total_quantity": 123.45
+      "template_id": "4",
+      "total_quantity": 123.45,
+      "uid": 4,
+      "updated_at": "xyz789"
     }
   }
 }
@@ -8483,7 +8802,7 @@ 
    Response
    
                   
    {
   "data": {
     "cancelOrder": {
-      "error": "abc123",
+      "error": "xyz789",
       "errorV2": CancelOrderError,
       "order": CustomerOrder
     }
@@ -8668,6 +8987,7 @@ 
    Query
    
     group {
       ...CustomerGroupStorefrontFragment
     }
+    id
     is_subscribed
     job_title
     lastname
@@ -8692,6 +9012,7 @@ 
    Query
    
       ...PurchaseOrdersFragment
     }
     purchase_orders_enabled
+    quote_enabled
     requisition_lists {
       ...RequisitionListsFragment
     }
@@ -8734,7 +9055,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "currentPassword": "xyz789",
+  "currentPassword": "abc123",
   "newPassword": "abc123"
 }
 
    
@@ -8752,19 +9073,20 @@ 
    Response
    
       "confirmation_status": "ACCOUNT_CONFIRMED",
       "created_at": "abc123",
       "custom_attributes": [AttributeValueInterface],
-      "date_of_birth": "xyz789",
+      "date_of_birth": "abc123",
       "default_billing": "abc123",
-      "default_shipping": "xyz789",
-      "email": "xyz789",
-      "firstname": "abc123",
-      "gender": 123,
+      "default_shipping": "abc123",
+      "email": "abc123",
+      "firstname": "xyz789",
+      "gender": 987,
       "gift_registries": [GiftRegistry],
       "gift_registry": GiftRegistry,
       "group": CustomerGroupStorefront,
+      "id": 4,
       "is_subscribed": true,
       "job_title": "xyz789",
-      "lastname": "abc123",
-      "middlename": "abc123",
+      "lastname": "xyz789",
+      "middlename": "xyz789",
       "orders": CustomerOrders,
       "prefix": "abc123",
       "purchase_order": PurchaseOrder,
@@ -8772,7 +9094,8 @@ 
    Response
    
       "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
       "purchase_order_approval_rules": PurchaseOrderApprovalRules,
       "purchase_orders": PurchaseOrders,
-      "purchase_orders_enabled": false,
+      "purchase_orders_enabled": true,
+      "quote_enabled": false,
       "requisition_lists": RequisitionLists,
       "return": Return,
       "returns": Returns,
@@ -8781,8 +9104,8 @@ 
    Response
    
       "segments": [CustomerSegmentStorefront],
       "status": "ACTIVE",
       "store_credit": CustomerStoreCredit,
-      "structure_id": "4",
-      "suffix": "abc123",
+      "structure_id": 4,
+      "suffix": "xyz789",
       "taxvat": "abc123",
       "team": CompanyTeam,
       "telephone": "xyz789",
@@ -8931,7 +9254,7 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"wishlistId": "4"}
+                  
    {"wishlistId": 4}
 
    
                 
    
                 
    
@@ -9187,7 +9510,7 @@ 
    Response
    
                   
    {
   "data": {
     "confirmCancelOrder": {
-      "error": "xyz789",
+      "error": "abc123",
       "errorV2": CancelOrderError,
       "order": CustomerOrder
     }
@@ -9493,8 +9816,8 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "sourceRequisitionListUid": 4,
-  "destinationRequisitionListUid": 4,
+  "sourceRequisitionListUid": "4",
+  "destinationRequisitionListUid": "4",
   "requisitionListItem": CopyItemsBetweenRequisitionListsInput
 }
 
    
@@ -9598,7 +9921,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "sourceWishlistUid": 4,
+  "sourceWishlistUid": "4",
   "destinationWishlistUid": "4",
   "wishlistItems": [WishlistItemCopyInput]
 }
@@ -10075,27 +10398,27 @@ 
    Response
    
                   
    {
   "data": {
     "createCustomerAddress": {
-      "city": "xyz789",
-      "company": "abc123",
+      "city": "abc123",
+      "company": "xyz789",
       "country_code": "AF",
       "custom_attributesV2": [AttributeValueInterface],
       "default_billing": false,
-      "default_shipping": true,
+      "default_shipping": false,
       "extension_attributes": [CustomerAddressAttribute],
-      "fax": "xyz789",
+      "fax": "abc123",
       "firstname": "xyz789",
-      "id": 123,
+      "id": 987,
       "lastname": "abc123",
-      "middlename": "abc123",
-      "postcode": "xyz789",
+      "middlename": "xyz789",
+      "postcode": "abc123",
       "prefix": "abc123",
       "region": CustomerAddressRegion,
       "region_id": 987,
-      "street": ["abc123"],
+      "street": ["xyz789"],
       "suffix": "xyz789",
-      "telephone": "abc123",
+      "telephone": "xyz789",
       "uid": "4",
-      "vat_id": "abc123"
+      "vat_id": "xyz789"
     }
   }
 }
@@ -10384,11 +10707,11 @@ 
    Response
    
                   
    {
   "data": {
     "createPaymentOrder": {
-      "amount": 987.65,
+      "amount": 123.45,
       "currency_code": "xyz789",
-      "id": "xyz789",
-      "mp_order_id": "abc123",
-      "status": "abc123"
+      "id": "abc123",
+      "mp_order_id": "xyz789",
+      "status": "xyz789"
     }
   }
 }
@@ -10480,12 +10803,12 @@ 
    Response
    
       "applies_to_roles": [CompanyRole],
       "approver_roles": [CompanyRole],
       "condition": PurchaseOrderApprovalRuleConditionInterface,
-      "created_at": "xyz789",
-      "created_by": "abc123",
-      "description": "abc123",
-      "name": "xyz789",
+      "created_at": "abc123",
+      "created_by": "xyz789",
+      "description": "xyz789",
+      "name": "abc123",
       "status": "ENABLED",
-      "uid": 4,
+      "uid": "4",
       "updated_at": "xyz789"
     }
   }
@@ -10712,7 +11035,7 @@ 
    Response
    
                   
    {
   "data": {
     "createVaultCardSetupToken": {
-      "setup_token": "abc123"
+      "setup_token": "xyz789"
     }
   }
 }
@@ -10915,12 +11238,12 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"id": 4}
+                  
    {"id": "4"}
 
    
                 
    
                 
    
                   
    Response
    
-                  
    {"data": {"deleteCompanyTeam": {"success": true}}}
+                  
    {"data": {"deleteCompanyTeam": {"success": false}}}
 
    
                 
    
               
    
@@ -10983,12 +11306,12 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"id": "4"}
+                  
    {"id": 4}
 
    
                 
    
                 
    
                   
    Response
    
-                  
    {"data": {"deleteCompanyUserV2": {"success": false}}}
+                  
    {"data": {"deleteCompanyUserV2": {"success": true}}}
 
    
                 
    
               
@@ -11050,7 +11373,7 @@ 
    Query
    
                 
                 
    
                   
    Variables
    
-                  
    {"uid": "4"}
+                  
    {"uid": 4}
 
    
                 
    
                 
    
@@ -11107,9 +11430,16 @@ 
    Response
    
             
    
               Mutations
             
    
-            
    
+            
    
               deleteCustomerAddress
             
    
+            
    
+              
    
+                
    
+                  
     Use deleteCustomerAddressV2 instead. 
    
+                
    
+              
    
+            
    
             
    
               
    
                 
    
@@ -11162,6 +11492,71 @@ 
    Variables
    
                 
    
                   
    Response
    
                   
    {"data": {"deleteCustomerAddress": false}}
+
    
+                
    
+              
    
+              back to top
+            
    
+
    +
    +
    + Mutations +
    +

    + deleteCustomerAddressV2 +

    +
    +
    +
    +
    Description
    +

    Delete the billing or shipping address of a customer.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a Boolean +

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

    Example

    +
    +
    Query
    + 
    mutation deleteCustomerAddressV2($uid: ID!) {
+  deleteCustomerAddressV2(uid: $uid)
+}
+
    +
    +
    +
    Variables
    + 
    {"uid": 4}
+
    +
    +
    +
    Response
    + 
    {"data": {"deleteCustomerAddressV2": true}}
    @@ -11226,7 +11621,7 @@
    Variables
    Response
    - 
    {"data": {"deleteNegotiableQuoteTemplate": false}}
+                  
    {"data": {"deleteNegotiableQuoteTemplate": true}}
    @@ -11379,7 +11774,7 @@
    Query
    Variables
    - 
    {"public_hash": "xyz789"}
+                  
    {"public_hash": "abc123"}
    @@ -11532,7 +11927,7 @@
    Query
    Variables
    - 
    {"requisitionListUid": "4"}
+                  
    {"requisitionListUid": 4}
    @@ -11620,7 +12015,10 @@
    Query
    Variables
    - 
    {"requisitionListUid": 4, "requisitionListItemUids": [4]}
+                  
    {
+  "requisitionListUid": "4",
+  "requisitionListItemUids": ["4"]
+}
    @@ -11696,7 +12094,7 @@
    Query
    Variables
    - 
    {"wishlistId": "4"}
+                  
    {"wishlistId": 4}
    @@ -11872,9 +12270,9 @@
    Response
    "additional_data": [ShippingAdditionalData], "amount": Money, "available": true, - "carrier_code": "xyz789", + "carrier_code": "abc123", "carrier_title": "abc123", - "error_message": "abc123", + "error_message": "xyz789", "method_code": "xyz789", "method_title": "xyz789", "price_excl_tax": Money, @@ -12025,7 +12423,95 @@
    Response
    "data": { "exchangeExternalCustomerToken": { "customer": Customer, - "token": "xyz789" + "token": "abc123" + } + } +} +     +
    + + back to top + +
    +
    +
    + Mutations +
    +

    + exchangeOtpForCustomerToken +

    +
    +
    +
    +
    Description
    +

    Exchange a customer's one time password for a customer token.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a CustomerToken +

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

    Example

    +
    +
    Query
    + 
    mutation exchangeOtpForCustomerToken(
+  $email: String!,
+  $otp: String!
+) {
+  exchangeOtpForCustomerToken(
+    email: $email,
+    otp: $otp
+  ) {
+    token
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {
+  "email": "abc123",
+  "otp": "xyz789"
+}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "exchangeOtpForCustomerToken": {
+      "token": "abc123"
     }
   }
 }
@@ -12094,8 +12580,8 @@ 
    Response
    
   "data": {
     "finishUpload": {
       "key": "abc123",
-      "message": "xyz789",
-      "success": true
+      "message": "abc123",
+      "success": false
     }
   }
 }
@@ -12256,7 +12742,7 @@ 
    Response
    
                   
    {
   "data": {
     "generateCustomerTokenAsAdmin": {
-      "customer_token": "xyz789"
+      "customer_token": "abc123"
     }
   }
 }
@@ -12397,9 +12883,9 @@ 
    Response
    
                   
    {
   "data": {
     "initiateUpload": {
-      "expires_at": "xyz789",
+      "expires_at": "abc123",
       "key": "abc123",
-      "upload_url": "abc123"
+      "upload_url": "xyz789"
     }
   }
 }
@@ -12527,7 +13013,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "source_cart_id": "abc123",
+  "source_cart_id": "xyz789",
   "destination_cart_id": "xyz789"
 }
 
    
@@ -12549,13 +13035,13 @@ 
    Response
    
       "custom_attributes": [CustomAttribute],
       "email": "xyz789",
       "gift_message": GiftMessage,
-      "gift_receipt_included": false,
+      "gift_receipt_included": true,
       "gift_wrapping": GiftWrapping,
-      "id": "4",
-      "is_virtual": true,
+      "id": 4,
+      "is_virtual": false,
       "itemsV2": CartItems,
       "prices": CartPrices,
-      "printed_card_included": true,
+      "printed_card_included": false,
       "rules": [CartRuleStorefront],
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
@@ -12642,7 +13128,10 @@ 
    Query
    
                 
    
                 
    
                   
    Variables
    
-                  
    {"cartUid": 4, "giftRegistryUid": "4"}
+                  
    {
+  "cartUid": "4",
+  "giftRegistryUid": "4"
+}
 
    
                 
    
                 
    
@@ -12651,7 +13140,7 @@ 
    Response
    
   "data": {
     "moveCartItemsToGiftRegistry": {
       "gift_registry": GiftRegistry,
-      "status": false,
+      "status": true,
       "user_errors": [GiftRegistryItemsUserError]
     }
   }
@@ -12924,7 +13413,7 @@ 
    Query
    
                 
    
                   
    Variables
    
                   
    {
-  "sourceWishlistUid": "4",
+  "sourceWishlistUid": 4,
   "destinationWishlistUid": 4,
   "wishlistItems": [WishlistItemMoveInput]
 }
@@ -13001,10 +13490,14 @@ 
    Query
    
     comments {
       ...NegotiableQuoteCommentFragment
     }
+    created_at
     expiration_date
     history {
       ...NegotiableQuoteHistoryEntryFragment
     }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
     is_min_max_qty_used
     is_virtual
     items {
@@ -13022,12 +13515,15 @@ 
    Query
    
     reference_document_links {
       ...NegotiableQuoteReferenceDocumentLinkFragment
     }
+    sales_rep_name
     shipping_addresses {
       ...NegotiableQuoteShippingAddressFragment
     }
     status
     template_id
     total_quantity
+    uid
+    updated_at
   }    
 }
 
    
@@ -13044,25 +13540,30 @@ 
    Response
    
     "openNegotiableQuoteTemplate": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
+      "created_at": "abc123",
       "expiration_date": "xyz789",
       "history": [NegotiableQuoteHistoryEntry],
+      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
       "is_min_max_qty_used": true,
-      "is_virtual": true,
+      "is_virtual": false,
       "items": [CartItemInterface],
       "max_order_commitment": 123,
-      "min_order_commitment": 987,
+      "min_order_commitment": 123,
       "name": "xyz789",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
         NegotiableQuoteReferenceDocumentLink
       ],
+      "sales_rep_name": "xyz789",
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
       "status": "xyz789",
-      "template_id": "4",
-      "total_quantity": 123.45
+      "template_id": 4,
+      "total_quantity": 123.45,
+      "uid": 4,
+      "updated_at": "xyz789"
     }
   }
 }
@@ -13076,9 +13577,16 @@ 
    Response
    
             
    
               Mutations
             
    
-            
    
+            
    
               placeNegotiableQuoteOrder
             
    
+            
    
+              
    
+                
    
+                  
     Use placeNegotiableQuoteOrderV2 instead. 
    
+                
    
+              
    
+            
    
             
    
               
    
                 
    
@@ -13123,7 +13631,76 @@ 
    Query
    
     order {
       ...OrderFragment
     }
-    orderV2 {
+  }
+}
+
    
+
    +
    +
    Variables
    + 
    {"input": PlaceNegotiableQuoteOrderInput}
+
    +
    +
    +
    Response
    + 
    {"data": {"placeNegotiableQuoteOrder": {"order": Order}}}
+
    +
    +
    + back to top +
    +
    +
    +
    + Mutations +
    +

    + placeNegotiableQuoteOrderV2 +

    +
    +
    +
    +
    Description
    +

    Convert a negotiable quote into an order.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a PlaceNegotiableQuoteOrderOutputV2 +

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

    Example

    +
    +
    Query
    + 
    mutation placeNegotiableQuoteOrderV2($input: PlaceNegotiableQuoteOrderInput!) {
+  placeNegotiableQuoteOrderV2(input: $input) {
+    errors {
+      ...PlaceOrderErrorFragment
+    }
+    order {
       ...CustomerOrderFragment
     }
   }
@@ -13139,9 +13716,9 @@ 
    Variables
    
                   
    Response
    
                   
    {
   "data": {
-    "placeNegotiableQuoteOrder": {
-      "order": Order,
-      "orderV2": CustomerOrder
+    "placeNegotiableQuoteOrderV2": {
+      "errors": [PlaceOrderError],
+      "order": CustomerOrder
     }
   }
 }
@@ -13448,7 +14025,7 @@ 
    Response
    
   "data": {
     "redeemGiftCardBalanceAsStoreCredit": {
       "balance": Money,
-      "code": "xyz789",
+      "code": "abc123",
       "expiration_date": "abc123"
     }
   }
@@ -13801,7 +14378,7 @@ 
    Query
    Variables
    - 
    {"giftRegistryUid": 4}
+                  
    {"giftRegistryUid": "4"}
    @@ -13882,7 +14459,10 @@
    Query
    Variables
    - 
    {"giftRegistryUid": "4", "itemsUid": [4]}
+                  
    {
+  "giftRegistryUid": "4",
+  "itemsUid": ["4"]
+}
    @@ -13970,8 +14550,8 @@
    Query
    Variables
    {
-  "giftRegistryUid": "4",
-  "registrantsUid": [4]
+  "giftRegistryUid": 4,
+  "registrantsUid": ["4"]
 }
    @@ -14188,10 +14768,14 @@
    Query
    comments { ...NegotiableQuoteCommentFragment } + created_at expiration_date history { ...NegotiableQuoteHistoryEntryFragment } + historyV2 { + ...NegotiableQuoteTemplateHistoryEntryFragment + } is_min_max_qty_used is_virtual items { @@ -14209,12 +14793,15 @@
    Query
    reference_document_links { ...NegotiableQuoteReferenceDocumentLinkFragment } + sales_rep_name shipping_addresses { ...NegotiableQuoteShippingAddressFragment } status template_id total_quantity + uid + updated_at }     }     @@ -14231,25 +14818,30 @@
    Response
    "removeNegotiableQuoteTemplateItems": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], + "created_at": "xyz789", "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], + "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, + "max_order_commitment": 987, "min_order_commitment": 987, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": "4", - "total_quantity": 123.45 + "total_quantity": 987.65, + "uid": 4, + "updated_at": "xyz789" } } } @@ -14330,9 +14922,9 @@
    Response
    "data": { "removeProductsFromCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -14864,7 +15456,7 @@
    Response
    {
   "data": {
     "requestGuestOrderCancel": {
-      "error": "xyz789",
+      "error": "abc123",
       "errorV2": CancelOrderError,
       "order": CustomerOrder
     }
@@ -15074,10 +15666,14 @@ 
    Query
    
     comments {
       ...NegotiableQuoteCommentFragment
     }
+    created_at
     expiration_date
     history {
       ...NegotiableQuoteHistoryEntryFragment
     }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
     is_min_max_qty_used
     is_virtual
     items {
@@ -15095,12 +15691,15 @@ 
    Query
    
     reference_document_links {
       ...NegotiableQuoteReferenceDocumentLinkFragment
     }
+    sales_rep_name
     shipping_addresses {
       ...NegotiableQuoteShippingAddressFragment
     }
     status
     template_id
     total_quantity
+    uid
+    updated_at
   }    
 }
    @@ -15117,25 +15716,30 @@
    Response
    "requestNegotiableQuoteTemplateFromQuote": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "created_at": "xyz789", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], + "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, + "max_order_commitment": 987, "min_order_commitment": 123, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": 4, - "total_quantity": 987.65 + "total_quantity": 987.65, + "uid": "4", + "updated_at": "abc123" } } } @@ -15203,7 +15807,7 @@
    Variables
    Response
    - 
    {"data": {"requestPasswordResetEmail": false}}
+                  
    {"data": {"requestPasswordResetEmail": true}}
    @@ -15342,7 +15946,7 @@
    Query
    Variables
    - 
    {"email": "abc123"}
+                  
    {"email": "xyz789"}
    @@ -15436,7 +16040,7 @@
    Variables
    Response
    - 
    {"data": {"resetPassword": false}}
+                  
    {"data": {"resetPassword": true}}
    @@ -15694,7 +16298,7 @@
    Response
    {
   "data": {
     "setCartAsInactive": {
-      "error": "abc123",
+      "error": "xyz789",
       "success": false
     }
   }
@@ -16860,10 +17464,14 @@ 
    Query
    
     comments {
       ...NegotiableQuoteCommentFragment
     }
+    created_at
     expiration_date
     history {
       ...NegotiableQuoteHistoryEntryFragment
     }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
     is_min_max_qty_used
     is_virtual
     items {
@@ -16881,12 +17489,15 @@ 
    Query
    
     reference_document_links {
       ...NegotiableQuoteReferenceDocumentLinkFragment
     }
+    sales_rep_name
     shipping_addresses {
       ...NegotiableQuoteShippingAddressFragment
     }
     status
     template_id
     total_quantity
+    uid
+    updated_at
   }    
 }
    @@ -16903,25 +17514,30 @@
    Response
    "setNegotiableQuoteTemplateShippingAddress": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], + "created_at": "abc123", "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], + "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": false, "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 123, - "name": "abc123", + "min_order_commitment": 987, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, - "total_quantity": 987.65 + "template_id": "4", + "total_quantity": 987.65, + "uid": 4, + "updated_at": "abc123" } } } @@ -16994,6 +17610,143 @@
    Variables
    Response
    {"data": {"setPaymentMethodOnCart": {"cart": Cart}}}
+
    +
    + + back to top + +
    +
    +
    + Mutations +
    +

    + setQuoteTemplateExpirationDate +

    +
    +
    +
    +
    Description
    +

    Set expiration date to a negotiable quote template.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a NegotiableQuoteTemplate +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - QuoteTemplateExpirationDateInput! + An input object that defines the quote template expiration date.
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    mutation setQuoteTemplateExpirationDate($input: QuoteTemplateExpirationDateInput!) {
+  setQuoteTemplateExpirationDate(input: $input) {
+    buyer {
+      ...NegotiableQuoteUserFragment
+    }
+    comments {
+      ...NegotiableQuoteCommentFragment
+    }
+    created_at
+    expiration_date
+    history {
+      ...NegotiableQuoteHistoryEntryFragment
+    }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
+    is_min_max_qty_used
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    max_order_commitment
+    min_order_commitment
+    name
+    notifications {
+      ...QuoteTemplateNotificationMessageFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    reference_document_links {
+      ...NegotiableQuoteReferenceDocumentLinkFragment
+    }
+    sales_rep_name
+    shipping_addresses {
+      ...NegotiableQuoteShippingAddressFragment
+    }
+    status
+    template_id
+    total_quantity
+    uid
+    updated_at
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"input": QuoteTemplateExpirationDateInput}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "setQuoteTemplateExpirationDate": {
+      "buyer": NegotiableQuoteUser,
+      "comments": [NegotiableQuoteComment],
+      "created_at": "xyz789",
+      "expiration_date": "abc123",
+      "history": [NegotiableQuoteHistoryEntry],
+      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
+      "is_min_max_qty_used": false,
+      "is_virtual": false,
+      "items": [CartItemInterface],
+      "max_order_commitment": 987,
+      "min_order_commitment": 987,
+      "name": "abc123",
+      "notifications": [QuoteTemplateNotificationMessage],
+      "prices": CartPrices,
+      "reference_document_links": [
+        NegotiableQuoteReferenceDocumentLink
+      ],
+      "sales_rep_name": "abc123",
+      "shipping_addresses": [
+        NegotiableQuoteShippingAddress
+      ],
+      "status": "abc123",
+      "template_id": "4",
+      "total_quantity": 987.65,
+      "uid": "4",
+      "updated_at": "xyz789"
+    }
+  }
+}
    @@ -17054,10 +17807,14 @@
    Query
    comments { ...NegotiableQuoteCommentFragment } + created_at expiration_date history { ...NegotiableQuoteHistoryEntryFragment } + historyV2 { + ...NegotiableQuoteTemplateHistoryEntryFragment + } is_min_max_qty_used is_virtual items { @@ -17075,12 +17832,15 @@
    Query
    reference_document_links { ...NegotiableQuoteReferenceDocumentLinkFragment } + sales_rep_name shipping_addresses { ...NegotiableQuoteShippingAddressFragment } status template_id total_quantity + uid + updated_at }     }     @@ -17097,25 +17857,30 @@
    Response
    "setQuoteTemplateLineItemNote": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "created_at": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, + "historyV2": [NegotiableQuoteTemplateHistoryEntry], + "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 123, - "min_order_commitment": 987, - "name": "xyz789", + "max_order_commitment": 987, + "min_order_commitment": 123, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": 4, - "total_quantity": 987.65 + "status": "xyz789", + "template_id": "4", + "total_quantity": 123.45, + "uid": 4, + "updated_at": "xyz789" } } } @@ -17408,10 +18173,14 @@
    Query
    comments { ...NegotiableQuoteCommentFragment } + created_at expiration_date history { ...NegotiableQuoteHistoryEntryFragment } + historyV2 { + ...NegotiableQuoteTemplateHistoryEntryFragment + } is_min_max_qty_used is_virtual items { @@ -17429,12 +18198,15 @@
    Query
    reference_document_links { ...NegotiableQuoteReferenceDocumentLinkFragment } + sales_rep_name shipping_addresses { ...NegotiableQuoteShippingAddressFragment } status template_id total_quantity + uid + updated_at }     }     @@ -17451,25 +18223,30 @@
    Response
    "submitNegotiableQuoteTemplateForReview": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], + "created_at": "xyz789", "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], + "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 123, - "name": "xyz789", + "max_order_commitment": 123, + "min_order_commitment": 987, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": "4", - "total_quantity": 123.45 + "template_id": 4, + "total_quantity": 123.45, + "uid": "4", + "updated_at": "abc123" } } } @@ -17604,7 +18381,7 @@
    Variables
    Response
    - 
    {"data": {"syncPaymentOrder": true}}
+                  
    {"data": {"syncPaymentOrder": false}}
    @@ -18044,9 +18821,16 @@
    Response
    Mutations
    -

    +

    updateCustomerAddress

    +
    +
    +
    +
    Use updateCustomerAddressV2 instead.
    +
    +
    +
    @@ -18133,7 +18917,7 @@
    Query
    Variables
    - 
    {"id": 987, "input": CustomerAddressInput}
+                  
    {"id": 123, "input": CustomerAddressInput}
    @@ -18141,23 +18925,23 @@
    Response
    {
   "data": {
     "updateCustomerAddress": {
-      "city": "xyz789",
+      "city": "abc123",
       "company": "xyz789",
       "country_code": "AF",
       "custom_attributesV2": [AttributeValueInterface],
       "default_billing": true,
       "default_shipping": true,
       "extension_attributes": [CustomerAddressAttribute],
-      "fax": "abc123",
+      "fax": "xyz789",
       "firstname": "xyz789",
       "id": 987,
       "lastname": "xyz789",
-      "middlename": "xyz789",
+      "middlename": "abc123",
       "postcode": "xyz789",
       "prefix": "abc123",
       "region": CustomerAddressRegion,
-      "region_id": 987,
-      "street": ["abc123"],
+      "region_id": 123,
+      "street": ["xyz789"],
       "suffix": "xyz789",
       "telephone": "abc123",
       "uid": 4,
@@ -18165,6 +18949,140 @@ 
    Response
    
     }
   }
 }
+
    +
    +
    + back to top +
    +
    +
    +
    + Mutations +
    +

    + updateCustomerAddressV2 +

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a CustomerAddress +

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

    Example

    +
    +
    Query
    + 
    mutation updateCustomerAddressV2(
+  $uid: ID!,
+  $input: CustomerAddressInput
+) {
+  updateCustomerAddressV2(
+    uid: $uid,
+    input: $input
+  ) {
+    city
+    company
+    country_code
+    custom_attributesV2 {
+      ...AttributeValueInterfaceFragment
+    }
+    default_billing
+    default_shipping
+    extension_attributes {
+      ...CustomerAddressAttributeFragment
+    }
+    fax
+    firstname
+    id
+    lastname
+    middlename
+    postcode
+    prefix
+    region {
+      ...CustomerAddressRegionFragment
+    }
+    region_id
+    street
+    suffix
+    telephone
+    uid
+    vat_id
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {
+  "uid": "4",
+  "input": CustomerAddressInput
+}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "updateCustomerAddressV2": {
+      "city": "xyz789",
+      "company": "xyz789",
+      "country_code": "AF",
+      "custom_attributesV2": [AttributeValueInterface],
+      "default_billing": false,
+      "default_shipping": true,
+      "extension_attributes": [CustomerAddressAttribute],
+      "fax": "xyz789",
+      "firstname": "xyz789",
+      "id": 123,
+      "lastname": "xyz789",
+      "middlename": "xyz789",
+      "postcode": "xyz789",
+      "prefix": "xyz789",
+      "region": CustomerAddressRegion,
+      "region_id": 987,
+      "street": ["abc123"],
+      "suffix": "xyz789",
+      "telephone": "abc123",
+      "uid": "4",
+      "vat_id": "abc123"
+    }
+  }
+}
    @@ -18482,7 +19400,7 @@
    Query
    Variables
    {
-  "giftRegistryUid": 4,
+  "giftRegistryUid": "4",
   "items": [UpdateGiftRegistryItemInput]
 }
    @@ -18572,7 +19490,7 @@
    Query
    Variables
    {
-  "giftRegistryUid": "4",
+  "giftRegistryUid": 4,
   "registrants": [UpdateGiftRegistryRegistrantInput]
 }
    @@ -18815,7 +19733,7 @@
    Query
    Variables
    {
-  "wishlistId": 4,
+  "wishlistId": "4",
   "wishlistItems": [WishlistItemUpdateInput]
 }
    @@ -18920,11 +19838,11 @@
    Response
    "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", "created_by": "xyz789", - "description": "xyz789", - "name": "abc123", + "description": "abc123", + "name": "xyz789", "status": "ENABLED", "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -19005,7 +19923,7 @@
    Query
    Variables
    {
-  "requisitionListUid": "4",
+  "requisitionListUid": 4,
   "input": UpdateRequisitionListInput
 }
    @@ -19095,7 +20013,7 @@
    Query
    Variables
    {
-  "requisitionListUid": "4",
+  "requisitionListUid": 4,
   "requisitionListItems": [
     UpdateRequisitionListItemsInput
   ]
@@ -19196,7 +20114,7 @@ 
    Query
    
                   
    Variables
    
                   
    {
   "wishlistId": 4,
-  "name": "xyz789",
+  "name": "abc123",
   "visibility": "PUBLIC"
 }
 
    
@@ -19206,8 +20124,8 @@ 
    Response
    
                   
    {
   "data": {
     "updateWishlist": {
-      "name": "abc123",
-      "uid": 4,
+      "name": "xyz789",
+      "uid": "4",
       "visibility": "PUBLIC"
     }
   }
@@ -19330,7 +20248,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"template_id": "4"}
+                  
    {"template_id": 4}
 
    
                 
    
               
    
@@ -19520,7 +20438,7 @@ 
    Example
    
     GiftRegistryDynamicAttributeInput
   ],
   "email": "xyz789",
-  "firstname": "xyz789",
+  "firstname": "abc123",
   "lastname": "xyz789"
 }
 
    
@@ -19657,7 +20575,10 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"products": ["4"], "uid": 4}
+                  
    {
+  "products": ["4"],
+  "uid": "4"
+}
 
    
                 
    
               
    
@@ -19841,7 +20762,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "comment": "abc123",
+  "comment": "xyz789",
   "purchase_order_uid": 4
 }
 
    
@@ -19937,9 +20858,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cart_id": "xyz789",
-  "purchase_order_uid": 4,
-  "replace_existing_cart_items": true
+  "cart_id": "abc123",
+  "purchase_order_uid": "4",
+  "replace_existing_cart_items": false
 }
 
    
                 
    
@@ -20248,7 +21169,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "carrier_uid": "4",
-  "return_uid": 4,
+  "return_uid": "4",
   "tracking_number": "abc123"
 }
 
    
@@ -20410,7 +21331,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "attribute": "abc123",
+  "attribute": "xyz789",
   "buckets": [Bucket],
   "title": "abc123",
   "type": "INTELLIGENT"
@@ -20543,13 +21464,13 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "button_styles": ButtonStyles,
-  "code": "abc123",
+  "code": "xyz789",
   "is_visible": true,
   "payment_intent": "abc123",
-  "payment_source": "xyz789",
+  "payment_source": "abc123",
   "sdk_params": [SDKParams],
-  "sort_order": "xyz789",
-  "title": "abc123"
+  "sort_order": "abc123",
+  "title": "xyz789"
 }
 
    
                 
    
@@ -20604,9 +21525,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "payment_source": "abc123",
+  "payment_source": "xyz789",
   "payments_order_id": "xyz789",
-  "paypal_order_id": "abc123"
+  "paypal_order_id": "xyz789"
 }
 
    
                 
    
@@ -20706,7 +21627,7 @@ 
    Example
    
   "applied_balance": Money,
   "code": "xyz789",
   "current_balance": Money,
-  "expiration_date": "abc123"
+  "expiration_date": "xyz789"
 }
    @@ -20759,7 +21680,7 @@
    Fields
    Example
    {
   "action_type": "BOOST",
-  "rule_id": "xyz789",
+  "rule_id": "abc123",
   "rule_name": "abc123"
 }
    @@ -20870,7 +21791,7 @@
    Example
    {
   "applied_balance": Money,
   "current_balance": Money,
-  "enabled": true
+  "enabled": false
 }
    @@ -20919,7 +21840,7 @@
    Fields
    Example
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "coupon_code": "xyz789"
 }
    @@ -21064,8 +21985,8 @@
    Fields
    Example
    {
-  "cart_id": "abc123",
-  "coupon_codes": ["xyz789"],
+  "cart_id": "xyz789",
+  "coupon_codes": ["abc123"],
   "type": "APPEND"
 }
    @@ -21115,8 +22036,8 @@
    Fields
    Example
    {
-  "cart_id": "xyz789",
-  "gift_card_code": "abc123"
+  "cart_id": "abc123",
+  "gift_card_code": "xyz789"
 }
    @@ -21204,7 +22125,7 @@
    Fields
    Example
    {
   "applied_balance": Money,
-  "code": "xyz789"
+  "code": "abc123"
 }
    @@ -21286,7 +22207,7 @@
    Fields
    Example
    - 
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}
    @@ -21373,7 +22294,7 @@
    Fields
    Example
    - 
    {"radius": 123, "search_term": "abc123"}
+                  
    {"radius": 123, "search_term": "xyz789"}
    @@ -21435,10 +22356,10 @@
    Fields
    Example
    {
   "asset_image": ProductMediaGalleryEntriesAssetImage,
-  "disabled": true,
+  "disabled": false,
   "label": "abc123",
-  "position": 987,
-  "url": "abc123"
+  "position": 123,
+  "url": "xyz789"
 }
    @@ -21504,7 +22425,7 @@
    Example
    "disabled": true, "label": "abc123", "position": 123, - "url": "abc123" + "url": "xyz789" }
    @@ -21550,7 +22471,7 @@
    Fields
    Example
    - 
    {"compare_list": CompareList, "result": true}
+                  
    {"compare_list": CompareList, "result": false}
    @@ -21644,15 +22565,25 @@
    Fields
    + + attribute_type - String + + Attribute type code. + code - ID! The attribute code. - url - String + url - String! - File URL to download the file + File URL to download the file. + + + value - String! + + File code. For file download use url field. @@ -21661,7 +22592,12 @@
    Fields
    Example
    - 
    {"code": 4, "url": "abc123"}
+                  
    {
+  "attribute_type": "xyz789",
+  "code": 4,
+  "url": "xyz789",
+  "value": "xyz789"
+}
    @@ -21769,17 +22705,17 @@
    Fields
    Example
    {
-  "is_comparable": false,
+  "is_comparable": true,
   "is_filterable": false,
   "is_filterable_in_search": true,
-  "is_html_allowed_on_front": false,
-  "is_searchable": false,
-  "is_used_for_customer_segment": false,
-  "is_used_for_price_rules": false,
+  "is_html_allowed_on_front": true,
+  "is_searchable": true,
+  "is_used_for_customer_segment": true,
+  "is_used_for_price_rules": true,
   "is_used_for_promo_rules": false,
-  "is_visible_in_advanced_search": false,
+  "is_visible_in_advanced_search": true,
   "is_visible_on_front": true,
-  "is_wysiwyg_enabled": false,
+  "is_wysiwyg_enabled": true,
   "used_in_product_listing": false
 }
    @@ -21929,6 +22865,62 @@
    Values
    Example
    "BOOLEAN"
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    AttributeImage

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    attribute_type - String + Attribute type code.
    code - ID! + The attribute code.
    url - String! + Image URL to download the image.
    value - String! + Image code. For image download use url field.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "attribute_type": "xyz789",
+  "code": "4",
+  "url": "abc123",
+  "value": "abc123"
+}
    @@ -21976,8 +22968,8 @@
    Fields
    Example
    {
-  "attribute_code": "abc123",
-  "entity_type": "abc123"
+  "attribute_code": "xyz789",
+  "entity_type": "xyz789"
 }
    @@ -22019,7 +23011,7 @@
    Fields
    Example
    - 
    {"value": "abc123"}
+                  
    {"value": "xyz789"}
    @@ -22100,14 +23092,14 @@
    Fields
    Example
    {
-  "code": 4,
+  "code": "4",
   "default_value": "abc123",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
   "is_required": false,
   "is_unique": false,
-  "label": "abc123",
+  "label": "xyz789",
   "options": [CustomAttributeOptionInterface]
 }
    @@ -22155,7 +23147,7 @@
    Fields
    Example
    {
-  "message": "abc123",
+  "message": "xyz789",
   "type": "ENTITY_NOT_FOUND"
 }
    @@ -22316,7 +23308,7 @@
    Fields
    Example
    {
   "is_default": false,
-  "label": "xyz789",
+  "label": "abc123",
   "value": "xyz789"
 }
    @@ -22422,7 +23414,7 @@
    Possible Types
    Example
    {
   "label": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
    @@ -22447,6 +23439,11 @@
    Fields
    + + attribute_type - String + + Attribute type code. + code - ID! @@ -22466,6 +23463,7 @@
    Fields
    Example
    {
+  "attribute_type": "xyz789",
   "code": "4",
   "selected_options": [AttributeSelectedOptionInterface]
 }
@@ -22492,6 +23490,11 @@ 
    Fields
    
                       
                     
                     
+                      
+                        attribute_type - String
+                        
+                         Attribute type code. 
+                      
                       
                         code - ID!
                         
@@ -22510,7 +23513,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "4",
+  "attribute_type": "xyz789",
+  "code": 4,
   "value": "abc123"
 }
 
    
@@ -22593,6 +23597,11 @@ 
    Fields
    
                       
                     
                     
+                      
+                        attribute_type - String
+                        
+                         Attribute type code. 
+                      
                       
                         code - ID!
                         
@@ -22615,6 +23624,11 @@ 
    Possible Types
    
                           
    AttributeFile
    
                         
                       
+                      
+                        
+                          
    AttributeImage
    
+                        
+                      
                       
                         
                           
    AttributeSelectedOptions
    
@@ -22632,7 +23646,10 @@ 
    Possible Types
    
               
    
                 
    
                   
    Example
    
-                  
    {"code": 4}
+                  
    {
+  "attribute_type": "xyz789",
+  "code": "4"
+}
 
    
                 
    
               
    
@@ -22773,7 +23790,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"code": "AFN", "symbol": "abc123"}
+                  
    {"code": "AFN", "symbol": "xyz789"}
 
    
                 
    
               
    
@@ -22829,10 +23846,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "abc123",
-  "is_deferred": true,
+  "code": "xyz789",
+  "is_deferred": false,
   "oope_payment_method_config": OopePaymentMethodConfig,
-  "title": "abc123"
+  "title": "xyz789"
 }
 
    
                 
    
@@ -22922,11 +23939,11 @@ 
    Example
    
   "additional_data": [ShippingAdditionalData],
   "amount": Money,
   "available": false,
-  "carrier_code": "xyz789",
+  "carrier_code": "abc123",
   "carrier_title": "abc123",
-  "error_message": "xyz789",
+  "error_message": "abc123",
   "method_code": "xyz789",
-  "method_title": "xyz789",
+  "method_title": "abc123",
   "price_excl_tax": Money,
   "price_incl_tax": Money
 }
@@ -23021,6 +24038,12 @@ 
    Fields
    
                         
                          An ID from the customer's address book that uniquely identifies the address to be used for billing. 
                       
+                      
+                        
+                          customer_address_uid - ID
+                        
+                         The unique ID from the customer's address book that uniquely identifies the address to be used for billing. 
+                      
                       
                         
                           same_as_shipping - Boolean
@@ -23043,8 +24066,9 @@ 
    Example
    
                   
    {
   "address": CartAddressInput,
   "customer_address_id": 123,
+  "customer_address_uid": 4,
   "same_as_shipping": true,
-  "use_for_shipping": false
+  "use_for_shipping": true
 }
 
    
                 
    
@@ -23117,12 +24141,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "address_line_1": "xyz789",
-  "address_line_2": "abc123",
-  "city": "abc123",
-  "country_code": "abc123",
-  "postal_code": "abc123",
-  "region": "xyz789"
+  "address_line_1": "abc123",
+  "address_line_2": "xyz789",
+  "city": "xyz789",
+  "country_code": "xyz789",
+  "postal_code": "xyz789",
+  "region": "abc123"
 }
 
    
                 
    
@@ -23171,6 +24195,11 @@ 
    Fields
    
                         
                          The custom attribute values of the billing or shipping address. 
                       
+                      
+                        customer_address_uid - ID
+                        
+                         The unique ID from the customer's address book that uniquely identifies the address. 
+                      
                       
                         fax - String
                         
@@ -23182,9 +24211,10 @@ 
    Fields
    
                          The first name of the customer or guest. 
                       
                       
-                        id - Int
+                        id - Int
+                        
+                         Id of the customer address. Use customer_address_uid instead.
                         
-                         Id of the customer address. 
                       
                       
                         lastname - String!
@@ -23227,9 +24257,9 @@ 
    Fields
    
                          The telephone number for the billing or shipping address. 
                       
                       
-                        uid - String!
+                        uid - ID!
                         
-                         The unique id of the customer address. 
+                         The unique id of the customer cart address. 
                       
                       
                         vat_id - String
@@ -23244,23 +24274,24 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "abc123",
+  "city": "xyz789",
   "company": "abc123",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "fax": "abc123",
-  "firstname": "abc123",
-  "id": 123,
-  "lastname": "xyz789",
+  "customer_address_uid": 4,
+  "fax": "xyz789",
+  "firstname": "xyz789",
+  "id": 987,
+  "lastname": "abc123",
   "middlename": "abc123",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "prefix": "xyz789",
   "region": CartAddressRegion,
   "street": ["abc123"],
-  "suffix": "xyz789",
-  "telephone": "xyz789",
-  "uid": "abc123",
-  "vat_id": "xyz789"
+  "suffix": "abc123",
+  "telephone": "abc123",
+  "uid": "4",
+  "vat_id": "abc123"
 }
 
    
                 
    
@@ -23281,6 +24312,11 @@ 
    Description
    +
    +
    Example
    + 
    true
+
    +
    back to top
    @@ -23340,9 +24376,9 @@
    Fields
    Example
    {
   "category_level": 987,
-  "category_name": "xyz789",
+  "category_name": "abc123",
   "category_uid": "4",
-  "category_url_key": "abc123",
+  "category_url_key": "xyz789",
   "category_url_path": "xyz789"
 }
    @@ -23556,15 +24592,15 @@
    Example
    "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": false, + "is_available": true, "max_qty": 123.45, - "min_qty": 123.45, + "min_qty": 987.65, "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": "4" }     @@ -23650,11 +24686,11 @@
    Example
    "bundle_options": [ItemSelectedBundleOption], "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_refunded": 123.45 }     @@ -23740,12 +24776,12 @@
    Example
    "bundle_options": [ItemSelectedBundleOption], "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 987.65 + "product_sku": "xyz789", + "quantity_invoiced": 123.45 }     @@ -23823,12 +24859,12 @@
    Fields
    Example
    {
   "options": [BundleItemOption],
-  "position": 123,
+  "position": 987,
   "price_range": PriceRange,
-  "required": false,
+  "required": true,
   "sku": "abc123",
   "title": "xyz789",
-  "type": "xyz789",
+  "type": "abc123",
   "uid": 4
 }
    @@ -23914,8 +24950,8 @@
    Example
    "can_change_quantity": true, "is_default": false, "label": "abc123", - "position": 987, - "price": 123.45, + "position": 123, + "price": 987.65, "price_type": "FIXED", "product": ProductInterface, "quantity": 123.45, @@ -24089,22 +25125,22 @@
    Example
    "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, - "parent_sku": "abc123", + "id": "4", + "parent_sku": "xyz789", "prices": OrderItemPrices, "product": ProductInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", - "product_type": "xyz789", - "product_url_key": "abc123", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, + "product_sku": "abc123", + "product_type": "abc123", + "product_url_key": "xyz789", + "quantity_canceled": 123.45, + "quantity_invoiced": 123.45, "quantity_ordered": 987.65, "quantity_refunded": 123.45, "quantity_return_requested": 987.65, - "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_returned": 123.45, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "abc123" } @@ -24402,25 +25438,25 @@
    Example
    "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "dynamic_price": true, + "dynamic_price": false, "dynamic_sku": false, - "dynamic_weight": false, - "gift_message_available": true, + "dynamic_weight": true, + "gift_message_available": false, "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", "items": [BundleItem], - "manufacturer": 987, + "manufacturer": 123, "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "meta_description": "xyz789", - "meta_keyword": "xyz789", + "meta_keyword": "abc123", "meta_title": "xyz789", - "min_sale_qty": 987.65, - "name": "abc123", + "min_sale_qty": 123.45, + "name": "xyz789", "new_from_date": "abc123", - "new_to_date": "xyz789", + "new_to_date": "abc123", "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "xyz789", @@ -24429,20 +25465,20 @@
    Example
    "price_tiers": [TierPrice], "price_view": "PRICE_RANGE", "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, "related_products": [ProductInterface], "ship_bundle_items": "TOGETHER", "short_description": ComplexTextValue, "sku": "abc123", "small_image": ProductImage, "special_price": 987.65, - "special_to_date": "xyz789", + "special_to_date": "abc123", "stock_status": "IN_STOCK", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, - "uid": 4, + "uid": "4", "upsell_products": [ProductInterface], - "url_key": "abc123", + "url_key": "xyz789", "weight": 123.45 }     @@ -24508,8 +25544,8 @@
    Example
    "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, - "uid": 4 + "quantity": 123.45, + "uid": "4" } @@ -24582,11 +25618,11 @@
    Fields
    Example
    {
   "bundle_options": [ItemSelectedBundleOption],
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
+  "product_sku": "abc123",
   "quantity_shipped": 123.45
 }
    @@ -24663,10 +25699,10 @@
    Example
    "added_at": "xyz789", "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", + "description": "abc123", + "id": 4, "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } @@ -24734,12 +25770,12 @@
    Fields
    Example
    {
-  "color": "xyz789",
-  "height": 987,
-  "label": "xyz789",
-  "layout": "xyz789",
-  "shape": "xyz789",
-  "tagline": true,
+  "color": "abc123",
+  "height": 123,
+  "label": "abc123",
+  "layout": "abc123",
+  "shape": "abc123",
+  "tagline": false,
   "use_default_height": true
 }
    @@ -24789,7 +25825,7 @@
    Fields
    Example
    {
-  "cancellation_comment": "xyz789",
+  "cancellation_comment": "abc123",
   "template_id": "4"
 }
    @@ -25047,7 +26083,7 @@
    Fields
    Example
    - 
    {"description": "xyz789"}
+                  
    {"description": "abc123"}
    @@ -25107,8 +26143,8 @@
    Example
    "bin_details": CardBin, "card_expiry_month": "abc123", "card_expiry_year": "xyz789", - "last_digits": "xyz789", - "name": "xyz789" + "last_digits": "abc123", + "name": "abc123" }
    @@ -25194,7 +26230,7 @@
    Fields
    Example
    {
   "billing_address": BillingAddressPaymentSourceInput,
-  "name": "xyz789"
+  "name": "abc123"
 }
    @@ -25246,8 +26282,8 @@
    Fields
    Example
    {
-  "brand": "xyz789",
-  "expiry": "xyz789",
+  "brand": "abc123",
+  "expiry": "abc123",
   "last_digits": "abc123"
 }
    @@ -25420,19 +26456,19 @@
    Example
    "available_payment_methods": [AvailablePaymentMethod], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": 4, - "is_virtual": false, + "is_virtual": true, "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, + "printed_card_included": false, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 }
    @@ -25619,19 +26655,19 @@
    Fields
    Example
    {
-  "city": "abc123",
+  "city": "xyz789",
   "company": "abc123",
   "country_code": "abc123",
   "custom_attributes": [AttributeValueInput],
   "fax": "abc123",
   "firstname": "abc123",
-  "lastname": "abc123",
+  "lastname": "xyz789",
   "middlename": "abc123",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "prefix": "abc123",
-  "region": "abc123",
-  "region_id": 123,
-  "save_in_address_book": false,
+  "region": "xyz789",
+  "region_id": 987,
+  "save_in_address_book": true,
   "street": ["xyz789"],
   "suffix": "xyz789",
   "telephone": "abc123",
@@ -25680,6 +26716,11 @@ 
    Fields
    
                         
                          The custom attribute values of the billing or shipping address. 
                       
+                      
+                        customer_address_uid - ID
+                        
+                         The unique ID from the customer's address book that uniquely identifies the address. 
+                      
                       
                         fax - String
                         
@@ -25691,9 +26732,10 @@ 
    Fields
    
                          The first name of the customer or guest. 
                       
                       
-                        id - Int
+                        id - Int
+                        
+                         Id of the customer address. Use customer_address_uid instead.
                         
-                         Id of the customer address. 
                       
                       
                         lastname - String!
@@ -25736,9 +26778,9 @@ 
    Fields
    
                          The telephone number for the billing or shipping address. 
                       
                       
-                        uid - String!
+                        uid - ID!
                         
-                         The unique id of the customer address. 
+                         The unique id of the customer cart address. 
                       
                       
                         vat_id - String
@@ -25779,18 +26821,19 @@ 
    Example
    
   "company": "xyz789",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "fax": "xyz789",
+  "customer_address_uid": "4",
+  "fax": "abc123",
   "firstname": "xyz789",
   "id": 123,
   "lastname": "xyz789",
-  "middlename": "xyz789",
+  "middlename": "abc123",
   "postcode": "abc123",
   "prefix": "xyz789",
   "region": CartAddressRegion,
-  "street": ["xyz789"],
-  "suffix": "xyz789",
+  "street": ["abc123"],
+  "suffix": "abc123",
   "telephone": "xyz789",
-  "uid": "xyz789",
+  "uid": 4,
   "vat_id": "abc123"
 }
    @@ -25844,8 +26887,8 @@
    Fields
    Example
    {
   "code": "xyz789",
-  "label": "abc123",
-  "region_id": 987
+  "label": "xyz789",
+  "region_id": 123
 }
    @@ -25894,7 +26937,7 @@
    Fields
    Example
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "custom_attributes": [CustomAttributeInput]
 }
    @@ -25995,8 +27038,8 @@
    Fields
    Example
    {
-  "cart_id": "xyz789",
-  "cart_item_id": "abc123",
+  "cart_id": "abc123",
+  "cart_item_id": "xyz789",
   "custom_attributes": [CustomAttributeInput]
 }
    @@ -26158,10 +27201,10 @@
    Fields
    Example
    {
   "entered_options": [EnteredOptionInput],
-  "parent_sku": "xyz789",
-  "quantity": 123.45,
-  "selected_options": ["4"],
-  "sku": "abc123"
+  "parent_sku": "abc123",
+  "quantity": 987.65,
+  "selected_options": [4],
+  "sku": "xyz789"
 }
    @@ -26310,15 +27353,15 @@
    Example
    "discount": [Discount], "errors": [CartItemError], "is_available": false, - "max_qty": 987.65, + "max_qty": 123.45, "min_qty": 123.45, "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, - "uid": 4 + "quantity": 123.45, + "uid": "4" }
    @@ -26541,7 +27584,7 @@
    Fields
    Example
    {
-  "cart_item_uid": "4",
+  "cart_item_uid": 4,
   "customizable_options": [CustomizableOptionInput],
   "gift_message": GiftMessageInput,
   "gift_wrapping_id": 4,
@@ -26595,7 +27638,7 @@ 
    Example
    
                   
    {
   "items": [CartItemInterface],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
    @@ -26716,7 +27759,7 @@
    Fields
    Example
    - 
    {"uid": "4"}
+                  
    {"uid": 4}
    @@ -27133,28 +28176,28 @@
    Example
    {
   "apply_to": ["SIMPLE"],
   "code": "4",
-  "default_value": "xyz789",
+  "default_value": "abc123",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "abc123",
+  "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
   "is_comparable": false,
-  "is_filterable": true,
+  "is_filterable": false,
   "is_filterable_in_search": true,
   "is_html_allowed_on_front": false,
-  "is_required": false,
-  "is_searchable": false,
-  "is_unique": true,
-  "is_used_for_price_rules": false,
-  "is_used_for_promo_rules": true,
+  "is_required": true,
+  "is_searchable": true,
+  "is_unique": false,
+  "is_used_for_price_rules": true,
+  "is_used_for_promo_rules": false,
   "is_visible_in_advanced_search": false,
   "is_visible_on_front": true,
-  "is_wysiwyg_enabled": true,
-  "label": "xyz789",
+  "is_wysiwyg_enabled": false,
+  "label": "abc123",
   "options": [CustomAttributeOptionInterface],
   "swatch_input_type": "BOOLEAN",
   "update_product_preview_image": true,
-  "use_product_image_for_swatch": true,
-  "used_in_product_listing": false
+  "use_product_image_for_swatch": false,
+  "used_in_product_listing": true
 }
    @@ -27215,7 +28258,7 @@
    Fields
    Example
    {
-  "count": 987,
+  "count": 123,
   "id": "4",
   "path": "xyz789",
   "title": "xyz789"
@@ -27273,7 +28316,7 @@ 
    Possible Types
    
               
    
                 
    
                   
    Example
    
-                  
    {"id": 4}
+                  
    {"id": "4"}
 
    
                 
    
               
    
@@ -27466,28 +28509,81 @@ 
    Example
    
   "available_sort_by": ["abc123"],
   "breadcrumbs": [Breadcrumb],
   "canonical_url": "xyz789",
-  "children_count": "xyz789",
-  "custom_layout_update_file": "abc123",
+  "children_count": "abc123",
+  "custom_layout_update_file": "xyz789",
   "default_sort_by": "abc123",
-  "description": "abc123",
+  "description": "xyz789",
   "display_mode": "xyz789",
-  "filter_price_range": 987.65,
+  "filter_price_range": 123.45,
   "image": "abc123",
-  "include_in_menu": 123,
-  "is_anchor": 987,
+  "include_in_menu": 987,
+  "is_anchor": 123,
   "landing_page": 123,
-  "level": 123,
-  "meta_description": "abc123",
+  "level": 987,
+  "meta_description": "xyz789",
   "meta_keywords": "xyz789",
   "meta_title": "abc123",
-  "name": "xyz789",
+  "name": "abc123",
   "path": "abc123",
   "path_in_store": "xyz789",
   "position": 987,
-  "product_count": 123,
+  "product_count": 987,
   "uid": "4",
   "url_key": "xyz789",
-  "url_path": "xyz789"
+  "url_path": "abc123"
+}
+
    +
    + + back to top + +
    +
    +
    + Types +
    +

    CategoryNavigationView

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    slug - String! + +
    name - String! + +
    children - [CategoryNavigationView] + +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "slug": "abc123",
+  "name": "abc123",
+  "children": [CategoryNavigationView]
 }
    @@ -27663,30 +28759,97 @@
    Example
    {
   "available_sort_by": ["xyz789"],
   "breadcrumbs": [Breadcrumb],
-  "canonical_url": "xyz789",
+  "canonical_url": "abc123",
   "children_count": "abc123",
   "custom_layout_update_file": "abc123",
-  "default_sort_by": "abc123",
+  "default_sort_by": "xyz789",
   "description": "xyz789",
-  "display_mode": "xyz789",
+  "display_mode": "abc123",
   "filter_price_range": 123.45,
-  "image": "abc123",
+  "image": "xyz789",
   "include_in_menu": 987,
-  "is_anchor": 123,
-  "landing_page": 123,
-  "level": 123,
-  "meta_description": "abc123",
-  "meta_keywords": "xyz789",
-  "meta_title": "abc123",
+  "is_anchor": 987,
+  "landing_page": 987,
+  "level": 987,
+  "meta_description": "xyz789",
+  "meta_keywords": "abc123",
+  "meta_title": "xyz789",
   "name": "xyz789",
   "path": "xyz789",
   "path_in_store": "abc123",
   "position": 123,
-  "product_count": 987,
-  "uid": "4",
-  "url_key": "abc123",
+  "product_count": 123,
+  "uid": 4,
+  "url_key": "xyz789",
   "url_path": "abc123"
 }
+
    +
    +
    + back to top + +
    +
    +
    + Types +
    +

    CategoryTreeView

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    slug - String! + +
    name - String! + +
    level - Int + +
    parentSlug - String + +
    childrenSlugs - [String] + +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "slug": "abc123",
+  "name": "xyz789",
+  "level": 987,
+  "parentSlug": "abc123",
+  "childrenSlugs": ["xyz789"]
+}
    @@ -27804,19 +28967,19 @@
    Fields
    Example
    {
-  "availableSortBy": ["abc123"],
+  "availableSortBy": ["xyz789"],
   "children": ["abc123"],
-  "defaultSortBy": "xyz789",
+  "defaultSortBy": "abc123",
   "id": "4",
-  "level": 123,
-  "name": "xyz789",
+  "level": 987,
+  "name": "abc123",
   "parentId": "xyz789",
   "path": "xyz789",
-  "roles": ["xyz789"],
-  "urlKey": "xyz789",
-  "urlPath": "abc123",
+  "roles": ["abc123"],
+  "urlKey": "abc123",
+  "urlPath": "xyz789",
   "count": 123,
-  "title": "abc123"
+  "title": "xyz789"
 }
    @@ -27922,14 +29085,82 @@
    Possible Types
    Example
    {
   "availableSortBy": ["abc123"],
-  "defaultSortBy": "abc123",
-  "id": "4",
+  "defaultSortBy": "xyz789",
+  "id": 4,
   "level": 987,
-  "name": "xyz789",
-  "path": "abc123",
+  "name": "abc123",
+  "path": "xyz789",
   "roles": ["xyz789"],
   "urlKey": "abc123",
-  "urlPath": "abc123"
+  "urlPath": "xyz789"
+}
+
    +
    + + back to top + +
    +
    +
    + Types +
    +

    CategoryViewV2

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    slug - String! + +
    name - String! + +
    +
    +
    +
    Possible Types
    + + + + + + + + + + + + + + +
    CategoryViewV2 Types
    +

    CategoryNavigationView

    +
    +

    CategoryTreeView

    +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "slug": "xyz789",
+  "name": "abc123"
 }
    @@ -28001,10 +29232,10 @@
    Fields
    Example
    {
-  "agreement_id": 987,
+  "agreement_id": 123,
   "checkbox_text": "xyz789",
-  "content": "xyz789",
-  "content_height": "xyz789",
+  "content": "abc123",
+  "content_height": "abc123",
   "is_html": true,
   "mode": "AUTO",
   "name": "abc123"
@@ -28220,7 +29451,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"cart": Cart, "status": false}
+                  
    {"cart": Cart, "status": true}
 
    
                 
    
               
    
@@ -28394,7 +29625,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"quote_uids": [4]}
+                  
    {"quote_uids": ["4"]}
 
    
                 
    
               
    
@@ -28515,7 +29746,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"value": "abc123"}
+                  
    {"value": "xyz789"}
 
    
                 
    
               
    
@@ -28769,6 +30000,11 @@ 
    currentPage
                          An object containing information about the company sales representative. 
                       
+                      
+                        status - CompanyStatusEnum
+                        
+                         The current status of the company. 
+                      
                       
                         structure - CompanyStructure
                         
@@ -28883,18 +30119,19 @@ 
    Example
    
   "email": "abc123",
   "id": "4",
   "legal_address": CompanyLegalAddress,
-  "legal_name": "abc123",
-  "name": "abc123",
+  "legal_name": "xyz789",
+  "name": "xyz789",
   "payment_methods": ["abc123"],
-  "reseller_id": "abc123",
+  "reseller_id": "xyz789",
   "role": CompanyRole,
   "roles": CompanyRoles,
   "sales_representative": CompanySalesRepresentative,
+  "status": "PENDING",
   "structure": CompanyStructure,
   "team": CompanyTeam,
   "user": Customer,
   "users": CompanyUsers,
-  "vat_tax_id": "abc123"
+  "vat_tax_id": "xyz789"
 }
    @@ -28953,8 +30190,8 @@
    Example
    {
   "children": [CompanyAclResource],
   "id": "4",
-  "sort_order": 987,
-  "text": "abc123"
+  "sort_order": 123,
+  "text": "xyz789"
 }
    @@ -29035,10 +30272,10 @@
    Example
    {
   "custom_attributes": [AttributeValueInput],
   "email": "abc123",
-  "firstname": "abc123",
-  "gender": 987,
-  "job_title": "abc123",
-  "lastname": "abc123",
+  "firstname": "xyz789",
+  "gender": 123,
+  "job_title": "xyz789",
+  "lastname": "xyz789",
   "telephone": "abc123"
 }
    @@ -29133,6 +30370,11 @@
    Fields
    The name of the company. + + status - CompanyStatusEnum + + The current status of the company. +
    @@ -29142,8 +30384,9 @@
    Fields
    Example
    {
   "id": 4,
-  "legal_name": "xyz789",
-  "name": "xyz789"
+  "legal_name": "abc123",
+  "name": "abc123",
+  "status": "PENDING"
 }
    @@ -29224,10 +30467,10 @@
    Example
    {
   "company_admin": CompanyAdminInput,
   "company_email": "xyz789",
-  "company_name": "xyz789",
+  "company_name": "abc123",
   "legal_address": CompanyLegalAddressCreateInput,
   "legal_name": "abc123",
-  "reseller_id": "xyz789",
+  "reseller_id": "abc123",
   "vat_tax_id": "abc123"
 }
    @@ -29267,6 +30510,11 @@
    Fields
    The amount of credit extended to the company. + + exceed_limit - Boolean! + + Indicates whether company credit functionality is allowed to exceed current company credit limit. + outstanding_balance - Money! @@ -29282,6 +30530,7 @@
    Example
    {
   "available_credit": Money,
   "credit_limit": Money,
+  "exceed_limit": true,
   "outstanding_balance": Money
 }
    @@ -29462,7 +30711,7 @@
    Example
    {
   "amount": Money,
   "balance": CompanyCredit,
-  "custom_reference_number": "abc123",
+  "custom_reference_number": "xyz789",
   "date": "xyz789",
   "type": "ALLOCATION",
   "updated_by": CompanyCreditOperationUser
@@ -29684,7 +30933,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "xyz789",
-  "role_id": "4",
+  "role_id": 4,
   "user": CompanyInvitationUserInput
 }
 
    
@@ -29726,7 +30975,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"success": false}
+                  
    {"success": true}
 
    
                 
    
               
    
@@ -29796,7 +31045,7 @@ 
    Example
    
   "customer_id": "4",
   "job_title": "xyz789",
   "status": "ACTIVE",
-  "telephone": "xyz789"
+  "telephone": "abc123"
 }
    @@ -29865,7 +31114,7 @@
    Example
    {
   "city": "abc123",
   "country_code": "AF",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "region": CustomerAddressRegion,
   "street": ["abc123"],
   "telephone": "abc123"
@@ -29941,11 +31190,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "abc123",
+  "city": "xyz789",
   "country_id": "AF",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "region": CustomerAddressRegionInput,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "telephone": "abc123"
 }
 
    
@@ -30024,7 +31273,7 @@ 
    Example
    
   "postcode": "xyz789",
   "region": CustomerAddressRegionInput,
   "street": ["abc123"],
-  "telephone": "xyz789"
+  "telephone": "abc123"
 }
    @@ -30081,10 +31330,10 @@
    Fields
    Example
    {
-  "id": 4,
-  "name": "abc123",
+  "id": "4",
+  "name": "xyz789",
   "permissions": [CompanyAclResource],
-  "users_count": 987
+  "users_count": 123
 }
    @@ -30121,7 +31370,7 @@
    Fields
    - permissions - [String]! + permissions - [String] A list of resources the role can access. @@ -30245,7 +31494,7 @@
    Example
    {
   "items": [CompanyRole],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
    @@ -30297,10 +31546,69 @@
    Fields
    Example
    {
-  "email": "abc123",
-  "firstname": "xyz789",
+  "email": "xyz789",
+  "firstname": "abc123",
   "lastname": "xyz789"
 }
+
    +
    + + back to top + +
    +
    +
    + Types +
    +

    CompanyStatusEnum

    +
    +
    +
    +
    Description
    +

    Defines the list of company status values.

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

    PENDING

    +     		Company is pending approval.
    +

    APPROVED

    +     		Company is approved.
    +

    REJECTED

    +     		Company is rejected.
    +

    BLOCKED

    +     		Company is blocked.
    +
    +
    +
    +
    +
    Example
    + 
    "PENDING"
    @@ -30433,7 +31741,7 @@
    Example
    {
   "entity": CompanyTeam,
   "id": "4",
-  "parent_id": "4"
+  "parent_id": 4
 }
    @@ -30481,10 +31789,7 @@
    Fields
    Example
    - 
    {
-  "parent_tree_id": "4",
-  "tree_id": "4"
-}
+                  
    {"parent_tree_id": "4", "tree_id": 4}
    @@ -30518,7 +31823,7 @@
    Fields
    An optional description of the team. - id - ID! + id - ID The unique ID for a CompanyTeam object. @@ -30541,7 +31846,7 @@
    Fields
    Example
    {
   "description": "xyz789",
-  "id": "4",
+  "id": 4,
   "name": "xyz789",
   "structure_id": "4"
 }
@@ -30598,9 +31903,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "description": "xyz789",
-  "name": "xyz789",
-  "target_id": "4"
+  "description": "abc123",
+  "name": "abc123",
+  "target_id": 4
 }
 
    
                 
    
@@ -30655,8 +31960,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "description": "abc123",
-  "id": "4",
+  "description": "xyz789",
+  "id": 4,
   "name": "abc123"
 }
 
    
@@ -30823,8 +32128,8 @@ 
    Example
    
   "email": "xyz789",
   "firstname": "abc123",
   "job_title": "abc123",
-  "lastname": "xyz789",
-  "role_id": 4,
+  "lastname": "abc123",
+  "role_id": "4",
   "status": "ACTIVE",
   "target_id": 4,
   "telephone": "xyz789"
@@ -30959,14 +32264,14 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "email": "xyz789",
-  "firstname": "xyz789",
-  "id": "4",
-  "job_title": "abc123",
+  "email": "abc123",
+  "firstname": "abc123",
+  "id": 4,
+  "job_title": "xyz789",
   "lastname": "xyz789",
-  "role_id": 4,
+  "role_id": "4",
   "status": "ACTIVE",
-  "telephone": "abc123"
+  "telephone": "xyz789"
 }
 
    
                 
    
@@ -31020,7 +32325,7 @@ 
    Example
    
                   
    {
   "items": [Customer],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
    
                 
    
@@ -31108,8 +32413,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "abc123",
-  "label": "abc123"
+  "code": "xyz789",
+  "label": "xyz789"
 }
 
    
                 
    
@@ -31164,7 +32469,7 @@ 
    Example
    
                   
    {
   "attributes": [ProductAttribute],
   "product": ProductInterface,
-  "uid": "4"
+  "uid": 4
 }
 
    
                 
@@ -31273,8 +32578,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cartId": "abc123",
-  "id": "xyz789"
+  "cartId": "xyz789",
+  "id": "abc123"
 }
 
    
                 
    
@@ -31324,7 +32629,7 @@ 
    Fields
    
                       
                         attributes - [ProductViewAttribute]
                         
-                         A list of merchant-defined attributes designated for the storefront. 
+                         A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names. 
                       
                       
                         
@@ -31335,6 +32640,10 @@ 
     Arguments 
    
                                 
    roles - [String]
                                 
    
                               
+                              
    
+                                
    names - [String]
+                                
    
+                              
    
                             
                           
                         
@@ -31476,30 +32785,30 @@ 
    linkTypes
                   
    Example
    
                   
    {
-  "addToCartAllowed": true,
+  "addToCartAllowed": false,
   "inStock": false,
   "lowStock": true,
   "attributes": [ProductViewAttribute],
-  "description": "abc123",
+  "description": "xyz789",
   "id": "4",
   "images": [ProductViewImage],
   "videos": [ProductViewVideo],
   "lastModifiedAt": "2007-12-03T10:15:30Z",
   "metaDescription": "xyz789",
-  "metaKeyword": "abc123",
-  "metaTitle": "abc123",
+  "metaKeyword": "xyz789",
+  "metaTitle": "xyz789",
   "name": "xyz789",
   "inputOptions": [ProductViewInputOption],
   "options": [ProductViewOption],
   "priceRange": ProductViewPriceRange,
   "shortDescription": "abc123",
-  "sku": "xyz789",
-  "externalId": "abc123",
+  "sku": "abc123",
+  "externalId": "xyz789",
   "url": "abc123",
-  "urlKey": "xyz789",
+  "urlKey": "abc123",
   "links": [ProductViewLink],
-  "queryType": "xyz789",
-  "visibility": "abc123"
+  "queryType": "abc123",
+  "visibility": "xyz789"
 }
 
    
                 
@@ -31536,7 +32845,63 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"html": "abc123"}
+                  
    {"html": "xyz789"}
+
    
+                
    
+              
    
+              back to top
+            
+
    +
    +
    + Types +
    +

    ConditionInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + field - Field + +
    + operator - OperatorInput + +
    + enabled - Boolean + +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "field": "UNKNOWN_FIELD",
+  "operator": OperatorInput,
+  "enabled": true
+}
    @@ -31592,10 +32957,10 @@
    Fields
    Example
    {
-  "code": "abc123",
-  "label": "xyz789",
+  "code": "xyz789",
+  "label": "abc123",
   "uid": "4",
-  "value_index": 123
+  "value_index": 987
 }
    @@ -31738,15 +33103,15 @@
    Example
    "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "is_available": true, - "max_qty": 987.65, + "max_qty": 123.45, "min_qty": 987.65, - "not_available_message": "abc123", + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, - "uid": "4" + "quantity": 987.65, + "uid": 4 }
    @@ -31950,7 +33315,7 @@
    Example
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
-  "eligible_for_return": true,
+  "eligible_for_return": false,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
@@ -31958,18 +33323,18 @@ 
    Example
    
   "parent_sku": "abc123",
   "prices": OrderItemPrices,
   "product": ProductInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "abc123",
   "product_type": "abc123",
   "product_url_key": "xyz789",
-  "quantity_canceled": 123.45,
+  "quantity_canceled": 987.65,
   "quantity_invoiced": 123.45,
-  "quantity_ordered": 123.45,
+  "quantity_ordered": 987.65,
   "quantity_refunded": 987.65,
   "quantity_return_requested": 987.65,
-  "quantity_returned": 123.45,
-  "quantity_shipped": 987.65,
+  "quantity_returned": 987.65,
+  "quantity_shipped": 123.45,
   "selected_options": [OrderItemOption],
   "status": "xyz789"
 }
@@ -32258,46 +33623,46 @@ 
    Example
    
   "categories": [CategoryInterface],
   "configurable_options": [ConfigurableProductOptions],
   "configurable_product_options_selection": ConfigurableProductOptionsSelection,
-  "country_of_manufacture": "abc123",
+  "country_of_manufacture": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "gift_message_available": false,
-  "gift_wrapping_available": false,
+  "gift_wrapping_available": true,
   "gift_wrapping_price": Money,
   "image": ProductImage,
-  "is_returnable": "xyz789",
-  "manufacturer": 987,
-  "max_sale_qty": 123.45,
+  "is_returnable": "abc123",
+  "manufacturer": 123,
+  "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
-  "meta_description": "abc123",
+  "meta_description": "xyz789",
   "meta_keyword": "xyz789",
   "meta_title": "abc123",
   "min_sale_qty": 987.65,
-  "name": "abc123",
+  "name": "xyz789",
   "new_from_date": "abc123",
   "new_to_date": "abc123",
-  "only_x_left_in_stock": 123.45,
+  "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
-  "options_container": "xyz789",
+  "options_container": "abc123",
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "quantity": 123.45,
+  "quantity": 987.65,
   "related_products": [ProductInterface],
   "short_description": ComplexTextValue,
   "sku": "xyz789",
   "small_image": ProductImage,
   "special_price": 123.45,
-  "special_to_date": "xyz789",
+  "special_to_date": "abc123",
   "stock_status": "IN_STOCK",
-  "swatch_image": "abc123",
+  "swatch_image": "xyz789",
   "thumbnail": ProductImage,
   "uid": 4,
   "upsell_products": [ProductInterface],
-  "url_key": "abc123",
+  "url_key": "xyz789",
   "variants": [ConfigurableVariant],
-  "weight": 987.65
+  "weight": 123.45
 }
    @@ -32354,9 +33719,9 @@
    Fields
    Example
    {
-  "attribute_code": "abc123",
+  "attribute_code": "xyz789",
   "label": "xyz789",
-  "uid": "4",
+  "uid": 4,
   "values": [ConfigurableProductOptionValue]
 }
    @@ -32419,11 +33784,11 @@
    Fields
    Example
    {
-  "is_available": false,
-  "is_use_default": true,
+  "is_available": true,
+  "is_use_default": false,
   "label": "abc123",
   "swatch": SwatchDataInterface,
-  "uid": 4
+  "uid": "4"
 }
    @@ -32497,9 +33862,9 @@
    Example
    {
   "attribute_code": "xyz789",
   "attribute_uid": 4,
-  "label": "abc123",
+  "label": "xyz789",
   "position": 123,
-  "uid": 4,
+  "uid": "4",
   "use_default": true,
   "values": [ConfigurableProductOptionsValues]
 }
@@ -32634,7 +33999,7 @@ 
    Example
    
   "label": "xyz789",
   "store_label": "xyz789",
   "swatch_data": SwatchDataInterface,
-  "uid": 4,
+  "uid": "4",
   "use_default_value": true
 }
    @@ -32700,7 +34065,7 @@
    Example
    "configurable_options": [SelectedConfigurableOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": 4 }     @@ -32831,8 +34196,8 @@
    Example
    "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", + "description": "abc123", + "id": 4, "product": ProductInterface, "quantity": 123.45 } @@ -32879,8 +34244,8 @@
    Fields
    Example
    {
-  "confirmation_key": "xyz789",
-  "order_id": 4
+  "confirmation_key": "abc123",
+  "order_id": "4"
 }
    @@ -32930,7 +34295,7 @@
    Fields
    Example
    {
   "confirmation_key": "xyz789",
-  "email": "abc123"
+  "email": "xyz789"
 }
    @@ -33082,8 +34447,8 @@
    Example
    {
   "comment": "abc123",
   "email": "xyz789",
-  "name": "xyz789",
-  "telephone": "xyz789"
+  "name": "abc123",
+  "telephone": "abc123"
 }
    @@ -33124,7 +34489,7 @@
    Fields
    Example
    - 
    {"status": false}
+                  
    {"status": true}
    @@ -33165,7 +34530,7 @@
    Fields
    Example
    - 
    {"requisitionListItemUids": ["4"]}
+                  
    {"requisitionListItemUids": [4]}
    @@ -33322,11 +34687,11 @@
    Fields
    Example
    {
   "available_regions": [Region],
-  "full_name_english": "abc123",
+  "full_name_english": "xyz789",
   "full_name_locale": "xyz789",
-  "id": "abc123",
-  "three_letter_abbreviation": "xyz789",
-  "two_letter_abbreviation": "abc123"
+  "id": "xyz789",
+  "three_letter_abbreviation": "abc123",
+  "two_letter_abbreviation": "xyz789"
 }
    @@ -35121,7 +36486,7 @@
    Example
    GiftRegistryDynamicAttributeInput ], "event_name": "xyz789", - "gift_registry_type_uid": 4, + "gift_registry_type_uid": "4", "message": "abc123", "privacy_settings": "PRIVATE", "registrants": [AddGiftRegistryRegistrantInput], @@ -35306,10 +36671,10 @@
    Fields
    Example
    {
-  "cartId": "abc123",
+  "cartId": "xyz789",
   "location": "PRODUCT_DETAIL",
   "methodCode": "abc123",
-  "paymentSource": "abc123",
+  "paymentSource": "xyz789",
   "vaultIntent": false
 }
    @@ -35372,9 +36737,9 @@
    Fields
    Example
    {
-  "amount": 987.65,
-  "currency_code": "xyz789",
-  "id": "abc123",
+  "amount": 123.45,
+  "currency_code": "abc123",
+  "id": "xyz789",
   "mp_order_id": "xyz789",
   "status": "xyz789"
 }
@@ -35424,7 +36789,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"currency": "AFN", "value": 987.65}
+                  
    {"currency": "AFN", "value": 123.45}
 
    
                 
    
               
    
@@ -35536,7 +36901,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "description": "xyz789",
+  "description": "abc123",
   "name": "xyz789"
 }
 
    
@@ -35675,7 +37040,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "payment_source": PaymentSourceOutput,
-  "vault_token_id": "abc123"
+  "vault_token_id": "xyz789"
 }
 
    
                 
    
@@ -35766,7 +37131,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"setup_token": "abc123"}
+                  
    {"setup_token": "xyz789"}
 
    
                 
    
               
    
@@ -35813,7 +37178,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"name": "abc123", "visibility": "PUBLIC"}
+                  
    {"name": "xyz789", "visibility": "PUBLIC"}
 
    
                 
    
               
    
@@ -35923,7 +37288,7 @@ 
    Example
    
   "custom_attributes": [CustomAttribute],
   "id": 4,
   "items": [CreditMemoItemInterface],
-  "number": "xyz789",
+  "number": "abc123",
   "total": CreditMemoTotal
 }
    @@ -35973,7 +37338,7 @@
    Fields
    Example
    {
-  "credit_memo_id": "xyz789",
+  "credit_memo_id": "abc123",
   "custom_attributes": [CustomAttributeInput]
 }
    @@ -36053,8 +37418,8 @@
    Example
    "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 123.45 + "product_sku": "xyz789", + "quantity_refunded": 987.65 }
    @@ -36109,8 +37474,8 @@
    Fields
    Example
    {
-  "credit_memo_id": "abc123",
-  "credit_memo_item_id": "xyz789",
+  "credit_memo_id": "xyz789",
+  "credit_memo_item_id": "abc123",
   "custom_attributes": [CustomAttributeInput]
 }
    @@ -36224,7 +37589,7 @@
    Example
    "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", "quantity_refunded": 123.45 @@ -36424,7 +37789,7 @@
    Example
    "base_currency_code": "xyz789", "base_currency_symbol": "xyz789", "default_display_currency_code": "abc123", - "default_display_currency_symbol": "abc123", + "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] } @@ -37690,7 +39055,7 @@
    Fields
    Example
    {
-  "attribute_code": "abc123",
+  "attribute_code": "xyz789",
   "value": "abc123"
 }
    @@ -37855,13 +39220,13 @@
    Possible Types
    Example
    {
-  "code": "4",
-  "default_value": "abc123",
+  "code": 4,
+  "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
-  "is_required": false,
-  "is_unique": false,
+  "is_required": true,
+  "is_unique": true,
   "label": "xyz789",
   "options": [CustomAttributeOptionInterface]
 }
@@ -37980,8 +39345,101 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "key": "xyz789",
-  "value": "xyz789"
+  "value": "abc123"
+}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    CustomOperatorInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + type - CustomOperatorType + +
    + value - [String] + +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "type": "UNKNOWN_CUSTOMOPERATOR_TYPE",
+  "value": ["abc123"]
 }
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    CustomOperatorType

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

    UNKNOWN_CUSTOMOPERATOR_TYPE

    +     		+
    +

    CUSTOM

    +     		+
    +
    +
    +
    +
    +
    Example
    + 
    "UNKNOWN_CUSTOMOPERATOR_TYPE"
    @@ -38152,6 +39610,12 @@
    giftRegistryUi Customer group assigned to the customer + + id - ID! + + The unique ID assigned to the customer. id is not needed as part of Customer, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side. + + is_subscribed - Boolean @@ -38311,6 +39775,11 @@
    pageSize Indicates whether purchase order functionality is enabled for the current customer. Global and company-level settings are factored into the result. + + quote_enabled - Boolean! + + Indicates whether negotiable quote functionality is enabled for the current customer. Global and company-level settings are factored into the result. + requisition_lists - RequisitionLists @@ -38336,6 +39805,11 @@
    filter<

    The filter to use to limit the number of requisition lists to return.

    +
    +
    sort - RequisitionListSortInput +
    +

    The field to use for sorting results.

    +
    @@ -38490,27 +39964,29 @@
    Example
    "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "abc123", - "default_billing": "xyz789", - "default_shipping": "xyz789", + "date_of_birth": "xyz789", + "default_billing": "abc123", + "default_shipping": "abc123", "email": "xyz789", "firstname": "abc123", "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, + "id": "4", "is_subscribed": false, - "job_title": "abc123", - "lastname": "xyz789", - "middlename": "xyz789", + "job_title": "xyz789", + "lastname": "abc123", + "middlename": "abc123", "orders": CustomerOrders, - "prefix": "abc123", + "prefix": "xyz789", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": true, + "purchase_orders_enabled": false, + "quote_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -38519,9 +39995,9 @@
    Example
    "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", + "structure_id": 4, "suffix": "abc123", - "taxvat": "abc123", + "taxvat": "xyz789", "team": CompanyTeam, "telephone": "abc123", "wishlist_v2": Wishlist, @@ -38613,9 +40089,10 @@
    attributeCodes The first name of the person associated with the shipping/billing address. - id - Int + id - Int + + The ID of a CustomerAddress object. Use uid instead. - The ID of a CustomerAddress object. lastname - String @@ -38663,7 +40140,7 @@
    attributeCodes The customer's telephone number. - uid - ID! + uid - ID The unique ID for a CustomerAddress object. @@ -38684,20 +40161,20 @@
    Example
    "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "default_billing": true, + "default_billing": false, "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", + "fax": "xyz789", "firstname": "xyz789", "id": 123, - "lastname": "xyz789", + "lastname": "abc123", "middlename": "xyz789", - "postcode": "abc123", + "postcode": "xyz789", "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 987, + "region_id": 123, "street": ["abc123"], - "suffix": "xyz789", + "suffix": "abc123", "telephone": "abc123", "uid": "4", "vat_id": "abc123" @@ -38748,7 +40225,7 @@
    Fields
    Example
    {
   "attribute_code": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
    @@ -38891,9 +40368,9 @@
    Example
    "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInput], - "default_billing": false, + "default_billing": true, "default_shipping": true, - "fax": "abc123", + "fax": "xyz789", "firstname": "abc123", "lastname": "abc123", "middlename": "xyz789", @@ -38901,9 +40378,9 @@
    Example
    "prefix": "abc123", "region": CustomerAddressRegionInput, "street": ["abc123"], - "suffix": "abc123", + "suffix": "xyz789", "telephone": "xyz789", - "vat_id": "xyz789" + "vat_id": "abc123" }     @@ -38955,8 +40432,8 @@
    Fields
    Example
    {
-  "region": "abc123",
-  "region_code": "xyz789",
+  "region": "xyz789",
+  "region_code": "abc123",
   "region_id": 123
 }
    @@ -39012,9 +40489,9 @@
    Fields
    Example
    {
-  "region": "xyz789",
-  "region_code": "abc123",
-  "region_id": 123
+  "region": "abc123",
+  "region_code": "xyz789",
+  "region_id": 987
 }
    @@ -39064,7 +40541,7 @@
    Example
    {
   "items": [CustomerAddress],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
    @@ -39172,9 +40649,9 @@
    Example
    "frontend_class": "abc123", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": true, - "is_unique": false, - "label": "xyz789", + "is_required": false, + "is_unique": true, + "label": "abc123", "multiline_count": 123, "options": [CustomAttributeOptionInterface], "sort_order": 987, @@ -39293,18 +40770,18 @@
    Fields
    Example
    {
-  "allow_remote_shopping_assistance": false,
+  "allow_remote_shopping_assistance": true,
   "custom_attributes": [AttributeValueInput],
-  "date_of_birth": "abc123",
+  "date_of_birth": "xyz789",
   "email": "xyz789",
-  "firstname": "xyz789",
+  "firstname": "abc123",
   "gender": 123,
   "is_subscribed": true,
-  "lastname": "abc123",
-  "middlename": "abc123",
-  "password": "xyz789",
-  "prefix": "abc123",
-  "suffix": "xyz789",
+  "lastname": "xyz789",
+  "middlename": "xyz789",
+  "password": "abc123",
+  "prefix": "xyz789",
+  "suffix": "abc123",
   "taxvat": "abc123"
 }
    @@ -39369,8 +40846,8 @@
    Example
    {
   "date": "abc123",
   "download_url": "abc123",
-  "order_increment_id": "xyz789",
-  "remaining_downloads": "xyz789",
+  "order_increment_id": "abc123",
+  "remaining_downloads": "abc123",
   "status": "abc123"
 }
    @@ -39572,6 +41049,11 @@
    Fields
    A list of order items eligible to be in a return request. + + negotiable_quote - NegotiableQuote + + The negotiable quote associated with this order. + number - String! @@ -39668,26 +41150,27 @@
    Example
    "credit_memos": [CreditMemo], "custom_attributes": [CustomAttribute], "customer_info": OrderCustomerInfo, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, "id": 4, "invoices": [Invoice], "is_virtual": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "abc123", + "negotiable_quote": NegotiableQuote, + "number": "xyz789", "order_date": "xyz789", - "order_status_change_date": "abc123", + "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "xyz789", - "status": "xyz789", - "token": "xyz789", + "status": "abc123", + "token": "abc123", "total": OrderTotal }     @@ -39842,7 +41325,7 @@
    Example
    "date_of_first_order": "xyz789", "items": [CustomerOrder], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 }
    @@ -40153,7 +41636,7 @@
    Example
    {
   "items": [CustomerStoreCreditHistoryItem],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
    @@ -40210,7 +41693,7 @@
    Fields
    Example
    {
-  "action": "xyz789",
+  "action": "abc123",
   "actual_balance": Money,
   "balance_change": Money,
   "date_time_changed": "abc123"
@@ -40356,17 +41839,17 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "allow_remote_shopping_assistance": true,
+  "allow_remote_shopping_assistance": false,
   "custom_attributes": [AttributeValueInput],
   "date_of_birth": "xyz789",
   "firstname": "xyz789",
   "gender": 987,
-  "is_subscribed": true,
-  "lastname": "abc123",
+  "is_subscribed": false,
+  "lastname": "xyz789",
   "middlename": "abc123",
-  "prefix": "abc123",
+  "prefix": "xyz789",
   "suffix": "xyz789",
-  "taxvat": "abc123"
+  "taxvat": "xyz789"
 }
 
    
                 
    
@@ -40433,10 +41916,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "product_sku": "abc123",
+  "product_sku": "xyz789",
   "required": false,
   "sort_order": 123,
-  "title": "xyz789",
+  "title": "abc123",
   "uid": 4,
   "value": CustomizableAreaValue
 }
@@ -40504,7 +41987,7 @@ 
    Example
    
   "price": 987.65,
   "price_type": "FIXED",
   "sku": "xyz789",
-  "uid": 4
+  "uid": "4"
 }
 
    
                 
    
@@ -40568,8 +42051,8 @@ 
    Example
    
                   
    {
   "required": true,
   "sort_order": 123,
-  "title": "xyz789",
-  "uid": 4,
+  "title": "abc123",
+  "uid": "4",
   "value": [CustomizableCheckboxValue]
 }
 
    
@@ -40717,9 +42200,9 @@ 
    Example
    
                   
    {
   "product_sku": "abc123",
   "required": false,
-  "sort_order": 987,
+  "sort_order": 123,
   "title": "abc123",
-  "uid": 4,
+  "uid": "4",
   "value": CustomizableDateValue
 }
 
    
@@ -40838,11 +42321,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "price": 987.65,
+  "price": 123.45,
   "price_type": "FIXED",
-  "sku": "abc123",
+  "sku": "xyz789",
   "type": "DATE",
-  "uid": 4
+  "uid": "4"
 }
 
    
                 
    
@@ -40904,7 +42387,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "required": false,
+  "required": true,
   "sort_order": 123,
   "title": "abc123",
   "uid": "4",
@@ -40980,12 +42463,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "option_type_id": 123,
-  "price": 123.45,
+  "option_type_id": 987,
+  "price": 987.65,
   "price_type": "FIXED",
   "sku": "abc123",
   "sort_order": 123,
-  "title": "abc123",
+  "title": "xyz789",
   "uid": 4
 }
 
    
@@ -41053,11 +42536,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "product_sku": "abc123",
+  "product_sku": "xyz789",
   "required": false,
-  "sort_order": 987,
+  "sort_order": 123,
   "title": "xyz789",
-  "uid": 4,
+  "uid": "4",
   "value": CustomizableFieldValue
 }
 
    
@@ -41121,10 +42604,10 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "max_characters": 987,
-  "price": 987.65,
+  "price": 123.45,
   "price_type": "FIXED",
-  "sku": "xyz789",
-  "uid": 4
+  "sku": "abc123",
+  "uid": "4"
 }
 
    
                 
    
@@ -41191,11 +42674,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "product_sku": "xyz789",
-  "required": true,
-  "sort_order": 987,
+  "product_sku": "abc123",
+  "required": false,
+  "sort_order": 123,
   "title": "abc123",
-  "uid": 4,
+  "uid": "4",
   "value": CustomizableFileValue
 }
 
    
@@ -41268,12 +42751,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "file_extension": "xyz789",
+  "file_extension": "abc123",
   "image_size_x": 123,
   "image_size_y": 987,
-  "price": 987.65,
+  "price": 123.45,
   "price_type": "FIXED",
-  "sku": "xyz789",
+  "sku": "abc123",
   "uid": "4"
 }
 
    
@@ -41336,9 +42819,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "required": false,
+  "required": true,
   "sort_order": 987,
-  "title": "abc123",
+  "title": "xyz789",
   "uid": 4,
   "value": [CustomizableMultipleValue]
 }
@@ -41417,7 +42900,7 @@ 
    Example
    
   "price_type": "FIXED",
   "sku": "xyz789",
   "sort_order": 123,
-  "title": "xyz789",
+  "title": "abc123",
   "uid": "4"
 }
 
    
@@ -41466,7 +42949,10 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"uid": 4, "value_string": "abc123"}
+                  
    {
+  "uid": "4",
+  "value_string": "xyz789"
+}
 
    
                 
    
               
    
@@ -41574,8 +43060,8 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "required": false,
-  "sort_order": 123,
+  "required": true,
+  "sort_order": 987,
   "title": "abc123",
   "uid": "4"
 }
@@ -41721,10 +43207,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "required": true,
+  "required": false,
   "sort_order": 123,
-  "title": "xyz789",
-  "uid": 4,
+  "title": "abc123",
+  "uid": "4",
   "value": [CustomizableRadioValue]
 }
 
    
@@ -41801,9 +43287,9 @@ 
    Example
    
   "price": 123.45,
   "price_type": "FIXED",
   "sku": "xyz789",
-  "sort_order": 123,
+  "sort_order": 987,
   "title": "abc123",
-  "uid": 4
+  "uid": "4"
 }
 
    
                 
    
@@ -42079,7 +43565,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "errors": [NegotiableQuoteInvalidStateError],
-  "quote_uid": "4"
+  "quote_uid": 4
 }
 
    
                 
    
@@ -42198,7 +43684,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"quote_uids": [4]}
+                  
    {"quote_uids": ["4"]}
 
    
                 
    
               
    
@@ -42330,7 +43816,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "customerPaymentTokens": CustomerPaymentTokens,
-  "result": true
+  "result": false
 }
 
    
                 
    
@@ -42587,7 +44073,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"requisition_lists": RequisitionLists, "status": true}
+                  
    {"requisition_lists": RequisitionLists, "status": false}
 
    
                 
    
               
    
@@ -42706,10 +44192,10 @@ 
    Example
    
   "amount": Money,
   "applied_to": "ITEM",
   "coupon": AppliedCoupon,
-  "is_discounting_locked": true,
+  "is_discounting_locked": false,
   "label": "abc123",
   "type": "abc123",
-  "value": 123.45
+  "value": 987.65
 }
 
    
                 
    
@@ -42831,16 +44317,16 @@ 
    Example
    
   "customizable_options": [SelectedCustomizableOption],
   "discount": [Discount],
   "errors": [CartItemError],
-  "is_available": true,
+  "is_available": false,
   "links": [DownloadableProductLinks],
-  "max_qty": 123.45,
+  "max_qty": 987.65,
   "min_qty": 987.65,
-  "not_available_message": "abc123",
+  "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "samples": [DownloadableProductSamples],
   "uid": "4"
 }
@@ -42927,7 +44413,7 @@ 
    Example
    
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
   "downloadable_links": [DownloadableItemsLinks],
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
@@ -43021,7 +44507,7 @@ 
    Example
    
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "abc123",
+  "product_sku": "xyz789",
   "quantity_invoiced": 987.65
 }
    @@ -43075,8 +44561,8 @@
    Fields
    Example
    {
   "sort_order": 987,
-  "title": "abc123",
-  "uid": 4
+  "title": "xyz789",
+  "uid": "4"
 }
    @@ -43244,20 +44730,20 @@
    Example
    "id": 4, "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "product_type": "xyz789", - "product_url_key": "abc123", + "product_sku": "xyz789", + "product_type": "abc123", + "product_url_key": "xyz789", "quantity_canceled": 123.45, "quantity_invoiced": 987.65, - "quantity_ordered": 987.65, + "quantity_ordered": 123.45, "quantity_refunded": 123.45, "quantity_return_requested": 987.65, - "quantity_returned": 123.45, - "quantity_shipped": 987.65, + "quantity_returned": 987.65, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } @@ -43539,40 +45025,40 @@
    Example
    "downloadable_product_samples": [ DownloadableProductSamples ], - "gift_message_available": true, + "gift_message_available": false, "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", - "links_purchased_separately": 123, + "links_purchased_separately": 987, "links_title": "abc123", - "manufacturer": 123, - "max_sale_qty": 123.45, + "manufacturer": 987, + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "meta_description": "xyz789", - "meta_keyword": "abc123", + "meta_keyword": "xyz789", "meta_title": "xyz789", "min_sale_qty": 987.65, "name": "abc123", - "new_from_date": "xyz789", - "new_to_date": "xyz789", + "new_from_date": "abc123", + "new_to_date": "abc123", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 987.65, + "quantity": 123.45, "related_products": [ProductInterface], "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, - "special_price": 987.65, - "special_to_date": "xyz789", + "special_price": 123.45, + "special_to_date": "abc123", "stock_status": "IN_STOCK", "swatch_image": "xyz789", "thumbnail": ProductImage, - "uid": 4, + "uid": "4", "upsell_products": [ProductInterface], "url_key": "abc123" } @@ -43696,9 +45182,9 @@
    Fields
    Example
    {
   "price": 123.45,
-  "sample_url": "abc123",
+  "sample_url": "xyz789",
   "sort_order": 987,
-  "title": "abc123",
+  "title": "xyz789",
   "uid": "4"
 }
    @@ -43792,7 +45278,7 @@
    Fields
    Example
    {
-  "sample_url": "xyz789",
+  "sample_url": "abc123",
   "sort_order": 123,
   "title": "xyz789"
 }
@@ -43864,7 +45350,7 @@ 
    Example
    
   "customizable_options": [SelectedCustomizableOption],
   "links": [DownloadableProductLinks],
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "samples": [DownloadableProductSamples],
   "uid": 4
 }
@@ -43950,7 +45436,7 @@ 
    Example
    
   "id": 4,
   "links_v2": [DownloadableProductLinks],
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "samples": [DownloadableProductSamples]
 }
    @@ -43999,10 +45485,7 @@
    Fields
    Example
    - 
    {
-  "duplicated_quote_uid": "4",
-  "quote_uid": 4
-}
+                  
    {"duplicated_quote_uid": 4, "quote_uid": 4}
    @@ -44091,7 +45574,7 @@
    Fields
    Example
    {
   "attribute_code": "xyz789",
-  "value": "xyz789"
+  "value": "abc123"
 }
    @@ -44139,10 +45622,7 @@
    Fields
    Example
    - 
    {
-  "uid": "4",
-  "value": "xyz789"
-}
+                  
    {"uid": 4, "value": "xyz789"}
    @@ -44613,6 +46093,11 @@
    Fields
    The relative order the payment method is displayed on the checkout page + + three_ds_mode - ThreeDSMode + + 3DS mode + title - String @@ -44626,13 +46111,14 @@
    Fields
    Example
    {
-  "code": "xyz789",
-  "is_visible": false,
+  "code": "abc123",
+  "is_visible": true,
   "payment_intent": "xyz789",
   "payment_source": "abc123",
   "sdk_params": [SDKParams],
-  "sort_order": "abc123",
-  "title": "abc123"
+  "sort_order": "xyz789",
+  "three_ds_mode": "OFF",
+  "title": "xyz789"
 }
    @@ -44684,6 +46170,93 @@
    Example
    "payment_source": "abc123", "paypal_fastlane_token": "abc123" } +     + + + back to top + +
    +
    +
    + Types +
    +

    Field

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

    UNKNOWN_FIELD

    +     		+
    +

    CATEGORY

    +     		+
    +

    PRICE

    +     		+
    +

    PRODUCT

    +     		+
    +

    OUT_OF_STOCK

    +     		+
    +

    LOW_STOCK

    +     		+
    +

    TYPE

    +     		+
    +

    VISIBILITY

    +     		+
    +
    +
    +
    +
    +
    Example
    + 
    "UNKNOWN_FIELD"
    @@ -44732,7 +46305,7 @@
    Fields
    Example
    {
   "eq": "abc123",
-  "in": ["xyz789"]
+  "in": ["abc123"]
 }
    @@ -44873,9 +46446,117 @@
    Fields
    Example
    {
-  "from": "abc123",
+  "from": "xyz789",
   "to": "xyz789"
 }
+
    +
    + + back to top + +
    +
    +
    + Types +
    +

    FilterRuleInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + name - String + +
    + type - FilterRuleType + +
    + conditions - [ConditionInput] + +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "name": "abc123",
+  "type": "UNKNOWN_FILTER_RULE_TYPE",
+  "conditions": [ConditionInput]
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    FilterRuleType

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

    UNKNOWN_FILTER_RULE_TYPE

    +     		+
    +

    INCLUSION

    +     		+
    +

    EXCLUSION

    +     		+
    +
    +
    +
    +
    +
    Example
    + 
    "UNKNOWN_FILTER_RULE_TYPE"
    @@ -44929,8 +46610,8 @@
    Fields
    Example
    {
-  "eq": "abc123",
-  "in": ["abc123"],
+  "eq": "xyz789",
+  "in": ["xyz789"],
   "match": "abc123"
 }
    @@ -45054,18 +46735,18 @@
    Example
    {
   "eq": "xyz789",
   "from": "abc123",
-  "gt": "xyz789",
-  "gteq": "abc123",
+  "gt": "abc123",
+  "gteq": "xyz789",
   "in": ["xyz789"],
   "like": "abc123",
-  "lt": "abc123",
-  "lteq": "abc123",
-  "moreq": "abc123",
-  "neq": "xyz789",
+  "lt": "xyz789",
+  "lteq": "xyz789",
+  "moreq": "xyz789",
+  "neq": "abc123",
   "nin": ["xyz789"],
-  "notnull": "xyz789",
-  "null": "xyz789",
-  "to": "xyz789"
+  "notnull": "abc123",
+  "null": "abc123",
+  "to": "abc123"
 }
    @@ -45122,9 +46803,9 @@
    Fields
    Example
    {
-  "attribute": "xyz789",
-  "frontendInput": "xyz789",
-  "label": "xyz789",
+  "attribute": "abc123",
+  "frontendInput": "abc123",
+  "label": "abc123",
   "numeric": false
 }
    @@ -45173,7 +46854,7 @@
    Fields
    Example
    {
   "amount": Money,
-  "label": "abc123"
+  "label": "xyz789"
 }
    @@ -45261,7 +46942,7 @@
    Description
    Example
    - 
    987.65
+                  
    123.45
    @@ -45342,7 +47023,7 @@
    Fields
    Example
    - 
    {"customer_token": "abc123"}
+                  
    {"customer_token": "xyz789"}
    @@ -45383,7 +47064,7 @@
    Fields
    Example
    - 
    {"template_id": 4}
+                  
    {"template_id": "4"}
    @@ -45423,7 +47104,7 @@
    Fields
    Example
    - 
    {"negotiable_quote_uid": 4}
+                  
    {"negotiable_quote_uid": "4"}
    @@ -45515,8 +47196,8 @@
    Fields
    Example
    {
   "balance": Money,
-  "code": "xyz789",
-  "expiration_date": "abc123"
+  "code": "abc123",
+  "expiration_date": "xyz789"
 }
    @@ -45558,7 +47239,7 @@
    Fields
    Example
    - 
    {"gift_card_code": "abc123"}
+                  
    {"gift_card_code": "xyz789"}
    @@ -45619,10 +47300,10 @@
    Fields
    Example
    {
-  "attribute_id": 987,
+  "attribute_id": 123,
   "uid": "4",
-  "value": 987.65,
-  "website_id": 987,
+  "value": 123.45,
+  "website_id": 123,
   "website_value": 987.65
 }
    @@ -45784,18 +47465,18 @@
    Example
    "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": false, + "is_available": true, "max_qty": 123.45, - "message": "abc123", - "min_qty": 987.65, - "not_available_message": "xyz789", + "message": "xyz789", + "min_qty": 123.45, + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "recipient_email": "abc123", - "recipient_name": "xyz789", + "recipient_name": "abc123", "sender_email": "abc123", "sender_name": "xyz789", "uid": 4 @@ -45879,12 +47560,12 @@
    Example
    "custom_attributes": [CustomAttribute], "discounts": [Discount], "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 123.45 + "product_sku": "xyz789", + "quantity_refunded": 987.65 }
    @@ -45965,7 +47646,7 @@
    Example
    "custom_attributes": [CustomAttribute], "discounts": [Discount], "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, @@ -46032,11 +47713,11 @@
    Fields
    Example
    {
-  "message": "abc123",
+  "message": "xyz789",
   "recipient_email": "abc123",
   "recipient_name": "xyz789",
-  "sender_email": "xyz789",
-  "sender_name": "xyz789"
+  "sender_email": "abc123",
+  "sender_name": "abc123"
 }
    @@ -46110,10 +47791,10 @@
    Example
    {
   "amount": Money,
   "custom_giftcard_amount": Money,
-  "message": "abc123",
+  "message": "xyz789",
   "recipient_email": "xyz789",
   "recipient_name": "xyz789",
-  "sender_email": "abc123",
+  "sender_email": "xyz789",
   "sender_name": "xyz789"
 }
    @@ -46270,28 +47951,28 @@
    Example
    {
   "custom_attributes": [CustomAttribute],
   "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,
   "prices": OrderItemPrices,
   "product": ProductInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "product_type": "abc123",
+  "product_sku": "xyz789",
+  "product_type": "xyz789",
   "product_url_key": "xyz789",
-  "quantity_canceled": 987.65,
+  "quantity_canceled": 123.45,
   "quantity_invoiced": 123.45,
-  "quantity_ordered": 987.65,
-  "quantity_refunded": 987.65,
+  "quantity_ordered": 123.45,
+  "quantity_refunded": 123.45,
   "quantity_return_requested": 987.65,
   "quantity_returned": 123.45,
-  "quantity_shipped": 123.45,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "abc123"
+  "status": "xyz789"
 }
    @@ -46596,9 +48277,9 @@
    filters
    Example
    {
-  "allow_message": false,
+  "allow_message": true,
   "allow_open_amount": true,
-  "canonical_url": "abc123",
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
   "country_of_manufacture": "abc123",
   "crosssell_products": [ProductInterface],
@@ -46611,23 +48292,23 @@ 
    Example
    
   "giftcard_amounts": [GiftCardAmounts],
   "giftcard_type": "VIRTUAL",
   "image": ProductImage,
-  "is_redeemable": true,
+  "is_redeemable": false,
   "is_returnable": "xyz789",
-  "lifetime": 123,
+  "lifetime": 987,
   "manufacturer": 987,
   "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
-  "message_max_length": 123,
-  "meta_description": "xyz789",
-  "meta_keyword": "abc123",
+  "message_max_length": 987,
+  "meta_description": "abc123",
+  "meta_keyword": "xyz789",
   "meta_title": "xyz789",
   "min_sale_qty": 987.65,
   "name": "xyz789",
-  "new_from_date": "abc123",
+  "new_from_date": "xyz789",
   "new_to_date": "abc123",
   "only_x_left_in_stock": 123.45,
-  "open_amount_max": 123.45,
-  "open_amount_min": 987.65,
+  "open_amount_max": 987.65,
+  "open_amount_min": 123.45,
   "options": [CustomizableOptionInterface],
   "options_container": "xyz789",
   "price_range": PriceRange,
@@ -46636,14 +48317,14 @@ 
    Example
    
   "quantity": 987.65,
   "related_products": [ProductInterface],
   "short_description": ComplexTextValue,
-  "sku": "xyz789",
+  "sku": "abc123",
   "small_image": ProductImage,
-  "special_price": 987.65,
+  "special_price": 123.45,
   "special_to_date": "xyz789",
   "stock_status": "IN_STOCK",
-  "swatch_image": "abc123",
+  "swatch_image": "xyz789",
   "thumbnail": ProductImage,
-  "uid": "4",
+  "uid": 4,
   "upsell_products": [ProductInterface],
   "url_key": "xyz789",
   "weight": 987.65
@@ -46782,11 +48463,11 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "gift_card": GiftCardItem,
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "abc123",
+  "product_sku": "xyz789",
   "quantity_shipped": 123.45
 }
 
    
@@ -46918,7 +48599,7 @@ 
    Example
    
                   
    {
   "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
+  "description": "xyz789",
   "gift_card_options": GiftCardOptions,
   "id": 4,
   "product": ProductInterface,
@@ -46975,8 +48656,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "from": "xyz789",
-  "message": "abc123",
-  "to": "xyz789"
+  "message": "xyz789",
+  "to": "abc123"
 }
    @@ -47031,9 +48712,9 @@
    Fields
    Example
    {
-  "from": "xyz789",
+  "from": "abc123",
   "message": "abc123",
-  "to": "xyz789"
+  "to": "abc123"
 }
    @@ -47206,14 +48887,14 @@
    Example
    "dynamic_attributes": [GiftRegistryDynamicAttribute], "event_name": "xyz789", "items": [GiftRegistryItemInterface], - "message": "abc123", - "owner_name": "abc123", + "message": "xyz789", + "owner_name": "xyz789", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": "4" + "uid": 4 }     @@ -47268,8 +48949,8 @@
    Example
    {
   "code": 4,
   "group": "EVENT_INFORMATION",
-  "label": "abc123",
-  "value": "abc123"
+  "label": "xyz789",
+  "value": "xyz789"
 }
    @@ -47463,8 +49144,8 @@
    Possible Types
    Example
    {
-  "code": "4",
-  "label": "xyz789",
+  "code": 4,
+  "label": "abc123",
   "value": "xyz789"
 }
    @@ -47528,12 +49209,12 @@
    Fields
    Example
    {
-  "attribute_group": "xyz789",
+  "attribute_group": "abc123",
   "code": "4",
   "input_type": "xyz789",
   "is_required": true,
-  "label": "abc123",
-  "sort_order": 987
+  "label": "xyz789",
+  "sort_order": 123
 }
    @@ -47613,12 +49294,12 @@
    Possible Types
    Example
    {
-  "attribute_group": "abc123",
+  "attribute_group": "xyz789",
   "code": "4",
   "input_type": "xyz789",
   "is_required": false,
-  "label": "xyz789",
-  "sort_order": 987
+  "label": "abc123",
+  "sort_order": 123
 }
    @@ -47682,12 +49363,12 @@
    Fields
    Example
    {
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "note": "xyz789",
   "product": ProductInterface,
   "quantity": 123.45,
   "quantity_fulfilled": 123.45,
-  "uid": 4
+  "uid": "4"
 }
    @@ -47768,12 +49449,12 @@
    Possible Types
    Example
    {
-  "created_at": "xyz789",
-  "note": "abc123",
+  "created_at": "abc123",
+  "note": "xyz789",
   "product": ProductInterface,
-  "quantity": 123.45,
-  "quantity_fulfilled": 123.45,
-  "uid": "4"
+  "quantity": 987.65,
+  "quantity_fulfilled": 987.65,
+  "uid": 4
 }
    @@ -48128,9 +49809,9 @@
    Example
    "dynamic_attributes": [ GiftRegistryRegistrantDynamicAttribute ], - "email": "abc123", - "firstname": "abc123", - "lastname": "abc123", + "email": "xyz789", + "firstname": "xyz789", + "lastname": "xyz789", "uid": "4" }     @@ -48180,8 +49861,8 @@
    Fields
    Example
    {
   "code": "4",
-  "label": "xyz789",
-  "value": "abc123"
+  "label": "abc123",
+  "value": "xyz789"
 }
    @@ -48248,11 +49929,11 @@
    Fields
    Example
    {
-  "event_date": "abc123",
+  "event_date": "xyz789",
   "event_title": "xyz789",
   "gift_registry_uid": 4,
   "location": "abc123",
-  "name": "abc123",
+  "name": "xyz789",
   "type": "xyz789"
 }
    @@ -48294,6 +49975,12 @@
    Fields
    The ID assigned to this customer address. + + + customer_address_uid - ID + + The unique ID assigned to this customer address. +
    @@ -48303,7 +49990,8 @@
    Fields
    Example
    {
   "address_data": CustomerAddressInput,
-  "address_id": "4"
+  "address_id": "4",
+  "customer_address_uid": 4
 }
    @@ -48407,7 +50095,7 @@
    Example
    "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "abc123", + "label": "xyz789", "uid": "4" } @@ -48465,10 +50153,10 @@
    Fields
    Example
    {
-  "design": "xyz789",
+  "design": "abc123",
   "image": GiftWrappingImage,
   "price": Money,
-  "uid": "4"
+  "uid": 4
 }
    @@ -48516,7 +50204,7 @@
    Fields
    Example
    {
   "label": "abc123",
-  "url": "abc123"
+  "url": "xyz789"
 }
    @@ -48564,7 +50252,7 @@
    Fields
    Example
    {
-  "color": "abc123",
+  "color": "xyz789",
   "height": 123,
   "type": "abc123"
 }
@@ -48650,9 +50338,9 @@ 
    Example
    
   "payment_intent": "abc123",
   "payment_source": "abc123",
   "sdk_params": [SDKParams],
-  "sort_order": "xyz789",
+  "sort_order": "abc123",
   "three_ds_mode": "OFF",
-  "title": "abc123"
+  "title": "xyz789"
 }
    @@ -48707,7 +50395,7 @@
    Fields
    Example
    {
-  "payment_source": "xyz789",
+  "payment_source": "abc123",
   "payments_order_id": "abc123",
   "paypal_order_id": "abc123"
 }
@@ -48964,29 +50652,29 @@ 
    filters
                 
    
                   
    Example
    
                   
    {
-  "canonical_url": "xyz789",
+  "canonical_url": "abc123",
   "categories": [CategoryInterface],
   "country_of_manufacture": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "gift_message_available": false,
-  "gift_wrapping_available": true,
+  "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
   "image": ProductImage,
   "is_returnable": "xyz789",
   "items": [GroupedProductItem],
   "manufacturer": 987,
-  "max_sale_qty": 123.45,
+  "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
-  "meta_description": "abc123",
-  "meta_keyword": "abc123",
-  "meta_title": "abc123",
+  "meta_description": "xyz789",
+  "meta_keyword": "xyz789",
+  "meta_title": "xyz789",
   "min_sale_qty": 123.45,
-  "name": "abc123",
+  "name": "xyz789",
   "new_from_date": "abc123",
   "new_to_date": "xyz789",
-  "only_x_left_in_stock": 123.45,
+  "only_x_left_in_stock": 987.65,
   "options_container": "xyz789",
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
@@ -48996,15 +50684,15 @@ 
    Example
    
   "short_description": ComplexTextValue,
   "sku": "xyz789",
   "small_image": ProductImage,
-  "special_price": 123.45,
-  "special_to_date": "xyz789",
+  "special_price": 987.65,
+  "special_to_date": "abc123",
   "stock_status": "IN_STOCK",
   "swatch_image": "xyz789",
   "thumbnail": ProductImage,
   "uid": 4,
   "upsell_products": [ProductInterface],
-  "url_key": "abc123",
-  "weight": 987.65
+  "url_key": "xyz789",
+  "weight": 123.45
 }
 
    
                 
    
@@ -49059,7 +50747,7 @@ 
    Example
    
                   
    {
   "position": 987,
   "product": ProductInterface,
-  "qty": 123.45
+  "qty": 987.65
 }
    @@ -49127,12 +50815,12 @@
    Fields
    Example
    {
-  "added_at": "xyz789",
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
   "id": 4,
   "product": ProductInterface,
-  "quantity": 123.45
+  "quantity": 987.65
 }
    @@ -49237,7 +50925,7 @@
    Fields
    Example
    {
-  "email": "abc123",
+  "email": "xyz789",
   "lastname": "xyz789",
   "number": "abc123"
 }
@@ -49291,10 +50979,82 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "attribute": "abc123",
-  "matched_words": ["xyz789"],
+  "attribute": "xyz789",
+  "matched_words": ["abc123"],
   "value": "abc123"
 }
+
    
+                
    
+
    + back to top + +
    +
    +
    + Types +
    +

    HistoryItemNoteData

    +
    +
    +
    +
    Description
    +

    Item note data that is added to the negotiable quote history object.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    created_at - String! + Datetime of the note added.
    creator_name - String! + Name of the creator.
    creator_type - String! + Creator type: Buyer or Seller.
    item_id - Int! + Id of the quote item for which the note has been added.
    note - String! + The note added by the creator for the item
    product_name - String! + Name of the quote item product for which note has been added.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "created_at": "abc123",
+  "creator_name": "xyz789",
+  "creator_type": "abc123",
+  "item_id": 123,
+  "note": "abc123",
+  "product_name": "xyz789"
+}
    @@ -49381,13 +51141,13 @@
    Fields
    Example
    {
-  "cc_vault_code": "xyz789",
+  "cc_vault_code": "abc123",
   "code": "xyz789",
   "is_vault_enabled": true,
   "is_visible": true,
-  "payment_intent": "abc123",
+  "payment_intent": "xyz789",
   "payment_source": "xyz789",
-  "requires_card_details": false,
+  "requires_card_details": true,
   "sdk_params": [SDKParams],
   "sort_order": "abc123",
   "three_ds_mode": "OFF",
@@ -49482,15 +51242,15 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "cardBin": "xyz789",
-  "cardExpiryMonth": "xyz789",
+  "cardBin": "abc123",
+  "cardExpiryMonth": "abc123",
   "cardExpiryYear": "abc123",
   "cardLast4": "abc123",
   "holderName": "xyz789",
   "is_active_payment_token_enabler": false,
-  "payment_source": "abc123",
+  "payment_source": "xyz789",
   "payments_order_id": "xyz789",
-  "paypal_order_id": "abc123"
+  "paypal_order_id": "xyz789"
 }
 
    
                 
    
@@ -49513,7 +51273,7 @@ 
    Description
    
               
    
                 
    
                   
    Example
    
-                  
    "4"
+                  
    4
 
    
                 
    
               
    
@@ -49555,7 +51315,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "thumbnail": "abc123",
+  "thumbnail": "xyz789",
   "value": "xyz789"
 }
 
    
@@ -49670,8 +51430,8 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "code": "PRODUCT_NOT_FOUND",
-  "message": "abc123",
-  "quantity": 123.45
+  "message": "xyz789",
+  "quantity": 987.65
 }
 
    
                 
    
@@ -49694,7 +51454,7 @@ 
    Description
    
               
    
                 
    
                   
    Example
    
-                  
    987
+                  
    123
 
    
                 
    
               
    
@@ -49932,10 +51692,10 @@ 
    Example
    
   "discounts": [Discount],
   "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "quantity_invoiced": 123.45
+  "product_sku": "abc123",
+  "quantity_invoiced": 987.65
 }
    @@ -50103,12 +51863,12 @@
    Example
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "quantity_invoiced": 987.65
+  "quantity_invoiced": 123.45
 }
    @@ -50353,7 +52113,7 @@
    Fields
    Example
    - 
    {"is_role_name_available": false}
+                  
    {"is_role_name_available": true}
    @@ -50434,6 +52194,96 @@
    Fields
    Example
    {"is_email_available": true}
+
    +
    + + back to top + +
    +
    +
    + Types +
    +

    IsOperatorInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + type - IsOperatorType + +
    + value - Boolean + +
    +
    +
    +
    +
    +
    Example
    + 
    {"type": "UNKNOWN_ISOPERATOR_TYPE", "value": true}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    IsOperatorType

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

    UNKNOWN_ISOPERATOR_TYPE

    +     		+
    +

    IS

    +     		+
    +
    +
    +
    +
    +
    Example
    + 
    "UNKNOWN_ISOPERATOR_TYPE"
    @@ -50471,6 +52321,11 @@
    Fields
    ID of the user who submitted a note. + + creator_name - String + + Name of the creator. + creator_type - Int @@ -50500,10 +52355,11 @@
    Fields
    Example
    {
   "created_at": "abc123",
-  "creator_id": 123,
-  "creator_type": 987,
-  "negotiable_quote_item_uid": 4,
-  "note": "xyz789",
+  "creator_id": 987,
+  "creator_name": "abc123",
+  "creator_type": 123,
+  "negotiable_quote_item_uid": "4",
+  "note": "abc123",
   "note_uid": 4
 }
    @@ -50556,8 +52412,8 @@
    Fields
    Example
    {
-  "label": "abc123",
-  "uid": 4,
+  "label": "xyz789",
+  "uid": "4",
   "values": [ItemSelectedBundleOptionValue]
 }
    @@ -50622,9 +52478,9 @@
    Example
    {
   "price": Money,
   "product_name": "abc123",
-  "product_sku": "xyz789",
-  "quantity": 123.45,
-  "uid": 4
+  "product_sku": "abc123",
+  "quantity": 987.65,
+  "uid": "4"
 }
    @@ -50749,9 +52605,9 @@
    Fields
    Example
    {
-  "note": "xyz789",
+  "note": "abc123",
   "quote_item_uid": 4,
-  "quote_uid": "4"
+  "quote_uid": 4
 }
    @@ -50841,8 +52697,8 @@
    Possible Types
    Example
    {
   "disabled": false,
-  "label": "abc123",
-  "position": 123,
+  "label": "xyz789",
+  "position": 987,
   "url": "abc123"
 }
    @@ -50872,12 +52728,36 @@
    Values
    + + +

    NEGOTIABLE_QUOTE_ATTACHMENT

    + + Negotiable quote comment file attachment +

    CUSTOMER_ATTRIBUTE_FILE

    Customer file resource type + + +

    CUSTOMER_ATTRIBUTE_IMAGE

    + + Customer image resource type + + + +

    CUSTOMER_ATTRIBUTE_ADDRESS_FILE

    + + Customer file resource type for customer address + + + +

    CUSTOMER_ATTRIBUTE_ADDRESS_IMAGE

    + + Customer image resource type for customer address +
    @@ -50885,7 +52765,7 @@
    Values
    Example
    - 
    "CUSTOMER_ATTRIBUTE_FILE"
+                  
    "NEGOTIABLE_QUOTE_ATTACHMENT"
    @@ -50963,7 +52843,7 @@
    Fields
    Example
    {
-  "layout": "abc123",
+  "layout": "xyz789",
   "logo": MessageStyleLogo
 }
    @@ -51010,7 +52890,7 @@
    Fields
    Example
    - 
    {"currency": "AFN", "value": 123.45}
+                  
    {"currency": "AFN", "value": 987.65}
    @@ -51062,7 +52942,7 @@
    Fields
    Example
    {
   "gift_registry": GiftRegistry,
-  "status": true,
+  "status": false,
   "user_errors": [GiftRegistryItemsUserError]
 }
    @@ -51206,7 +53086,11 @@
    Fields
    Example
    - 
    {"quote_item_uid": 4, "quote_uid": 4, "requisition_list_uid": 4}
+                  
    {
+  "quote_item_uid": "4",
+  "quote_uid": 4,
+  "requisition_list_uid": 4
+}
    @@ -51363,6 +53247,11 @@
    Fields
    The email address of the company user. + + expiration_date - String! + + The expiration period of the negotiable quote. + history - [NegotiableQuoteHistoryEntry] @@ -51383,11 +53272,21 @@
    Fields
    The title assigned to the negotiable quote. + + order - CustomerOrder + + The order created from the negotiable quote. + prices - CartPrices A set of subtotals and totals applied to the negotiable quote. + + sales_rep_name - String! + + The first and last name of the sales representative. + selected_payment_method - SelectedPaymentMethod @@ -51403,6 +53302,16 @@
    Fields
    The status of the negotiable quote. + + template_id - ID + + The unique ID of a NegotiableQuoteTemplate object. + + + template_name - String + + The title assigned to the negotiable quote template. + total_quantity - Float! @@ -51432,17 +53341,22 @@
    Example
    "comments": [NegotiableQuoteComment], "created_at": "xyz789", "custom_attributes": [CustomAttribute], - "email": "abc123", + "email": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_virtual": false, "items": [CartItemInterface], - "name": "xyz789", + "name": "abc123", + "order": CustomerOrder, "prices": CartPrices, + "sales_rep_name": "xyz789", "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "SUBMITTED", + "template_id": "4", + "template_name": "xyz789", "total_quantity": 123.45, - "uid": 4, + "uid": "4", "updated_at": "xyz789" }     @@ -51490,7 +53404,7 @@
    Fields
    Example
    {
-  "code": "abc123",
+  "code": "xyz789",
   "label": "abc123"
 }
    @@ -51630,21 +53544,21 @@
    Fields
    Example
    {
-  "city": "xyz789",
+  "city": "abc123",
   "company": "xyz789",
   "country_code": "xyz789",
   "custom_attributes": [AttributeValueInput],
-  "fax": "abc123",
-  "firstname": "abc123",
-  "lastname": "abc123",
-  "middlename": "xyz789",
+  "fax": "xyz789",
+  "firstname": "xyz789",
+  "lastname": "xyz789",
+  "middlename": "abc123",
   "postcode": "xyz789",
-  "prefix": "xyz789",
-  "region": "xyz789",
-  "region_id": 123,
-  "save_in_address_book": true,
+  "prefix": "abc123",
+  "region": "abc123",
+  "region_id": 987,
+  "save_in_address_book": false,
   "street": ["xyz789"],
-  "suffix": "abc123",
+  "suffix": "xyz789",
   "telephone": "abc123",
   "vat_id": "abc123"
 }
@@ -51691,6 +53605,11 @@ 
    Fields
    
                         
                          The custom attribute values of the billing or shipping negotiable quote address. 
                       
+                      
+                        customer_address_uid - ID
+                        
+                         The unique ID from the customer's address book that uniquely identifies the address. 
+                      
                       
                         fax - String
                         
@@ -51744,7 +53663,7 @@ 
    Fields
    
                       
                         uid - ID!
                         
-                         The unique identifier of the address. 
+                         The unique identifier of the negotiable quote address. 
                       
                       
                         vat_id - String
@@ -51781,20 +53700,21 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "city": "abc123",
-  "company": "abc123",
+  "city": "xyz789",
+  "company": "xyz789",
   "country": NegotiableQuoteAddressCountry,
   "custom_attributes": [AttributeValueInterface],
+  "customer_address_uid": 4,
   "fax": "abc123",
   "firstname": "xyz789",
   "lastname": "xyz789",
-  "middlename": "abc123",
+  "middlename": "xyz789",
   "postcode": "xyz789",
   "prefix": "xyz789",
   "region": NegotiableQuoteAddressRegion,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "suffix": "xyz789",
-  "telephone": "abc123",
+  "telephone": "xyz789",
   "uid": 4,
   "vat_id": "abc123"
 }
@@ -51850,7 +53770,7 @@ 
    Example
    
                   
    {
   "code": "xyz789",
   "label": "abc123",
-  "region_id": 987
+  "region_id": 123
 }
 
    
                 
    
@@ -51895,6 +53815,11 @@ 
    Fields
    
                         
                          The custom attribute values of the billing or shipping negotiable quote address. 
                       
+                      
+                        customer_address_uid - ID
+                        
+                         The unique ID from the customer's address book that uniquely identifies the address. 
+                      
                       
                         fax - String
                         
@@ -51948,7 +53873,7 @@ 
    Fields
    
                       
                         uid - ID!
                         
-                         The unique identifier of the address. 
+                         The unique identifier of the negotiable quote address. 
                       
                       
                         vat_id - String
@@ -51963,22 +53888,23 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "city": "abc123",
-  "company": "abc123",
+  "city": "xyz789",
+  "company": "xyz789",
   "country": NegotiableQuoteAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "fax": "abc123",
+  "customer_address_uid": "4",
+  "fax": "xyz789",
   "firstname": "abc123",
-  "lastname": "xyz789",
-  "middlename": "xyz789",
+  "lastname": "abc123",
+  "middlename": "abc123",
   "postcode": "xyz789",
   "prefix": "abc123",
   "region": NegotiableQuoteAddressRegion,
   "street": ["abc123"],
   "suffix": "xyz789",
-  "telephone": "xyz789",
+  "telephone": "abc123",
   "uid": "4",
-  "vat_id": "xyz789"
+  "vat_id": "abc123"
 }
 
    
                 
    
@@ -52041,7 +53967,7 @@ 
    Example
    
                   
    {
   "address": NegotiableQuoteAddressInput,
   "customer_address_uid": 4,
-  "same_as_shipping": false,
+  "same_as_shipping": true,
   "use_for_shipping": false
 }
 
    
@@ -52071,6 +53997,11 @@ 
    Fields
    
                       
                     
                     
+                      
+                        attachments - [NegotiableQuoteCommentAttachment]!
+                        
+                         Negotiable quote comment file attachments. 
+                      
                       
                         author - NegotiableQuoteUser!
                         
@@ -52104,12 +54035,102 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
+  "attachments": [NegotiableQuoteCommentAttachment],
   "author": NegotiableQuoteUser,
   "created_at": "abc123",
   "creator_type": "BUYER",
   "text": "xyz789",
   "uid": "4"
 }
+
    
+                
    
+
    + back to top +
    +
    +
    +
    + Types +
    +

    NegotiableQuoteCommentAttachment

    +
    +
    +
    +
    Description
    +

    Negotiable quote comment file attachment.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    name - String! + Negotiable quote comment attachment file name.
    url - String! + Negotiable quote comment attachment file url.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "name": "abc123",
+  "url": "xyz789"
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    NegotiableQuoteCommentAttachmentInput

    +
    +
    +
    +
    Description
    +

    Negotiable quote comment file attachment.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + key - String! + Negotiable quote comment attachment file key.
    +
    +
    +
    +
    +
    Example
    + 
    {"key": "abc123"}
    @@ -52182,6 +54203,12 @@
    Fields
    + + + attachments - [NegotiableQuoteCommentAttachmentInput] + + Negotiable quote comment file attachments. + comment - String! @@ -52195,7 +54222,10 @@
    Fields
    Example
    - 
    {"comment": "abc123"}
+                  
    {
+  "attachments": [NegotiableQuoteCommentAttachmentInput],
+  "comment": "xyz789"
+}
    @@ -52246,7 +54276,7 @@
    Fields
    Example
    {
-  "new_value": "abc123",
+  "new_value": "xyz789",
   "old_value": "xyz789",
   "title": "xyz789"
 }
@@ -52459,6 +54489,11 @@ 
    Fields
    
                         
                          Timestamp indicating when the negotiable quote entry was created. 
                       
+                      
+                        item_note - HistoryItemNoteData
+                        
+                         Item note data that is added to the negotiable quote history object. 
+                      
                       
                         uid - ID!
                         
@@ -52476,7 +54511,8 @@ 
    Example
    
   "change_type": "CREATED",
   "changes": NegotiableQuoteHistoryChanges,
   "created_at": "abc123",
-  "uid": "4"
+  "item_note": HistoryItemNoteData,
+  "uid": 4
 }
    @@ -52583,7 +54619,7 @@
    Fields
    Example
    {
   "new_expiration": "xyz789",
-  "old_expiration": "abc123"
+  "old_expiration": "xyz789"
 }
    @@ -52853,7 +54889,7 @@
    Fields
    Example
    - 
    {"quantity": 123.45, "quote_item_uid": 4}
+                  
    {"quantity": 123.45, "quote_item_uid": "4"}
    @@ -52901,7 +54937,7 @@
    Fields
    Example
    {
-  "code": "xyz789",
+  "code": "abc123",
   "purchase_order_number": "abc123"
 }
    @@ -52959,9 +54995,9 @@
    Fields
    Example
    {
-  "document_identifier": "abc123",
+  "document_identifier": "xyz789",
   "document_name": "abc123",
-  "link_id": "4",
+  "link_id": 4,
   "reference_document_url": "abc123"
 }
    @@ -53012,6 +55048,11 @@
    Fields
    The custom attribute values of the billing or shipping negotiable quote address. + + customer_address_uid - ID + + The unique ID from the customer's address book that uniquely identifies the address. + fax - String @@ -53070,7 +55111,7 @@
    Fields
    uid - ID! - The unique identifier of the address. + The unique identifier of the negotiable quote address. vat_id - String @@ -53086,21 +55127,22 @@
    Fields
    Example
    {
   "available_shipping_methods": [AvailableShippingMethod],
-  "city": "abc123",
-  "company": "xyz789",
+  "city": "xyz789",
+  "company": "abc123",
   "country": NegotiableQuoteAddressCountry,
   "custom_attributes": [AttributeValueInterface],
+  "customer_address_uid": "4",
   "fax": "abc123",
-  "firstname": "abc123",
-  "lastname": "xyz789",
+  "firstname": "xyz789",
+  "lastname": "abc123",
   "middlename": "xyz789",
-  "postcode": "abc123",
-  "prefix": "xyz789",
+  "postcode": "xyz789",
+  "prefix": "abc123",
   "region": NegotiableQuoteAddressRegion,
   "selected_shipping_method": SelectedShippingMethod,
   "street": ["xyz789"],
   "suffix": "xyz789",
-  "telephone": "abc123",
+  "telephone": "xyz789",
   "uid": 4,
   "vat_id": "abc123"
 }
@@ -53388,6 +55430,11 @@ 
    Fields
    
                         
                          A list of comments made by the buyer and seller. 
                       
+                      
+                        created_at - String!
+                        
+                         Timestamp indicating when the negotiable quote template was created. 
+                      
                       
                         expiration_date - String!
                         
@@ -53398,6 +55445,12 @@ 
    Fields
    
                         
                          A list of status and price changes for the negotiable quote template. 
                       
+                      
+                        historyV2 - [NegotiableQuoteTemplateHistoryEntry]
+                        
+                        
+                        
+                      
                       
                         is_min_max_qty_used - Boolean!
                         
@@ -53443,6 +55496,11 @@ 
    Fields
    
                         
                          A list of reference document links for the negotiable quote template. 
                       
+                      
+                        sales_rep_name - String!
+                        
+                         The first and last name of the sales representative. 
+                      
                       
                         shipping_addresses - [NegotiableQuoteShippingAddress]!
                         
@@ -53463,6 +55521,16 @@ 
    Fields
    
                         
                          The total number of items in the negotiable quote template. 
                       
+                      
+                        uid - ID!
+                        
+                         The unique ID of a NegotiableQuoteTemplate object. 
+                      
+                      
+                        updated_at - String!
+                        
+                         Timestamp indicating when the negotiable quote template was updated. 
+
    @@ -53473,12 +55541,14 @@
    Example
    {
   "buyer": NegotiableQuoteUser,
   "comments": [NegotiableQuoteComment],
-  "expiration_date": "xyz789",
+  "created_at": "xyz789",
+  "expiration_date": "abc123",
   "history": [NegotiableQuoteHistoryEntry],
+  "historyV2": [NegotiableQuoteTemplateHistoryEntry],
   "is_min_max_qty_used": true,
-  "is_virtual": true,
+  "is_virtual": false,
   "items": [CartItemInterface],
-  "max_order_commitment": 123,
+  "max_order_commitment": 987,
   "min_order_commitment": 987,
   "name": "xyz789",
   "notifications": [QuoteTemplateNotificationMessage],
@@ -53486,10 +55556,13 @@ 
    Example
    
   "reference_document_links": [
     NegotiableQuoteReferenceDocumentLink
   ],
+  "sales_rep_name": "abc123",
   "shipping_addresses": [NegotiableQuoteShippingAddress],
-  "status": "xyz789",
-  "template_id": 4,
-  "total_quantity": 123.45
+  "status": "abc123",
+  "template_id": "4",
+  "total_quantity": 987.65,
+  "uid": "4",
+  "updated_at": "xyz789"
 }
    @@ -53578,6 +55651,11 @@
    Fields
    Company name the quote template is assigned to + + created_at - String! + + Timestamp indicating when the negotiable quote template was created. + expiration_date - String! @@ -53588,6 +55666,11 @@
    Fields
    Indicates whether the minimum and maximum quantity settings are used. + + last_ordered_at - String! + + Timestamp indicating when the last negotiable quote template order was placed. + last_shared_at - String! @@ -53618,6 +55701,11 @@
    Fields
    The number of orders placed for the negotiable quote template. + + prices - CartPrices + + A set of subtotals and totals applied to the negotiable quote template. + sales_rep_name - String! @@ -53643,6 +55731,16 @@
    Fields
    The unique ID of a NegotiableQuoteTemplate object. + + uid - ID! + + The unique ID of a NegotiableQuoteTemplate object. + + + updated_at - String! + + Timestamp indicating when the negotiable quote template was updated. + @@ -53652,21 +55750,252 @@
    Fields
    Example
    {
   "activated_at": "xyz789",
-  "company_name": "abc123",
-  "expiration_date": "xyz789",
-  "is_min_max_qty_used": false,
-  "last_shared_at": "abc123",
+  "company_name": "xyz789",
+  "created_at": "xyz789",
+  "expiration_date": "abc123",
+  "is_min_max_qty_used": true,
+  "last_ordered_at": "xyz789",
+  "last_shared_at": "xyz789",
   "max_order_commitment": 123,
-  "min_negotiated_grand_total": 987.65,
-  "min_order_commitment": 987,
-  "name": "xyz789",
-  "orders_placed": 987,
+  "min_negotiated_grand_total": 123.45,
+  "min_order_commitment": 123,
+  "name": "abc123",
+  "orders_placed": 123,
+  "prices": CartPrices,
   "sales_rep_name": "xyz789",
-  "state": "xyz789",
+  "state": "abc123",
   "status": "abc123",
   "submitted_by": "xyz789",
-  "template_id": 4
+  "template_id": "4",
+  "uid": "4",
+  "updated_at": "xyz789"
+}
+
    + + + back to top + +
    +
    +
    + Types +
    +

    NegotiableQuoteTemplateHistoryChanges

    +
    +
    +
    +
    Description
    +

    Contains a list of changes to a negotiable quote template.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    comment_added - NegotiableQuoteHistoryCommentChange + The comment provided with a change in the negotiable quote history.
    custom_changes - NegotiableQuoteCustomLogChange + Lists log entries added by third-party extensions.
    expiration - NegotiableQuoteHistoryExpirationChange + The expiration date of the negotiable quote before and after a change in the quote history.
    products_removed - NegotiableQuoteHistoryProductsRemovedChange + Lists products that were removed as a result of a change in the quote history.
    statuses - NegotiableQuoteTemplateHistoryStatusesChange + The status before and after a change in the negotiable quote template history.
    total - NegotiableQuoteHistoryTotalChange + The total amount of the negotiable quote before and after a change in the quote history.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "comment_added": NegotiableQuoteHistoryCommentChange,
+  "custom_changes": NegotiableQuoteCustomLogChange,
+  "expiration": NegotiableQuoteHistoryExpirationChange,
+  "products_removed": NegotiableQuoteHistoryProductsRemovedChange,
+  "statuses": NegotiableQuoteTemplateHistoryStatusesChange,
+  "total": NegotiableQuoteHistoryTotalChange
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    NegotiableQuoteTemplateHistoryEntry

    +
    +
    +
    +
    Description
    +

    Contains details about a change for a negotiable quote template.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    author - NegotiableQuoteUser! + The person who made a change in the status of the negotiable quote.
    change_type - NegotiableQuoteHistoryEntryChangeType! + An enum that specifies the reason for a status change in the negotiable quote history entry.
    changes - NegotiableQuoteTemplateHistoryChanges + The set of changes in the negotiable quote template.
    created_at - String! + Timestamp indicating when the negotiable quote entry was created.
    uid - ID! + The unique ID of a NegotiableQuoteHistoryEntry object.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "author": NegotiableQuoteUser,
+  "change_type": "CREATED",
+  "changes": NegotiableQuoteTemplateHistoryChanges,
+  "created_at": "xyz789",
+  "uid": "4"
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    NegotiableQuoteTemplateHistoryStatusChange

    +
    +
    +
    +
    Description
    +

    Lists a new status change applied to a negotiable quote template and the previous status.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    new_status - String! + The updated status.
    old_status - String + The previous status. The value will be null for the first history entry in a negotiable quote.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "new_status": "abc123",
+  "old_status": "abc123"
 }
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    NegotiableQuoteTemplateHistoryStatusesChange

    +
    +
    +
    +
    Description
    +

    Contains a list of status changes that occurred for the negotiable quote template.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Field NameDescription
    changes - [NegotiableQuoteTemplateHistoryStatusChange]! + A list of status changes.
    +
    +
    +
    +
    +
    Example
    + 
    {"changes": [NegotiableQuoteTemplateHistoryStatusChange]}
    @@ -53725,12 +56054,7 @@
    Fields
    Example
    - 
    {
-  "item_id": "4",
-  "max_qty": 987.65,
-  "min_qty": 123.45,
-  "quantity": 123.45
-}
+                  
    {"item_id": 4, "max_qty": 123.45, "min_qty": 123.45, "quantity": 123.45}
    @@ -53792,7 +56116,7 @@
    Example
    {
   "document_identifier": "xyz789",
   "document_name": "xyz789",
-  "link_id": "4",
+  "link_id": 4,
   "reference_document_url": "xyz789"
 }
    @@ -54054,7 +56378,7 @@
    Possible Types
    Example
    - 
    {"quote_uid": 4}
+                  
    {"quote_uid": "4"}
    @@ -54140,7 +56464,7 @@
    Fields
    Example
    {
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "lastname": "abc123"
 }
    @@ -54247,7 +56571,100 @@
    Fields
    Example
    - 
    {"message": "xyz789", "uid": 4}
+                  
    {
+  "message": "abc123",
+  "uid": "4"
+}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    NumericOperatorInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + type - NumericOperatorType + +
    +
    +
    +
    +
    +
    Example
    + 
    {"type": "UNKNOWN_NUMERIC_OPERATOR"}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    NumericOperatorType

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

    UNKNOWN_NUMERIC_OPERATOR

    +     		+
    +

    GREATER_THAN_CURRENT

    +     		+
    +

    LESS_THAN_CURRENT

    +     		+
    +
    +
    +
    +
    +
    Example
    + 
    "UNKNOWN_NUMERIC_OPERATOR"
    @@ -54289,7 +56706,7 @@
    Fields
    Example
    {
-  "backend_integration_url": "xyz789",
+  "backend_integration_url": "abc123",
   "custom_config": [CustomConfigKeyValue]
 }
    @@ -54332,7 +56749,79 @@
    Fields
    Example
    - 
    {"template_id": 4}
+                  
    {"template_id": "4"}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    OperatorInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + rangeOperator - RangeOperatorInput + +
    + customOperator - CustomOperatorInput + +
    + isOperator - IsOperatorInput + +
    + numericOperator - NumericOperatorInput + +
    + stringOperator - StringOperatorInput + +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "rangeOperator": RangeOperatorInput,
+  "customOperator": CustomOperatorInput,
+  "isOperator": IsOperatorInput,
+  "numericOperator": NumericOperatorInput,
+  "stringOperator": StringOperatorInput
+}
    @@ -54372,7 +56861,7 @@
    Fields
    Example
    - 
    {"order_number": "abc123"}
+                  
    {"order_number": "xyz789"}
    @@ -54558,21 +57047,21 @@
    attributeCodes
    Example
    {
   "city": "abc123",
-  "company": "abc123",
+  "company": "xyz789",
   "country_code": "AF",
   "custom_attributesV2": [AttributeValueInterface],
-  "fax": "abc123",
+  "fax": "xyz789",
   "firstname": "abc123",
-  "lastname": "abc123",
-  "middlename": "abc123",
-  "postcode": "xyz789",
-  "prefix": "xyz789",
-  "region": "abc123",
-  "region_id": 4,
-  "street": ["xyz789"],
+  "lastname": "xyz789",
+  "middlename": "xyz789",
+  "postcode": "abc123",
+  "prefix": "abc123",
+  "region": "xyz789",
+  "region_id": "4",
+  "street": ["abc123"],
   "suffix": "abc123",
-  "telephone": "abc123",
-  "vat_id": "xyz789"
+  "telephone": "xyz789",
+  "vat_id": "abc123"
 }
    @@ -54630,8 +57119,8 @@
    Fields
    Example
    {
-  "firstname": "xyz789",
-  "lastname": "xyz789",
+  "firstname": "abc123",
+  "lastname": "abc123",
   "middlename": "abc123",
   "prefix": "xyz789",
   "suffix": "abc123"
@@ -54785,7 +57274,7 @@ 
    Example
    
                   
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
-  "eligible_for_return": false,
+  "eligible_for_return": true,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
@@ -54795,14 +57284,14 @@ 
    Example
    
   "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "product_type": "abc123",
-  "product_url_key": "abc123",
-  "quantity_canceled": 123.45,
-  "quantity_invoiced": 123.45,
-  "quantity_ordered": 987.65,
-  "quantity_refunded": 123.45,
-  "quantity_return_requested": 987.65,
-  "quantity_returned": 123.45,
+  "product_type": "xyz789",
+  "product_url_key": "xyz789",
+  "quantity_canceled": 987.65,
+  "quantity_invoiced": 987.65,
+  "quantity_ordered": 123.45,
+  "quantity_refunded": 987.65,
+  "quantity_return_requested": 123.45,
+  "quantity_returned": 987.65,
   "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
   "status": "abc123"
@@ -55001,23 +57490,23 @@ 
    Example
    
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": 4,
+  "id": "4",
   "prices": OrderItemPrices,
   "product": ProductInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "abc123",
+  "product_sku": "xyz789",
   "product_type": "abc123",
   "product_url_key": "xyz789",
-  "quantity_canceled": 987.65,
-  "quantity_invoiced": 123.45,
+  "quantity_canceled": 123.45,
+  "quantity_invoiced": 987.65,
   "quantity_ordered": 987.65,
-  "quantity_refunded": 987.65,
+  "quantity_refunded": 123.45,
   "quantity_return_requested": 987.65,
   "quantity_returned": 123.45,
-  "quantity_shipped": 123.45,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "abc123"
+  "status": "xyz789"
 }
    @@ -55064,7 +57553,7 @@
    Fields
    Example
    {
-  "label": "abc123",
+  "label": "xyz789",
   "value": "abc123"
 }
    @@ -55218,7 +57707,7 @@
    Example
    {
   "additional_data": [KeyValue],
   "name": "abc123",
-  "type": "xyz789"
+  "type": "abc123"
 }
    @@ -55281,7 +57770,7 @@
    Fields
    Example
    {
   "comments": [SalesCommentItem],
-  "id": 4,
+  "id": "4",
   "items": [ShipmentItemInterface],
   "number": "abc123",
   "tracking": [ShipmentTracking]
@@ -55326,7 +57815,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"token": "xyz789"}
+                  
    {"token": "abc123"}
 
    
                 
    
               
    
@@ -55573,7 +58062,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "key": "xyz789",
+  "key": "abc123",
   "value": "xyz789"
 }
 
    
@@ -55678,9 +58167,9 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "code": "xyz789",
-  "is_visible": true,
-  "payment_intent": "abc123",
+  "code": "abc123",
+  "is_visible": false,
+  "payment_intent": "xyz789",
   "sdk_params": [SDKParams],
   "sort_order": "abc123",
   "title": "abc123"
@@ -55918,7 +58407,7 @@ 
    Example
    
   "payment_services_paypal_hosted_fields": HostedFieldsInput,
   "payment_services_paypal_smart_buttons": SmartButtonMethodInput,
   "payment_services_paypal_vault": VaultMethodInput,
-  "purchase_order_number": "xyz789"
+  "purchase_order_number": "abc123"
 }
 
    
                 
    
@@ -55976,7 +58465,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "id": "abc123",
-  "mp_order_id": "xyz789",
+  "mp_order_id": "abc123",
   "payment_source_details": PaymentSourceDetails,
   "status": "xyz789"
 }
@@ -56021,7 +58510,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "code": "xyz789",
+  "code": "abc123",
   "params": [SDKParams]
 }
 
    
@@ -56196,9 +58685,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "details": "xyz789",
+  "details": "abc123",
   "payment_method_code": "xyz789",
-  "public_hash": "xyz789",
+  "public_hash": "abc123",
   "type": "card"
 }
 
    
@@ -56453,14 +58942,14 @@ 
    Example
    
   "city": "xyz789",
   "contact_name": "abc123",
   "country_id": "xyz789",
-  "description": "xyz789",
+  "description": "abc123",
   "email": "abc123",
-  "fax": "abc123",
-  "latitude": 123.45,
-  "longitude": 123.45,
+  "fax": "xyz789",
+  "latitude": 987.65,
+  "longitude": 987.65,
   "name": "xyz789",
-  "phone": "abc123",
-  "pickup_location_code": "xyz789",
+  "phone": "xyz789",
+  "pickup_location_code": "abc123",
   "postcode": "xyz789",
   "region": "abc123",
   "region_id": 123,
@@ -56800,7 +59289,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"quote_uid": 4}
+                  
    {"quote_uid": "4"}
 
    
                 
    
               
    
@@ -56833,8 +59322,48 @@ 
    Fields
    
                         
                          Contains the generated order number. 
                       
+                    
+                  
+                
    
+              
    
+              
    
+                
    
+                  
    Example
    
+                  
    {"order": Order}
+
    
+                
    
+              
    
+              back to top
+            
    
+
    +
    +
    + Types +
    +

    PlaceNegotiableQuoteOrderOutputV2

    +
    +
    +
    +
    Description
    +

    An output object that returns the generated order.

    +
    +
    +
    Fields
    + + + + + + + + - + + + + @@ -56846,8 +59375,8 @@
    Fields
    Example
    {
-  "order": Order,
-  "orderV2": CustomerOrder
+  "errors": [PlaceOrderError],
+  "order": CustomerOrder
 }
    @@ -56895,7 +59424,7 @@
    Fields
    Example
    {
   "code": "CART_NOT_FOUND",
-  "message": "xyz789"
+  "message": "abc123"
 }
    @@ -57173,7 +59702,7 @@
    Fields
    Example
    - 
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}
    @@ -57306,7 +59835,7 @@
    Fields
    Example
    - 
    {"amount": 987.65, "code": "abc123"}
+                  
    {"amount": 123.45, "code": "xyz789"}
    @@ -57559,7 +60088,7 @@
    Fields
    Example
    {
-  "code": "abc123",
+  "code": "xyz789",
   "value": "abc123"
 }
    @@ -57654,7 +60183,7 @@
    Fields
    Example
    - 
    {"amount_off": 123.45, "percent_off": 987.65}
+                  
    {"amount_off": 123.45, "percent_off": 123.45}
    @@ -57710,9 +60239,9 @@
    Fields
    Example
    {
-  "disabled": false,
-  "label": "xyz789",
-  "position": 123,
+  "disabled": true,
+  "label": "abc123",
+  "position": 987,
   "url": "abc123"
 }
    @@ -58095,8 +60624,8 @@
    Example
    "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": false, - "gift_wrapping_available": false, + "gift_message_available": true, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", @@ -58106,28 +60635,28 @@
    Example
    "meta_description": "xyz789", "meta_keyword": "xyz789", "meta_title": "abc123", - "min_sale_qty": 123.45, + "min_sale_qty": 987.65, "name": "xyz789", - "new_from_date": "xyz789", - "new_to_date": "xyz789", + "new_from_date": "abc123", + "new_to_date": "abc123", "only_x_left_in_stock": 987.65, "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 987.65, + "quantity": 123.45, "related_products": [ProductInterface], "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, "special_price": 987.65, "special_to_date": "abc123", "stock_status": "IN_STOCK", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, - "uid": "4", + "uid": 4, "upsell_products": [ProductInterface], - "url_key": "abc123" + "url_key": "xyz789" }
    @@ -58192,7 +60721,7 @@
    Example
    "link_type": "xyz789", "linked_product_sku": "abc123", "linked_product_type": "xyz789", - "position": 123, + "position": 987, "sku": "abc123" }     @@ -58272,7 +60801,7 @@
    Possible Types
    Example
    {
-  "link_type": "xyz789",
+  "link_type": "abc123",
   "linked_product_sku": "xyz789",
   "linked_product_type": "abc123",
   "position": 123,
@@ -58330,7 +60859,7 @@ 
    Example
    
                   
    {
   "asset_id": "xyz789",
   "media_type": "abc123",
-  "media_url": "abc123"
+  "media_url": "xyz789"
 }
    @@ -58382,7 +60911,7 @@
    Fields
    Example
    {
-  "media_type": "abc123",
+  "media_type": "xyz789",
   "video_asset_id": "abc123",
   "video_media_url": "abc123"
 }
@@ -58453,10 +60982,10 @@ 
    Example
    
                   
    {
   "media_type": "xyz789",
   "video_description": "abc123",
-  "video_metadata": "abc123",
-  "video_provider": "abc123",
-  "video_title": "abc123",
-  "video_url": "xyz789"
+  "video_metadata": "xyz789",
+  "video_provider": "xyz789",
+  "video_title": "xyz789",
+  "video_url": "abc123"
 }
    @@ -58629,6 +61158,11 @@
    Fields
     + + + +
    Field NameDescription
    orderV2 - CustomerOrder + errors - [PlaceOrderError] + An array of place negotiable quote order errors.
    order - CustomerOrder Full order information.
    The total number of products returned that matched the query
    warnings - [ProductSearchWarning] + An array of warning messages for validation issues (e.g., sort parameter ignored due to missing categoryPath)
    @@ -58642,7 +61176,8 @@
    Example
    "page_info": SearchResultPageInfo, "related_terms": ["abc123"], "suggestions": ["abc123"], - "total_count": 987 + "total_count": 123, + "warnings": [ProductSearchWarning] }
    @@ -58690,7 +61225,55 @@
    Fields
    Example
    - 
    {"attribute": "xyz789", "direction": "ASC"}
+                  
    {"attribute": "abc123", "direction": "ASC"}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    ProductSearchWarning

    +
    +
    +
    +
    Description
    +

    Structured warning with code and message for easier client handling

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    code - String! + Error code for programmatic handling (e.g., EMPTY_CATEGORY_PATH)
    message - String! + Human-readable message describing the warning
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "code": "xyz789",
+  "message": "xyz789"
+}
    @@ -58800,10 +61383,10 @@
    Fields
    Example
    {
-  "disabled": false,
+  "disabled": true,
   "label": "xyz789",
   "position": 987,
-  "url": "abc123",
+  "url": "xyz789",
   "video_content": ProductMediaGalleryEntriesVideoContent
 }
    @@ -58854,7 +61437,7 @@
    Fields
    attributes - [ProductViewAttribute] - A list of merchant-defined attributes designated for the storefront. + A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names. @@ -58865,6 +61448,10 @@
    Arguments
    roles - [String]
    +
    +
    names - [String] +
    +
    @@ -59022,23 +61609,23 @@
    Example
    "inStock": true, "lowStock": false, "attributes": [ProductViewAttribute], - "description": "xyz789", - "id": "4", + "description": "abc123", + "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", "metaDescription": "abc123", "metaKeyword": "xyz789", - "metaTitle": "xyz789", + "metaTitle": "abc123", "name": "xyz789", - "shortDescription": "abc123", + "shortDescription": "xyz789", "inputOptions": [ProductViewInputOption], "sku": "xyz789", - "externalId": "abc123", + "externalId": "xyz789", "url": "xyz789", - "urlKey": "xyz789", + "urlKey": "abc123", "links": [ProductViewLink], - "queryType": "xyz789", + "queryType": "abc123", "visibility": "abc123" }     @@ -59097,7 +61684,7 @@
    Fields
    Example
    {
   "label": "xyz789",
-  "name": "abc123",
+  "name": "xyz789",
   "roles": ["abc123"],
   "value": {}
 }
@@ -60378,7 +62965,7 @@ 
    Example
    
                   
    {
   "label": "abc123",
   "roles": ["abc123"],
-  "url": "abc123"
+  "url": "xyz789"
 }
 
    
                 
@@ -60468,16 +63055,16 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": "4",
-  "title": "abc123",
-  "required": true,
-  "type": "abc123",
-  "markupAmount": 987.65,
-  "suffix": "abc123",
+  "id": 4,
+  "title": "xyz789",
+  "required": false,
+  "type": "xyz789",
+  "markupAmount": 123.45,
+  "suffix": "xyz789",
   "sortOrder": 987,
   "range": ProductViewInputOptionRange,
   "imageSize": ProductViewInputOptionImageSize,
-  "fileExtensions": "abc123"
+  "fileExtensions": "xyz789"
 }
 
    
                 
    
@@ -60521,7 +63108,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"width": 123, "height": 987}
+                  
    {"width": 987, "height": 987}
 
    
                 
    
               
    
@@ -60564,7 +63151,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"from": 987.65, "to": 987.65}
+                  
    {"from": 123.45, "to": 987.65}
 
    
                 
    
               
    
@@ -60611,7 +63198,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "product": ProductView,
-  "linkTypes": ["abc123"]
+  "linkTypes": ["xyz789"]
 }
 
    
                 
@@ -60657,7 +63244,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"currency": "AED", "value": 987.65}
+                  
    {"currency": "AED", "value": 123.45}
 
    
                 
    
               
    
@@ -60718,10 +63305,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": "4",
-  "multi": true,
+  "id": 4,
+  "multi": false,
   "required": false,
-  "title": "abc123",
+  "title": "xyz789",
   "values": [ProductViewOptionValue]
 }
 
    
@@ -60801,9 +63388,9 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "id": "4",
+  "id": 4,
   "title": "abc123",
-  "inStock": false
+  "inStock": true
 }
 
    
                 
    
@@ -60855,8 +63442,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": "4",
-  "title": "abc123",
+  "id": 4,
+  "title": "xyz789",
   "inStock": true
 }
 
    
@@ -60924,11 +63511,11 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "id": 4,
-  "isDefault": false,
+  "id": "4",
+  "isDefault": true,
   "product": SimpleProductView,
-  "quantity": 123.45,
-  "title": "abc123",
+  "quantity": 987.65,
+  "title": "xyz789",
   "inStock": true
 }
 
    
@@ -60992,9 +63579,9 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "id": "4",
-  "title": "abc123",
+  "title": "xyz789",
   "type": "TEXT",
-  "value": "xyz789",
+  "value": "abc123",
   "inStock": false
 }
 
    
@@ -61055,7 +63642,7 @@ 
    Example
    
   "final": Price,
   "regular": Price,
   "tiers": [ProductViewTierPrice],
-  "roles": ["abc123"]
+  "roles": ["xyz789"]
 }
    @@ -61181,7 +63768,7 @@
    Fields
    Example
    - 
    {"in": [987.65]}
+                  
    {"in": [123.45]}
    @@ -61268,7 +63855,7 @@
    Fields
    Example
    - 
    {"gte": 987.65, "lt": 123.45}
+                  
    {"gte": 987.65, "lt": 987.65}
    @@ -61310,7 +63897,7 @@
    Fields
    Example
    {
-  "selections": ["xyz789"],
+  "selections": ["abc123"],
   "product": ProductView
 }
    @@ -61413,8 +64000,8 @@
    Fields
    Example
    {
   "preview": ProductViewImage,
-  "url": "abc123",
-  "description": "xyz789",
+  "url": "xyz789",
+  "description": "abc123",
   "title": "xyz789"
 }
    @@ -61497,7 +64084,7 @@
    Fields
    - approval_flow - [PurchaseOrderRuleApprovalFlow]! + approval_flow - [PurchaseOrderRuleApprovalFlow] The approval flows for each applied rules. @@ -61570,12 +64157,12 @@
    Example
    "created_at": "xyz789", "created_by": Customer, "history_log": [PurchaseOrderHistoryItem], - "number": "xyz789", + "number": "abc123", "order": CustomerOrder, "quote": Cart, "status": "PENDING", - "uid": "4", - "updated_at": "xyz789" + "uid": 4, + "updated_at": "abc123" }
    @@ -61748,8 +64335,8 @@
    Fields
    Example
    {
-  "message": "xyz789",
-  "name": "abc123",
+  "message": "abc123",
+  "name": "xyz789",
   "role": "abc123",
   "status": "PENDING",
   "updated_at": "xyz789"
@@ -61894,10 +64481,10 @@ 
    Example
    
   "applies_to_roles": [CompanyRole],
   "approver_roles": [CompanyRole],
   "condition": PurchaseOrderApprovalRuleConditionInterface,
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "created_by": "xyz789",
-  "description": "xyz789",
-  "name": "abc123",
+  "description": "abc123",
+  "name": "xyz789",
   "status": "ENABLED",
   "uid": 4,
   "updated_at": "abc123"
@@ -62131,7 +64718,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}
+                  
    {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123}
 
    
                 
    
               
    
@@ -62204,7 +64791,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "applies_to": ["4"],
-  "approvers": ["4"],
+  "approvers": [4],
   "condition": CreatePurchaseOrderApprovalRuleConditionInput,
   "description": "xyz789",
   "name": "abc123",
@@ -62413,7 +65000,7 @@ 
    Example
    
                   
    {
   "items": [PurchaseOrderApprovalRule],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
    @@ -62472,8 +65059,8 @@
    Example
    {
   "author": Customer,
   "created_at": "xyz789",
-  "text": "xyz789",
-  "uid": "4"
+  "text": "abc123",
+  "uid": 4
 }
    @@ -62598,8 +65185,8 @@
    Example
    {
   "activity": "xyz789",
   "created_at": "abc123",
-  "message": "xyz789",
-  "uid": 4
+  "message": "abc123",
+  "uid": "4"
 }
    @@ -62647,7 +65234,7 @@
    Fields
    Example
    {
   "events": [PurchaseOrderApprovalFlowEvent],
-  "rule_name": "xyz789"
+  "rule_name": "abc123"
 }
    @@ -62837,7 +65424,7 @@
    Fields
    Example
    - 
    {"purchase_order_uids": ["4"]}
+                  
    {"purchase_order_uids": [4]}
    @@ -62925,6 +65512,12 @@
    Fields
    Filter by the creation date of the purchase order. + + + my_approvals - Boolean + + Include purchase orders that are pending approval by the customer or eligible for their approval but have already been dealt with. + require_my_approval - Boolean @@ -62945,8 +65538,9 @@
    Fields
    Example
    {
-  "company_purchase_orders": false,
+  "company_purchase_orders": true,
   "created_date": FilterRangeTypeInput,
+  "my_approvals": true,
   "require_my_approval": true,
   "status": "PENDING"
 }
@@ -63043,6 +65637,56 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {"field": "ITEM_ID", "order": "ASC"}
+
    
+                
    
+
    + back to top + +
    +
    +
    + Types +
    +

    QuoteTemplateExpirationDateInput

    +
    +
    +
    +
    Description
    +

    Sets quote template expiration date.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + expiration_date - String! + The expiration period of the negotiable quote template.
    + template_id - ID! + The unique ID of a NegotiableQuoteTemplate object.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "expiration_date": "abc123",
+  "template_id": 4
+}
    @@ -63072,7 +65716,13 @@
    Fields
    - item_id - ID! + item_id - ID + + The unique ID of a CartLineItem object. + + + + item_uid - ID The unique ID of a CartLineItem object. @@ -63097,6 +65747,7 @@
    Fields
    Example
    {
   "item_id": "4",
+  "item_uid": 4,
   "note": "xyz789",
   "templateId": "4"
 }
@@ -63146,7 +65797,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "message": "xyz789",
-  "type": "abc123"
+  "type": "xyz789"
 }
    @@ -63204,10 +65855,159 @@
    Fields
    Example
    {
   "count": 123,
-  "from": 123.45,
-  "title": "abc123",
-  "to": 987.65
+  "from": 987.65,
+  "title": "xyz789",
+  "to": 123.45
 }
+
    + + + back to top + +
    +
    +
    + Types +
    +

    RangeOperatorInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + type - RangeType + +
    + value - RangeValueInput + +
    +
    +
    +
    +
    +
    Example
    + 
    {"type": "UNKNOWN_RANGE_TYPE", "value": RangeValueInput}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    RangeType

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

    UNKNOWN_RANGE_TYPE

    +     		+
    +

    STATIC

    +     		+
    +

    PERCENTAGE

    +     		+
    +

    DYNAMIC

    +     		+
    +
    +
    +
    +
    +
    Example
    + 
    "UNKNOWN_RANGE_TYPE"
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    RangeValueInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + from - Float + +
    + to - Float + +
    +
    +
    +
    +
    +
    Example
    + 
    {"from": 987.65, "to": 987.65}
    @@ -63412,11 +66212,11 @@
    Fields
    Example
    {
-  "badge_position": "xyz789",
+  "badge_position": "abc123",
   "failure_message": "xyz789",
   "forms": ["PLACE_ORDER"],
-  "is_enabled": true,
-  "language_code": "abc123",
+  "is_enabled": false,
+  "language_code": "xyz789",
   "minimum_score": 123.45,
   "theme": "abc123",
   "website_key": "xyz789"
@@ -63573,6 +66373,13 @@ 
    Values
    
                         
                         
                       
+                      
+                        
+                          
    RECAPTCHA_ENTERPRISE
    
+                        
+                        
+                        
+
    @@ -63663,7 +66470,7 @@
    Example
    "totalProducts": 987, "typeId": "abc123", "unitId": "abc123", - "unitName": "xyz789" + "unitName": "abc123" }
    @@ -63756,9 +66563,9 @@
    Fields
    Example
    {
-  "code": "abc123",
+  "code": "xyz789",
   "id": 123,
-  "name": "xyz789"
+  "name": "abc123"
 }
    @@ -63938,8 +66745,8 @@
    Fields
    Example
    {
-  "cart_id": "abc123",
-  "gift_card_code": "abc123"
+  "cart_id": "xyz789",
+  "gift_card_code": "xyz789"
 }
    @@ -64148,7 +66955,7 @@
    Fields
    Example
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "cart_item_uid": "4"
 }
    @@ -64237,7 +67044,7 @@
    Fields
    Example
    - 
    {"quote_item_uids": ["4"], "quote_uid": 4}
+                  
    {"quote_item_uids": [4], "quote_uid": 4}
    @@ -64324,7 +67131,7 @@
    Fields
    Example
    - 
    {"item_uids": [4], "template_id": 4}
+                  
    {"item_uids": [4], "template_id": "4"}
    @@ -64371,7 +67178,10 @@
    Fields
    Example
    - 
    {"products": ["4"], "uid": 4}
+                  
    {
+  "products": ["4"],
+  "uid": "4"
+}
    @@ -64890,10 +67700,10 @@
    Fields
    Example
    {
-  "cart_id": "4",
+  "cart_id": 4,
   "comment": NegotiableQuoteCommentInput,
   "is_draft": true,
-  "quote_name": "xyz789"
+  "quote_name": "abc123"
 }
    @@ -64975,7 +67785,7 @@
    Fields
    Example
    - 
    {"cart_id": "4"}
+                  
    {"cart_id": 4}
    @@ -65035,8 +67845,8 @@
    Fields
    Example
    {
-  "comment_text": "abc123",
-  "contact_email": "xyz789",
+  "comment_text": "xyz789",
+  "contact_email": "abc123",
   "items": [RequestReturnItemInput],
   "order_uid": 4
 }
@@ -65103,7 +67913,7 @@ 
    Example
    
     EnteredCustomAttributeInput
   ],
   "order_item_uid": 4,
-  "quantity_to_return": 123.45,
+  "quantity_to_return": 987.65,
   "selected_custom_attributes": [
     SelectedCustomAttributeInput
   ]
@@ -65259,12 +68069,12 @@ 
    pageSize
                   
    Example
    
                   
    {
-  "description": "xyz789",
+  "description": "abc123",
   "items": RequistionListItems,
   "items_count": 987,
-  "name": "abc123",
-  "uid": 4,
-  "updated_at": "xyz789"
+  "name": "xyz789",
+  "uid": "4",
+  "updated_at": "abc123"
 }
    @@ -65416,7 +68226,7 @@
    Example
    {
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": "4"
 }
    @@ -65485,11 +68295,101 @@
    Fields
    Example
    {
   "entered_options": [EnteredOptionInput],
-  "parent_sku": "xyz789",
-  "quantity": 123.45,
-  "selected_options": ["abc123"],
+  "parent_sku": "abc123",
+  "quantity": 987.65,
+  "selected_options": ["xyz789"],
   "sku": "xyz789"
 }
+
    +
    + + back to top + +
    +
    +
    + Types +
    +

    RequisitionListSortInput

    +
    +
    +
    +
    Description
    +

    Defines the field to use to sort a list of requisition lists.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + sort_direction - SortEnum + Whether to return results in ascending or descending order.
    + sort_field - RequisitionListSortableField! + The specified sort field.
    +
    +
    +
    +
    +
    Example
    + 
    {"sort_direction": "ASC", "sort_field": "NAME"}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    RequisitionListSortableField

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

    NAME

    +     		Sorts requisition lists by requisition list name.
    +

    UPDATED_AT

    +     		Sorts requisition lists by the date they were last updated.
    +
    +
    +
    +
    +
    Example
    + 
    "NAME"
    @@ -65527,6 +68427,11 @@
    Fields
    Pagination metadata. + + sort_fields - SortFields + + Contains the default sort field and all available sort fields. + total_count - Int @@ -65542,7 +68447,8 @@
    Example
    {
   "items": [RequisitionList],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "sort_fields": SortFields,
+  "total_count": 987
 }
    @@ -65596,7 +68502,7 @@
    Example
    {
   "items": [RequisitionListItemInterface],
   "page_info": SearchResultPageInfo,
-  "total_pages": 987
+  "total_pages": 123
 }
    @@ -65685,14 +68591,14 @@
    Example
    {
   "available_shipping_carriers": [ReturnShippingCarrier],
   "comments": [ReturnComment],
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "customer": ReturnCustomer,
   "items": [ReturnItem],
-  "number": "abc123",
+  "number": "xyz789",
   "order": CustomerOrder,
   "shipping": ReturnShipping,
   "status": "PENDING",
-  "uid": "4"
+  "uid": 4
 }
    @@ -65750,8 +68656,8 @@
    Fields
    Example
    {
   "author_name": "xyz789",
-  "created_at": "abc123",
-  "text": "xyz789",
+  "created_at": "xyz789",
+  "text": "abc123",
   "uid": 4
 }
    @@ -65805,7 +68711,7 @@
    Fields
    Example
    {
   "email": "abc123",
-  "firstname": "xyz789",
+  "firstname": "abc123",
   "lastname": "xyz789"
 }
    @@ -65875,10 +68781,10 @@
    Example
    {
   "custom_attributesV2": [AttributeValueInterface],
   "order_item": OrderItemInterface,
-  "quantity": 987.65,
-  "request_quantity": 123.45,
+  "quantity": 123.45,
+  "request_quantity": 987.65,
   "status": "PENDING",
-  "uid": "4"
+  "uid": 4
 }
    @@ -65981,17 +68887,17 @@
    Fields
    Example
    {
   "code": 4,
-  "default_value": "abc123",
+  "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "abc123",
+  "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
   "input_filter": "NONE",
-  "is_required": true,
+  "is_required": false,
   "is_unique": true,
-  "label": "abc123",
-  "multiline_count": 987,
+  "label": "xyz789",
+  "multiline_count": 123,
   "options": [CustomAttributeOptionInterface],
-  "sort_order": 987,
+  "sort_order": 123,
   "validate_rules": [ValidationRule]
 }
    @@ -66198,8 +69104,8 @@
    Fields
    Example
    {
-  "city": "xyz789",
-  "contact_name": "abc123",
+  "city": "abc123",
+  "contact_name": "xyz789",
   "country": Country,
   "postcode": "xyz789",
   "region": Region,
@@ -66251,7 +69157,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "label": "abc123",
+  "label": "xyz789",
   "uid": "4"
 }
 
    
@@ -66311,7 +69217,7 @@ 
    Example
    
                   
    {
   "carrier": ReturnShippingCarrier,
   "status": ReturnShippingTrackingStatus,
-  "tracking_number": "abc123",
+  "tracking_number": "xyz789",
   "uid": 4
 }
 
    
@@ -66358,7 +69264,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"text": "abc123", "type": "INFORMATION"}
+                  
    {"text": "xyz789", "type": "INFORMATION"}
 
    
                 
    
               
    
@@ -66619,7 +69525,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"result": false}
+                  
    {"result": true}
 
    
                 
    
               
    
@@ -66720,7 +69626,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"money": Money, "points": 123.45}
+                  
    {"money": Money, "points": 987.65}
 
    
                 
    
               
    
@@ -66777,7 +69683,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "balance": RewardPointsAmount,
-  "change_reason": "abc123",
+  "change_reason": "xyz789",
   "date": "xyz789",
   "points_change": 123.45
 }
@@ -66873,7 +69779,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"currency_amount": 123.45, "points": 987.65}
+                  
    {"currency_amount": 123.45, "points": 123.45}
 
    
                 
    
               
    
@@ -67240,12 +70146,12 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "attribute": "abc123",
-  "contains": "xyz789",
-  "eq": "xyz789",
-  "in": ["xyz789"],
+  "attribute": "xyz789",
+  "contains": "abc123",
+  "eq": "abc123",
+  "in": ["abc123"],
   "range": SearchRangeInput,
-  "startsWith": "abc123"
+  "startsWith": "xyz789"
 }
 
    
                 
    
@@ -67293,7 +70199,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"from": 987.65, "to": 123.45}
+                  
    {"from": 987.65, "to": 987.65}
 
    
                 
    
               
    
@@ -67343,7 +70249,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"current_page": 987, "page_size": 123, "total_pages": 123}
+                  
    {"current_page": 123, "page_size": 123, "total_pages": 987}
 
    
                 
    
               
    
@@ -67399,8 +70305,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "label": "xyz789",
-  "type": "abc123",
+  "label": "abc123",
+  "type": "xyz789",
   "uid": 4,
   "values": [SelectedBundleOptionValue]
 }
@@ -67464,7 +70370,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "label": "xyz789",
+  "label": "abc123",
   "original_price": Money,
   "priceV2": Money,
   "quantity": 123.45,
@@ -67527,8 +70433,8 @@ 
    Example
    
                   
    {
   "configurable_product_option_uid": 4,
   "configurable_product_option_value_uid": "4",
-  "option_label": "xyz789",
-  "value_label": "abc123"
+  "option_label": "abc123",
+  "value_label": "xyz789"
 }
 
    
                 
    
@@ -67578,7 +70484,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "attribute_code": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
    
                 
    
@@ -67645,10 +70551,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "customizable_option_uid": 4,
-  "is_required": false,
+  "customizable_option_uid": "4",
+  "is_required": true,
   "label": "xyz789",
-  "sort_order": 123,
+  "sort_order": 987,
   "type": "abc123",
   "values": [SelectedCustomizableOptionValue]
 }
@@ -67707,10 +70613,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "customizable_option_value_uid": 4,
-  "label": "abc123",
+  "customizable_option_value_uid": "4",
+  "label": "xyz789",
   "price": CartItemSelectedOptionValuePrice,
-  "value": "xyz789"
+  "value": "abc123"
 }
 
    
                 
    
@@ -67769,8 +70675,8 @@ 
    Example
    
                   
    {
   "code": "abc123",
   "oope_payment_method_config": OopePaymentMethodConfig,
-  "purchase_order_number": "xyz789",
-  "title": "abc123"
+  "purchase_order_number": "abc123",
+  "title": "xyz789"
 }
 
    
                 
    
@@ -67902,10 +70808,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {
-  "comment": NegotiableQuoteCommentInput,
-  "quote_uid": "4"
-}
+                  
    {"comment": NegotiableQuoteCommentInput, "quote_uid": 4}
 
    
                 
    
               
    
@@ -67994,7 +70897,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "billing_address": BillingAddressInput,
-  "cart_id": "xyz789"
+  "cart_id": "abc123"
 }
 
    
                 
    
@@ -68080,7 +70983,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"error": "xyz789", "success": true}
+                  
    {"error": "xyz789", "success": false}
 
    
                 
    
               
    
@@ -68127,7 +71030,10 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {"custom_attributes": [CustomAttributeInput], "id": 4}
+                  
    {
+  "custom_attributes": [CustomAttributeInput],
+  "id": "4"
+}
 
    
                 
    
               
    
@@ -68216,7 +71122,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "custom_attributes": [CustomAttributeInput],
-  "quote_uid": 4
+  "quote_uid": "4"
 }
    @@ -68323,11 +71229,11 @@
    Fields
    Example
    {
-  "cart_id": "abc123",
+  "cart_id": "xyz789",
   "gift_message": GiftMessageInput,
   "gift_receipt_included": true,
-  "gift_wrapping_id": 4,
-  "printed_card_included": false
+  "gift_wrapping_id": "4",
+  "printed_card_included": true
 }
    @@ -68417,7 +71323,7 @@
    Fields
    Example
    {
   "cart_id": "abc123",
-  "email": "abc123"
+  "email": "xyz789"
 }
    @@ -68547,7 +71453,7 @@
    Fields
    Example
    {
   "billing_address": NegotiableQuoteBillingAddressInput,
-  "quote_uid": "4"
+  "quote_uid": 4
 }
    @@ -68637,7 +71543,7 @@
    Fields
    Example
    {
   "payment_method": NegotiableQuotePaymentMethodInput,
-  "quote_uid": "4"
+  "quote_uid": 4
 }
    @@ -68818,7 +71724,7 @@
    Fields
    Example
    {
-  "quote_uid": 4,
+  "quote_uid": "4",
   "shipping_methods": [ShippingMethodInput]
 }
    @@ -68909,7 +71815,7 @@
    Fields
    Example
    {
   "shipping_address": NegotiableQuoteTemplateShippingAddressInput,
-  "template_id": 4
+  "template_id": "4"
 }
    @@ -68958,7 +71864,7 @@
    Fields
    Example
    {
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "payment_method": PaymentMethodInput
 }
    @@ -69318,8 +72224,8 @@
    Fields
    Example
    {
-  "message": "abc123",
-  "name": "xyz789"
+  "message": "xyz789",
+  "name": "abc123"
 }
    @@ -69431,9 +72337,9 @@
    Fields
    Example
    {
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "abc123",
   "quantity_shipped": 987.65
@@ -69588,7 +72494,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "carrier": "xyz789",
-  "number": "xyz789",
+  "number": "abc123",
   "title": "xyz789"
 }
 
    
@@ -69638,7 +72544,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "key": "abc123",
+  "key": "xyz789",
   "value": "xyz789"
 }
 
    
@@ -69680,6 +72586,12 @@ 
    Fields
    
                         
                          An ID from the customer's address book that uniquely identifies the address to be used for shipping. 
                       
+                      
+                        
+                          customer_address_uid - ID
+                        
+                         The unique ID from the customer's address book that uniquely identifies the address to be used for shipping. 
+                      
                       
                         
                           customer_notes - String
@@ -69702,6 +72614,7 @@ 
    Example
    
                   
    {
   "address": CartAddressInput,
   "customer_address_id": 987,
+  "customer_address_uid": 4,
   "customer_notes": "abc123",
   "pickup_location_code": "abc123"
 }
@@ -69762,6 +72675,11 @@ 
    Fields
    
                         
                          The custom attribute values of the billing or shipping address. 
                       
+                      
+                        customer_address_uid - ID
+                        
+                         The unique ID from the customer's address book that uniquely identifies the address. 
+                      
                       
                         customer_notes - String
                         
@@ -69778,9 +72696,10 @@ 
    Fields
    
                          The first name of the customer or guest. 
                       
                       
-                        id - Int
+                        id - Int
+                        
+                         Id of the customer address. Use customer_address_uid instead.
                         
-                         Id of the customer address. 
                       
                       
                         lastname - String!
@@ -69839,9 +72758,9 @@ 
    Fields
    
                          The telephone number for the billing or shipping address. 
                       
                       
-                        uid - String!
+                        uid - ID!
                         
-                         The unique id of the customer address. 
+                         The unique id of the customer cart address. 
                       
                       
                         vat_id - String
@@ -69858,27 +72777,28 @@ 
    Example
    
                   
    {
   "available_shipping_methods": [AvailableShippingMethod],
   "cart_items_v2": [CartItemInterface],
-  "city": "xyz789",
+  "city": "abc123",
   "company": "xyz789",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
+  "customer_address_uid": 4,
   "customer_notes": "abc123",
-  "fax": "xyz789",
-  "firstname": "xyz789",
+  "fax": "abc123",
+  "firstname": "abc123",
   "id": 987,
   "lastname": "abc123",
-  "middlename": "xyz789",
-  "pickup_location_code": "abc123",
-  "postcode": "xyz789",
+  "middlename": "abc123",
+  "pickup_location_code": "xyz789",
+  "postcode": "abc123",
   "prefix": "abc123",
   "region": CartAddressRegion,
-  "same_as_billing": false,
+  "same_as_billing": true,
   "selected_shipping_method": SelectedShippingMethod,
-  "street": ["abc123"],
+  "street": ["xyz789"],
   "suffix": "abc123",
-  "telephone": "abc123",
-  "uid": "abc123",
-  "vat_id": "abc123"
+  "telephone": "xyz789",
+  "uid": "4",
+  "vat_id": "xyz789"
 }
 
    
                 
    
@@ -70033,7 +72953,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "carrier_code": "xyz789",
+  "carrier_code": "abc123",
   "method_code": "abc123"
 }
 
    
@@ -70165,9 +73085,9 @@ 
    Example
    
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
   "is_available": true,
-  "max_qty": 987.65,
-  "min_qty": 123.45,
-  "not_available_message": "abc123",
+  "max_qty": 123.45,
+  "min_qty": 987.65,
+  "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
@@ -70428,9 +73348,9 @@ 
    filters
                 
    
                   
    Example
    
                   
    {
-  "canonical_url": "xyz789",
+  "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "country_of_manufacture": "abc123",
+  "country_of_manufacture": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
@@ -70438,37 +73358,37 @@ 
    Example
    
   "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
   "image": ProductImage,
-  "is_returnable": "xyz789",
-  "manufacturer": 987,
-  "max_sale_qty": 123.45,
+  "is_returnable": "abc123",
+  "manufacturer": 123,
+  "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "meta_description": "xyz789",
-  "meta_keyword": "xyz789",
+  "meta_keyword": "abc123",
   "meta_title": "xyz789",
-  "min_sale_qty": 123.45,
+  "min_sale_qty": 987.65,
   "name": "abc123",
   "new_from_date": "xyz789",
   "new_to_date": "abc123",
   "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
-  "options_container": "xyz789",
+  "options_container": "abc123",
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "quantity": 987.65,
+  "quantity": 123.45,
   "related_products": [ProductInterface],
   "short_description": ComplexTextValue,
-  "sku": "abc123",
+  "sku": "xyz789",
   "small_image": ProductImage,
-  "special_price": 987.65,
-  "special_to_date": "xyz789",
+  "special_price": 123.45,
+  "special_to_date": "abc123",
   "stock_status": "IN_STOCK",
-  "swatch_image": "abc123",
+  "swatch_image": "xyz789",
   "thumbnail": ProductImage,
   "uid": 4,
   "upsell_products": [ProductInterface],
   "url_key": "xyz789",
-  "weight": 987.65
+  "weight": 123.45
 }
 
    
                 
    
@@ -70518,7 +73438,7 @@ 
    Fields
    
                       
                         attributes - [ProductViewAttribute]
                         
-                         A list of merchant-defined attributes designated for the storefront. 
+                         A list of merchant-defined attributes designated for the storefront. They can be filtered by names and roles. 
                       
                       
                         
@@ -70529,6 +73449,10 @@ 
     Arguments 
    
                                 
    roles - [String]
                                 
    
                               
    
+                              
    
+                                
    names - [String]
+                                
    
+
    @@ -70665,29 +73589,29 @@
    linkTypes
    Example
    {
-  "addToCartAllowed": true,
-  "inStock": false,
-  "lowStock": false,
+  "addToCartAllowed": false,
+  "inStock": true,
+  "lowStock": true,
   "attributes": [ProductViewAttribute],
   "description": "abc123",
-  "id": 4,
+  "id": "4",
   "images": [ProductViewImage],
   "videos": [ProductViewVideo],
   "inputOptions": [ProductViewInputOption],
   "lastModifiedAt": "2007-12-03T10:15:30Z",
   "metaDescription": "xyz789",
   "metaKeyword": "xyz789",
-  "metaTitle": "abc123",
-  "name": "abc123",
+  "metaTitle": "xyz789",
+  "name": "xyz789",
   "price": ProductViewPrice,
   "shortDescription": "xyz789",
-  "sku": "abc123",
+  "sku": "xyz789",
   "externalId": "xyz789",
   "url": "xyz789",
   "urlKey": "xyz789",
   "links": [ProductViewLink],
-  "queryType": "abc123",
-  "visibility": "xyz789"
+  "queryType": "xyz789",
+  "visibility": "abc123"
 }
    @@ -70747,7 +73671,7 @@
    Example
    {
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": "4"
 }
    @@ -70816,10 +73740,10 @@
    Fields
    Example
    {
-  "added_at": "xyz789",
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
-  "id": 4,
+  "description": "abc123",
+  "id": "4",
   "product": ProductInterface,
   "quantity": 987.65
 }
@@ -70877,7 +73801,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "payment_source": "xyz789",
-  "payments_order_id": "xyz789",
+  "payments_order_id": "abc123",
   "paypal_order_id": "xyz789"
 }
 
    
@@ -70903,6 +73827,11 @@ 
    Fields
    
                       
                     
                     
+                      
+                        app_switch_when_available - Boolean
+                        
+                         Indicated whether to use App Switch on enabled mobile devices 
+                      
                       
                         button_styles - ButtonStyles
                         
@@ -70961,13 +73890,14 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
+  "app_switch_when_available": false,
   "button_styles": ButtonStyles,
   "code": "xyz789",
   "display_message": true,
   "display_venmo": true,
-  "is_visible": false,
+  "is_visible": true,
   "message_styles": MessageStyles,
-  "payment_intent": "abc123",
+  "payment_intent": "xyz789",
   "sdk_params": [SDKParams],
   "sort_order": "abc123",
   "title": "xyz789"
@@ -71066,8 +73996,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "label": "xyz789",
-  "value": "xyz789"
+  "label": "abc123",
+  "value": "abc123"
 }
 
    
                 
    
@@ -71114,7 +74044,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "default": "abc123",
+  "default": "xyz789",
   "options": [SortField]
 }
 
    
@@ -71495,7 +74425,7 @@ 
    Example
    
                   
    {
   "max": 123.45,
   "min": 987.65,
-  "title": "abc123"
+  "title": "xyz789"
 }
 
    
                 
    
@@ -71524,6 +74454,11 @@ 
    Fields
    
                       
                     
                     
+                      
+                        allow_company_registration - Boolean!
+                        
+                         Indicates if company registration is allowed 
+                      
                       
                         allow_gift_receipt - String
                         
@@ -71674,6 +74609,16 @@ 
    Fields
    
                         
                          The title of the Check/Money Order payment method displayed on the storefront. 
                       
+                      
+                        company_credit_enabled - Boolean!
+                        
+                         Indicates if company credit is enabled. 
+                      
+                      
+                        company_enabled - Boolean!
+                        
+                         Indicates if B2B company functionality is enabled 
+                      
                       
                         configurable_product_image - ProductImageThumbnail!
                         
@@ -72009,6 +74954,16 @@ 
    Fields
    
                         
                          Indicates whether quick order functionality is enabled. 
                       
+                      
+                        quote_minimum_amount - Float
+                        
+                         Minimum order total for quote request. 
+                      
+                      
+                        quote_minimum_amount_message - String
+                        
+                         A message that will be shown in the cart when the subtotal (after discount) is lower than the minimum allowed amount. 
+                      
                       
                         required_character_classes_number - String
                         
@@ -72202,139 +75157,144 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
+  "allow_company_registration": true,
   "allow_gift_receipt": "abc123",
   "allow_gift_wrapping_on_order": "abc123",
   "allow_gift_wrapping_on_order_items": "abc123",
   "allow_items": "xyz789",
-  "allow_order": "abc123",
+  "allow_order": "xyz789",
   "allow_printed_card": "abc123",
-  "autocomplete_on_storefront": true,
+  "autocomplete_on_storefront": false,
   "base_currency_code": "xyz789",
-  "base_link_url": "xyz789",
+  "base_link_url": "abc123",
   "base_media_url": "xyz789",
   "base_static_url": "abc123",
   "base_url": "xyz789",
   "cart_expires_in_days": 123,
-  "cart_gift_wrapping": "xyz789",
-  "cart_merge_preference": "xyz789",
+  "cart_gift_wrapping": "abc123",
+  "cart_merge_preference": "abc123",
   "cart_printed_card": "xyz789",
-  "cart_summary_display_quantity": 987,
-  "catalog_default_sort_by": "xyz789",
+  "cart_summary_display_quantity": 123,
+  "catalog_default_sort_by": "abc123",
   "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
   "category_url_suffix": "abc123",
   "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": "xyz789",
-  "check_money_order_max_order_total": "xyz789",
-  "check_money_order_min_order_total": "xyz789",
+  "check_money_order_max_order_total": "abc123",
+  "check_money_order_min_order_total": "abc123",
   "check_money_order_new_order_status": "abc123",
   "check_money_order_payment_from_specific_countries": "abc123",
-  "check_money_order_send_check_to": "abc123",
-  "check_money_order_sort_order": 987,
-  "check_money_order_title": "abc123",
+  "check_money_order_send_check_to": "xyz789",
+  "check_money_order_sort_order": 123,
+  "check_money_order_title": "xyz789",
+  "company_credit_enabled": false,
+  "company_enabled": false,
   "configurable_product_image": "ITSELF",
-  "configurable_thumbnail_source": "abc123",
+  "configurable_thumbnail_source": "xyz789",
   "contact_enabled": false,
-  "countries_with_required_region": "abc123",
+  "countries_with_required_region": "xyz789",
   "create_account_confirmation": false,
   "customer_access_token_lifetime": 123.45,
   "default_country": "abc123",
   "default_display_currency_code": "abc123",
-  "display_product_prices_in_catalog": 123,
+  "display_product_prices_in_catalog": 987,
   "display_shipping_prices": 987,
   "display_state_if_optional": false,
   "enable_multiple_wishlists": "xyz789",
   "fixed_product_taxes_apply_tax_to_fpt": false,
   "fixed_product_taxes_display_prices_in_emails": 987,
-  "fixed_product_taxes_display_prices_in_product_lists": 987,
-  "fixed_product_taxes_display_prices_in_sales_modules": 987,
+  "fixed_product_taxes_display_prices_in_product_lists": 123,
+  "fixed_product_taxes_display_prices_in_sales_modules": 123,
   "fixed_product_taxes_display_prices_on_product_view_page": 123,
-  "fixed_product_taxes_enable": false,
+  "fixed_product_taxes_enable": true,
   "fixed_product_taxes_include_fpt_in_subtotal": false,
-  "graphql_share_customer_group": true,
+  "graphql_share_customer_group": false,
   "grid_per_page": 987,
   "grid_per_page_values": "abc123",
   "grouped_product_image": "ITSELF",
   "is_checkout_agreements_enabled": true,
-  "is_default_store": false,
+  "is_default_store": true,
   "is_default_store_group": true,
   "is_guest_checkout_enabled": true,
-  "is_negotiable_quote_active": false,
-  "is_one_page_checkout_enabled": true,
+  "is_negotiable_quote_active": true,
+  "is_one_page_checkout_enabled": false,
   "is_requisition_list_active": "xyz789",
   "list_mode": "xyz789",
   "list_per_page": 987,
-  "list_per_page_values": "abc123",
+  "list_per_page_values": "xyz789",
   "locale": "abc123",
-  "magento_reward_general_is_enabled": "abc123",
+  "magento_reward_general_is_enabled": "xyz789",
   "magento_reward_general_is_enabled_on_front": "abc123",
   "magento_reward_general_min_points_balance": "xyz789",
   "magento_reward_general_publish_history": "abc123",
   "magento_reward_points_invitation_customer": "xyz789",
-  "magento_reward_points_invitation_customer_limit": "xyz789",
-  "magento_reward_points_invitation_order": "xyz789",
-  "magento_reward_points_invitation_order_limit": "xyz789",
+  "magento_reward_points_invitation_customer_limit": "abc123",
+  "magento_reward_points_invitation_order": "abc123",
+  "magento_reward_points_invitation_order_limit": "abc123",
   "magento_reward_points_newsletter": "xyz789",
-  "magento_reward_points_order": "xyz789",
-  "magento_reward_points_register": "abc123",
-  "magento_reward_points_review": "abc123",
+  "magento_reward_points_order": "abc123",
+  "magento_reward_points_register": "xyz789",
+  "magento_reward_points_review": "xyz789",
   "magento_reward_points_review_limit": "abc123",
   "magento_wishlist_general_is_enabled": "xyz789",
-  "max_items_in_order_summary": 123,
-  "maximum_number_of_wishlists": "abc123",
+  "max_items_in_order_summary": 987,
+  "maximum_number_of_wishlists": "xyz789",
   "minicart_display": false,
   "minicart_max_items": 987,
-  "minimum_password_length": "abc123",
+  "minimum_password_length": "xyz789",
   "newsletter_enabled": false,
-  "optional_zip_countries": "abc123",
-  "order_cancellation_enabled": true,
+  "optional_zip_countries": "xyz789",
+  "order_cancellation_enabled": false,
   "order_cancellation_reasons": [CancellationReason],
-  "orders_invoices_credit_memos_display_full_summary": false,
-  "orders_invoices_credit_memos_display_grandtotal": true,
+  "orders_invoices_credit_memos_display_full_summary": true,
+  "orders_invoices_credit_memos_display_grandtotal": false,
   "orders_invoices_credit_memos_display_price": 123,
   "orders_invoices_credit_memos_display_shipping_amount": 123,
-  "orders_invoices_credit_memos_display_subtotal": 123,
-  "orders_invoices_credit_memos_display_zero_tax": false,
+  "orders_invoices_credit_memos_display_subtotal": 987,
+  "orders_invoices_credit_memos_display_zero_tax": true,
   "printed_card_priceV2": Money,
   "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-  "product_url_suffix": "xyz789",
+  "product_url_suffix": "abc123",
   "quickorder_active": false,
-  "required_character_classes_number": "abc123",
-  "returns_enabled": "xyz789",
+  "quote_minimum_amount": 987.65,
+  "quote_minimum_amount_message": "abc123",
+  "required_character_classes_number": "xyz789",
+  "returns_enabled": "abc123",
   "root_category_uid": "4",
   "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-  "sales_gift_wrapping": "abc123",
-  "sales_printed_card": "xyz789",
+  "sales_gift_wrapping": "xyz789",
+  "sales_printed_card": "abc123",
   "secure_base_link_url": "abc123",
   "secure_base_media_url": "xyz789",
   "secure_base_static_url": "xyz789",
-  "secure_base_url": "abc123",
-  "share_active_segments": false,
+  "secure_base_url": "xyz789",
+  "share_active_segments": true,
   "share_applied_cart_rule": true,
   "shopping_cart_display_full_summary": false,
   "shopping_cart_display_grand_total": true,
   "shopping_cart_display_price": 987,
-  "shopping_cart_display_shipping": 987,
+  "shopping_cart_display_shipping": 123,
   "shopping_cart_display_subtotal": 987,
   "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
-  "shopping_cart_display_zero_tax": false,
+  "shopping_cart_display_zero_tax": true,
   "store_code": "4",
-  "store_group_code": 4,
-  "store_group_name": "xyz789",
+  "store_group_code": "4",
+  "store_group_name": "abc123",
   "store_name": "abc123",
   "store_sort_order": 987,
   "timezone": "abc123",
   "title_separator": "abc123",
-  "use_store_in_url": true,
+  "use_store_in_url": false,
   "website_code": "4",
-  "website_name": "abc123",
-  "weight_unit": "xyz789",
+  "website_name": "xyz789",
+  "weight_unit": "abc123",
   "zero_subtotal_enable_for_specific_countries": false,
   "zero_subtotal_enabled": true,
-  "zero_subtotal_new_order_status": "xyz789",
-  "zero_subtotal_payment_action": "xyz789",
+  "zero_subtotal_new_order_status": "abc123",
+  "zero_subtotal_payment_action": "abc123",
   "zero_subtotal_payment_from_specific_countries": "abc123",
-  "zero_subtotal_sort_order": 987,
+  "zero_subtotal_sort_order": 123,
   "zero_subtotal_title": "abc123"
 }
 
    
@@ -72359,6 +75319,96 @@ 
    Description
    
                 
    
                   
    Example
    
                   
    "abc123"
+
    
+                
    
+              
    
+              back to top
+            
    
+
    +
    +
    + Types +
    +

    StringOperatorInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + type - StringOperatorType + +
    +
    +
    +
    +
    +
    Example
    + 
    {"type": "UNKNOWN_STRING_OPERATOR"}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    StringOperatorType

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

    UNKNOWN_STRING_OPERATOR

    +     		+
    +

    SAME_AS_CURRENT

    +     		+
    +

    ALL_EXCEPT_CURRENT

    +     		+
    +
    +
    +
    +
    +
    Example
    + 
    "UNKNOWN_STRING_OPERATOR"
    @@ -72386,6 +75436,12 @@
    Fields
    + + + attachments - [NegotiableQuoteCommentAttachmentInput] + + Negotiable quote template comment file attachments. + comment - String @@ -72430,14 +75486,15 @@
    Fields
    Example
    {
-  "comment": "abc123",
+  "attachments": [NegotiableQuoteCommentAttachmentInput],
+  "comment": "xyz789",
   "max_order_commitment": 123,
   "min_order_commitment": 987,
-  "name": "xyz789",
+  "name": "abc123",
   "reference_document_links": [
     NegotiableQuoteTemplateReferenceDocumentLinkInput
   ],
-  "template_id": 4
+  "template_id": "4"
 }
    @@ -72586,7 +75643,7 @@
    Fields
    Example
    - 
    {"depth": 123, "startLevel": 987}
+                  
    {"depth": 123, "startLevel": 123}
    @@ -72649,7 +75706,7 @@
    Possible Types
    Example
    - 
    {"value": "abc123"}
+                  
    {"value": "xyz789"}
    @@ -72971,7 +76028,7 @@
    Fields
    Example
    {
   "amount": Money,
-  "rate": 987.65,
+  "rate": 123.45,
   "title": "abc123"
 }
    @@ -73061,7 +76118,7 @@
    Fields
    Example
    - 
    {"value": "xyz789"}
+                  
    {"value": "abc123"}
    @@ -73170,7 +76227,103 @@
    Example
    {
   "discount": ProductDiscount,
   "final_price": Money,
-  "quantity": 987.65
+  "quantity": 123.45
+}
+
    +
    + + back to top + +
    +
    +
    + Types +
    +

    UnitConfigInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + unitName - String + +
    + storefrontLabel - String + +
    + pagePlacement - String + +
    + displayNumber - Int + +
    + pageType - String + +
    + unitStatus - String + +
    + typeId - String + +
    + filterRules - [FilterRuleInput] + +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "unitName": "xyz789",
+  "storefrontLabel": "abc123",
+  "pagePlacement": "xyz789",
+  "displayNumber": 987,
+  "pageType": "xyz789",
+  "unitStatus": "abc123",
+  "typeId": "xyz789",
+  "filterRules": [FilterRuleInput]
 }
    @@ -73545,7 +76698,7 @@
    Example
    GiftRegistryDynamicAttributeInput ], "event_name": "abc123", - "message": "abc123", + "message": "xyz789", "privacy_settings": "PRIVATE", "shipping_address": GiftRegistryShippingAddressInput, "status": "ACTIVE" @@ -73603,7 +76756,7 @@
    Fields
    Example
    {
-  "gift_registry_item_uid": 4,
+  "gift_registry_item_uid": "4",
   "note": "abc123",
   "quantity": 123.45
 }
@@ -73758,7 +76911,7 @@ 
    Example
    
   "email": "xyz789",
   "firstname": "xyz789",
   "gift_registry_registrant_uid": "4",
-  "lastname": "abc123"
+  "lastname": "xyz789"
 }
    @@ -74415,7 +77568,7 @@
    Fields
    Example
    {
   "currentPage": 987,
-  "pageSize": 123,
+  "pageSize": 987,
   "sort": [CompaniesSortInput]
 }
    @@ -74510,7 +77663,7 @@
    Fields
    Example
    - 
    {"message": "abc123", "type": "NOT_FOUND"}
+                  
    {"message": "xyz789", "type": "NOT_FOUND"}
    @@ -74712,7 +77865,7 @@
    Fields
    Example
    {
   "name": "DATE_RANGE_MAX",
-  "value": "abc123"
+  "value": "xyz789"
 }
    @@ -74898,7 +78051,7 @@
    Fields
    Example
    {
-  "is_vault_enabled": false,
+  "is_vault_enabled": true,
   "sdk_params": [SDKParams],
   "three_ds_mode": "OFF"
 }
@@ -74961,10 +78114,10 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "payment_source": "abc123",
+  "payment_source": "xyz789",
   "payments_order_id": "abc123",
-  "paypal_order_id": "xyz789",
-  "public_hash": "xyz789"
+  "paypal_order_id": "abc123",
+  "public_hash": "abc123"
 }
 
    
                 
    
@@ -75057,7 +78210,7 @@ 
    Fields
    
                   
    Example
    
                   
    {
   "date": "2007-12-03T10:15:30Z",
-  "sku": "xyz789"
+  "sku": "abc123"
 }
    @@ -75109,7 +78262,7 @@
    Fields
    Example
    {
   "dateTime": "2007-12-03T10:15:30Z",
-  "sku": "xyz789"
+  "sku": "abc123"
 }
    @@ -75221,9 +78374,9 @@
    Example
    "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "is_available": false, - "max_qty": 987.65, - "min_qty": 123.45, + "is_available": true, + "max_qty": 123.45, + "min_qty": 987.65, "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], @@ -75482,44 +78635,44 @@
    Example
    {
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "country_of_manufacture": "abc123",
+  "country_of_manufacture": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "gift_message_available": true,
+  "gift_message_available": false,
   "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
   "image": ProductImage,
   "is_returnable": "xyz789",
-  "manufacturer": 123,
+  "manufacturer": 987,
   "max_sale_qty": 123.45,
   "media_gallery": [MediaGalleryInterface],
   "meta_description": "xyz789",
   "meta_keyword": "xyz789",
-  "meta_title": "abc123",
-  "min_sale_qty": 123.45,
-  "name": "abc123",
+  "meta_title": "xyz789",
+  "min_sale_qty": 987.65,
+  "name": "xyz789",
   "new_from_date": "xyz789",
   "new_to_date": "xyz789",
   "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
-  "options_container": "abc123",
+  "options_container": "xyz789",
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "quantity": 123.45,
+  "quantity": 987.65,
   "related_products": [ProductInterface],
   "short_description": ComplexTextValue,
   "sku": "xyz789",
   "small_image": ProductImage,
-  "special_price": 123.45,
+  "special_price": 987.65,
   "special_to_date": "abc123",
   "stock_status": "IN_STOCK",
   "swatch_image": "abc123",
   "thumbnail": ProductImage,
   "uid": "4",
   "upsell_products": [ProductInterface],
-  "url_key": "xyz789"
+  "url_key": "abc123"
 }
    @@ -75648,12 +78801,12 @@
    Fields
    Example
    {
-  "added_at": "xyz789",
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
-  "id": 4,
+  "id": "4",
   "product": ProductInterface,
-  "quantity": 987.65
+  "quantity": 123.45
 }
    @@ -75839,12 +78992,12 @@
    pageSize
    Example
    {
-  "id": 4,
-  "items_count": 987,
+  "id": "4",
+  "items_count": 123,
   "items_v2": WishlistItems,
-  "name": "abc123",
-  "sharing_code": "abc123",
-  "updated_at": "xyz789",
+  "name": "xyz789",
+  "sharing_code": "xyz789",
+  "updated_at": "abc123",
   "visibility": "PUBLIC"
 }
    @@ -75903,9 +79056,9 @@
    Fields
    Example
    {
   "code": "PRODUCT_NOT_FOUND",
-  "message": "abc123",
-  "wishlistId": "4",
-  "wishlistItemId": "4"
+  "message": "xyz789",
+  "wishlistId": 4,
+  "wishlistItemId": 4
 }
    @@ -76093,8 +79246,8 @@
    Fields
    Example
    {
   "entered_options": [EnteredOptionInput],
-  "parent_sku": "xyz789",
-  "quantity": 123.45,
+  "parent_sku": "abc123",
+  "quantity": 987.65,
   "selected_options": [4],
   "sku": "xyz789"
 }
@@ -76211,9 +79364,9 @@ 
    Possible Types
    
                 
    
                   
    Example
    
                   
    {
-  "added_at": "abc123",
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
+  "description": "abc123",
   "id": 4,
   "product": ProductInterface,
   "quantity": 123.45
@@ -76264,10 +79417,7 @@ 
    Fields
    
               
    
                 
    
                   
    Example
    
-                  
    {
-  "quantity": 123.45,
-  "wishlist_item_id": "4"
-}
+                  
    {"quantity": 987.65, "wishlist_item_id": 4}
 
    
                 
    
               
    
@@ -76333,9 +79483,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "description": "xyz789",
+  "description": "abc123",
   "entered_options": [EnteredOptionInput],
-  "quantity": 123.45,
+  "quantity": 987.65,
   "selected_options": ["4"],
   "wishlist_item_id": 4
 }
@@ -76479,8 +79629,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "key": "xyz789",
-  "media_resource_type": "CUSTOMER_ATTRIBUTE_FILE"
+  "key": "abc123",
+  "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT"
 }
 
    
                 
    
@@ -76528,9 +79678,9 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "key": "xyz789",
+  "key": "abc123",
   "message": "xyz789",
-  "success": false
+  "success": true
 }
 
    
                 
    
@@ -76575,8 +79725,8 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "key": "xyz789",
-  "media_resource_type": "CUSTOMER_ATTRIBUTE_FILE"
+  "key": "abc123",
+  "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT"
 }
 
    
                 
    
@@ -76624,7 +79774,7 @@ 
    Fields
    
                 
    
                   
    Example
    
                   
    {
-  "expires_at": "abc123",
+  "expires_at": "xyz789",
   "key": "abc123",
   "upload_url": "xyz789"
 }