diff --git a/spectaql/schema_saas.json b/spectaql/schema_saas.json index 52b050599..c4cbc770e 100644 --- a/spectaql/schema_saas.json +++ b/spectaql/schema_saas.json @@ -1344,6 +1344,45 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "AddProductsToNewCartOutput", + "description": "Contains details about the cart after adding products to it.", + "fields": [ + { + "name": "cart", + "description": "The cart after products have been added.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user_errors", + "description": "Contains errors encountered while adding an item to the cart.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserInputError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "AddProductsToRequisitionListOutput", @@ -3158,6 +3197,51 @@ ], "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "AttributeFile", + "description": "", + "fields": [ + { + "name": "code", + "description": "The attribute code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "File URL to download the file", + "args": [], + "type": { + "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": "AttributeFilterInput", @@ -4207,6 +4291,11 @@ "interfaces": [], "enumValues": null, "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AttributeFile", + "ofType": null + }, { "kind": "OBJECT", "name": "AttributeSelectedOptions", @@ -11989,6 +12078,38 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "available_payment_methods", + "description": "Available payment methods for the company with proper B2B configuration and company-specific filtering.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AvailablePaymentMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available_shipping_methods", + "description": "Available shipping carriers for the company with proper B2B configuration and company-specific filtering.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyAvailableShippingMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "company_admin", "description": "An object containing information about the company administrator.", @@ -12647,6 +12768,49 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "CompanyAvailableShippingMethod", + "description": "Describes a carrier-level shipping option available to the company.", + "fields": [ + { + "name": "code", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "CompanyBasicInfo", @@ -14697,6 +14861,45 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "CompleteOrderInput", + "description": "Update the quote and complete the order", + "fields": null, + "inputFields": [ + { + "name": "cartId", + "description": "The customer cart ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "id", + "description": "PayPal order ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "ComplexProductView", @@ -23210,6 +23413,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "uid", + "description": "The unique ID for a `CustomerAddress` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "vat_id", "description": "The customer's Value-added tax (VAT) number (for corporate customers).", @@ -30232,6 +30451,142 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "FastlaneConfig", + "description": "", + "fields": [ + { + "name": "code", + "description": "The payment method code as defined in the payment gateway", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_visible", + "description": "Indicates whether the payment method is displayed", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_intent", + "description": "Defines the payment intent (Authorize or Capture", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_source", + "description": "The payment source for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sdk_params", + "description": "The PayPal parameters required to load the JS SDK", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SDKParams", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The relative order the payment method is displayed on the checkout page", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name displayed for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "PaymentConfigItem", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FastlaneMethodInput", + "description": "Fastlane Payment inputs", + "fields": null, + "inputFields": [ + { + "name": "payment_source", + "description": "The payment source for the payment method", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paypal_fastlane_token", + "description": "The single use token from Fastlane", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "FilterableInSearchAttribute", @@ -30619,6 +30974,100 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "finishUploadInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "The unique key identifier from the upload", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "media_resource_type", + "description": "The type of media resource being uploaded", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaResourceType", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "finishUploadOutput", + "description": "", + "fields": [ + { + "name": "key", + "description": "The unique key identifier", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "Additional information about the confirmation", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "success", + "description": "Whether the confirmation was successful", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "FixedProductTax", @@ -36455,6 +36904,104 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "initiateUploadInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "The name of the file to be uploaded, cannot contain slashes", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "media_resource_type", + "description": "The type of media resource being uploaded", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaResourceType", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "initiateUploadOutput", + "description": "", + "fields": [ + { + "name": "expires_at", + "description": "The expiration timestamp of the URL", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "key", + "description": "The unique key identifier for the upload", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "upload_url", + "description": "The presigned URL for uploading the file", + "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": "InputFilterEnum", @@ -37893,6 +38440,23 @@ } ] }, + { + "kind": "ENUM", + "name": "MediaResourceType", + "description": "Enumeration of media resource types", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CUSTOMER_ATTRIBUTE_FILE", + "description": "Customer file resource type", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "OBJECT", "name": "MessageStyleLogo", @@ -38462,6 +39026,41 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "addProductsToNewCart", + "description": "Creates a new cart and add any type of product to it", + "args": [ + { + "name": "cartItems", + "description": "An array that defines the products to add to the new cart", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddProductsToNewCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "addProductsToRequisitionList", "description": "Add items to the specified requisition list.", @@ -39169,6 +39768,29 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "completeOrder", + "description": "Synchronizes order details and place the order", + "args": [ + { + "name": "input", + "description": "Describes the variables needed to complete or place the order", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompleteOrderInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PlaceOrderOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "confirmCancelOrder", "description": "Cancel the specified guest customer order.", @@ -40254,6 +40876,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "finishUpload", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "finishUploadInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "finishUploadOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "generateCustomerToken", "description": "Generate a token for specified customer.", @@ -40349,6 +40998,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "initiateUpload", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "initiateUploadInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "initiateUploadOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "mergeCarts", "description": "Transfer the contents of a guest cart into the cart of a logged-in customer.", @@ -41537,6 +42213,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "setCartAsInactive", + "description": "Sets the cart as inactive", + "args": [ + { + "name": "cartId", + "description": "The customer cart ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetCartAsInactiveOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "setCustomAttributesOnCart", "description": "Add custom attributes to the cart.", @@ -43237,6 +43940,30 @@ }, "defaultValue": null }, + { + "name": "custom_attributes", + "description": "The custom attribute values of the billing or shipping negotiable quote address.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeValueInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "fax", + "description": "The fax number of the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, { "name": "firstname", "description": "The first name of the company user.", @@ -43265,6 +43992,16 @@ }, "defaultValue": null }, + { + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, { "name": "postcode", "description": "The ZIP or postal code of the billing or shipping address.", @@ -43275,6 +44012,16 @@ }, "defaultValue": null }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, { "name": "region", "description": "A string that defines the state or province of the billing or shipping address.", @@ -43323,6 +44070,16 @@ }, "defaultValue": null }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, { "name": "telephone", "description": "The telephone number for the billing or shipping address.", @@ -43332,6 +44089,16 @@ "ofType": null }, "defaultValue": null + }, + { + "name": "vat_id", + "description": "The customer's Tax/VAT number (for corporate customers).", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null } ], "interfaces": null, @@ -43387,6 +44154,34 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "custom_attributes", + "description": "The custom attribute values of the billing or shipping negotiable quote address.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fax", + "description": "The fax number of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "firstname", "description": "The first name of the company user.", @@ -43419,6 +44214,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "postcode", "description": "The company's ZIP or postal code.", @@ -43431,6 +44238,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "region", "description": "An object containing the region name, region code, and region ID.", @@ -43463,6 +44282,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "telephone", "description": "The customer's telephone number.", @@ -43474,6 +44305,34 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique identifier of the address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vat_id", + "description": "The customer's Tax/VAT number (for corporate customers).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -43588,6 +44447,34 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "custom_attributes", + "description": "The custom attribute values of the billing or shipping negotiable quote address.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fax", + "description": "The fax number of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "firstname", "description": "The first name of the company user.", @@ -43620,6 +44507,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "postcode", "description": "The company's ZIP or postal code.", @@ -43632,6 +44531,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "region", "description": "An object containing the region name, region code, and region ID.", @@ -43664,6 +44575,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "telephone", "description": "The customer's telephone number.", @@ -43675,6 +44598,34 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique identifier of the address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vat_id", + "description": "The customer's Tax/VAT number (for corporate customers).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -44618,6 +45569,34 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "custom_attributes", + "description": "The custom attribute values of the billing or shipping negotiable quote address.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fax", + "description": "The fax number of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "firstname", "description": "The first name of the company user.", @@ -44650,6 +45629,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "postcode", "description": "The company's ZIP or postal code.", @@ -44662,6 +45653,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "region", "description": "An object containing the region name, region code, and region ID.", @@ -44706,6 +45709,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "telephone", "description": "The customer's telephone number.", @@ -44717,6 +45732,34 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique identifier of the address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vat_id", + "description": "The customer's Tax/VAT number (for corporate customers).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -48062,6 +49105,11 @@ "name": "ApplePayConfig", "ofType": null }, + { + "kind": "OBJECT", + "name": "FastlaneConfig", + "ofType": null + }, { "kind": "OBJECT", "name": "GooglePayConfig", @@ -48101,6 +49149,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "fastlane", + "description": "Fastlane payment method configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FastlaneConfig", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "google_pay", "description": "GooglePay payment method configuration", @@ -48228,6 +49288,16 @@ }, "defaultValue": null }, + { + "name": "payment_services_paypal_fastlane", + "description": "Required input for fastlane", + "type": { + "kind": "INPUT_OBJECT", + "name": "FastlaneMethodInput", + "ofType": null + }, + "defaultValue": null + }, { "name": "payment_services_paypal_google_pay", "description": "Required input for Google Pay button", @@ -49148,6 +50218,18 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "orderV2", + "description": "Full order information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -53362,6 +54444,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "tiers", + "description": "Volume based pricing", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductViewTierPrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "roles", "description": "Price roles, stating if the price should be visible or hidden.", @@ -53419,6 +54517,136 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "UNION", + "name": "ProductViewTierCondition", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ProductViewTierRangeCondition", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductViewTierExactMatchCondition", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "ProductViewTierExactMatchCondition", + "description": null, + "fields": [ + { + "name": "in", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductViewTierPrice", + "description": null, + "fields": [ + { + "name": "tier", + "description": "Volume based price", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Price", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "Condition to active price", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "ProductViewTierCondition", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductViewTierRangeCondition", + "description": null, + "fields": [ + { + "name": "gte", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lt", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "ProductViewVariant", @@ -61878,6 +63106,45 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "SetCartAsInactiveOutput", + "description": "Sets the cart as inactive", + "fields": [ + { + "name": "error", + "description": "The error message returned after failing to set the cart as inactive", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "success", + "description": "Indicates whether the cart was set as inactive", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "SetCustomAttributesOnCompanyInput", diff --git a/src/openapi/accs-schema.yaml b/src/openapi/accs-schema.yaml index 8213ec94a..5bc100c9b 100644 --- a/src/openapi/accs-schema.yaml +++ b/src/openapi/accs-schema.yaml @@ -17,6 +17,7 @@ schemes: tags: - name: addresses/{addressId} - name: adminuisdk/massaction/{request_id} +- name: adminuisdk/orderviewbutton/{request_id} - name: adobe_io_events/check_configuration - name: adobestock/asset/{id} - name: adobestock/asset/list @@ -133,6 +134,7 @@ tags: - name: customers/{customerId}/confirm - name: customers/{customerId}/permissions/readonly - name: customers/{customerId}/shippingAddress +- name: customers/{customerId}/token - name: customers/{email}/activate - name: customers/addresses/{addressId} - name: customers/companies @@ -196,6 +198,8 @@ tags: - name: invoices/{id}/emails - name: invoices/{id}/void - name: invoices/comments +- name: media/finish-upload +- name: media/initiate-upload - name: modules - name: negotiable-cart-item-note - name: negotiable-cart-item-note/{noteId} @@ -221,6 +225,8 @@ tags: - name: negotiableQuoteTemplate/referenceDocumentLink/{linkId} - name: negotiableQuoteTemplate/request - name: negotiableQuoteTemplate/submitToCustomer +- name: oope_observability/subscription +- name: oope_observability/subscription/{subscriptionId} - name: oope_payment_method - name: oope_payment_method/{code} - name: oope_shipping_carrier @@ -286,12 +292,14 @@ tags: - name: products/cost-information - name: products/downloadable-links/{id} - name: products/downloadable-links/samples/{id} +- name: products/external-media/asset - name: products/external-media/get-sku/assetId/{assetId} - name: products/external-media/image - name: products/external-media/ping - name: products/external-media/remove-by-asset-id - name: products/external-media/remove-by-asset-id-and-sku - name: products/external-media/remove-by-sku +- name: products/external-media/version - name: products/external-media/video - name: products/links/{type}/attributes - name: products/links/types @@ -444,6 +452,41 @@ paths: schema: "$ref": "#/definitions/error-response" summary: adminuisdk/massaction/{request_id} + "/V1/adminuisdk/orderviewbutton/{request_id}": + get: + tags: + - adminuisdk/orderviewbutton/{request_id} + description: Load order view button failed request by request id + operationId: GetV1AdminuisdkOrderviewbuttonRequest_id + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: requestId + in: query + type: string + required: true + - name: request_id + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/commerce-backend-uix-data-order-view-button-failed-request-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: adminuisdk/orderviewbutton/{request_id} "/V1/adobe_io_events/check_configuration": get: tags: @@ -6837,6 +6880,43 @@ paths: schema: "$ref": "#/definitions/error-response" summary: customers/{customerId}/shippingAddress + "/V1/customers/{customerId}/token": + post: + tags: + - customers/{customerId}/token + description: Generate a customer token based on the provided customer ID. + operationId: PostV1CustomersCustomerIdToken + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + description: The ID of the customer for whom the token is to be generated. + responses: + '200': + description: 200 Success. + schema: + type: string + description: The generated customer token. + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/token "/V1/customers/{email}/activate": put: tags: @@ -9795,6 +9875,97 @@ paths: schema: "$ref": "#/definitions/error-response" summary: invoices/{id}/void + "/V1/media/finish-upload": + post: + tags: + - media/finish-upload + description: Finish the upload and move object from presigned bucket to final + destination. + operationId: PostV1MediaFinishupload + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1MediaFinishuploadBody + in: body + schema: + required: + - key + - mediaResourceType + properties: + key: + type: string + mediaResourceType: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/s3-presigned-upload-data-finish-upload-response-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: media/finish-upload + "/V1/media/initiate-upload": + post: + tags: + - media/initiate-upload + description: Generate a presigned S3 URL for direct upload. + operationId: PostV1MediaInitiateupload + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1MediaInitiateuploadBody + in: body + schema: + required: + - key + - mediaResourceType + properties: + key: + type: string + mediaResourceType: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/s3-presigned-upload-data-initiate-upload-response-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: media/initiate-upload "/V1/modules": get: tags: @@ -11006,6 +11177,212 @@ paths: schema: "$ref": "#/definitions/error-response" summary: negotiableQuoteTemplate/{templateId} + "/V1/oope_observability/subscription": + get: + tags: + - oope_observability/subscription + description: Get a list of subscriptions matching criteria + operationId: GetV1Oope_observabilitySubscription + 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/out-of-process-observability-data-subscription-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: oope_observability/subscription + post: + tags: + - oope_observability/subscription + description: Create or update a subscription + operationId: PostV1Oope_observabilitySubscription + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1Oope_observabilitySubscriptionBody + in: body + schema: + required: + - subscription + properties: + subscription: + "$ref": "#/definitions/out-of-process-observability-data-subscription-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/out-of-process-observability-data-subscription-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: oope_observability/subscription + put: + tags: + - oope_observability/subscription + description: Create or update a subscription + operationId: PutV1Oope_observabilitySubscription + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1Oope_observabilitySubscriptionBody + in: body + schema: + required: + - subscription + properties: + subscription: + "$ref": "#/definitions/out-of-process-observability-data-subscription-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/out-of-process-observability-data-subscription-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: oope_observability/subscription + "/V1/oope_observability/subscription/{subscriptionId}": + get: + tags: + - oope_observability/subscription/{subscriptionId} + description: Get a single subscription by ID + operationId: GetV1Oope_observabilitySubscriptionSubscriptionId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: subscriptionId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/out-of-process-observability-data-subscription-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: oope_observability/subscription/{subscriptionId} + delete: + tags: + - oope_observability/subscription/{subscriptionId} + description: Delete a subscription by ID + operationId: DeleteV1Oope_observabilitySubscriptionSubscriptionId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: subscriptionId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: oope_observability/subscription/{subscriptionId} "/V1/oope_payment_method": get: tags: @@ -13509,6 +13886,52 @@ paths: schema: "$ref": "#/definitions/error-response" summary: products/downloadable-links/{id} + "/V1/products/external-media/asset": + post: + tags: + - products/external-media/asset + description: POST endpoint to replace existing assets for a product + operationId: PostV1ProductsExternalmediaAsset + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsExternalmediaAssetBody + in: body + schema: + required: + - sku + properties: + sku: + type: string + videos: + type: array + items: + "$ref": "#/definitions/adobe-assets-integration-data-video-item-interface" + images: + type: array + items: + "$ref": "#/definitions/adobe-assets-integration-data-image-item-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/external-media/asset "/V1/products/external-media/get-sku/assetId/{assetId}": get: tags: @@ -13718,6 +14141,32 @@ paths: schema: "$ref": "#/definitions/error-response" summary: products/external-media/remove-by-sku + "/V1/products/external-media/version": + get: + tags: + - products/external-media/version + description: GET extension version + operationId: GetV1ProductsExternalmediaVersion + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/external-media/version "/V1/products/external-media/video": post: tags: @@ -18591,7 +19040,7 @@ paths: schema: type: array items: - "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface" + "$ref": "#/definitions/adobe-commerce-webhooks-core-saas-data-webhook-data-interface" '401': description: 401 Unauthorized schema: @@ -18625,7 +19074,7 @@ paths: - webhook properties: webhook: - "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface" + "$ref": "#/definitions/adobe-commerce-webhooks-core-saas-data-webhook-data-interface" type: object xml: name: request @@ -18691,7 +19140,7 @@ paths: - webhook properties: webhook: - "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface" + "$ref": "#/definitions/adobe-commerce-webhooks-core-saas-data-webhook-data-interface" type: object xml: name: request @@ -19767,10 +20216,12 @@ definitions: - label - description - workspace_configuration - adobe-commerce-webhooks-data-webhook-data-interface: + adobe-commerce-webhooks-core-saas-data-webhook-data-interface: type: object - description: Interface for webhook data from webapi requests + description: Interface for webhook data from Core SaaS 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 @@ -19842,6 +20293,27 @@ 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 @@ -24217,12 +24689,6 @@ definitions: type: string gw_card_tax_refunded: type: string - pickup_location_code: - type: string - notification_sent: - type: integer - send_notification: - type: integer coupon_codes: type: array items: @@ -24231,6 +24697,12 @@ definitions: type: array items: type: string + pickup_location_code: + type: string + notification_sent: + type: integer + send_notification: + type: integer reward_points_balance: type: integer reward_currency_amount: @@ -26353,6 +26825,38 @@ definitions: - error_message - request_timestamp - selected_ids + commerce-backend-uix-data-order-view-button-failed-request-interface: + type: object + description: Defines the order view button failed requests database model + properties: + id: + type: string + description: Internal id + request_id: + type: string + description: Request id + button_id: + type: string + description: Button id + order_id: + type: string + description: Order id + error_status: + type: string + description: Error status + error_message: + type: string + description: Error message + request_timestamp: + type: string + description: Request timestamp + required: + - request_id + - button_id + - order_id + - error_status + - error_message + - request_timestamp company-data-company-search-results-interface: type: object description: Interface for company search results @@ -26458,14 +26962,14 @@ definitions: type: integer quote_config: "$ref": "#/definitions/negotiable-quote-data-company-quote-config-interface" - is_purchase_order_enabled: - type: boolean applicable_shipping_method: type: integer available_shipping_methods: type: string use_config_settings_shipping: type: integer + is_purchase_order_enabled: + type: boolean negotiable-quote-data-company-quote-config-interface: type: object description: Interface CompanyQuoteConfigInterface @@ -26853,6 +27357,62 @@ 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. @@ -28387,6 +28947,83 @@ definitions: - items - search_criteria - total_count + out-of-process-observability-data-subscription-search-result-interface: + type: object + description: Search result interface for observability subscriptions + properties: + items: + type: array + items: + "$ref": "#/definitions/out-of-process-observability-data-subscription-interface" + required: + - items + out-of-process-observability-data-subscription-interface: + type: object + description: Observability Subscription data interface + properties: + id: + type: integer + description: Entity ID + 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", + "admin-ui-sdk") + items: + type: string + headers: + type: array + description: The request headers for the subscription + items: + "$ref": "#/definitions/out-of-process-observability-data-subscription-header-interface" + service_name: + type: string + description: The service name for the subscription + is_active: + type: boolean + description: If the subscription is active + log_message_settings: + type: array + description: The configured log message settings for the subscription + items: + type: string + required: + - destination + - destination_endpoint + - destination_api_key + - component + - headers + - service_name + - is_active + - log_message_settings + out-of-process-observability-data-subscription-header-interface: + type: object + description: Observability Subscription Header data interface + properties: + name: + type: string + description: Header name + value: + type: string + description: Header value + secret: + type: boolean + description: If header value is secret + required: + - name + - value + - secret out-of-process-shipping-methods-data-out-of-process-carrier-interface: type: object description: Shipping carrier interface for out of process shipping carriers @@ -28717,6 +29354,39 @@ definitions: description: Code of the attribute. required: - attribute_code + s3-presigned-upload-data-initiate-upload-response-interface: + type: object + description: Data interface representing presigned URL response payload. Contains + the presigned upload URL, the server-generated unique key that identifies the + object for finish upload, and the expiration timestamp. + properties: + upload_url: + type: string + description: The presigned URL to upload directly to S3. + key: + type: string + description: The unique key (hashed filename) to be used in the finish step. + expires_at: + type: integer + description: UNIX timestamp when the presigned URL expires. + required: + - upload_url + - key + - expires_at + s3-presigned-upload-data-finish-upload-response-interface: + type: object + description: Data interface representing the finish result of a presigned upload. + Indicates whether the finish was successful and returns the final filename. + properties: + success: + type: boolean + description: The finish was successful. + key: + type: string + description: Final filename stored in destination. + required: + - success + - key adobe-commerce-events-core-saas-data-supported-event-interface: type: object description: Interface for supported event data returned in webapi requests @@ -28742,6 +29412,7 @@ x-tagGroups: - name: adminuisdk tags: - adminuisdk/massaction/{request_id} + - adminuisdk/orderviewbutton/{request_id} - name: adobe_io_events tags: - adobe_io_events/check_configuration @@ -28895,6 +29566,7 @@ x-tagGroups: - customers/{customerId}/confirm - customers/{customerId}/permissions/readonly - customers/{customerId}/shippingAddress + - customers/{customerId}/token - customers/{email}/activate - name: eav tags: @@ -28969,6 +29641,10 @@ x-tagGroups: - invoices/{id}/comments - invoices/{id}/emails - invoices/{id}/void +- name: media + tags: + - media/finish-upload + - media/initiate-upload - name: modules tags: - modules @@ -29002,6 +29678,10 @@ x-tagGroups: - negotiableQuoteTemplate/request - negotiableQuoteTemplate/submitToCustomer - negotiableQuoteTemplate/{templateId} +- name: oope_observability + tags: + - oope_observability/subscription + - oope_observability/subscription/{subscriptionId} - name: oope_payment_method tags: - oope_payment_method @@ -29061,12 +29741,14 @@ x-tagGroups: - products/cost-information - products/downloadable-links/samples/{id} - products/downloadable-links/{id} + - products/external-media/asset - products/external-media/get-sku/assetId/{assetId} - products/external-media/image - products/external-media/ping - products/external-media/remove-by-asset-id - products/external-media/remove-by-asset-id-and-sku - products/external-media/remove-by-sku + - products/external-media/version - products/external-media/video - products/links/types - products/links/{type}/attributes diff --git a/static/graphql-api/saas/index.html b/static/graphql-api/saas/index.html index e567fb299..5686fa2ab 100644 --- a/static/graphql-api/saas/index.html +++ b/static/graphql-api/saas/index.html @@ -101,6 +101,7 @@
{"formCode": "abc123"}
+ {"formCode": "xyz789"}
{"cart_id": "abc123"}
+ {"cart_id": "xyz789"}
{
- "ids": ["abc123"],
- "roles": ["abc123"],
+ "ids": ["xyz789"],
+ "roles": ["xyz789"],
"subtree": Subtree
}
@@ -1898,16 +1919,16 @@ {"uid": 4}
+ {"uid": "4"}
{"cartId": "abc123"}
+ {"cartId": "xyz789"}
{
- "data": {
- "customerSegments": [{"uid": "4"}]
- }
-}
+ {"data": {"customerSegments": [{"uid": 4}]}}
{
- "cartId": "abc123",
- "id": "xyz789"
+ "cartId": "xyz789",
+ "id": "abc123"
}
{
"data": {
"getPaymentOrder": {
- "id": "xyz789",
- "mp_order_id": "xyz789",
+ "id": "abc123",
+ "mp_order_id": "abc123",
"payment_source_details": PaymentSourceDetails,
"status": "abc123"
}
@@ -3363,7 +3396,7 @@ Response
"data": {
"giftCardAccount": {
"balance": Money,
- "code": "xyz789",
+ "code": "abc123",
"expiration_date": "abc123"
}
}
@@ -3450,7 +3483,7 @@ Query
Variables
- {"giftRegistryUid": "4"}
+ {"giftRegistryUid": 4}
@@ -3458,14 +3491,14 @@ Response
{
"data": {
"giftRegistry": {
- "created_at": "xyz789",
+ "created_at": "abc123",
"dynamic_attributes": [
GiftRegistryDynamicAttribute
],
- "event_name": "xyz789",
+ "event_name": "abc123",
"items": [GiftRegistryItemInterface],
- "message": "abc123",
- "owner_name": "xyz789",
+ "message": "xyz789",
+ "owner_name": "abc123",
"privacy_settings": "PRIVATE",
"registrants": [GiftRegistryRegistrant],
"shipping_address": CustomerAddress,
@@ -3541,7 +3574,7 @@ Query
Variables
- {"email": "abc123"}
+ {"email": "xyz789"}
@@ -3553,7 +3586,7 @@ Response
"event_date": "xyz789",
"event_title": "xyz789",
"gift_registry_uid": 4,
- "location": "xyz789",
+ "location": "abc123",
"name": "abc123",
"type": "abc123"
}
@@ -3637,9 +3670,9 @@ Response
{
"event_date": "abc123",
"event_title": "abc123",
- "gift_registry_uid": 4,
+ "gift_registry_uid": "4",
"location": "xyz789",
- "name": "xyz789",
+ "name": "abc123",
"type": "abc123"
}
]
@@ -3732,9 +3765,9 @@ Query
Variables
{
- "firstName": "abc123",
+ "firstName": "xyz789",
"lastName": "abc123",
- "giftRegistryTypeUid": "4"
+ "giftRegistryTypeUid": 4
}
@@ -3745,10 +3778,10 @@ Response
"giftRegistryTypeSearch": [
{
"event_date": "xyz789",
- "event_title": "abc123",
- "gift_registry_uid": "4",
+ "event_title": "xyz789",
+ "gift_registry_uid": 4,
"location": "abc123",
- "name": "abc123",
+ "name": "xyz789",
"type": "xyz789"
}
]
@@ -3807,7 +3840,7 @@ Response
"dynamic_attributes_metadata": [
GiftRegistryDynamicAttributeMetadataInterface
],
- "label": "xyz789",
+ "label": "abc123",
"uid": "4"
}
]
@@ -3955,11 +3988,11 @@ Response
"credit_memos": [CreditMemo],
"custom_attributes": [CustomAttribute],
"customer_info": OrderCustomerInfo,
- "email": "abc123",
+ "email": "xyz789",
"gift_message": GiftMessage,
- "gift_receipt_included": true,
+ "gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
- "id": 4,
+ "id": "4",
"invoices": [Invoice],
"is_virtual": true,
"items": [OrderItemInterface],
@@ -3968,13 +4001,13 @@ Response
"order_date": "xyz789",
"order_status_change_date": "xyz789",
"payment_methods": [OrderPaymentMethod],
- "printed_card_included": true,
+ "printed_card_included": false,
"returns": Returns,
"shipments": [OrderShipment],
"shipping_address": OrderAddress,
- "shipping_method": "abc123",
+ "shipping_method": "xyz789",
"status": "abc123",
- "token": "abc123",
+ "token": "xyz789",
"total": OrderTotal
}
}
@@ -4121,25 +4154,25 @@ Response
"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,
+ "id": "4",
"invoices": [Invoice],
- "is_virtual": true,
+ "is_virtual": false,
"items": [OrderItemInterface],
"items_eligible_for_return": [OrderItemInterface],
"number": "xyz789",
"order_date": "abc123",
- "order_status_change_date": "abc123",
+ "order_status_change_date": "xyz789",
"payment_methods": [OrderPaymentMethod],
- "printed_card_included": false,
+ "printed_card_included": true,
"returns": Returns,
"shipments": [OrderShipment],
"shipping_address": OrderAddress,
- "shipping_method": "abc123",
- "status": "xyz789",
+ "shipping_method": "xyz789",
+ "status": "abc123",
"token": "xyz789",
"total": OrderTotal
}
@@ -4207,12 +4240,12 @@ Query
Variables
- {"email": "abc123"}
+ {"email": "xyz789"}
Response
- {"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}}
+ {"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}}
@@ -4348,7 +4381,7 @@ Variables
Response
- {"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}}
+ {"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}}
@@ -4411,12 +4444,12 @@ Query
Variables
- {"email": "xyz789"}
+ {"email": "abc123"}
Response
- {"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}}
+ {"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}}
@@ -4483,7 +4516,7 @@ Variables
Response
- {"data": {"isEmailAvailable": {"is_email_available": false}}}
+ {"data": {"isEmailAvailable": {"is_email_available": true}}}
@@ -4599,20 +4632,20 @@ Response
"comments": [NegotiableQuoteComment],
"created_at": "xyz789",
"custom_attributes": [CustomAttribute],
- "email": "abc123",
+ "email": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
- "is_virtual": false,
+ "is_virtual": true,
"items": [CartItemInterface],
- "name": "abc123",
+ "name": "xyz789",
"prices": CartPrices,
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
"status": "SUBMITTED",
- "total_quantity": 123.45,
+ "total_quantity": 987.65,
"uid": "4",
- "updated_at": "xyz789"
+ "updated_at": "abc123"
}
}
}
@@ -4710,7 +4743,7 @@ Query
Variables
- {"templateId": "4"}
+ {"templateId": 4}
@@ -4723,7 +4756,7 @@ Response
"expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": false,
- "is_virtual": false,
+ "is_virtual": true,
"items": [CartItemInterface],
"max_order_commitment": 987,
"min_order_commitment": 123,
@@ -4737,7 +4770,7 @@ Response
NegotiableQuoteShippingAddress
],
"status": "abc123",
- "template_id": 4,
+ "template_id": "4",
"total_quantity": 987.65
}
}
@@ -5244,8 +5277,8 @@ Response
"facets": [Aggregation],
"items": [ProductSearchItem],
"page_info": SearchResultPageInfo,
- "related_terms": ["xyz789"],
- "suggestions": ["xyz789"],
+ "related_terms": ["abc123"],
+ "suggestions": ["abc123"],
"total_count": 987
}
}
@@ -5343,7 +5376,7 @@ Query
Variables
- {"skus": ["abc123"]}
+ {"skus": ["xyz789"]}
@@ -5353,27 +5386,27 @@ Response
"products": [
{
"addToCartAllowed": true,
- "inStock": false,
+ "inStock": true,
"lowStock": false,
"attributes": [ProductViewAttribute],
"description": "xyz789",
- "id": "4",
+ "id": 4,
"images": [ProductViewImage],
"videos": [ProductViewVideo],
"lastModifiedAt": "2007-12-03T10:15:30Z",
"metaDescription": "xyz789",
- "metaKeyword": "xyz789",
+ "metaKeyword": "abc123",
"metaTitle": "xyz789",
- "name": "xyz789",
- "shortDescription": "xyz789",
+ "name": "abc123",
+ "shortDescription": "abc123",
"inputOptions": [ProductViewInputOption],
- "sku": "xyz789",
- "externalId": "abc123",
- "url": "xyz789",
+ "sku": "abc123",
+ "externalId": "xyz789",
+ "url": "abc123",
"urlKey": "xyz789",
"links": [ProductViewLink],
- "queryType": "xyz789",
- "visibility": "xyz789"
+ "queryType": "abc123",
+ "visibility": "abc123"
}
]
}
@@ -5444,7 +5477,7 @@ Response
"data": {
"recaptchaFormConfig": {
"configurations": ReCaptchaConfiguration,
- "is_enabled": false
+ "is_enabled": true
}
}
}
@@ -5501,12 +5534,12 @@ Response
"data": {
"recaptchaV3Config": {
"badge_position": "abc123",
- "failure_message": "abc123",
+ "failure_message": "xyz789",
"forms": ["PLACE_ORDER"],
"is_enabled": true,
"language_code": "abc123",
"minimum_score": 987.65,
- "theme": "abc123",
+ "theme": "xyz789",
"website_key": "abc123"
}
}
@@ -5620,9 +5653,9 @@ Query
Variables
{
- "cartSkus": ["xyz789"],
+ "cartSkus": ["abc123"],
"category": "xyz789",
- "currentSku": "abc123",
+ "currentSku": "xyz789",
"pageType": "CMS",
"userPurchaseHistory": [PurchaseHistory],
"userViewHistory": [ViewHistory]
@@ -5635,7 +5668,7 @@ Response
"data": {
"recommendations": {
"results": [RecommendationUnit],
- "totalResults": 987
+ "totalResults": 123
}
}
}
@@ -5733,10 +5766,10 @@ Query
Variables
{
"unitIds": ["abc123"],
- "currentSku": "abc123",
+ "currentSku": "xyz789",
"userPurchaseHistory": [PurchaseHistory],
"userViewHistory": [ViewHistory],
- "cartSkus": ["xyz789"]
+ "cartSkus": ["abc123"]
}
@@ -5746,7 +5779,7 @@ Response
"data": {
"recommendationsByUnitIds": {
"results": [RecommendationUnit],
- "totalResults": 123
+ "totalResults": 987
}
}
}
@@ -5850,7 +5883,7 @@ Query
Variables
{
"optionIds": ["xyz789"],
- "sku": "abc123"
+ "sku": "xyz789"
}
@@ -5859,24 +5892,24 @@ Response
{
"data": {
"refineProduct": {
- "addToCartAllowed": false,
- "inStock": true,
- "lowStock": false,
+ "addToCartAllowed": true,
+ "inStock": false,
+ "lowStock": true,
"attributes": [ProductViewAttribute],
"description": "abc123",
- "id": 4,
+ "id": "4",
"images": [ProductViewImage],
"videos": [ProductViewVideo],
"lastModifiedAt": "2007-12-03T10:15:30Z",
"metaDescription": "xyz789",
- "metaKeyword": "xyz789",
- "metaTitle": "xyz789",
+ "metaKeyword": "abc123",
+ "metaTitle": "abc123",
"name": "xyz789",
- "shortDescription": "xyz789",
+ "shortDescription": "abc123",
"inputOptions": [ProductViewInputOption],
"sku": "xyz789",
"externalId": "abc123",
- "url": "abc123",
+ "url": "xyz789",
"urlKey": "xyz789",
"links": [ProductViewLink],
"queryType": "abc123",
@@ -6073,120 +6106,120 @@ Response
"allow_order": "abc123",
"allow_printed_card": "abc123",
"autocomplete_on_storefront": true,
- "base_currency_code": "xyz789",
- "base_link_url": "abc123",
- "base_media_url": "xyz789",
+ "base_currency_code": "abc123",
+ "base_link_url": "xyz789",
+ "base_media_url": "abc123",
"base_static_url": "abc123",
"base_url": "xyz789",
- "cart_expires_in_days": 123,
- "cart_gift_wrapping": "abc123",
- "cart_merge_preference": "abc123",
+ "cart_expires_in_days": 987,
+ "cart_gift_wrapping": "xyz789",
+ "cart_merge_preference": "xyz789",
"cart_printed_card": "abc123",
"cart_summary_display_quantity": 987,
- "catalog_default_sort_by": "xyz789",
+ "catalog_default_sort_by": "abc123",
"category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"category_url_suffix": "abc123",
- "check_money_order_enable_for_specific_countries": false,
+ "check_money_order_enable_for_specific_countries": true,
"check_money_order_enabled": true,
"check_money_order_make_check_payable_to": "xyz789",
- "check_money_order_max_order_total": "abc123",
+ "check_money_order_max_order_total": "xyz789",
"check_money_order_min_order_total": "xyz789",
- "check_money_order_new_order_status": "abc123",
+ "check_money_order_new_order_status": "xyz789",
"check_money_order_payment_from_specific_countries": "xyz789",
- "check_money_order_send_check_to": "xyz789",
+ "check_money_order_send_check_to": "abc123",
"check_money_order_sort_order": 123,
"check_money_order_title": "abc123",
"configurable_product_image": "ITSELF",
- "configurable_thumbnail_source": "xyz789",
- "contact_enabled": false,
+ "configurable_thumbnail_source": "abc123",
+ "contact_enabled": true,
"countries_with_required_region": "abc123",
- "create_account_confirmation": true,
- "customer_access_token_lifetime": 987.65,
+ "create_account_confirmation": false,
+ "customer_access_token_lifetime": 123.45,
"default_country": "abc123",
"default_display_currency_code": "xyz789",
"display_product_prices_in_catalog": 987,
- "display_shipping_prices": 987,
- "display_state_if_optional": true,
- "enable_multiple_wishlists": "xyz789",
- "fixed_product_taxes_apply_tax_to_fpt": true,
- "fixed_product_taxes_display_prices_in_emails": 987,
+ "display_shipping_prices": 123,
+ "display_state_if_optional": false,
+ "enable_multiple_wishlists": "abc123",
+ "fixed_product_taxes_apply_tax_to_fpt": false,
+ "fixed_product_taxes_display_prices_in_emails": 123,
"fixed_product_taxes_display_prices_in_product_lists": 123,
- "fixed_product_taxes_display_prices_in_sales_modules": 123,
- "fixed_product_taxes_display_prices_on_product_view_page": 123,
+ "fixed_product_taxes_display_prices_in_sales_modules": 987,
+ "fixed_product_taxes_display_prices_on_product_view_page": 987,
"fixed_product_taxes_enable": true,
- "fixed_product_taxes_include_fpt_in_subtotal": true,
+ "fixed_product_taxes_include_fpt_in_subtotal": false,
"graphql_share_customer_group": false,
"grid_per_page": 987,
- "grid_per_page_values": "abc123",
+ "grid_per_page_values": "xyz789",
"grouped_product_image": "ITSELF",
- "is_checkout_agreements_enabled": false,
+ "is_checkout_agreements_enabled": true,
"is_default_store": false,
- "is_default_store_group": true,
+ "is_default_store_group": false,
"is_guest_checkout_enabled": true,
"is_negotiable_quote_active": false,
"is_one_page_checkout_enabled": false,
"is_requisition_list_active": "xyz789",
- "list_mode": "xyz789",
+ "list_mode": "abc123",
"list_per_page": 987,
- "list_per_page_values": "xyz789",
- "locale": "xyz789",
- "magento_reward_general_is_enabled": "xyz789",
- "magento_reward_general_is_enabled_on_front": "abc123",
+ "list_per_page_values": "abc123",
+ "locale": "abc123",
+ "magento_reward_general_is_enabled": "abc123",
+ "magento_reward_general_is_enabled_on_front": "xyz789",
"magento_reward_general_min_points_balance": "xyz789",
"magento_reward_general_publish_history": "xyz789",
"magento_reward_points_invitation_customer": "abc123",
- "magento_reward_points_invitation_customer_limit": "xyz789",
+ "magento_reward_points_invitation_customer_limit": "abc123",
"magento_reward_points_invitation_order": "xyz789",
"magento_reward_points_invitation_order_limit": "xyz789",
- "magento_reward_points_newsletter": "abc123",
- "magento_reward_points_order": "xyz789",
- "magento_reward_points_register": "xyz789",
+ "magento_reward_points_newsletter": "xyz789",
+ "magento_reward_points_order": "abc123",
+ "magento_reward_points_register": "abc123",
"magento_reward_points_review": "xyz789",
- "magento_reward_points_review_limit": "abc123",
- "magento_wishlist_general_is_enabled": "abc123",
- "max_items_in_order_summary": 123,
- "maximum_number_of_wishlists": "xyz789",
- "minicart_display": true,
+ "magento_reward_points_review_limit": "xyz789",
+ "magento_wishlist_general_is_enabled": "xyz789",
+ "max_items_in_order_summary": 987,
+ "maximum_number_of_wishlists": "abc123",
+ "minicart_display": false,
"minicart_max_items": 123,
- "minimum_password_length": "xyz789",
+ "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": false,
+ "orders_invoices_credit_memos_display_full_summary": true,
"orders_invoices_credit_memos_display_grandtotal": false,
"orders_invoices_credit_memos_display_price": 987,
"orders_invoices_credit_memos_display_shipping_amount": 987,
"orders_invoices_credit_memos_display_subtotal": 987,
- "orders_invoices_credit_memos_display_zero_tax": true,
+ "orders_invoices_credit_memos_display_zero_tax": false,
"printed_card_priceV2": Money,
"product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"product_url_suffix": "xyz789",
- "quickorder_active": true,
+ "quickorder_active": false,
"required_character_classes_number": "abc123",
- "returns_enabled": "xyz789",
- "root_category_uid": 4,
+ "returns_enabled": "abc123",
+ "root_category_uid": "4",
"sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
- "sales_gift_wrapping": "xyz789",
- "sales_printed_card": "xyz789",
+ "sales_gift_wrapping": "abc123",
+ "sales_printed_card": "abc123",
"secure_base_link_url": "xyz789",
- "secure_base_media_url": "xyz789",
+ "secure_base_media_url": "abc123",
"secure_base_static_url": "xyz789",
"secure_base_url": "abc123",
- "share_active_segments": true,
+ "share_active_segments": false,
"share_applied_cart_rule": true,
"shopping_cart_display_full_summary": true,
- "shopping_cart_display_grand_total": true,
- "shopping_cart_display_price": 987,
- "shopping_cart_display_shipping": 987,
- "shopping_cart_display_subtotal": 987,
+ "shopping_cart_display_grand_total": false,
+ "shopping_cart_display_price": 123,
+ "shopping_cart_display_shipping": 123,
+ "shopping_cart_display_subtotal": 123,
"shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
- "shopping_cart_display_zero_tax": false,
- "store_code": "4",
+ "shopping_cart_display_zero_tax": true,
+ "store_code": 4,
"store_group_code": 4,
"store_group_name": "abc123",
"store_name": "xyz789",
- "store_sort_order": 987,
+ "store_sort_order": 123,
"timezone": "xyz789",
"title_separator": "abc123",
"use_store_in_url": false,
@@ -6195,10 +6228,10 @@ Response
"weight_unit": "abc123",
"zero_subtotal_enable_for_specific_countries": false,
"zero_subtotal_enabled": true,
- "zero_subtotal_new_order_status": "abc123",
- "zero_subtotal_payment_action": "abc123",
+ "zero_subtotal_new_order_status": "xyz789",
+ "zero_subtotal_payment_action": "xyz789",
"zero_subtotal_payment_from_specific_countries": "abc123",
- "zero_subtotal_sort_order": 987,
+ "zero_subtotal_sort_order": 123,
"zero_subtotal_title": "abc123"
}
}
@@ -6295,7 +6328,7 @@ Variables
"sku": "xyz789",
"optionIds": ["xyz789"],
"pageSize": 123,
- "cursor": "abc123"
+ "cursor": "xyz789"
}
@@ -6481,11 +6514,11 @@ Response
"expiration_date": "abc123",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": false,
- "is_virtual": false,
+ "is_virtual": true,
"items": [CartItemInterface],
- "max_order_commitment": 123,
+ "max_order_commitment": 987,
"min_order_commitment": 987,
- "name": "abc123",
+ "name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -6494,9 +6527,9 @@ Response
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
- "status": "xyz789",
- "template_id": "4",
- "total_quantity": 987.65
+ "status": "abc123",
+ "template_id": 4,
+ "total_quantity": 123.45
}
}
}
@@ -6649,7 +6682,7 @@ Query
Variables
{
- "giftRegistryUid": 4,
+ "giftRegistryUid": "4",
"registrants": [AddGiftRegistryRegistrantInput]
}
@@ -6742,7 +6775,7 @@ Query
Variables
{
- "cartId": "abc123",
+ "cartId": "xyz789",
"cartItems": [CartItemInput]
}
@@ -6834,9 +6867,88 @@ Response
"data": {
"addProductsToCompareList": {
"attributes": [ComparableAttribute],
- "item_count": 123,
+ "item_count": 987,
"items": [ComparableItem],
- "uid": 4
+ "uid": "4"
+ }
+ }
+}
+
+
+
+ back to top
+
+
+
+
+ Mutations
+
+
+ addProductsToNewCart
+
+
+
+
+ Description
+ Creates a new cart and add any type of product to it
+
+
+
+
+
+
+ Response
+ Returns an AddProductsToNewCartOutput
+
+
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ cartItems - [CartItemInput!]!
+
+ An array that defines the products to add to the new cart
+
+
+
+
+
+
+ Example
+
+ Query
+ mutation addProductsToNewCart($cartItems: [CartItemInput!]!) {
+ addProductsToNewCart(cartItems: $cartItems) {
+ cart {
+ ...CartFragment
+ }
+ user_errors {
+ ...CartUserInputErrorFragment
+ }
+ }
+}
+
+
+
+ Variables
+ {"cartItems": [CartItemInput]}
+
+
+
+ Response
+ {
+ "data": {
+ "addProductsToNewCart": {
+ "cart": Cart,
+ "user_errors": [CartUserInputError]
}
}
}
@@ -7008,7 +7120,10 @@ Query
Variables
- {"wishlistId": 4, "wishlistItems": [WishlistItemInput]}
+ {
+ "wishlistId": "4",
+ "wishlistItems": [WishlistItemInput]
+}
@@ -7271,7 +7386,7 @@ Response
AddRequisitionListItemToCartUserError
],
"cart": Cart,
- "status": false
+ "status": true
}
}
}
@@ -7502,10 +7617,7 @@ Query
Variables
- {
- "wishlistId": "4",
- "wishlistItemIds": ["4"]
-}
+ {"wishlistId": 4, "wishlistItemIds": ["4"]}
@@ -7516,7 +7628,7 @@ Response
"add_wishlist_items_to_cart_user_errors": [
WishlistCartUserInputError
],
- "status": false,
+ "status": true,
"wishlist": Wishlist
}
}
@@ -7792,7 +7904,7 @@ Query
Variables
- {"cartId": "4"}
+ {"cartId": 4}
@@ -8011,7 +8123,7 @@ Query
Variables
- {"uid": 4}
+ {"uid": "4"}
@@ -8136,7 +8248,7 @@ Query
Variables
- {"cart_id": "xyz789"}
+ {"cart_id": "abc123"}
@@ -8154,15 +8266,15 @@ Response
],
"billing_address": BillingCartAddress,
"custom_attributes": [CustomAttribute],
- "email": "xyz789",
+ "email": "abc123",
"gift_message": GiftMessage,
- "gift_receipt_included": false,
+ "gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
"id": 4,
- "is_virtual": true,
+ "is_virtual": false,
"itemsV2": CartItems,
"prices": CartPrices,
- "printed_card_included": false,
+ "printed_card_included": true,
"rules": [CartRuleStorefront],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
@@ -8273,14 +8385,14 @@ Response
"cancelNegotiableQuoteTemplate": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "expiration_date": "abc123",
+ "expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
- "is_min_max_qty_used": false,
- "is_virtual": true,
+ "is_min_max_qty_used": true,
+ "is_virtual": false,
"items": [CartItemInterface],
- "max_order_commitment": 123,
+ "max_order_commitment": 987,
"min_order_commitment": 987,
- "name": "xyz789",
+ "name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -8289,9 +8401,9 @@ Response
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
- "status": "abc123",
- "template_id": "4",
- "total_quantity": 987.65
+ "status": "xyz789",
+ "template_id": 4,
+ "total_quantity": 123.45
}
}
}
@@ -8622,8 +8734,8 @@ Query
Variables
{
- "currentPassword": "abc123",
- "newPassword": "xyz789"
+ "currentPassword": "xyz789",
+ "newPassword": "abc123"
}
@@ -8634,18 +8746,18 @@ Response
"changeCustomerPassword": {
"addresses": [CustomerAddress],
"addressesV2": CustomerAddresses,
- "allow_remote_shopping_assistance": true,
+ "allow_remote_shopping_assistance": false,
"companies": UserCompaniesOutput,
"compare_list": CompareList,
"confirmation_status": "ACCOUNT_CONFIRMED",
"created_at": "abc123",
"custom_attributes": [AttributeValueInterface],
- "date_of_birth": "abc123",
- "default_billing": "xyz789",
- "default_shipping": "abc123",
+ "date_of_birth": "xyz789",
+ "default_billing": "abc123",
+ "default_shipping": "xyz789",
"email": "xyz789",
"firstname": "abc123",
- "gender": 987,
+ "gender": 123,
"gift_registries": [GiftRegistry],
"gift_registry": GiftRegistry,
"group": CustomerGroupStorefront,
@@ -8670,8 +8782,8 @@ Response
"status": "ACTIVE",
"store_credit": CustomerStoreCredit,
"structure_id": "4",
- "suffix": "xyz789",
- "taxvat": "xyz789",
+ "suffix": "abc123",
+ "taxvat": "abc123",
"team": CompanyTeam,
"telephone": "xyz789",
"wishlist_v2": Wishlist,
@@ -8743,14 +8855,14 @@ Query
Variables
- {"cartUid": "xyz789"}
+ {"cartUid": "abc123"}
Response
{
"data": {
- "clearCustomerCart": {"cart": Cart, "status": true}
+ "clearCustomerCart": {"cart": Cart, "status": false}
}
}
@@ -8819,7 +8931,7 @@ Query
Variables
- {"wishlistId": 4}
+ {"wishlistId": "4"}
@@ -8920,6 +9032,85 @@ Response
}
}
}
+
+
+
+ back to top
+
+
+
+
+ Mutations
+
+
+ completeOrder
+
+
+
+
+ Description
+ Synchronizes order details and place the order
+
+
+
+
+
+
+ Response
+ Returns a PlaceOrderOutput
+
+
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ input - CompleteOrderInput
+
+ Describes the variables needed to complete or place the order
+
+
+
+
+
+
+ Example
+
+ Query
+ mutation completeOrder($input: CompleteOrderInput) {
+ completeOrder(input: $input) {
+ errors {
+ ...PlaceOrderErrorFragment
+ }
+ orderV2 {
+ ...CustomerOrderFragment
+ }
+ }
+}
+
+
+
+ Variables
+ {"input": CompleteOrderInput}
+
+
+
+ Response
+ {
+ "data": {
+ "completeOrder": {
+ "errors": [PlaceOrderError],
+ "orderV2": CustomerOrder
+ }
+ }
+}
@@ -8996,7 +9187,7 @@ Response
{
"data": {
"confirmCancelOrder": {
- "error": "abc123",
+ "error": "xyz789",
"errorV2": CancelOrderError,
"order": CustomerOrder
}
@@ -9217,7 +9408,7 @@ Variables
Response
- {"data": {"contactUs": {"status": true}}}
+ {"data": {"contactUs": {"status": false}}}
@@ -9302,7 +9493,7 @@ Query
Variables
{
- "sourceRequisitionListUid": "4",
+ "sourceRequisitionListUid": 4,
"destinationRequisitionListUid": 4,
"requisitionListItem": CopyItemsBetweenRequisitionListsInput
}
@@ -9407,7 +9598,7 @@ Query
Variables
{
- "sourceWishlistUid": "4",
+ "sourceWishlistUid": 4,
"destinationWishlistUid": "4",
"wishlistItems": [WishlistItemCopyInput]
}
@@ -9782,7 +9973,7 @@ Response
"data": {
"createCompareList": {
"attributes": [ComparableAttribute],
- "item_count": 987,
+ "item_count": 123,
"items": [ComparableItem],
"uid": 4
}
@@ -9868,6 +10059,7 @@ Query
street
suffix
telephone
+ uid
vat_id
}
}
@@ -9888,21 +10080,22 @@ Response
"country_code": "AF",
"custom_attributesV2": [AttributeValueInterface],
"default_billing": false,
- "default_shipping": false,
+ "default_shipping": true,
"extension_attributes": [CustomerAddressAttribute],
- "fax": "abc123",
- "firstname": "abc123",
+ "fax": "xyz789",
+ "firstname": "xyz789",
"id": 123,
- "lastname": "xyz789",
+ "lastname": "abc123",
"middlename": "abc123",
- "postcode": "abc123",
- "prefix": "xyz789",
+ "postcode": "xyz789",
+ "prefix": "abc123",
"region": CustomerAddressRegion,
- "region_id": 123,
+ "region_id": 987,
"street": ["abc123"],
- "suffix": "abc123",
- "telephone": "xyz789",
- "vat_id": "xyz789"
+ "suffix": "xyz789",
+ "telephone": "abc123",
+ "uid": "4",
+ "vat_id": "abc123"
}
}
}
@@ -10191,11 +10384,11 @@ Response
{
"data": {
"createPaymentOrder": {
- "amount": 123.45,
- "currency_code": "abc123",
- "id": "abc123",
- "mp_order_id": "xyz789",
- "status": "xyz789"
+ "amount": 987.65,
+ "currency_code": "xyz789",
+ "id": "xyz789",
+ "mp_order_id": "abc123",
+ "status": "abc123"
}
}
}
@@ -10288,12 +10481,12 @@ Response
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
"created_at": "xyz789",
- "created_by": "xyz789",
+ "created_by": "abc123",
"description": "abc123",
"name": "xyz789",
"status": "ENABLED",
- "uid": "4",
- "updated_at": "abc123"
+ "uid": 4,
+ "updated_at": "xyz789"
}
}
}
@@ -10446,7 +10639,7 @@ Response
"data": {
"createVaultCardPaymentToken": {
"payment_source": PaymentSourceOutput,
- "vault_token_id": "abc123"
+ "vault_token_id": "xyz789"
}
}
}
@@ -10519,7 +10712,7 @@ Response
{
"data": {
"createVaultCardSetupToken": {
- "setup_token": "xyz789"
+ "setup_token": "abc123"
}
}
}
@@ -10654,7 +10847,7 @@ Query
Variables
- {"id": "4"}
+ {"id": 4}
@@ -10722,7 +10915,7 @@ Query
Variables
- {"id": "4"}
+ {"id": 4}
@@ -10795,7 +10988,7 @@ Variables
Response
- {"data": {"deleteCompanyUserV2": {"success": true}}}
+ {"data": {"deleteCompanyUserV2": {"success": false}}}
@@ -10857,12 +11050,12 @@ Query
Variables
- {"uid": 4}
+ {"uid": "4"}
Response
- {"data": {"deleteCompareList": {"result": false}}}
+ {"data": {"deleteCompareList": {"result": true}}}
@@ -10963,12 +11156,12 @@ Query
Variables
- {"id": 123}
+ {"id": 987}
Response
- {"data": {"deleteCustomerAddress": true}}
+ {"data": {"deleteCustomerAddress": false}}
@@ -11195,7 +11388,7 @@ Response
"data": {
"deletePaymentToken": {
"customerPaymentTokens": CustomerPaymentTokens,
- "result": true
+ "result": false
}
}
}
@@ -11339,7 +11532,7 @@ Query
Variables
- {"requisitionListUid": 4}
+ {"requisitionListUid": "4"}
@@ -11427,10 +11620,7 @@ Query
Variables
- {
- "requisitionListUid": "4",
- "requisitionListItemUids": ["4"]
-}
+ {"requisitionListUid": 4, "requisitionListItemUids": [4]}
@@ -11506,7 +11696,7 @@ Query
Variables
- {"wishlistId": 4}
+ {"wishlistId": "4"}
@@ -11514,7 +11704,7 @@ Response
{
"data": {
"deleteWishlist": {
- "status": true,
+ "status": false,
"wishlists": [Wishlist]
}
}
@@ -11682,10 +11872,10 @@ Response
"additional_data": [ShippingAdditionalData],
"amount": Money,
"available": true,
- "carrier_code": "abc123",
+ "carrier_code": "xyz789",
"carrier_title": "abc123",
- "error_message": "xyz789",
- "method_code": "abc123",
+ "error_message": "abc123",
+ "method_code": "xyz789",
"method_title": "xyz789",
"price_excl_tax": Money,
"price_incl_tax": Money
@@ -11839,6 +12029,76 @@ Response
}
}
}
+
+
+
+ back to top
+
+
+
+
+ Mutations
+
+
+ finishUpload
+
+
+
+
+ Response
+ Returns a finishUploadOutput
+
+
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ input - finishUploadInput!
+
+
+
+
+
+
+
+
+
+ Example
+
+ Query
+ mutation finishUpload($input: finishUploadInput!) {
+ finishUpload(input: $input) {
+ key
+ message
+ success
+ }
+}
+
+
+
+ Variables
+ {"input": finishUploadInput}
+
+
+
+ Response
+ {
+ "data": {
+ "finishUpload": {
+ "key": "abc123",
+ "message": "xyz789",
+ "success": true
+ }
+ }
+}
@@ -11913,7 +12173,7 @@ Query
Variables
{
- "email": "xyz789",
+ "email": "abc123",
"password": "abc123"
}
@@ -11996,7 +12256,7 @@ Response
{
"data": {
"generateCustomerTokenAsAdmin": {
- "customer_token": "abc123"
+ "customer_token": "xyz789"
}
}
}
@@ -12066,7 +12326,83 @@ Variables
Response
- {"data": {"generateNegotiableQuoteFromTemplate": {"negotiable_quote_uid": 4}}}
+ {
+ "data": {
+ "generateNegotiableQuoteFromTemplate": {
+ "negotiable_quote_uid": "4"
+ }
+ }
+}
+
+
+
+ back to top
+
+
+
+
+ Mutations
+
+
+ initiateUpload
+
+
+
+
+ Response
+ Returns an initiateUploadOutput
+
+
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ input - initiateUploadInput!
+
+
+
+
+
+
+
+
+
+ Example
+
+ Query
+ mutation initiateUpload($input: initiateUploadInput!) {
+ initiateUpload(input: $input) {
+ expires_at
+ key
+ upload_url
+ }
+}
+
+
+
+ Variables
+ {"input": initiateUploadInput}
+
+
+
+ Response
+ {
+ "data": {
+ "initiateUpload": {
+ "expires_at": "xyz789",
+ "key": "abc123",
+ "upload_url": "abc123"
+ }
+ }
+}
@@ -12213,13 +12549,13 @@ Response
"custom_attributes": [CustomAttribute],
"email": "xyz789",
"gift_message": GiftMessage,
- "gift_receipt_included": true,
+ "gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
- "id": 4,
- "is_virtual": false,
+ "id": "4",
+ "is_virtual": true,
"itemsV2": CartItems,
"prices": CartPrices,
- "printed_card_included": false,
+ "printed_card_included": true,
"rules": [CartRuleStorefront],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
@@ -12306,10 +12642,7 @@ Query
Variables
- {
- "cartUid": "4",
- "giftRegistryUid": "4"
-}
+ {"cartUid": 4, "giftRegistryUid": "4"}
@@ -12318,7 +12651,7 @@ Response
"data": {
"moveCartItemsToGiftRegistry": {
"gift_registry": GiftRegistry,
- "status": true,
+ "status": false,
"user_errors": [GiftRegistryItemsUserError]
}
}
@@ -12411,7 +12744,7 @@ Query
Variables
{
"sourceRequisitionListUid": "4",
- "destinationRequisitionListUid": "4",
+ "destinationRequisitionListUid": 4,
"requisitionListItem": MoveItemsBetweenRequisitionListsInput
}
@@ -12714,11 +13047,11 @@ Response
"expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": true,
- "is_virtual": false,
+ "is_virtual": true,
"items": [CartItemInterface],
"max_order_commitment": 123,
"min_order_commitment": 987,
- "name": "abc123",
+ "name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -12728,8 +13061,8 @@ Response
NegotiableQuoteShippingAddress
],
"status": "xyz789",
- "template_id": 4,
- "total_quantity": 987.65
+ "template_id": "4",
+ "total_quantity": 123.45
}
}
}
@@ -12790,6 +13123,9 @@ Query
order {
...OrderFragment
}
+ orderV2 {
+ ...CustomerOrderFragment
+ }
}
}
@@ -12801,7 +13137,14 @@ Variables
Response
- {"data": {"placeNegotiableQuoteOrder": {"order": Order}}}
+ {
+ "data": {
+ "placeNegotiableQuoteOrder": {
+ "order": Order,
+ "orderV2": CustomerOrder
+ }
+ }
+}
@@ -13106,7 +13449,7 @@ Response
"redeemGiftCardBalanceAsStoreCredit": {
"balance": Money,
"code": "xyz789",
- "expiration_date": "xyz789"
+ "expiration_date": "abc123"
}
}
}
@@ -13458,7 +13801,7 @@ Query
Variables
- {"giftRegistryUid": "4"}
+ {"giftRegistryUid": 4}
@@ -13539,7 +13882,7 @@ Query
Variables
- {"giftRegistryUid": 4, "itemsUid": ["4"]}
+ {"giftRegistryUid": "4", "itemsUid": [4]}
@@ -13628,7 +13971,7 @@ Query
Variables
{
"giftRegistryUid": "4",
- "registrantsUid": ["4"]
+ "registrantsUid": [4]
}
@@ -13894,8 +14237,8 @@ Response
"is_virtual": true,
"items": [CartItemInterface],
"max_order_commitment": 123,
- "min_order_commitment": 123,
- "name": "xyz789",
+ "min_order_commitment": 987,
+ "name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -13904,8 +14247,8 @@ Response
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
- "status": "xyz789",
- "template_id": 4,
+ "status": "abc123",
+ "template_id": "4",
"total_quantity": 123.45
}
}
@@ -14071,10 +14414,7 @@ Query
Variables
- {
- "wishlistId": "4",
- "wishlistItemsIds": ["4"]
-}
+ {"wishlistId": 4, "wishlistItemsIds": ["4"]}
@@ -14435,7 +14775,7 @@ Query
Variables
- {"orderNumber": "abc123"}
+ {"orderNumber": "xyz789"}
@@ -14524,7 +14864,7 @@ Response
{
"data": {
"requestGuestOrderCancel": {
- "error": "abc123",
+ "error": "xyz789",
"errorV2": CancelOrderError,
"order": CustomerOrder
}
@@ -14777,12 +15117,12 @@ Response
"requestNegotiableQuoteTemplateFromQuote": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "expiration_date": "xyz789",
+ "expiration_date": "abc123",
"history": [NegotiableQuoteHistoryEntry],
- "is_min_max_qty_used": false,
- "is_virtual": false,
+ "is_min_max_qty_used": true,
+ "is_virtual": true,
"items": [CartItemInterface],
- "max_order_commitment": 987,
+ "max_order_commitment": 123,
"min_order_commitment": 123,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
@@ -14858,12 +15198,12 @@ Query
Variables
- {"email": "xyz789"}
+ {"email": "abc123"}
Response
- {"data": {"requestPasswordResetEmail": true}}
+ {"data": {"requestPasswordResetEmail": false}}
@@ -15007,7 +15347,7 @@ Variables
Response
- {"data": {"resendConfirmationEmail": false}}
+ {"data": {"resendConfirmationEmail": true}}
@@ -15088,8 +15428,8 @@ Query
Variables
{
- "email": "abc123",
- "resetPasswordToken": "xyz789",
+ "email": "xyz789",
+ "resetPasswordToken": "abc123",
"newPassword": "xyz789"
}
@@ -15284,6 +15624,81 @@ Variables
Response
{"data": {"setBillingAddressOnCart": {"cart": Cart}}}
+
+
+
+ back to top
+
+
+
+
+ Mutations
+
+
+ setCartAsInactive
+
+
+
+
+ Description
+ Sets the cart as inactive
+
+
+
+
+
+
+ Response
+ Returns a SetCartAsInactiveOutput
+
+
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ cartId - String!
+
+ The customer cart ID
+
+
+
+
+
+
+ Example
+
+ Query
+ mutation setCartAsInactive($cartId: String!) {
+ setCartAsInactive(cartId: $cartId) {
+ error
+ success
+ }
+}
+
+
+
+ Variables
+ {"cartId": "abc123"}
+
+
+
+ Response
+ {
+ "data": {
+ "setCartAsInactive": {
+ "error": "abc123",
+ "success": false
+ }
+ }
+}
@@ -16488,14 +16903,14 @@ Response
"setNegotiableQuoteTemplateShippingAddress": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "expiration_date": "xyz789",
+ "expiration_date": "abc123",
"history": [NegotiableQuoteHistoryEntry],
- "is_min_max_qty_used": true,
+ "is_min_max_qty_used": false,
"is_virtual": false,
"items": [CartItemInterface],
"max_order_commitment": 123,
- "min_order_commitment": 987,
- "name": "xyz789",
+ "min_order_commitment": 123,
+ "name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -16504,9 +16919,9 @@ Response
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
- "status": "xyz789",
+ "status": "abc123",
"template_id": 4,
- "total_quantity": 123.45
+ "total_quantity": 987.65
}
}
}
@@ -16685,10 +17100,10 @@ Response
"expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": true,
- "is_virtual": false,
+ "is_virtual": true,
"items": [CartItemInterface],
- "max_order_commitment": 987,
- "min_order_commitment": 123,
+ "max_order_commitment": 123,
+ "min_order_commitment": 987,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
@@ -16700,7 +17115,7 @@ Response
],
"status": "abc123",
"template_id": 4,
- "total_quantity": 123.45
+ "total_quantity": 987.65
}
}
}
@@ -16924,7 +17339,7 @@ Query
Variables
{
- "giftRegistryUid": 4,
+ "giftRegistryUid": "4",
"sender": ShareGiftRegistrySenderInput,
"invitees": [ShareGiftRegistryInviteeInput]
}
@@ -17041,8 +17456,8 @@ Response
"is_min_max_qty_used": false,
"is_virtual": true,
"items": [CartItemInterface],
- "max_order_commitment": 123,
- "min_order_commitment": 987,
+ "max_order_commitment": 987,
+ "min_order_commitment": 123,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
@@ -17054,7 +17469,7 @@ Response
],
"status": "abc123",
"template_id": "4",
- "total_quantity": 987.65
+ "total_quantity": 123.45
}
}
}
@@ -17710,6 +18125,7 @@ Query
street
suffix
telephone
+ uid
vat_id
}
}
@@ -17725,26 +18141,27 @@ Response
{
"data": {
"updateCustomerAddress": {
- "city": "abc123",
- "company": "abc123",
+ "city": "xyz789",
+ "company": "xyz789",
"country_code": "AF",
"custom_attributesV2": [AttributeValueInterface],
"default_billing": true,
"default_shipping": true,
"extension_attributes": [CustomerAddressAttribute],
"fax": "abc123",
- "firstname": "abc123",
+ "firstname": "xyz789",
"id": 987,
"lastname": "xyz789",
- "middlename": "abc123",
- "postcode": "abc123",
- "prefix": "xyz789",
+ "middlename": "xyz789",
+ "postcode": "xyz789",
+ "prefix": "abc123",
"region": CustomerAddressRegion,
- "region_id": 123,
- "street": ["xyz789"],
- "suffix": "abc123",
+ "region_id": 987,
+ "street": ["abc123"],
+ "suffix": "xyz789",
"telephone": "abc123",
- "vat_id": "abc123"
+ "uid": 4,
+ "vat_id": "xyz789"
}
}
}
@@ -17825,7 +18242,7 @@ Query
Variables
{
"email": "xyz789",
- "password": "xyz789"
+ "password": "abc123"
}
@@ -18155,7 +18572,7 @@ Query
Variables
{
- "giftRegistryUid": 4,
+ "giftRegistryUid": "4",
"registrants": [UpdateGiftRegistryRegistrantInput]
}
@@ -18501,13 +18918,13 @@ Response
"applies_to_roles": [CompanyRole],
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
- "created_at": "xyz789",
- "created_by": "abc123",
+ "created_at": "abc123",
+ "created_by": "xyz789",
"description": "xyz789",
"name": "abc123",
"status": "ENABLED",
- "uid": "4",
- "updated_at": "abc123"
+ "uid": 4,
+ "updated_at": "xyz789"
}
}
}
@@ -18588,7 +19005,7 @@ Query
Variables
{
- "requisitionListUid": 4,
+ "requisitionListUid": "4",
"input": UpdateRequisitionListInput
}
@@ -18789,8 +19206,8 @@ Response
{
"data": {
"updateWishlist": {
- "name": "xyz789",
- "uid": "4",
+ "name": "abc123",
+ "uid": 4,
"visibility": "PUBLIC"
}
}
@@ -18913,7 +19330,7 @@ Fields
Example
- {"template_id": 4}
+ {"template_id": "4"}
@@ -18997,7 +19414,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"cart_items": [DownloadableProductCartItemInput]
}
@@ -19104,7 +19521,7 @@ Example
],
"email": "xyz789",
"firstname": "xyz789",
- "lastname": "abc123"
+ "lastname": "xyz789"
}
@@ -19237,12 +19654,57 @@ Fields
+
+
+ Example
+ {"products": ["4"], "uid": 4}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ AddProductsToNewCartOutput
+
+
+
+ Description
+ Contains details about the cart after adding products to it.
+
+
+ Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+ cart - Cart
+
+ The cart after products have been added.
+
+
+ user_errors - [CartUserInputError]
+
+ Contains errors encountered while adding an item to the cart.
+
+
+
+
+
Example
{
- "products": ["4"],
- "uid": "4"
+ "cart": Cart,
+ "user_errors": [CartUserInputError]
}
@@ -19379,7 +19841,7 @@ Fields
Example
{
- "comment": "xyz789",
+ "comment": "abc123",
"purchase_order_uid": 4
}
@@ -19476,8 +19938,8 @@ Fields
Example
{
"cart_id": "xyz789",
- "purchase_order_uid": "4",
- "replace_existing_cart_items": false
+ "purchase_order_uid": 4,
+ "replace_existing_cart_items": true
}
@@ -19640,7 +20102,7 @@ Example
AddRequisitionListItemToCartUserError
],
"cart": Cart,
- "status": true
+ "status": false
}
@@ -19785,7 +20247,7 @@ Fields
Example
{
- "carrier_uid": 4,
+ "carrier_uid": "4",
"return_uid": 4,
"tracking_number": "abc123"
}
@@ -19948,7 +20410,7 @@ Fields
Example
{
- "attribute": "xyz789",
+ "attribute": "abc123",
"buckets": [Bucket],
"title": "abc123",
"type": "INTELLIGENT"
@@ -20081,12 +20543,12 @@ Fields
Example
{
"button_styles": ButtonStyles,
- "code": "xyz789",
+ "code": "abc123",
"is_visible": true,
- "payment_intent": "xyz789",
- "payment_source": "abc123",
+ "payment_intent": "abc123",
+ "payment_source": "xyz789",
"sdk_params": [SDKParams],
- "sort_order": "abc123",
+ "sort_order": "xyz789",
"title": "abc123"
}
@@ -20142,8 +20604,8 @@ Fields
Example
{
- "payment_source": "xyz789",
- "payments_order_id": "abc123",
+ "payment_source": "abc123",
+ "payments_order_id": "xyz789",
"paypal_order_id": "abc123"
}
@@ -20244,7 +20706,7 @@ Example
"applied_balance": Money,
"code": "xyz789",
"current_balance": Money,
- "expiration_date": "xyz789"
+ "expiration_date": "abc123"
}
@@ -20408,7 +20870,7 @@ Example
{
"applied_balance": Money,
"current_balance": Money,
- "enabled": false
+ "enabled": true
}
@@ -20457,8 +20919,8 @@ Fields
Example
{
- "cart_id": "xyz789",
- "coupon_code": "abc123"
+ "cart_id": "abc123",
+ "coupon_code": "xyz789"
}
@@ -20602,7 +21064,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"coupon_codes": ["xyz789"],
"type": "APPEND"
}
@@ -20653,7 +21115,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"gift_card_code": "abc123"
}
@@ -20742,7 +21204,7 @@ Fields
Example
{
"applied_balance": Money,
- "code": "abc123"
+ "code": "xyz789"
}
@@ -20911,7 +21373,7 @@ Fields
Example
- {"radius": 123, "search_term": "xyz789"}
+ {"radius": 123, "search_term": "abc123"}
@@ -21039,10 +21501,10 @@ Fields
Example
{
"asset_video": ProductMediaGalleryEntriesAssetVideo,
- "disabled": false,
+ "disabled": true,
"label": "abc123",
- "position": 987,
- "url": "xyz789"
+ "position": 123,
+ "url": "abc123"
}
@@ -21159,6 +21621,47 @@ Values
Example
"CATALOG_PRODUCT"
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ AttributeFile
+
+
+
+
+
+
+ Example
+ {"code": 4, "url": "abc123"}
@@ -21270,11 +21773,11 @@ Example
"is_filterable": false,
"is_filterable_in_search": true,
"is_html_allowed_on_front": false,
- "is_searchable": true,
- "is_used_for_customer_segment": true,
+ "is_searchable": false,
+ "is_used_for_customer_segment": false,
"is_used_for_price_rules": false,
- "is_used_for_promo_rules": true,
- "is_visible_in_advanced_search": true,
+ "is_used_for_promo_rules": false,
+ "is_visible_in_advanced_search": false,
"is_visible_on_front": true,
"is_wysiwyg_enabled": false,
"used_in_product_listing": false
@@ -21516,7 +22019,7 @@ Fields
Example
- {"value": "xyz789"}
+ {"value": "abc123"}
@@ -21598,13 +22101,13 @@ Fields
Example
{
"code": 4,
- "default_value": "xyz789",
+ "default_value": "abc123",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
- "is_required": true,
- "is_unique": true,
- "label": "xyz789",
+ "is_required": false,
+ "is_unique": false,
+ "label": "abc123",
"options": [CustomAttributeOptionInterface]
}
@@ -21813,7 +22316,7 @@ Fields
Example
{
"is_default": false,
- "label": "abc123",
+ "label": "xyz789",
"value": "xyz789"
}
@@ -21857,8 +22360,8 @@ Fields
Example
{
- "label": "xyz789",
- "value": "abc123"
+ "label": "abc123",
+ "value": "xyz789"
}
@@ -21919,7 +22422,7 @@ Possible Types
Example
{
"label": "xyz789",
- "value": "xyz789"
+ "value": "abc123"
}
@@ -21963,7 +22466,7 @@ Fields
Example
{
- "code": 4,
+ "code": "4",
"selected_options": [AttributeSelectedOptionInterface]
}
@@ -22006,7 +22509,10 @@ Fields
Example
- {"code": 4, "value": "abc123"}
+ {
+ "code": "4",
+ "value": "abc123"
+}
@@ -22060,9 +22566,9 @@ Fields
Example
{
- "attribute_code": "xyz789",
+ "attribute_code": "abc123",
"selected_options": [AttributeInputSelectedOption],
- "value": "abc123"
+ "value": "xyz789"
}
@@ -22104,6 +22610,11 @@ Possible Types
+
+
+
+
+
@@ -22262,7 +22773,7 @@ Fields
Example
- {"code": "AFN", "symbol": "xyz789"}
+ {"code": "AFN", "symbol": "abc123"}
@@ -22318,7 +22829,7 @@ Fields
Example
{
- "code": "xyz789",
+ "code": "abc123",
"is_deferred": true,
"oope_payment_method_config": OopePaymentMethodConfig,
"title": "abc123"
@@ -22411,10 +22922,10 @@ Example
"additional_data": [ShippingAdditionalData],
"amount": Money,
"available": false,
- "carrier_code": "abc123",
+ "carrier_code": "xyz789",
"carrier_title": "abc123",
"error_message": "xyz789",
- "method_code": "abc123",
+ "method_code": "xyz789",
"method_title": "xyz789",
"price_excl_tax": Money,
"price_incl_tax": Money
@@ -22531,9 +23042,9 @@ Fields
Example
{
"address": CartAddressInput,
- "customer_address_id": 987,
+ "customer_address_id": 123,
"same_as_shipping": true,
- "use_for_shipping": true
+ "use_for_shipping": false
}
@@ -22609,9 +23120,9 @@ Example
"address_line_1": "xyz789",
"address_line_2": "abc123",
"city": "abc123",
- "country_code": "xyz789",
+ "country_code": "abc123",
"postal_code": "abc123",
- "region": "abc123"
+ "region": "xyz789"
}
@@ -22733,23 +23244,23 @@ Fields
Example
{
- "city": "xyz789",
+ "city": "abc123",
"company": "abc123",
"country": CartAddressCountry,
"custom_attributes": [AttributeValueInterface],
"fax": "abc123",
"firstname": "abc123",
"id": 123,
- "lastname": "abc123",
- "middlename": "xyz789",
+ "lastname": "xyz789",
+ "middlename": "abc123",
"postcode": "xyz789",
- "prefix": "abc123",
+ "prefix": "xyz789",
"region": CartAddressRegion,
"street": ["abc123"],
- "suffix": "abc123",
+ "suffix": "xyz789",
"telephone": "xyz789",
- "uid": "xyz789",
- "vat_id": "abc123"
+ "uid": "abc123",
+ "vat_id": "xyz789"
}
@@ -22828,11 +23339,11 @@ Fields
Example
{
- "category_level": 123,
+ "category_level": 987,
"category_name": "xyz789",
"category_uid": "4",
"category_url_key": "abc123",
- "category_url_path": "abc123"
+ "category_url_path": "xyz789"
}
@@ -23046,15 +23557,15 @@ Example
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
"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"
}
@@ -23141,7 +23652,7 @@ Example
"discounts": [Discount],
"id": "4",
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "abc123",
"quantity_refunded": 123.45
@@ -23229,12 +23740,12 @@ Example
"bundle_options": [ItemSelectedBundleOption],
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "quantity_invoiced": 123.45
+ "product_sku": "abc123",
+ "quantity_invoiced": 987.65
}
@@ -23312,11 +23823,11 @@ Fields
Example
{
"options": [BundleItemOption],
- "position": 987,
+ "position": 123,
"price_range": PriceRange,
"required": false,
- "sku": "xyz789",
- "title": "abc123",
+ "sku": "abc123",
+ "title": "xyz789",
"type": "xyz789",
"uid": 4
}
@@ -23400,11 +23911,11 @@ Fields
Example
{
- "can_change_quantity": false,
+ "can_change_quantity": true,
"is_default": false,
"label": "abc123",
- "position": 123,
- "price": 987.65,
+ "position": 987,
+ "price": 123.45,
"price_type": "FIXED",
"product": ProductInterface,
"quantity": 123.45,
@@ -23574,25 +24085,25 @@ Example
"bundle_options": [ItemSelectedBundleOption],
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": "4",
+ "id": 4,
"parent_sku": "abc123",
"prices": OrderItemPrices,
"product": ProductInterface,
"product_name": "abc123",
"product_sale_price": Money,
"product_sku": "xyz789",
- "product_type": "abc123",
- "product_url_key": "xyz789",
+ "product_type": "xyz789",
+ "product_url_key": "abc123",
"quantity_canceled": 987.65,
- "quantity_invoiced": 123.45,
- "quantity_ordered": 123.45,
- "quantity_refunded": 987.65,
- "quantity_return_requested": 123.45,
- "quantity_returned": 123.45,
+ "quantity_invoiced": 987.65,
+ "quantity_ordered": 987.65,
+ "quantity_refunded": 123.45,
+ "quantity_return_requested": 987.65,
+ "quantity_returned": 987.65,
"quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
"status": "abc123"
@@ -23885,31 +24396,31 @@ 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,
- "dynamic_price": false,
- "dynamic_sku": true,
- "dynamic_weight": true,
- "gift_message_available": false,
+ "dynamic_price": true,
+ "dynamic_sku": false,
+ "dynamic_weight": false,
+ "gift_message_available": true,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"image": ProductImage,
"is_returnable": "abc123",
"items": [BundleItem],
- "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": 123.45,
- "name": "xyz789",
- "new_from_date": "xyz789",
- "new_to_date": "abc123",
+ "min_sale_qty": 987.65,
+ "name": "abc123",
+ "new_from_date": "abc123",
+ "new_to_date": "xyz789",
"only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
@@ -23918,7 +24429,7 @@ Example
"price_tiers": [TierPrice],
"price_view": "PRICE_RANGE",
"product_links": [ProductLinksInterface],
- "quantity": 987.65,
+ "quantity": 123.45,
"related_products": [ProductInterface],
"ship_bundle_items": "TOGETHER",
"short_description": ComplexTextValue,
@@ -23927,12 +24438,12 @@ Example
"special_price": 987.65,
"special_to_date": "xyz789",
"stock_status": "IN_STOCK",
- "swatch_image": "abc123",
+ "swatch_image": "xyz789",
"thumbnail": ProductImage,
"uid": 4,
"upsell_products": [ProductInterface],
"url_key": "abc123",
- "weight": 987.65
+ "weight": 123.45
}
@@ -24071,12 +24582,12 @@ Fields
Example
{
"bundle_options": [ItemSelectedBundleOption],
- "id": 4,
+ "id": "4",
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
- "quantity_shipped": 987.65
+ "product_sku": "xyz789",
+ "quantity_shipped": 123.45
}
@@ -24149,11 +24660,11 @@ Fields
Example
{
- "added_at": "abc123",
+ "added_at": "xyz789",
"bundle_options": [SelectedBundleOption],
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
- "id": 4,
+ "id": "4",
"product": ProductInterface,
"quantity": 123.45
}
@@ -24223,13 +24734,13 @@ Fields
Example
{
- "color": "abc123",
+ "color": "xyz789",
"height": 987,
"label": "xyz789",
- "layout": "abc123",
+ "layout": "xyz789",
"shape": "xyz789",
"tagline": true,
- "use_default_height": false
+ "use_default_height": true
}
@@ -24279,7 +24790,7 @@ Fields
Example
{
"cancellation_comment": "xyz789",
- "template_id": 4
+ "template_id": "4"
}
@@ -24444,10 +24955,7 @@ Fields
Example
- {
- "order_id": "4",
- "reason": "abc123"
-}
+ {"order_id": 4, "reason": "abc123"}
@@ -24499,7 +25007,7 @@ Fields
Example
{
- "error": "xyz789",
+ "error": "abc123",
"errorV2": CancelOrderError,
"order": CustomerOrder
}
@@ -24598,8 +25106,8 @@ Example
{
"bin_details": CardBin,
"card_expiry_month": "abc123",
- "card_expiry_year": "abc123",
- "last_digits": "abc123",
+ "card_expiry_year": "xyz789",
+ "last_digits": "xyz789",
"name": "xyz789"
}
@@ -24637,7 +25145,7 @@ Fields
Example
- {"bin": "xyz789"}
+ {"bin": "abc123"}
@@ -24738,7 +25246,7 @@ Fields
Example
{
- "brand": "abc123",
+ "brand": "xyz789",
"expiry": "xyz789",
"last_digits": "abc123"
}
@@ -24914,9 +25422,9 @@ Example
"custom_attributes": [CustomAttribute],
"email": "abc123",
"gift_message": GiftMessage,
- "gift_receipt_included": true,
+ "gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
- "id": "4",
+ "id": 4,
"is_virtual": false,
"itemsV2": CartItems,
"prices": CartPrices,
@@ -25111,23 +25619,23 @@ Fields
Example
{
- "city": "xyz789",
+ "city": "abc123",
"company": "abc123",
"country_code": "abc123",
"custom_attributes": [AttributeValueInput],
"fax": "abc123",
- "firstname": "xyz789",
+ "firstname": "abc123",
"lastname": "abc123",
- "middlename": "xyz789",
+ "middlename": "abc123",
"postcode": "abc123",
"prefix": "abc123",
"region": "abc123",
"region_id": 123,
- "save_in_address_book": true,
+ "save_in_address_book": false,
"street": ["xyz789"],
- "suffix": "abc123",
- "telephone": "xyz789",
- "vat_id": "xyz789"
+ "suffix": "xyz789",
+ "telephone": "abc123",
+ "vat_id": "abc123"
}
@@ -25267,23 +25775,23 @@ Possible Types
Example
{
- "city": "xyz789",
- "company": "abc123",
+ "city": "abc123",
+ "company": "xyz789",
"country": CartAddressCountry,
"custom_attributes": [AttributeValueInterface],
- "fax": "abc123",
+ "fax": "xyz789",
"firstname": "xyz789",
- "id": 987,
- "lastname": "abc123",
- "middlename": "abc123",
+ "id": 123,
+ "lastname": "xyz789",
+ "middlename": "xyz789",
"postcode": "abc123",
"prefix": "xyz789",
"region": CartAddressRegion,
"street": ["xyz789"],
- "suffix": "abc123",
- "telephone": "abc123",
+ "suffix": "xyz789",
+ "telephone": "xyz789",
"uid": "xyz789",
- "vat_id": "xyz789"
+ "vat_id": "abc123"
}
@@ -25336,8 +25844,8 @@ Fields
Example
{
"code": "xyz789",
- "label": "xyz789",
- "region_id": 123
+ "label": "abc123",
+ "region_id": 987
}
@@ -25386,7 +25894,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"custom_attributes": [CustomAttributeInput]
}
@@ -25487,7 +25995,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"cart_item_id": "abc123",
"custom_attributes": [CustomAttributeInput]
}
@@ -25650,7 +26158,7 @@ Fields
Example
{
"entered_options": [EnteredOptionInput],
- "parent_sku": "abc123",
+ "parent_sku": "xyz789",
"quantity": 123.45,
"selected_options": ["4"],
"sku": "abc123"
@@ -25804,13 +26312,13 @@ Example
"is_available": false,
"max_qty": 987.65,
"min_qty": 123.45,
- "not_available_message": "xyz789",
+ "not_available_message": "abc123",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
"quantity": 987.65,
- "uid": "4"
+ "uid": 4
}
@@ -26036,8 +26544,8 @@ Example
"cart_item_uid": "4",
"customizable_options": [CustomizableOptionInput],
"gift_message": GiftMessageInput,
- "gift_wrapping_id": "4",
- "quantity": 987.65
+ "gift_wrapping_id": 4,
+ "quantity": 123.45
}
@@ -26087,7 +26595,7 @@ Example
{
"items": [CartItemInterface],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -26208,7 +26716,7 @@ Fields
Example
- {"uid": 4}
+ {"uid": "4"}
@@ -26255,7 +26763,7 @@ Fields
Example
{
"amount": Money,
- "label": "xyz789"
+ "label": "abc123"
}
@@ -26299,7 +26807,7 @@ Fields
Example
{
"code": "PRODUCT_NOT_FOUND",
- "message": "xyz789"
+ "message": "abc123"
}
@@ -26624,28 +27132,28 @@ Fields
Example
{
"apply_to": ["SIMPLE"],
- "code": 4,
- "default_value": "abc123",
+ "code": "4",
+ "default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
- "is_comparable": true,
- "is_filterable": false,
+ "is_comparable": false,
+ "is_filterable": true,
"is_filterable_in_search": true,
"is_html_allowed_on_front": false,
- "is_required": true,
- "is_searchable": true,
+ "is_required": false,
+ "is_searchable": false,
"is_unique": true,
- "is_used_for_price_rules": true,
- "is_used_for_promo_rules": false,
+ "is_used_for_price_rules": false,
+ "is_used_for_promo_rules": true,
"is_visible_in_advanced_search": false,
- "is_visible_on_front": false,
- "is_wysiwyg_enabled": false,
- "label": "abc123",
+ "is_visible_on_front": true,
+ "is_wysiwyg_enabled": true,
+ "label": "xyz789",
"options": [CustomAttributeOptionInterface],
"swatch_input_type": "BOOLEAN",
"update_product_preview_image": true,
- "use_product_image_for_swatch": false,
+ "use_product_image_for_swatch": true,
"used_in_product_listing": false
}
@@ -26709,7 +27217,7 @@ Example
{
"count": 987,
"id": "4",
- "path": "abc123",
+ "path": "xyz789",
"title": "xyz789"
}
@@ -26765,7 +27273,7 @@ Possible Types
Example
- {"id": "4"}
+ {"id": 4}
@@ -26957,29 +27465,29 @@ Example
{
"available_sort_by": ["abc123"],
"breadcrumbs": [Breadcrumb],
- "canonical_url": "abc123",
- "children_count": "abc123",
+ "canonical_url": "xyz789",
+ "children_count": "xyz789",
"custom_layout_update_file": "abc123",
- "default_sort_by": "xyz789",
- "description": "xyz789",
- "display_mode": "abc123",
- "filter_price_range": 123.45,
+ "default_sort_by": "abc123",
+ "description": "abc123",
+ "display_mode": "xyz789",
+ "filter_price_range": 987.65,
"image": "abc123",
- "include_in_menu": 987,
- "is_anchor": 123,
+ "include_in_menu": 123,
+ "is_anchor": 987,
"landing_page": 123,
- "level": 987,
+ "level": 123,
"meta_description": "abc123",
"meta_keywords": "xyz789",
- "meta_title": "xyz789",
+ "meta_title": "abc123",
"name": "xyz789",
"path": "abc123",
- "path_in_store": "abc123",
+ "path_in_store": "xyz789",
"position": 987,
- "product_count": 987,
- "uid": 4,
+ "product_count": 123,
+ "uid": "4",
"url_key": "xyz789",
- "url_path": "abc123"
+ "url_path": "xyz789"
}
@@ -27153,29 +27661,29 @@ Fields
Example
{
- "available_sort_by": ["abc123"],
+ "available_sort_by": ["xyz789"],
"breadcrumbs": [Breadcrumb],
- "canonical_url": "abc123",
+ "canonical_url": "xyz789",
"children_count": "abc123",
"custom_layout_update_file": "abc123",
- "default_sort_by": "xyz789",
+ "default_sort_by": "abc123",
"description": "xyz789",
- "display_mode": "abc123",
+ "display_mode": "xyz789",
"filter_price_range": 123.45,
- "image": "xyz789",
- "include_in_menu": 123,
- "is_anchor": 987,
+ "image": "abc123",
+ "include_in_menu": 987,
+ "is_anchor": 123,
"landing_page": 123,
- "level": 987,
- "meta_description": "xyz789",
+ "level": 123,
+ "meta_description": "abc123",
"meta_keywords": "xyz789",
"meta_title": "abc123",
- "name": "abc123",
+ "name": "xyz789",
"path": "xyz789",
- "path_in_store": "xyz789",
+ "path_in_store": "abc123",
"position": 123,
"product_count": 987,
- "uid": 4,
+ "uid": "4",
"url_key": "abc123",
"url_path": "abc123"
}
@@ -27296,19 +27804,19 @@ Fields
Example
{
- "availableSortBy": ["xyz789"],
- "children": ["xyz789"],
- "defaultSortBy": "abc123",
+ "availableSortBy": ["abc123"],
+ "children": ["abc123"],
+ "defaultSortBy": "xyz789",
"id": "4",
"level": 123,
- "name": "abc123",
- "parentId": "abc123",
+ "name": "xyz789",
+ "parentId": "xyz789",
"path": "xyz789",
- "roles": ["abc123"],
- "urlKey": "abc123",
- "urlPath": "xyz789",
- "count": 987,
- "title": "xyz789"
+ "roles": ["xyz789"],
+ "urlKey": "xyz789",
+ "urlPath": "abc123",
+ "count": 123,
+ "title": "abc123"
}
@@ -27416,12 +27924,12 @@ Example
"availableSortBy": ["abc123"],
"defaultSortBy": "abc123",
"id": "4",
- "level": 123,
+ "level": 987,
"name": "xyz789",
"path": "abc123",
"roles": ["xyz789"],
"urlKey": "abc123",
- "urlPath": "xyz789"
+ "urlPath": "abc123"
}
@@ -27493,13 +28001,13 @@ Fields
Example
{
- "agreement_id": 123,
+ "agreement_id": 987,
"checkbox_text": "xyz789",
- "content": "abc123",
+ "content": "xyz789",
"content_height": "xyz789",
"is_html": true,
"mode": "AUTO",
- "name": "xyz789"
+ "name": "abc123"
}
@@ -27712,7 +28220,7 @@ Fields
Example
- {"cart": Cart, "status": true}
+ {"cart": Cart, "status": false}
@@ -28128,6 +28636,16 @@ Fields
The list of all resources defined within the company.
+
+ available_payment_methods - [AvailablePaymentMethod]
+
+ Available payment methods for the company with proper B2B configuration and company-specific filtering.
+
+
+ available_shipping_methods - [CompanyAvailableShippingMethod]
+
+ Available shipping carriers for the company with proper B2B configuration and company-specific filtering.
+
company_admin - Customer
@@ -28354,17 +28872,21 @@ currentPageExample
{
"acl_resources": [CompanyAclResource],
+ "available_payment_methods": [AvailablePaymentMethod],
+ "available_shipping_methods": [
+ CompanyAvailableShippingMethod
+ ],
"company_admin": Customer,
"credit": CompanyCredit,
"credit_history": CompanyCreditHistory,
"custom_attributes": [CustomAttribute],
"email": "abc123",
- "id": 4,
+ "id": "4",
"legal_address": CompanyLegalAddress,
"legal_name": "abc123",
- "name": "xyz789",
+ "name": "abc123",
"payment_methods": ["abc123"],
- "reseller_id": "xyz789",
+ "reseller_id": "abc123",
"role": CompanyRole,
"roles": CompanyRoles,
"sales_representative": CompanySalesRepresentative,
@@ -28431,7 +28953,7 @@ Example
{
"children": [CompanyAclResource],
"id": "4",
- "sort_order": 123,
+ "sort_order": 987,
"text": "abc123"
}
@@ -28517,7 +29039,57 @@ Example
"gender": 987,
"job_title": "abc123",
"lastname": "abc123",
- "telephone": "xyz789"
+ "telephone": "abc123"
+}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ CompanyAvailableShippingMethod
+
+
+
+ Description
+ Describes a carrier-level shipping option available to the company.
+
+
+
+
+
+ Example
+ {
+ "code": "abc123",
+ "title": "abc123"
}
@@ -28651,10 +29223,10 @@ Fields
Example
{
"company_admin": CompanyAdminInput,
- "company_email": "abc123",
+ "company_email": "xyz789",
"company_name": "xyz789",
"legal_address": CompanyLegalAddressCreateInput,
- "legal_name": "xyz789",
+ "legal_name": "abc123",
"reseller_id": "xyz789",
"vat_tax_id": "abc123"
}
@@ -28764,7 +29336,7 @@ Example
{
"items": [CompanyCreditOperation],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -28821,7 +29393,7 @@ Example
{
"custom_reference_number": "abc123",
"operation_type": "ALLOCATION",
- "updated_by": "abc123"
+ "updated_by": "xyz789"
}
@@ -29111,8 +29683,8 @@ Fields
Example
{
- "code": "abc123",
- "role_id": 4,
+ "code": "xyz789",
+ "role_id": "4",
"user": CompanyInvitationUserInput
}
@@ -29154,7 +29726,7 @@ Fields
Example
- {"success": true}
+ {"success": false}
@@ -29222,7 +29794,7 @@ Example
{
"company_id": 4,
"customer_id": "4",
- "job_title": "abc123",
+ "job_title": "xyz789",
"status": "ACTIVE",
"telephone": "xyz789"
}
@@ -29291,12 +29863,12 @@ Fields
Example
{
- "city": "xyz789",
+ "city": "abc123",
"country_code": "AF",
- "postcode": "xyz789",
+ "postcode": "abc123",
"region": CustomerAddressRegion,
"street": ["abc123"],
- "telephone": "xyz789"
+ "telephone": "abc123"
}
@@ -29374,7 +29946,7 @@ Example
"postcode": "abc123",
"region": CustomerAddressRegionInput,
"street": ["xyz789"],
- "telephone": "xyz789"
+ "telephone": "abc123"
}
@@ -29449,10 +30021,10 @@ Example
{
"city": "xyz789",
"country_id": "AF",
- "postcode": "abc123",
+ "postcode": "xyz789",
"region": CustomerAddressRegionInput,
- "street": ["xyz789"],
- "telephone": "abc123"
+ "street": ["abc123"],
+ "telephone": "xyz789"
}
@@ -29512,7 +30084,7 @@ Example
"id": 4,
"name": "abc123",
"permissions": [CompanyAclResource],
- "users_count": 123
+ "users_count": 987
}
@@ -29561,8 +30133,8 @@ Fields
Example
{
- "name": "xyz789",
- "permissions": ["abc123"]
+ "name": "abc123",
+ "permissions": ["xyz789"]
}
@@ -29617,9 +30189,9 @@ Fields
Example
{
- "id": "4",
+ "id": 4,
"name": "xyz789",
- "permissions": ["xyz789"]
+ "permissions": ["abc123"]
}
@@ -29725,8 +30297,8 @@ Fields
Example
{
- "email": "xyz789",
- "firstname": "abc123",
+ "email": "abc123",
+ "firstname": "xyz789",
"lastname": "xyz789"
}
@@ -29909,7 +30481,10 @@ Fields
Example
- {"parent_tree_id": 4, "tree_id": "4"}
+ {
+ "parent_tree_id": "4",
+ "tree_id": "4"
+}
@@ -29966,8 +30541,8 @@ Fields
Example
{
"description": "xyz789",
- "id": 4,
- "name": "abc123",
+ "id": "4",
+ "name": "xyz789",
"structure_id": "4"
}
@@ -30082,7 +30657,7 @@ Example
{
"description": "abc123",
"id": "4",
- "name": "xyz789"
+ "name": "abc123"
}
@@ -30159,7 +30734,7 @@ Example
"company_name": "abc123",
"legal_address": CompanyLegalAddressUpdateInput,
"legal_name": "xyz789",
- "reseller_id": "xyz789",
+ "reseller_id": "abc123",
"vat_tax_id": "xyz789"
}
@@ -30248,10 +30823,10 @@ Example
"email": "xyz789",
"firstname": "abc123",
"job_title": "abc123",
- "lastname": "abc123",
- "role_id": "4",
+ "lastname": "xyz789",
+ "role_id": 4,
"status": "ACTIVE",
- "target_id": "4",
+ "target_id": 4,
"telephone": "xyz789"
}
@@ -30385,13 +30960,13 @@ Fields
Example
{
"email": "xyz789",
- "firstname": "abc123",
- "id": 4,
+ "firstname": "xyz789",
+ "id": "4",
"job_title": "abc123",
- "lastname": "abc123",
- "role_id": "4",
+ "lastname": "xyz789",
+ "role_id": 4,
"status": "ACTIVE",
- "telephone": "xyz789"
+ "telephone": "abc123"
}
@@ -30445,7 +31020,7 @@ Example
{
"items": [Customer],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -30533,7 +31108,7 @@ Fields
Example
{
- "code": "xyz789",
+ "code": "abc123",
"label": "abc123"
}
@@ -30589,7 +31164,7 @@ Example
{
"attributes": [ProductAttribute],
"product": ProductInterface,
- "uid": 4
+ "uid": "4"
}
@@ -30647,9 +31222,59 @@ Fields
Example
{
"attributes": [ComparableAttribute],
- "item_count": 123,
+ "item_count": 987,
"items": [ComparableItem],
- "uid": "4"
+ "uid": 4
+}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ CompleteOrderInput
+
+
+
+ Description
+ Update the quote and complete the order
+
+
+
+
+
+ Example
+ {
+ "cartId": "abc123",
+ "id": "xyz789"
}
@@ -30851,30 +31476,30 @@ linkTypes
Example
{
- "addToCartAllowed": false,
+ "addToCartAllowed": true,
"inStock": false,
- "lowStock": false,
+ "lowStock": true,
"attributes": [ProductViewAttribute],
- "description": "xyz789",
- "id": 4,
+ "description": "abc123",
+ "id": "4",
"images": [ProductViewImage],
"videos": [ProductViewVideo],
"lastModifiedAt": "2007-12-03T10:15:30Z",
"metaDescription": "xyz789",
"metaKeyword": "abc123",
"metaTitle": "abc123",
- "name": "abc123",
+ "name": "xyz789",
"inputOptions": [ProductViewInputOption],
"options": [ProductViewOption],
"priceRange": ProductViewPriceRange,
"shortDescription": "abc123",
"sku": "xyz789",
- "externalId": "xyz789",
+ "externalId": "abc123",
"url": "abc123",
"urlKey": "xyz789",
"links": [ProductViewLink],
"queryType": "xyz789",
- "visibility": "xyz789"
+ "visibility": "abc123"
}
@@ -30911,7 +31536,7 @@ Fields
Example
- {"html": "xyz789"}
+ {"html": "abc123"}
@@ -31112,8 +31737,8 @@ Example
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "is_available": false,
- "max_qty": 123.45,
+ "is_available": true,
+ "max_qty": 987.65,
"min_qty": 987.65,
"not_available_message": "abc123",
"note_from_buyer": [ItemNote],
@@ -31168,8 +31793,8 @@ Fields
Example
{
- "attribute_code": "abc123",
- "option_value_uids": [4]
+ "attribute_code": "xyz789",
+ "option_value_uids": ["4"]
}
@@ -31325,28 +31950,28 @@ Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
- "eligible_for_return": false,
+ "eligible_for_return": true,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": 4,
- "parent_sku": "xyz789",
+ "id": "4",
+ "parent_sku": "abc123",
"prices": OrderItemPrices,
"product": ProductInterface,
"product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
+ "product_sku": "abc123",
"product_type": "abc123",
- "product_url_key": "abc123",
+ "product_url_key": "xyz789",
"quantity_canceled": 123.45,
"quantity_invoiced": 123.45,
- "quantity_ordered": 987.65,
+ "quantity_ordered": 123.45,
"quantity_refunded": 987.65,
"quantity_return_requested": 987.65,
- "quantity_returned": 987.65,
- "quantity_shipped": 123.45,
+ "quantity_returned": 123.45,
+ "quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
- "status": "abc123"
+ "status": "xyz789"
}
@@ -31637,42 +32262,42 @@ Example
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
- "gift_message_available": true,
- "gift_wrapping_available": true,
+ "gift_message_available": false,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
"image": ProductImage,
- "is_returnable": "abc123",
+ "is_returnable": "xyz789",
"manufacturer": 987,
- "max_sale_qty": 987.65,
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"meta_description": "abc123",
"meta_keyword": "xyz789",
"meta_title": "abc123",
"min_sale_qty": 987.65,
- "name": "xyz789",
+ "name": "abc123",
"new_from_date": "abc123",
"new_to_date": "abc123",
- "only_x_left_in_stock": 987.65,
+ "only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
"price_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": 123.45,
- "special_to_date": "abc123",
+ "special_to_date": "xyz789",
"stock_status": "IN_STOCK",
"swatch_image": "abc123",
"thumbnail": ProductImage,
"uid": 4,
"upsell_products": [ProductInterface],
- "url_key": "xyz789",
+ "url_key": "abc123",
"variants": [ConfigurableVariant],
- "weight": 123.45
+ "weight": 987.65
}
@@ -31795,8 +32420,8 @@ Fields
Example
{
"is_available": false,
- "is_use_default": false,
- "label": "xyz789",
+ "is_use_default": true,
+ "label": "abc123",
"swatch": SwatchDataInterface,
"uid": 4
}
@@ -31875,7 +32500,7 @@ Example
"label": "abc123",
"position": 123,
"uid": 4,
- "use_default": false,
+ "use_default": true,
"values": [ConfigurableProductOptionsValues]
}
@@ -32006,10 +32631,10 @@ Fields
Example
{
"default_label": "abc123",
- "label": "abc123",
- "store_label": "abc123",
+ "label": "xyz789",
+ "store_label": "xyz789",
"swatch_data": SwatchDataInterface,
- "uid": "4",
+ "uid": 4,
"use_default_value": true
}
@@ -32075,8 +32700,8 @@ Example
"configurable_options": [SelectedConfigurableOption],
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
- "quantity": 987.65,
- "uid": "4"
+ "quantity": 123.45,
+ "uid": 4
}
@@ -32206,7 +32831,7 @@ Example
"configurable_options": [SelectedConfigurableOption],
"configured_variant": ProductInterface,
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
+ "description": "xyz789",
"id": "4",
"product": ProductInterface,
"quantity": 123.45
@@ -32254,8 +32879,8 @@ Fields
Example
{
- "confirmation_key": "abc123",
- "order_id": "4"
+ "confirmation_key": "xyz789",
+ "order_id": 4
}
@@ -32304,7 +32929,7 @@ Fields
Example
{
- "confirmation_key": "abc123",
+ "confirmation_key": "xyz789",
"email": "abc123"
}
@@ -32455,9 +33080,9 @@ Fields
Example
{
- "comment": "xyz789",
+ "comment": "abc123",
"email": "xyz789",
- "name": "abc123",
+ "name": "xyz789",
"telephone": "xyz789"
}
@@ -32700,7 +33325,7 @@ Example
"full_name_english": "abc123",
"full_name_locale": "xyz789",
"id": "abc123",
- "three_letter_abbreviation": "abc123",
+ "three_letter_abbreviation": "xyz789",
"two_letter_abbreviation": "abc123"
}
@@ -34681,7 +35306,7 @@ Fields
Example
{
- "cartId": "xyz789",
+ "cartId": "abc123",
"location": "PRODUCT_DETAIL",
"methodCode": "abc123",
"paymentSource": "abc123",
@@ -34749,8 +35374,8 @@ Example
{
"amount": 987.65,
"currency_code": "xyz789",
- "id": "xyz789",
- "mp_order_id": "abc123",
+ "id": "abc123",
+ "mp_order_id": "xyz789",
"status": "xyz789"
}
@@ -34799,7 +35424,7 @@ Fields
Example
- {"currency": "AFN", "value": 123.45}
+ {"currency": "AFN", "value": 987.65}
@@ -34862,7 +35487,7 @@ Example
"amount": CreatePurchaseOrderApprovalRuleConditionAmountInput,
"attribute": "GRAND_TOTAL",
"operator": "MORE_THAN",
- "quantity": 987
+ "quantity": 123
}
@@ -34911,8 +35536,8 @@ Fields
Example
{
- "description": "abc123",
- "name": "abc123"
+ "description": "xyz789",
+ "name": "xyz789"
}
@@ -35001,7 +35626,7 @@ Fields
Example
{
- "card_description": "xyz789",
+ "card_description": "abc123",
"setup_token_id": "abc123"
}
@@ -35050,7 +35675,7 @@ Fields
Example
{
"payment_source": PaymentSourceOutput,
- "vault_token_id": "xyz789"
+ "vault_token_id": "abc123"
}
@@ -35188,7 +35813,7 @@ Fields
Example
- {"name": "xyz789", "visibility": "PUBLIC"}
+ {"name": "abc123", "visibility": "PUBLIC"}
@@ -35348,7 +35973,7 @@ Fields
Example
{
- "credit_memo_id": "abc123",
+ "credit_memo_id": "xyz789",
"custom_attributes": [CustomAttributeInput]
}
@@ -35424,12 +36049,12 @@ Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
- "id": 4,
+ "id": "4",
"order_item": OrderItemInterface,
"product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "quantity_refunded": 987.65
+ "product_sku": "abc123",
+ "quantity_refunded": 123.45
}
@@ -35597,9 +36222,9 @@ Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
"quantity_refunded": 123.45
@@ -35795,11 +36420,11 @@ Fields
Example
{
- "available_currency_codes": ["xyz789"],
+ "available_currency_codes": ["abc123"],
"base_currency_code": "xyz789",
"base_currency_symbol": "xyz789",
"default_display_currency_code": "abc123",
- "default_display_currency_symbol": "xyz789",
+ "default_display_currency_symbol": "abc123",
"exchange_rates": [ExchangeRate]
}
@@ -37066,7 +37691,7 @@ Fields
Example
{
"attribute_code": "abc123",
- "value": "xyz789"
+ "value": "abc123"
}
@@ -37115,7 +37740,7 @@ Fields
Example
{
- "attribute_code": "xyz789",
+ "attribute_code": "abc123",
"value": "xyz789"
}
@@ -37230,13 +37855,13 @@ Possible Types
Example
{
- "code": 4,
- "default_value": "xyz789",
+ "code": "4",
+ "default_value": "abc123",
"entity_type": "CATALOG_PRODUCT",
- "frontend_class": "xyz789",
+ "frontend_class": "abc123",
"frontend_input": "BOOLEAN",
- "is_required": true,
- "is_unique": true,
+ "is_required": false,
+ "is_unique": false,
"label": "xyz789",
"options": [CustomAttributeOptionInterface]
}
@@ -37303,9 +37928,9 @@ Possible Types
Example
{
- "is_default": true,
+ "is_default": false,
"label": "xyz789",
- "value": "xyz789"
+ "value": "abc123"
}
@@ -37859,27 +38484,27 @@ Example
{
"addresses": [CustomerAddress],
"addressesV2": CustomerAddresses,
- "allow_remote_shopping_assistance": false,
+ "allow_remote_shopping_assistance": true,
"companies": UserCompaniesOutput,
"compare_list": CompareList,
"confirmation_status": "ACCOUNT_CONFIRMED",
- "created_at": "xyz789",
+ "created_at": "abc123",
"custom_attributes": [AttributeValueInterface],
- "date_of_birth": "xyz789",
+ "date_of_birth": "abc123",
"default_billing": "xyz789",
"default_shipping": "xyz789",
"email": "xyz789",
"firstname": "abc123",
- "gender": 123,
+ "gender": 987,
"gift_registries": [GiftRegistry],
"gift_registry": GiftRegistry,
"group": CustomerGroupStorefront,
"is_subscribed": false,
"job_title": "abc123",
"lastname": "xyz789",
- "middlename": "abc123",
+ "middlename": "xyz789",
"orders": CustomerOrders,
- "prefix": "xyz789",
+ "prefix": "abc123",
"purchase_order": PurchaseOrder,
"purchase_order_approval_rule": PurchaseOrderApprovalRule,
"purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
@@ -37895,10 +38520,10 @@ Example
"status": "ACTIVE",
"store_credit": CustomerStoreCredit,
"structure_id": "4",
- "suffix": "xyz789",
+ "suffix": "abc123",
"taxvat": "abc123",
"team": CompanyTeam,
- "telephone": "xyz789",
+ "telephone": "abc123",
"wishlist_v2": Wishlist,
"wishlists": [Wishlist]
}
@@ -38037,6 +38662,11 @@ attributeCodes
The customer's telephone number.
+
+ uid - ID!
+
+ The unique ID for a CustomerAddress object.
+
vat_id - String
@@ -38050,8 +38680,8 @@ attributeCodes
Example
{
- "city": "xyz789",
- "company": "xyz789",
+ "city": "abc123",
+ "company": "abc123",
"country_code": "AF",
"custom_attributesV2": [AttributeValueInterface],
"default_billing": true,
@@ -38059,17 +38689,18 @@ Example
"extension_attributes": [CustomerAddressAttribute],
"fax": "abc123",
"firstname": "xyz789",
- "id": 987,
+ "id": 123,
"lastname": "xyz789",
- "middlename": "abc123",
- "postcode": "xyz789",
+ "middlename": "xyz789",
+ "postcode": "abc123",
"prefix": "xyz789",
"region": CustomerAddressRegion,
- "region_id": 123,
+ "region_id": 987,
"street": ["abc123"],
"suffix": "xyz789",
"telephone": "abc123",
- "vat_id": "xyz789"
+ "uid": "4",
+ "vat_id": "abc123"
}
@@ -38117,7 +38748,7 @@ Fields
Example
{
"attribute_code": "xyz789",
- "value": "xyz789"
+ "value": "abc123"
}
@@ -38256,23 +38887,23 @@ Fields
Example
{
- "city": "xyz789",
+ "city": "abc123",
"company": "abc123",
"country_code": "AF",
"custom_attributesV2": [AttributeValueInput],
- "default_billing": true,
- "default_shipping": false,
- "fax": "xyz789",
- "firstname": "xyz789",
- "lastname": "xyz789",
- "middlename": "abc123",
- "postcode": "abc123",
- "prefix": "xyz789",
+ "default_billing": false,
+ "default_shipping": true,
+ "fax": "abc123",
+ "firstname": "abc123",
+ "lastname": "abc123",
+ "middlename": "xyz789",
+ "postcode": "xyz789",
+ "prefix": "abc123",
"region": CustomerAddressRegionInput,
- "street": ["xyz789"],
- "suffix": "xyz789",
+ "street": ["abc123"],
+ "suffix": "abc123",
"telephone": "xyz789",
- "vat_id": "abc123"
+ "vat_id": "xyz789"
}
@@ -38325,7 +38956,7 @@ Fields
Example
{
"region": "abc123",
- "region_code": "abc123",
+ "region_code": "xyz789",
"region_id": 123
}
@@ -38381,9 +39012,9 @@ Fields
Example
{
- "region": "abc123",
- "region_code": "xyz789",
- "region_id": 987
+ "region": "xyz789",
+ "region_code": "abc123",
+ "region_id": 123
}
@@ -38433,7 +39064,7 @@ Example
{
"items": [CustomerAddress],
"page_info": SearchResultPageInfo,
- "total_count": 123
+ "total_count": 987
}
@@ -38536,15 +39167,15 @@ Fields
Example
{
"code": 4,
- "default_value": "abc123",
+ "default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
- "frontend_class": "xyz789",
+ "frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"input_filter": "NONE",
"is_required": true,
"is_unique": false,
- "label": "abc123",
- "multiline_count": 987,
+ "label": "xyz789",
+ "multiline_count": 123,
"options": [CustomAttributeOptionInterface],
"sort_order": 987,
"validate_rules": [ValidationRule]
@@ -38662,18 +39293,18 @@ Fields
Example
{
- "allow_remote_shopping_assistance": true,
+ "allow_remote_shopping_assistance": false,
"custom_attributes": [AttributeValueInput],
- "date_of_birth": "xyz789",
- "email": "abc123",
- "firstname": "abc123",
+ "date_of_birth": "abc123",
+ "email": "xyz789",
+ "firstname": "xyz789",
"gender": 123,
- "is_subscribed": false,
+ "is_subscribed": true,
"lastname": "abc123",
"middlename": "abc123",
- "password": "abc123",
+ "password": "xyz789",
"prefix": "abc123",
- "suffix": "abc123",
+ "suffix": "xyz789",
"taxvat": "abc123"
}
@@ -38739,8 +39370,8 @@ Example
"date": "abc123",
"download_url": "abc123",
"order_increment_id": "xyz789",
- "remaining_downloads": "abc123",
- "status": "xyz789"
+ "remaining_downloads": "xyz789",
+ "status": "abc123"
}
@@ -38821,7 +39452,7 @@ Fields
Example
- {"uid": "4"}
+ {"uid": 4}
@@ -39032,12 +39663,12 @@ Example
"applied_gift_cards": [ApplyGiftCardToOrder],
"available_actions": ["REORDER"],
"billing_address": OrderAddress,
- "carrier": "abc123",
+ "carrier": "xyz789",
"comments": [SalesCommentItem],
"credit_memos": [CreditMemo],
"custom_attributes": [CustomAttribute],
"customer_info": OrderCustomerInfo,
- "email": "abc123",
+ "email": "xyz789",
"gift_message": GiftMessage,
"gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
@@ -39048,9 +39679,9 @@ Example
"items_eligible_for_return": [OrderItemInterface],
"number": "abc123",
"order_date": "xyz789",
- "order_status_change_date": "xyz789",
+ "order_status_change_date": "abc123",
"payment_methods": [OrderPaymentMethod],
- "printed_card_included": false,
+ "printed_card_included": true,
"returns": Returns,
"shipments": [OrderShipment],
"shipping_address": OrderAddress,
@@ -39211,7 +39842,7 @@ Example
"date_of_first_order": "xyz789",
"items": [CustomerOrder],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -39468,7 +40099,7 @@ Example
{
"balance_history": CustomerStoreCreditHistory,
"current_balance": Money,
- "enabled": true
+ "enabled": false
}
@@ -39579,10 +40210,10 @@ Fields
Example
{
- "action": "abc123",
+ "action": "xyz789",
"actual_balance": Money,
"balance_change": Money,
- "date_time_changed": "xyz789"
+ "date_time_changed": "abc123"
}
@@ -39623,7 +40254,7 @@ Fields
Example
- {"token": "abc123"}
+ {"token": "xyz789"}
@@ -39725,13 +40356,13 @@ Fields
Example
{
- "allow_remote_shopping_assistance": false,
+ "allow_remote_shopping_assistance": true,
"custom_attributes": [AttributeValueInput],
- "date_of_birth": "abc123",
- "firstname": "abc123",
- "gender": 123,
+ "date_of_birth": "xyz789",
+ "firstname": "xyz789",
+ "gender": 987,
"is_subscribed": true,
- "lastname": "xyz789",
+ "lastname": "abc123",
"middlename": "abc123",
"prefix": "abc123",
"suffix": "xyz789",
@@ -39802,8 +40433,8 @@ Fields
Example
{
- "product_sku": "xyz789",
- "required": true,
+ "product_sku": "abc123",
+ "required": false,
"sort_order": 123,
"title": "xyz789",
"uid": 4,
@@ -39870,10 +40501,10 @@ Fields
Example
{
"max_characters": 123,
- "price": 123.45,
+ "price": 987.65,
"price_type": "FIXED",
"sku": "xyz789",
- "uid": "4"
+ "uid": 4
}
@@ -39935,10 +40566,10 @@ Fields
Example
{
- "required": false,
+ "required": true,
"sort_order": 123,
"title": "xyz789",
- "uid": "4",
+ "uid": 4,
"value": [CustomizableCheckboxValue]
}
@@ -40012,10 +40643,10 @@ Fields
Example
{
"option_type_id": 123,
- "price": 987.65,
+ "price": 123.45,
"price_type": "FIXED",
- "sku": "abc123",
- "sort_order": 123,
+ "sku": "xyz789",
+ "sort_order": 987,
"title": "abc123",
"uid": "4"
}
@@ -40084,10 +40715,10 @@ Fields
Example
{
- "product_sku": "xyz789",
- "required": true,
+ "product_sku": "abc123",
+ "required": false,
"sort_order": 987,
- "title": "xyz789",
+ "title": "abc123",
"uid": 4,
"value": CustomizableDateValue
}
@@ -40211,7 +40842,7 @@ Example
"price_type": "FIXED",
"sku": "abc123",
"type": "DATE",
- "uid": "4"
+ "uid": 4
}
@@ -40273,10 +40904,10 @@ Fields
Example
{
- "required": true,
+ "required": false,
"sort_order": 123,
"title": "abc123",
- "uid": 4,
+ "uid": "4",
"value": [CustomizableDropDownValue]
}
@@ -40354,7 +40985,7 @@ Example
"price_type": "FIXED",
"sku": "abc123",
"sort_order": 123,
- "title": "xyz789",
+ "title": "abc123",
"uid": 4
}
@@ -40423,10 +41054,10 @@ Fields
Example
{
"product_sku": "abc123",
- "required": true,
- "sort_order": 123,
- "title": "abc123",
- "uid": "4",
+ "required": false,
+ "sort_order": 987,
+ "title": "xyz789",
+ "uid": 4,
"value": CustomizableFieldValue
}
@@ -40489,10 +41120,10 @@ Fields
Example
{
- "max_characters": 123,
- "price": 123.45,
+ "max_characters": 987,
+ "price": 987.65,
"price_type": "FIXED",
- "sku": "abc123",
+ "sku": "xyz789",
"uid": 4
}
@@ -40561,9 +41192,9 @@ Fields
Example
{
"product_sku": "xyz789",
- "required": false,
- "sort_order": 123,
- "title": "xyz789",
+ "required": true,
+ "sort_order": 987,
+ "title": "abc123",
"uid": 4,
"value": CustomizableFileValue
}
@@ -40637,13 +41268,13 @@ Fields
Example
{
- "file_extension": "abc123",
- "image_size_x": 987,
- "image_size_y": 123,
- "price": 123.45,
+ "file_extension": "xyz789",
+ "image_size_x": 123,
+ "image_size_y": 987,
+ "price": 987.65,
"price_type": "FIXED",
"sku": "xyz789",
- "uid": 4
+ "uid": "4"
}
@@ -40705,9 +41336,9 @@ Fields
Example
{
- "required": true,
+ "required": false,
"sort_order": 987,
- "title": "xyz789",
+ "title": "abc123",
"uid": 4,
"value": [CustomizableMultipleValue]
}
@@ -40781,7 +41412,7 @@ Fields
Example
{
- "option_type_id": 987,
+ "option_type_id": 123,
"price": 123.45,
"price_type": "FIXED",
"sku": "xyz789",
@@ -40944,8 +41575,8 @@ Possible Types
Example
{
"required": false,
- "sort_order": 987,
- "title": "xyz789",
+ "sort_order": 123,
+ "title": "abc123",
"uid": "4"
}
@@ -41091,9 +41722,9 @@ Fields
Example
{
"required": true,
- "sort_order": 987,
+ "sort_order": 123,
"title": "xyz789",
- "uid": "4",
+ "uid": 4,
"value": [CustomizableRadioValue]
}
@@ -41166,13 +41797,13 @@ Fields
Example
{
- "option_type_id": 123,
- "price": 987.65,
+ "option_type_id": 987,
+ "price": 123.45,
"price_type": "FIXED",
- "sku": "abc123",
- "sort_order": 987,
- "title": "xyz789",
- "uid": "4"
+ "sku": "xyz789",
+ "sort_order": 123,
+ "title": "abc123",
+ "uid": 4
}
@@ -41235,7 +41866,7 @@ Fields
Example
- {"success": false}
+ {"success": true}
@@ -41315,7 +41946,7 @@ Fields
Example
- {"success": true}
+ {"success": false}
@@ -41355,7 +41986,7 @@ Fields
Example
- {"result": false}
+ {"result": true}
@@ -41448,7 +42079,7 @@ Fields
Example
{
"errors": [NegotiableQuoteInvalidStateError],
- "quote_uid": 4
+ "quote_uid": "4"
}
@@ -41567,7 +42198,7 @@ Fields
Example
- {"quote_uids": ["4"]}
+ {"quote_uids": [4]}
@@ -41831,7 +42462,7 @@ Fields
Example
- {"approval_rule_uids": [4]}
+ {"approval_rule_uids": ["4"]}
@@ -41956,7 +42587,7 @@ Fields
Example
- {"requisition_lists": RequisitionLists, "status": false}
+ {"requisition_lists": RequisitionLists, "status": true}
@@ -42075,10 +42706,10 @@ Example
"amount": Money,
"applied_to": "ITEM",
"coupon": AppliedCoupon,
- "is_discounting_locked": false,
+ "is_discounting_locked": true,
"label": "abc123",
- "type": "xyz789",
- "value": 987.65
+ "type": "abc123",
+ "value": 123.45
}
@@ -42200,11 +42831,11 @@ Example
"customizable_options": [SelectedCustomizableOption],
"discount": [Discount],
"errors": [CartItemError],
- "is_available": false,
+ "is_available": true,
"links": [DownloadableProductLinks],
- "max_qty": 987.65,
- "min_qty": 123.45,
- "not_available_message": "xyz789",
+ "max_qty": 123.45,
+ "min_qty": 987.65,
+ "not_available_message": "abc123",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
@@ -42300,8 +42931,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
}
@@ -42391,7 +43022,7 @@ Example
"product_name": "abc123",
"product_sale_price": Money,
"product_sku": "abc123",
- "quantity_invoiced": 123.45
+ "quantity_invoiced": 987.65
}
@@ -42445,7 +43076,7 @@ Example
{
"sort_order": 987,
"title": "abc123",
- "uid": "4"
+ "uid": 4
}
@@ -42615,16 +43246,16 @@ Example
"product": ProductInterface,
"product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
+ "product_sku": "abc123",
"product_type": "xyz789",
"product_url_key": "abc123",
"quantity_canceled": 123.45,
- "quantity_invoiced": 123.45,
- "quantity_ordered": 123.45,
- "quantity_refunded": 987.65,
+ "quantity_invoiced": 987.65,
+ "quantity_ordered": 987.65,
+ "quantity_refunded": 123.45,
"quantity_return_requested": 987.65,
- "quantity_returned": 987.65,
- "quantity_shipped": 123.45,
+ "quantity_returned": 123.45,
+ "quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
"status": "abc123"
}
@@ -42896,9 +43527,9 @@ filters
Example
{
- "canonical_url": "xyz789",
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "country_of_manufacture": "xyz789",
+ "country_of_manufacture": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
@@ -42908,42 +43539,42 @@ Example
"downloadable_product_samples": [
DownloadableProductSamples
],
- "gift_message_available": false,
+ "gift_message_available": true,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"image": ProductImage,
"is_returnable": "abc123",
- "links_purchased_separately": 987,
- "links_title": "xyz789",
- "manufacturer": 987,
- "max_sale_qty": 987.65,
+ "links_purchased_separately": 123,
+ "links_title": "abc123",
+ "manufacturer": 123,
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
- "meta_description": "abc123",
+ "meta_description": "xyz789",
"meta_keyword": "abc123",
"meta_title": "xyz789",
"min_sale_qty": 987.65,
- "name": "xyz789",
- "new_from_date": "abc123",
- "new_to_date": "abc123",
+ "name": "abc123",
+ "new_from_date": "xyz789",
+ "new_to_date": "xyz789",
"only_x_left_in_stock": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "abc123",
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "quantity": 123.45,
+ "quantity": 987.65,
"related_products": [ProductInterface],
"short_description": ComplexTextValue,
- "sku": "abc123",
+ "sku": "xyz789",
"small_image": ProductImage,
- "special_price": 123.45,
+ "special_price": 987.65,
"special_to_date": "xyz789",
"stock_status": "IN_STOCK",
"swatch_image": "xyz789",
"thumbnail": ProductImage,
- "uid": "4",
+ "uid": 4,
"upsell_products": [ProductInterface],
- "url_key": "xyz789"
+ "url_key": "abc123"
}
@@ -43064,10 +43695,10 @@ Fields
Example
{
- "price": 987.65,
- "sample_url": "xyz789",
+ "price": 123.45,
+ "sample_url": "abc123",
"sort_order": 987,
- "title": "xyz789",
+ "title": "abc123",
"uid": "4"
}
@@ -43110,7 +43741,7 @@ Fields
Example
- {"link_id": 123}
+ {"link_id": 987}
@@ -43161,9 +43792,9 @@ Fields
Example
{
- "sample_url": "abc123",
+ "sample_url": "xyz789",
"sort_order": 123,
- "title": "abc123"
+ "title": "xyz789"
}
@@ -43235,7 +43866,7 @@ Example
"product": ProductInterface,
"quantity": 987.65,
"samples": [DownloadableProductSamples],
- "uid": "4"
+ "uid": 4
}
@@ -43313,9 +43944,9 @@ Fields
Example
{
- "added_at": "abc123",
+ "added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
+ "description": "xyz789",
"id": 4,
"links_v2": [DownloadableProductLinks],
"product": ProductInterface,
@@ -43369,8 +44000,8 @@ Fields
Example
{
- "duplicated_quote_uid": 4,
- "quote_uid": "4"
+ "duplicated_quote_uid": "4",
+ "quote_uid": 4
}
@@ -43459,8 +44090,8 @@ Fields
Example
{
- "attribute_code": "abc123",
- "value": "abc123"
+ "attribute_code": "xyz789",
+ "value": "xyz789"
}
@@ -43510,7 +44141,7 @@ Fields
Example
{
"uid": "4",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -43580,7 +44211,7 @@ Possible Types
Example
{
"code": "PRODUCT_NOT_FOUND",
- "message": "abc123"
+ "message": "xyz789"
}
@@ -43644,7 +44275,7 @@ Possible Types
Example
- {"message": "xyz789"}
+ {"message": "abc123"}
@@ -43752,7 +44383,7 @@ Fields
Example
{
"address": EstimateAddressInput,
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"shipping_method": ShippingMethodInput
}
@@ -43928,7 +44559,131 @@ Fields
Example
- {"currency_to": "xyz789", "rate": 123.45}
+ {"currency_to": "xyz789", "rate": 987.65}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ FastlaneConfig
+
+
+
+ Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+ code - String
+
+ The payment method code as defined in the payment gateway
+
+
+ is_visible - Boolean
+
+ Indicates whether the payment method is displayed
+
+
+ payment_intent - String
+
+ Defines the payment intent (Authorize or Capture
+
+
+ payment_source - String
+
+ The payment source for the payment method
+
+
+ sdk_params - [SDKParams]
+
+ The PayPal parameters required to load the JS SDK
+
+
+ sort_order - String
+
+ The relative order the payment method is displayed on the checkout page
+
+
+ title - String
+
+ The name displayed for the payment method
+
+
+
+
+
+
+
+ Example
+ {
+ "code": "xyz789",
+ "is_visible": false,
+ "payment_intent": "xyz789",
+ "payment_source": "abc123",
+ "sdk_params": [SDKParams],
+ "sort_order": "abc123",
+ "title": "abc123"
+}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ FastlaneMethodInput
+
+
+
+ Description
+ Fastlane Payment inputs
+
+
+
+
+
+ Example
+ {
+ "payment_source": "abc123",
+ "paypal_fastlane_token": "abc123"
+}
@@ -43977,7 +44732,7 @@ Fields
Example
{
"eq": "abc123",
- "in": ["abc123"]
+ "in": ["xyz789"]
}
@@ -44298,18 +45053,18 @@ Fields
Example
{
"eq": "xyz789",
- "from": "xyz789",
+ "from": "abc123",
"gt": "xyz789",
- "gteq": "xyz789",
- "in": ["abc123"],
- "like": "xyz789",
- "lt": "xyz789",
- "lteq": "xyz789",
- "moreq": "xyz789",
- "neq": "abc123",
- "nin": ["abc123"],
+ "gteq": "abc123",
+ "in": ["xyz789"],
+ "like": "abc123",
+ "lt": "abc123",
+ "lteq": "abc123",
+ "moreq": "abc123",
+ "neq": "xyz789",
+ "nin": ["xyz789"],
"notnull": "xyz789",
- "null": "abc123",
+ "null": "xyz789",
"to": "xyz789"
}
@@ -44418,7 +45173,7 @@ Fields
Example
{
"amount": Money,
- "label": "xyz789"
+ "label": "abc123"
}
@@ -44547,7 +45302,7 @@ Fields
Example
- {"customer_email": "abc123"}
+ {"customer_email": "xyz789"}
@@ -44587,7 +45342,7 @@ Fields
Example
- {"customer_token": "xyz789"}
+ {"customer_token": "abc123"}
@@ -44761,7 +45516,7 @@ Example
{
"balance": Money,
"code": "xyz789",
- "expiration_date": "xyz789"
+ "expiration_date": "abc123"
}
@@ -44867,8 +45622,8 @@ Example
"attribute_id": 987,
"uid": "4",
"value": 987.65,
- "website_id": 123,
- "website_value": 123.45
+ "website_id": 987,
+ "website_value": 987.65
}
@@ -45029,9 +45784,9 @@ Example
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "is_available": true,
+ "is_available": false,
"max_qty": 123.45,
- "message": "xyz789",
+ "message": "abc123",
"min_qty": 987.65,
"not_available_message": "xyz789",
"note_from_buyer": [ItemNote],
@@ -45039,11 +45794,11 @@ Example
"prices": CartItemPrices,
"product": ProductInterface,
"quantity": 123.45,
- "recipient_email": "xyz789",
- "recipient_name": "abc123",
- "sender_email": "xyz789",
+ "recipient_email": "abc123",
+ "recipient_name": "xyz789",
+ "sender_email": "abc123",
"sender_name": "xyz789",
- "uid": "4"
+ "uid": 4
}
@@ -45124,11 +45879,11 @@ Example
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"gift_card": GiftCardItem,
- "id": 4,
+ "id": "4",
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
+ "product_sku": "abc123",
"quantity_refunded": 123.45
}
@@ -45212,10 +45967,10 @@ Example
"gift_card": GiftCardItem,
"id": "4",
"order_item": OrderItemInterface,
- "product_name": "xyz789",
+ "product_name": "abc123",
"product_sale_price": Money,
"product_sku": "xyz789",
- "quantity_invoiced": 987.65
+ "quantity_invoiced": 123.45
}
@@ -45280,7 +46035,7 @@ Example
"message": "abc123",
"recipient_email": "abc123",
"recipient_name": "xyz789",
- "sender_email": "abc123",
+ "sender_email": "xyz789",
"sender_name": "xyz789"
}
@@ -45355,9 +46110,9 @@ Example
{
"amount": Money,
"custom_giftcard_amount": Money,
- "message": "xyz789",
- "recipient_email": "abc123",
- "recipient_name": "abc123",
+ "message": "abc123",
+ "recipient_email": "xyz789",
+ "recipient_name": "xyz789",
"sender_email": "abc123",
"sender_name": "xyz789"
}
@@ -45515,28 +46270,28 @@ Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
- "eligible_for_return": false,
+ "eligible_for_return": true,
"entered_options": [OrderItemOption],
"gift_card": GiftCardItem,
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": 4,
+ "id": "4",
"prices": OrderItemPrices,
"product": ProductInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "product_type": "xyz789",
+ "product_sku": "abc123",
+ "product_type": "abc123",
"product_url_key": "xyz789",
- "quantity_canceled": 123.45,
- "quantity_invoiced": 987.65,
+ "quantity_canceled": 987.65,
+ "quantity_invoiced": 123.45,
"quantity_ordered": 987.65,
- "quantity_refunded": 123.45,
- "quantity_return_requested": 123.45,
- "quantity_returned": 987.65,
- "quantity_shipped": 987.65,
+ "quantity_refunded": 987.65,
+ "quantity_return_requested": 987.65,
+ "quantity_returned": 123.45,
+ "quantity_shipped": 123.45,
"selected_options": [OrderItemOption],
- "status": "xyz789"
+ "status": "abc123"
}
@@ -45841,16 +46596,16 @@ filters
Example
{
- "allow_message": true,
+ "allow_message": false,
"allow_open_amount": true,
- "canonical_url": "xyz789",
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
"country_of_manufacture": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"gift_card_options": [CustomizableOptionInterface],
- "gift_message_available": false,
+ "gift_message_available": true,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"giftcard_amounts": [GiftCardAmounts],
@@ -45858,30 +46613,30 @@ Example
"image": ProductImage,
"is_redeemable": true,
"is_returnable": "xyz789",
- "lifetime": 987,
- "manufacturer": 123,
+ "lifetime": 123,
+ "manufacturer": 987,
"max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"message_max_length": 123,
- "meta_description": "abc123",
- "meta_keyword": "xyz789",
- "meta_title": "abc123",
+ "meta_description": "xyz789",
+ "meta_keyword": "abc123",
+ "meta_title": "xyz789",
"min_sale_qty": 987.65,
"name": "xyz789",
- "new_from_date": "xyz789",
+ "new_from_date": "abc123",
"new_to_date": "abc123",
"only_x_left_in_stock": 123.45,
"open_amount_max": 123.45,
- "open_amount_min": 123.45,
+ "open_amount_min": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "quantity": 123.45,
+ "quantity": 987.65,
"related_products": [ProductInterface],
"short_description": ComplexTextValue,
- "sku": "abc123",
+ "sku": "xyz789",
"small_image": ProductImage,
"special_price": 987.65,
"special_to_date": "xyz789",
@@ -45958,7 +46713,7 @@ Example
"gift_card_options": GiftCardOptions,
"product": ProductInterface,
"quantity": 123.45,
- "uid": 4
+ "uid": "4"
}
@@ -46165,9 +46920,9 @@ Example
"customizable_options": [SelectedCustomizableOption],
"description": "abc123",
"gift_card_options": GiftCardOptions,
- "id": "4",
+ "id": 4,
"product": ProductInterface,
- "quantity": 987.65
+ "quantity": 123.45
}
@@ -46219,8 +46974,8 @@ Fields
Example
{
- "from": "abc123",
- "message": "xyz789",
+ "from": "xyz789",
+ "message": "abc123",
"to": "xyz789"
}
@@ -46278,7 +47033,7 @@ Example
{
"from": "xyz789",
"message": "abc123",
- "to": "abc123"
+ "to": "xyz789"
}
@@ -46451,8 +47206,8 @@ Example
"dynamic_attributes": [GiftRegistryDynamicAttribute],
"event_name": "xyz789",
"items": [GiftRegistryItemInterface],
- "message": "xyz789",
- "owner_name": "xyz789",
+ "message": "abc123",
+ "owner_name": "abc123",
"privacy_settings": "PRIVATE",
"registrants": [GiftRegistryRegistrant],
"shipping_address": CustomerAddress,
@@ -46513,7 +47268,7 @@ Example
{
"code": 4,
"group": "EVENT_INFORMATION",
- "label": "xyz789",
+ "label": "abc123",
"value": "abc123"
}
@@ -46639,10 +47394,7 @@ Fields
Example
- {
- "code": "4",
- "value": "xyz789"
-}
+ {"code": 4, "value": "xyz789"}
@@ -46776,12 +47528,12 @@ Fields
Example
{
- "attribute_group": "abc123",
- "code": 4,
+ "attribute_group": "xyz789",
+ "code": "4",
"input_type": "xyz789",
- "is_required": false,
+ "is_required": true,
"label": "abc123",
- "sort_order": 123
+ "sort_order": 987
}
@@ -46861,11 +47613,11 @@ Possible Types
Example
{
- "attribute_group": "xyz789",
- "code": 4,
- "input_type": "abc123",
- "is_required": true,
- "label": "abc123",
+ "attribute_group": "abc123",
+ "code": "4",
+ "input_type": "xyz789",
+ "is_required": false,
+ "label": "xyz789",
"sort_order": 987
}
@@ -46930,12 +47682,12 @@ Fields
Example
{
- "created_at": "abc123",
+ "created_at": "xyz789",
"note": "xyz789",
"product": ProductInterface,
- "quantity": 987.65,
+ "quantity": 123.45,
"quantity_fulfilled": 123.45,
- "uid": "4"
+ "uid": 4
}
@@ -47016,11 +47768,11 @@ Possible Types
Example
{
- "created_at": "abc123",
+ "created_at": "xyz789",
"note": "abc123",
"product": ProductInterface,
"quantity": 123.45,
- "quantity_fulfilled": 987.65,
+ "quantity_fulfilled": 123.45,
"uid": "4"
}
@@ -47085,7 +47837,7 @@ Possible Types
Example
{
- "status": true,
+ "status": false,
"user_errors": [GiftRegistryItemsUserError]
}
@@ -47152,7 +47904,7 @@ Example
"gift_registry_item_uid": 4,
"gift_registry_uid": 4,
"message": "abc123",
- "product_uid": "4"
+ "product_uid": 4
}
@@ -47379,7 +48131,7 @@ Example
"email": "abc123",
"firstname": "abc123",
"lastname": "abc123",
- "uid": 4
+ "uid": "4"
}
@@ -47429,7 +48181,7 @@ Example
{
"code": "4",
"label": "xyz789",
- "value": "xyz789"
+ "value": "abc123"
}
@@ -47496,12 +48248,12 @@ Fields
Example
{
- "event_date": "xyz789",
- "event_title": "abc123",
- "gift_registry_uid": "4",
+ "event_date": "abc123",
+ "event_title": "xyz789",
+ "gift_registry_uid": 4,
"location": "abc123",
- "name": "xyz789",
- "type": "abc123"
+ "name": "abc123",
+ "type": "xyz789"
}
@@ -47549,7 +48301,10 @@ Fields
Example
- {"address_data": CustomerAddressInput, "address_id": 4}
+ {
+ "address_data": CustomerAddressInput,
+ "address_id": "4"
+}
@@ -47652,8 +48407,8 @@ Example
"dynamic_attributes_metadata": [
GiftRegistryDynamicAttributeMetadataInterface
],
- "label": "xyz789",
- "uid": 4
+ "label": "abc123",
+ "uid": "4"
}
@@ -47710,7 +48465,7 @@ Fields
Example
{
- "design": "abc123",
+ "design": "xyz789",
"image": GiftWrappingImage,
"price": Money,
"uid": "4"
@@ -47761,7 +48516,7 @@ Fields
Example
{
"label": "abc123",
- "url": "xyz789"
+ "url": "abc123"
}
@@ -47810,8 +48565,8 @@ Fields
Example
{
"color": "abc123",
- "height": 987,
- "type": "xyz789"
+ "height": 123,
+ "type": "abc123"
}
@@ -47893,9 +48648,9 @@ Example
"code": "abc123",
"is_visible": false,
"payment_intent": "abc123",
- "payment_source": "xyz789",
+ "payment_source": "abc123",
"sdk_params": [SDKParams],
- "sort_order": "abc123",
+ "sort_order": "xyz789",
"three_ds_mode": "OFF",
"title": "abc123"
}
@@ -47952,7 +48707,7 @@ Fields
Example
{
- "payment_source": "abc123",
+ "payment_source": "xyz789",
"payments_order_id": "abc123",
"paypal_order_id": "abc123"
}
@@ -48216,23 +48971,23 @@ Example
"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",
"items": [GroupedProductItem],
- "manufacturer": 123,
- "max_sale_qty": 987.65,
+ "manufacturer": 987,
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
- "meta_description": "xyz789",
- "meta_keyword": "xyz789",
+ "meta_description": "abc123",
+ "meta_keyword": "abc123",
"meta_title": "abc123",
- "min_sale_qty": 987.65,
+ "min_sale_qty": 123.45,
"name": "abc123",
- "new_from_date": "xyz789",
- "new_to_date": "abc123",
+ "new_from_date": "abc123",
+ "new_to_date": "xyz789",
"only_x_left_in_stock": 123.45,
- "options_container": "abc123",
+ "options_container": "xyz789",
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
@@ -48248,8 +49003,8 @@ Example
"thumbnail": ProductImage,
"uid": 4,
"upsell_products": [ProductInterface],
- "url_key": "xyz789",
- "weight": 123.45
+ "url_key": "abc123",
+ "weight": 987.65
}
@@ -48302,7 +49057,7 @@ Fields
Example
{
- "position": 123,
+ "position": 987,
"product": ProductInterface,
"qty": 123.45
}
@@ -48374,8 +49129,8 @@ Example
{
"added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
- "id": "4",
+ "description": "xyz789",
+ "id": 4,
"product": ProductInterface,
"quantity": 123.45
}
@@ -48482,9 +49237,9 @@ Fields
Example
{
- "email": "xyz789",
+ "email": "abc123",
"lastname": "xyz789",
- "number": "xyz789"
+ "number": "abc123"
}
@@ -48538,7 +49293,7 @@ Example
{
"attribute": "abc123",
"matched_words": ["xyz789"],
- "value": "xyz789"
+ "value": "abc123"
}
@@ -48626,15 +49381,15 @@ Fields
Example
{
- "cc_vault_code": "abc123",
+ "cc_vault_code": "xyz789",
"code": "xyz789",
- "is_vault_enabled": false,
- "is_visible": false,
- "payment_intent": "xyz789",
+ "is_vault_enabled": true,
+ "is_visible": true,
+ "payment_intent": "abc123",
"payment_source": "xyz789",
"requires_card_details": false,
"sdk_params": [SDKParams],
- "sort_order": "xyz789",
+ "sort_order": "abc123",
"three_ds_mode": "OFF",
"title": "xyz789"
}
@@ -48727,11 +49482,11 @@ Fields
Example
{
- "cardBin": "abc123",
+ "cardBin": "xyz789",
"cardExpiryMonth": "xyz789",
"cardExpiryYear": "abc123",
- "cardLast4": "xyz789",
- "holderName": "abc123",
+ "cardLast4": "abc123",
+ "holderName": "xyz789",
"is_active_payment_token_enabler": false,
"payment_source": "abc123",
"payments_order_id": "xyz789",
@@ -48758,7 +49513,7 @@ Description
Example
- 4
+ "4"
@@ -48800,7 +49555,7 @@ Fields
Example
{
- "thumbnail": "xyz789",
+ "thumbnail": "abc123",
"value": "xyz789"
}
@@ -48915,8 +49670,8 @@ Fields
Example
{
"code": "PRODUCT_NOT_FOUND",
- "message": "xyz789",
- "quantity": 987.65
+ "message": "abc123",
+ "quantity": 123.45
}
@@ -48939,7 +49694,7 @@ Description
Example
- 123
+ 987
@@ -49049,7 +49804,7 @@ Example
"custom_attributes": [CustomAttribute],
"id": 4,
"items": [InvoiceItemInterface],
- "number": "xyz789",
+ "number": "abc123",
"total": InvoiceTotal
}
@@ -49100,7 +49855,7 @@ Fields
Example
{
"custom_attributes": [CustomAttributeInput],
- "invoice_id": "xyz789"
+ "invoice_id": "abc123"
}
@@ -49177,10 +49932,10 @@ Example
"discounts": [Discount],
"id": "4",
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
- "quantity_invoiced": 987.65
+ "product_sku": "xyz789",
+ "quantity_invoiced": 123.45
}
@@ -49236,7 +49991,7 @@ Fields
Example
{
"custom_attributes": [CustomAttributeInput],
- "invoice_id": "xyz789",
+ "invoice_id": "abc123",
"invoice_item_id": "abc123"
}
@@ -49348,9 +50103,9 @@ Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "xyz789",
+ "product_name": "abc123",
"product_sale_price": Money,
"product_sku": "abc123",
"quantity_invoiced": 987.65
@@ -49518,7 +50273,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -49558,7 +50313,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -49598,7 +50353,7 @@ Fields
Example
- {"is_role_name_available": true}
+ {"is_role_name_available": false}
@@ -49638,7 +50393,7 @@ Fields
Example
- {"is_email_available": false}
+ {"is_email_available": true}
@@ -49678,7 +50433,7 @@ Fields
Example
- {"is_email_available": false}
+ {"is_email_available": true}
@@ -49744,10 +50499,10 @@ Fields
Example
{
- "created_at": "xyz789",
+ "created_at": "abc123",
"creator_id": 123,
"creator_type": 987,
- "negotiable_quote_item_uid": "4",
+ "negotiable_quote_item_uid": 4,
"note": "xyz789",
"note_uid": 4
}
@@ -49802,7 +50557,7 @@ Fields
Example
{
"label": "abc123",
- "uid": "4",
+ "uid": 4,
"values": [ItemSelectedBundleOptionValue]
}
@@ -49866,9 +50621,9 @@ Fields
Example
{
"price": Money,
- "product_name": "xyz789",
- "product_sku": "abc123",
- "quantity": 987.65,
+ "product_name": "abc123",
+ "product_sku": "xyz789",
+ "quantity": 123.45,
"uid": 4
}
@@ -50088,8 +50843,49 @@ Example
"disabled": false,
"label": "abc123",
"position": 123,
- "url": "xyz789"
+ "url": "abc123"
}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ MediaResourceType
+
+
+
+ Description
+ Enumeration of media resource types
+
+
+ Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ CUSTOMER_ATTRIBUTE_FILE
+
+ Customer file resource type
+
+
+
+
+
+
+
+ Example
+ "CUSTOMER_ATTRIBUTE_FILE"
@@ -50125,7 +50921,7 @@ Fields
Example
- {"type": "xyz789"}
+ {"type": "abc123"}
@@ -50214,7 +51010,7 @@ Fields
Example
- {"currency": "AFN", "value": 987.65}
+ {"currency": "AFN", "value": 123.45}
@@ -50266,7 +51062,7 @@ Fields
Example
{
"gift_registry": GiftRegistry,
- "status": false,
+ "status": true,
"user_errors": [GiftRegistryItemsUserError]
}
@@ -50636,16 +51432,16 @@ Example
"comments": [NegotiableQuoteComment],
"created_at": "xyz789",
"custom_attributes": [CustomAttribute],
- "email": "xyz789",
+ "email": "abc123",
"history": [NegotiableQuoteHistoryEntry],
- "is_virtual": true,
+ "is_virtual": false,
"items": [CartItemInterface],
- "name": "abc123",
+ "name": "xyz789",
"prices": CartPrices,
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [NegotiableQuoteShippingAddress],
"status": "SUBMITTED",
- "total_quantity": 987.65,
+ "total_quantity": 123.45,
"uid": 4,
"updated_at": "xyz789"
}
@@ -50742,6 +51538,18 @@ Fields
The country code and label for the billing or shipping address.
+
+
+ custom_attributes - [AttributeValueInput]
+
+ The custom attribute values of the billing or shipping negotiable quote address.
+
+
+
+ fax - String
+
+ The fax number of the customer.
+
firstname - String!
@@ -50754,12 +51562,24 @@ Fields
The last name of the company user.
+
+
+ middlename - String
+
+ The middle name of the person associated with the billing/shipping address.
+
postcode - String
The ZIP or postal code of the billing or shipping address.
+
+
+ prefix - String
+
+ An honorific, such as Dr., Mr., or Mrs.
+
region - String
@@ -50784,12 +51604,24 @@ Fields
An array containing the street for the billing or shipping address.
+
+
+ suffix - String
+
+ A value such as Sr., Jr., or III.
+
telephone - String
The telephone number for the billing or shipping address.
+
+
+ vat_id - String
+
+ The customer's Tax/VAT number (for corporate customers).
+
@@ -50798,17 +51630,23 @@ Fields
Example
{
- "city": "abc123",
- "company": "abc123",
- "country_code": "abc123",
+ "city": "xyz789",
+ "company": "xyz789",
+ "country_code": "xyz789",
+ "custom_attributes": [AttributeValueInput],
+ "fax": "abc123",
"firstname": "abc123",
"lastname": "abc123",
+ "middlename": "xyz789",
"postcode": "xyz789",
+ "prefix": "xyz789",
"region": "xyz789",
- "region_id": 987,
- "save_in_address_book": false,
+ "region_id": 123,
+ "save_in_address_book": true,
"street": ["xyz789"],
- "telephone": "xyz789"
+ "suffix": "abc123",
+ "telephone": "abc123",
+ "vat_id": "abc123"
}
@@ -50848,6 +51686,16 @@ Fields
The company's country.
+
+ custom_attributes - [AttributeValueInterface]
+
+ The custom attribute values of the billing or shipping negotiable quote address.
+
+
+ fax - String
+
+ The fax number of the customer.
+
firstname - String!
@@ -50858,11 +51706,21 @@ Fields
The last name of the company user.
+
+ middlename - String
+
+ The middle name of the person associated with the billing/shipping address.
+
postcode - String
The company's ZIP or postal code.
+
+ prefix - String
+
+ An honorific, such as Dr., Mr., or Mrs.
+
region - NegotiableQuoteAddressRegion
@@ -50873,11 +51731,26 @@ Fields
An array of strings that define the street number and name.
+
+ suffix - String
+
+ A value such as Sr., Jr., or III.
+
telephone - String
The customer's telephone number.
+
+ uid - ID!
+
+ The unique identifier of the address.
+
+
+ vat_id - String
+
+ The customer's Tax/VAT number (for corporate customers).
+
@@ -50911,12 +51784,19 @@ Example
"city": "abc123",
"company": "abc123",
"country": NegotiableQuoteAddressCountry,
+ "custom_attributes": [AttributeValueInterface],
+ "fax": "abc123",
"firstname": "xyz789",
- "lastname": "abc123",
- "postcode": "abc123",
+ "lastname": "xyz789",
+ "middlename": "abc123",
+ "postcode": "xyz789",
+ "prefix": "xyz789",
"region": NegotiableQuoteAddressRegion,
"street": ["xyz789"],
- "telephone": "abc123"
+ "suffix": "xyz789",
+ "telephone": "abc123",
+ "uid": 4,
+ "vat_id": "abc123"
}
@@ -50968,7 +51848,7 @@ {
- "code": "abc123",
+ "code": "xyz789",
"label": "abc123",
"region_id": 987
}
@@ -51010,6 +51890,16 @@ Fields
The company's country.
+
+ custom_attributes - [AttributeValueInterface]
+
+ The custom attribute values of the billing or shipping negotiable quote address.
+
+
+ fax - String
+
+ The fax number of the customer.
+
firstname - String!
@@ -51020,11 +51910,21 @@ Fields
The last name of the company user.
+
+ middlename - String
+
+ The middle name of the person associated with the billing/shipping address.
+
postcode - String
The company's ZIP or postal code.
+
+ prefix - String
+
+ An honorific, such as Dr., Mr., or Mrs.
+
region - NegotiableQuoteAddressRegion
@@ -51035,11 +51935,26 @@ Fields
An array of strings that define the street number and name.
+
+ suffix - String
+
+ A value such as Sr., Jr., or III.
+
telephone - String
The customer's telephone number.
+
+ uid - ID!
+
+ The unique identifier of the address.
+
+
+ vat_id - String
+
+ The customer's Tax/VAT number (for corporate customers).
+
{
- "city": "xyz789",
+ "city": "abc123",
"company": "abc123",
"country": NegotiableQuoteAddressCountry,
- "firstname": "xyz789",
- "lastname": "abc123",
+ "custom_attributes": [AttributeValueInterface],
+ "fax": "abc123",
+ "firstname": "abc123",
+ "lastname": "xyz789",
+ "middlename": "xyz789",
"postcode": "xyz789",
+ "prefix": "abc123",
"region": NegotiableQuoteAddressRegion,
- "street": ["xyz789"],
- "telephone": "xyz789"
+ "street": ["abc123"],
+ "suffix": "xyz789",
+ "telephone": "xyz789",
+ "uid": "4",
+ "vat_id": "xyz789"
}
{
"address": NegotiableQuoteAddressInput,
- "customer_address_uid": "4",
- "same_as_shipping": true,
- "use_for_shipping": true
+ "customer_address_uid": 4,
+ "same_as_shipping": false,
+ "use_for_shipping": false
}
@@ -51183,7 +52105,7 @@ {
"author": NegotiableQuoteUser,
- "created_at": "xyz789",
+ "created_at": "abc123",
"creator_type": "BUYER",
"text": "xyz789",
"uid": "4"
@@ -51273,7 +52195,7 @@ Fields
Example
- {"comment": "xyz789"}
+ {"comment": "abc123"}
@@ -51324,9 +52246,9 @@ Fields
Example
{
- "new_value": "xyz789",
+ "new_value": "abc123",
"old_value": "xyz789",
- "title": "abc123"
+ "title": "xyz789"
}
@@ -51553,7 +52475,7 @@ Example
"author": NegotiableQuoteUser,
"change_type": "CREATED",
"changes": NegotiableQuoteHistoryChanges,
- "created_at": "xyz789",
+ "created_at": "abc123",
"uid": "4"
}
@@ -51660,7 +52582,7 @@ {
- "new_expiration": "abc123",
+ "new_expiration": "xyz789",
"old_expiration": "abc123"
}
@@ -51709,7 +52631,7 @@ {
- "products_removed_from_catalog": [4],
+ "products_removed_from_catalog": ["4"],
"products_removed_from_quote": [ProductInterface]
}
@@ -51931,7 +52853,7 @@ {"quantity": 987.65, "quote_item_uid": "4"}
+ {"quantity": 123.45, "quote_item_uid": 4}
{
- "code": "abc123",
- "purchase_order_number": "xyz789"
+ "code": "xyz789",
+ "purchase_order_number": "abc123"
}
{
- "document_identifier": "xyz789",
+ "document_identifier": "abc123",
"document_name": "abc123",
"link_id": "4",
- "reference_document_url": "xyz789"
+ "reference_document_url": "abc123"
}
custom_attributes - [AttributeValueInterface]
+ fax - String
+ firstname - String!
middlename - String
+ postcode - String
prefix - String
+ region - NegotiableQuoteAddressRegion
suffix - String
+ telephone - String
uid - ID!
+ vat_id - String
+ {
"address": NegotiableQuoteAddressInput,
"customer_address_uid": 4,
- "customer_notes": "abc123"
+ "customer_notes": "xyz789"
}
@@ -52511,12 +53475,12 @@ {
"activated_at": "xyz789",
- "company_name": "xyz789",
- "expiration_date": "abc123",
+ "company_name": "abc123",
+ "expiration_date": "xyz789",
"is_min_max_qty_used": false,
"last_shared_at": "abc123",
"max_order_commitment": 123,
- "min_negotiated_grand_total": 123.45,
+ "min_negotiated_grand_total": 987.65,
"min_order_commitment": 987,
- "name": "abc123",
- "orders_placed": 123,
+ "name": "xyz789",
+ "orders_placed": 987,
"sales_rep_name": "xyz789",
"state": "xyz789",
- "status": "xyz789",
+ "status": "abc123",
"submitted_by": "xyz789",
"template_id": 4
}
@@ -52764,8 +53728,8 @@ Example
{
"item_id": "4",
"max_qty": 987.65,
- "min_qty": 987.65,
- "quantity": 987.65
+ "min_qty": 123.45,
+ "quantity": 123.45
}
@@ -52826,7 +53790,7 @@ Fields
Example
{
- "document_identifier": "abc123",
+ "document_identifier": "xyz789",
"document_name": "xyz789",
"link_id": "4",
"reference_document_url": "xyz789"
@@ -52886,7 +53850,7 @@ Example
{
"address": NegotiableQuoteAddressInput,
"customer_address_uid": 4,
- "customer_notes": "abc123"
+ "customer_notes": "xyz789"
}
@@ -53090,7 +54054,7 @@ Possible Types
Example
- {"quote_uid": "4"}
+ {"quote_uid": 4}
@@ -53176,7 +54140,7 @@ Fields
Example
{
- "firstname": "xyz789",
+ "firstname": "abc123",
"lastname": "abc123"
}
@@ -53237,7 +54201,7 @@ Example
"items": [NegotiableQuote],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
- "total_count": 987
+ "total_count": 123
}
@@ -53283,7 +54247,7 @@ Fields
Example
- {"message": "abc123", "uid": 4}
+ {"message": "xyz789", "uid": 4}
@@ -53597,18 +54561,18 @@ Example
"company": "abc123",
"country_code": "AF",
"custom_attributesV2": [AttributeValueInterface],
- "fax": "xyz789",
- "firstname": "xyz789",
- "lastname": "xyz789",
- "middlename": "xyz789",
+ "fax": "abc123",
+ "firstname": "abc123",
+ "lastname": "abc123",
+ "middlename": "abc123",
"postcode": "xyz789",
"prefix": "xyz789",
"region": "abc123",
"region_id": 4,
"street": ["xyz789"],
- "suffix": "xyz789",
+ "suffix": "abc123",
"telephone": "abc123",
- "vat_id": "abc123"
+ "vat_id": "xyz789"
}
@@ -53669,8 +54633,8 @@ {
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
"id": "4",
"prices": OrderItemPrices,
"product": ProductInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "product_type": "xyz789",
+ "product_sku": "abc123",
+ "product_type": "abc123",
"product_url_key": "abc123",
"quantity_canceled": 123.45,
- "quantity_invoiced": 987.65,
- "quantity_ordered": 123.45,
+ "quantity_invoiced": 123.45,
+ "quantity_ordered": 987.65,
"quantity_refunded": 123.45,
- "quantity_return_requested": 123.45,
- "quantity_returned": 987.65,
- "quantity_shipped": 123.45,
+ "quantity_return_requested": 987.65,
+ "quantity_returned": 123.45,
+ "quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
- "status": "xyz789"
+ "status": "abc123"
}
@@ -54040,17 +55004,17 @@ {
"additional_data": [KeyValue],
"name": "abc123",
- "type": "abc123"
+ "type": "xyz789"
}
@@ -54317,9 +55281,9 @@ {
"comments": [SalesCommentItem],
- "id": "4",
+ "id": 4,
"items": [ShipmentItemInterface],
- "number": "xyz789",
+ "number": "abc123",
"tracking": [ShipmentTracking]
}
@@ -54362,7 +55326,7 @@ {"token": "abc123"}
+ {"token": "xyz789"}
{
"code": "xyz789",
"is_visible": true,
- "payment_intent": "xyz789",
+ "payment_intent": "abc123",
"sdk_params": [SDKParams],
"sort_order": "abc123",
"title": "abc123"
@@ -54748,6 +55717,11 @@ Fields
fastlane - FastlaneConfig
+ google_pay - GooglePayConfig
{
"apple_pay": ApplePayConfig,
+ "fastlane": FastlaneConfig,
"google_pay": GooglePayConfig,
"hosted_fields": HostedFieldsConfig,
"smart_buttons": SmartButtonsConfig
@@ -54891,6 +55866,12 @@ Fields
Required input for Apple Pay button
payment_services_paypal_fastlane - FastlaneMethodInput
+ payment_services_paypal_google_pay - GooglePayMethodInput
@@ -54932,11 +55913,12 @@ {
"id": "abc123",
- "mp_order_id": "abc123",
+ "mp_order_id": "xyz789",
"payment_source_details": PaymentSourceDetails,
"status": "xyz789"
}
@@ -55215,8 +56197,8 @@ Fields
Example
{
"details": "xyz789",
- "payment_method_code": "abc123",
- "public_hash": "abc123",
+ "payment_method_code": "xyz789",
+ "public_hash": "xyz789",
"type": "card"
}
@@ -55342,7 +56324,7 @@ Possible Types
Example
- {"weight": 987.65}
+ {"weight": 123.45}
@@ -55468,21 +56450,21 @@ Fields
Example
{
- "city": "abc123",
- "contact_name": "xyz789",
- "country_id": "abc123",
+ "city": "xyz789",
+ "contact_name": "abc123",
+ "country_id": "xyz789",
"description": "xyz789",
"email": "abc123",
- "fax": "xyz789",
+ "fax": "abc123",
"latitude": 123.45,
"longitude": 123.45,
- "name": "abc123",
+ "name": "xyz789",
"phone": "abc123",
"pickup_location_code": "xyz789",
"postcode": "xyz789",
"region": "abc123",
- "region_id": 987,
- "street": "abc123"
+ "region_id": 123,
+ "street": "xyz789"
}
@@ -55776,7 +56758,7 @@ Example
{
"items": [PickupLocation],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -55851,6 +56833,11 @@ Fields
orderV2 - CustomerOrder
+ {"order": Order}
+ {
+ "order": Order,
+ "orderV2": CustomerOrder
+}
{
"code": "CART_NOT_FOUND",
- "message": "abc123"
+ "message": "xyz789"
}
@@ -56316,7 +57306,7 @@ {"amount": 987.65, "code": "xyz789"}
+ {"amount": 987.65, "code": "abc123"}
{
- "discount_percentage": 123.45,
- "main_final_price": 987.65,
+ "discount_percentage": 987.65,
+ "main_final_price": 123.45,
"main_price": 123.45
}
@@ -56570,7 +57560,7 @@ {
"code": "abc123",
- "value": "xyz789"
+ "value": "abc123"
}
{"amount_off": 987.65, "percent_off": 123.45}
+ {"amount_off": 123.45, "percent_off": 987.65}
{
"disabled": false,
- "label": "abc123",
+ "label": "xyz789",
"position": 123,
"url": "abc123"
}
@@ -57101,7 +58091,7 @@ Example
{
"canonical_url": "xyz789",
"categories": [CategoryInterface],
- "country_of_manufacture": "xyz789",
+ "country_of_manufacture": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
@@ -57109,35 +58099,35 @@ Example
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"image": ProductImage,
- "is_returnable": "xyz789",
- "manufacturer": 987,
+ "is_returnable": "abc123",
+ "manufacturer": 123,
"max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"meta_description": "xyz789",
"meta_keyword": "xyz789",
- "meta_title": "xyz789",
- "min_sale_qty": 987.65,
- "name": "abc123",
+ "meta_title": "abc123",
+ "min_sale_qty": 123.45,
+ "name": "xyz789",
"new_from_date": "xyz789",
"new_to_date": "xyz789",
- "only_x_left_in_stock": 123.45,
- "options_container": "xyz789",
+ "only_x_left_in_stock": 987.65,
+ "options_container": "abc123",
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
"quantity": 987.65,
"related_products": [ProductInterface],
"short_description": ComplexTextValue,
- "sku": "abc123",
+ "sku": "xyz789",
"small_image": ProductImage,
- "special_price": 123.45,
- "special_to_date": "xyz789",
+ "special_price": 987.65,
+ "special_to_date": "abc123",
"stock_status": "IN_STOCK",
- "swatch_image": "abc123",
+ "swatch_image": "xyz789",
"thumbnail": ProductImage,
"uid": "4",
"upsell_products": [ProductInterface],
- "url_key": "xyz789"
+ "url_key": "abc123"
}
@@ -57199,11 +58189,11 @@ Fields
Example
{
- "link_type": "abc123",
+ "link_type": "xyz789",
"linked_product_sku": "abc123",
- "linked_product_type": "abc123",
- "position": 987,
- "sku": "xyz789"
+ "linked_product_type": "xyz789",
+ "position": 123,
+ "sku": "abc123"
}
@@ -57282,11 +58272,11 @@ Possible Types
Example
{
- "link_type": "abc123",
- "linked_product_sku": "abc123",
- "linked_product_type": "xyz789",
- "position": 987,
- "sku": "xyz789"
+ "link_type": "xyz789",
+ "linked_product_sku": "xyz789",
+ "linked_product_type": "abc123",
+ "position": 123,
+ "sku": "abc123"
}
@@ -57338,7 +58328,7 @@ Fields
Example
{
- "asset_id": "abc123",
+ "asset_id": "xyz789",
"media_type": "abc123",
"media_url": "abc123"
}
@@ -57392,9 +58382,9 @@ Fields
Example
{
- "media_type": "xyz789",
+ "media_type": "abc123",
"video_asset_id": "abc123",
- "video_media_url": "xyz789"
+ "video_media_url": "abc123"
}
@@ -57463,10 +58453,10 @@ Example
{
"media_type": "xyz789",
"video_description": "abc123",
- "video_metadata": "xyz789",
- "video_provider": "xyz789",
+ "video_metadata": "abc123",
+ "video_provider": "abc123",
"video_title": "abc123",
- "video_url": "abc123"
+ "video_url": "xyz789"
}
@@ -57650,9 +58640,9 @@ Example
"facets": [Aggregation],
"items": [ProductSearchItem],
"page_info": SearchResultPageInfo,
- "related_terms": ["xyz789"],
- "suggestions": ["xyz789"],
- "total_count": 123
+ "related_terms": ["abc123"],
+ "suggestions": ["abc123"],
+ "total_count": 987
}
@@ -57810,10 +58800,10 @@ {
- "disabled": true,
- "label": "abc123",
+ "disabled": false,
+ "label": "xyz789",
"position": 987,
- "url": "xyz789",
+ "url": "abc123",
"video_content": ProductMediaGalleryEntriesVideoContent
}
@@ -58028,28 +59018,28 @@ {
- "addToCartAllowed": false,
- "inStock": false,
+ "addToCartAllowed": true,
+ "inStock": true,
"lowStock": false,
"attributes": [ProductViewAttribute],
"description": "xyz789",
- "id": 4,
+ "id": "4",
"images": [ProductViewImage],
"videos": [ProductViewVideo],
"lastModifiedAt": "2007-12-03T10:15:30Z",
- "metaDescription": "xyz789",
- "metaKeyword": "abc123",
+ "metaDescription": "abc123",
+ "metaKeyword": "xyz789",
"metaTitle": "xyz789",
- "name": "abc123",
+ "name": "xyz789",
"shortDescription": "abc123",
"inputOptions": [ProductViewInputOption],
- "sku": "abc123",
+ "sku": "xyz789",
"externalId": "abc123",
"url": "xyz789",
- "urlKey": "abc123",
+ "urlKey": "xyz789",
"links": [ProductViewLink],
- "queryType": "abc123",
- "visibility": "xyz789"
+ "queryType": "xyz789",
+ "visibility": "abc123"
}
{
"label": "xyz789",
- "name": "xyz789",
- "roles": ["xyz789"],
+ "name": "abc123",
+ "roles": ["abc123"],
"value": {}
}
@@ -59387,8 +60377,8 @@ {
"label": "abc123",
- "roles": ["xyz789"],
- "url": "xyz789"
+ "roles": ["abc123"],
+ "url": "abc123"
}
{
- "id": 4,
- "title": "xyz789",
+ "id": "4",
+ "title": "abc123",
"required": true,
- "type": "xyz789",
+ "type": "abc123",
"markupAmount": 987.65,
"suffix": "abc123",
"sortOrder": 987,
@@ -59531,7 +60521,7 @@ Fields
Example
- {"width": 123, "height": 123}
+ {"width": 123, "height": 987}
@@ -59667,7 +60657,7 @@ Fields
Example
- {"currency": "AED", "value": 123.45}
+ {"currency": "AED", "value": 987.65}
@@ -59728,10 +60718,10 @@ Fields
Example
{
- "id": 4,
+ "id": "4",
"multi": true,
"required": false,
- "title": "xyz789",
+ "title": "abc123",
"values": [ProductViewOptionValue]
}
@@ -59812,7 +60802,7 @@ Possible Types
Example
{
"id": "4",
- "title": "xyz789",
+ "title": "abc123",
"inStock": false
}
@@ -59865,8 +60855,8 @@ Fields
Example
{
- "id": 4,
- "title": "xyz789",
+ "id": "4",
+ "title": "abc123",
"inStock": true
}
@@ -59935,11 +60925,11 @@ Fields
Example
{
"id": 4,
- "isDefault": true,
+ "isDefault": false,
"product": SimpleProductView,
- "quantity": 987.65,
+ "quantity": 123.45,
"title": "abc123",
- "inStock": false
+ "inStock": true
}
@@ -60001,11 +60991,11 @@ Fields
Example
{
- "id": 4,
- "title": "xyz789",
+ "id": "4",
+ "title": "abc123",
"type": "TEXT",
- "value": "abc123",
- "inStock": true
+ "value": "xyz789",
+ "inStock": false
}
@@ -60044,6 +61034,11 @@ Fields
Base product price specified by the merchant.
+
+ tiers - [ProductViewTierPrice]
+
+ Volume based pricing
+
roles - [String]
@@ -60059,7 +61054,8 @@ Example
{
"final": Price,
"regular": Price,
- "roles": ["xyz789"]
+ "tiers": [ProductViewTierPrice],
+ "roles": ["abc123"]
}
@@ -60109,6 +61105,170 @@ Example
"maximum": ProductViewPrice,
"minimum": ProductViewPrice
}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ ProductViewTierCondition
+
+
+
+ Types
+
+
+
+ Union Types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Example
+ ProductViewTierRangeCondition
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ ProductViewTierExactMatchCondition
+
+
+
+ Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+ in - [Float]
+
+
+
+
+
+
+
+
+
+
+ Example
+ {"in": [987.65]}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ ProductViewTierPrice
+
+
+
+ Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+ tier - Price
+
+ Volume based price
+
+
+ quantity - [ProductViewTierCondition!]!
+
+ Condition to active price
+
+
+
+
+
+
+
+ Example
+ {
+ "tier": Price,
+ "quantity": [ProductViewTierRangeCondition]
+}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ ProductViewTierRangeCondition
+
+
+
+
+
+
+ Example
+ {"gte": 987.65, "lt": 123.45}
@@ -60150,7 +61310,7 @@ Fields
Example
{
- "selections": ["abc123"],
+ "selections": ["xyz789"],
"product": ProductView
}
@@ -60253,8 +61413,8 @@ Fields
Example
{
"preview": ProductViewImage,
- "url": "xyz789",
- "description": "abc123",
+ "url": "abc123",
+ "description": "xyz789",
"title": "xyz789"
}
@@ -60407,7 +61567,7 @@ Example
"approval_flow": [PurchaseOrderRuleApprovalFlow],
"available_actions": ["REJECT"],
"comments": [PurchaseOrderComment],
- "created_at": "abc123",
+ "created_at": "xyz789",
"created_by": Customer,
"history_log": [PurchaseOrderHistoryItem],
"number": "xyz789",
@@ -60415,7 +61575,7 @@ Example
"quote": Cart,
"status": "PENDING",
"uid": "4",
- "updated_at": "abc123"
+ "updated_at": "xyz789"
}
@@ -60588,7 +61748,7 @@ Fields
Example
{
- "message": "abc123",
+ "message": "xyz789",
"name": "abc123",
"role": "abc123",
"status": "PENDING",
@@ -60734,8 +61894,8 @@ Example
"applies_to_roles": [CompanyRole],
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
- "created_at": "xyz789",
- "created_by": "abc123",
+ "created_at": "abc123",
+ "created_by": "xyz789",
"description": "xyz789",
"name": "abc123",
"status": "ENABLED",
@@ -60971,7 +62131,7 @@ Fields
Example
- {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123}
+ {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}
@@ -61043,11 +62203,11 @@ Fields
Example
{
- "applies_to": [4],
- "approvers": [4],
+ "applies_to": ["4"],
+ "approvers": ["4"],
"condition": CreatePurchaseOrderApprovalRuleConditionInput,
- "description": "abc123",
- "name": "xyz789",
+ "description": "xyz789",
+ "name": "abc123",
"status": "ENABLED"
}
@@ -61311,7 +62471,7 @@ Fields
Example
{
"author": Customer,
- "created_at": "abc123",
+ "created_at": "xyz789",
"text": "xyz789",
"uid": "4"
}
@@ -61437,9 +62597,9 @@ Fields
Example
{
"activity": "xyz789",
- "created_at": "xyz789",
+ "created_at": "abc123",
"message": "xyz789",
- "uid": "4"
+ "uid": 4
}
@@ -61487,7 +62647,7 @@ Fields
Example
{
"events": [PurchaseOrderApprovalFlowEvent],
- "rule_name": "abc123"
+ "rule_name": "xyz789"
}
@@ -61635,7 +62795,7 @@ Example
{
"items": [PurchaseOrder],
"page_info": SearchResultPageInfo,
- "total_count": 123
+ "total_count": 987
}
@@ -61677,7 +62837,7 @@ Fields
Example
- {"purchase_order_uids": [4]}
+ {"purchase_order_uids": ["4"]}
@@ -61937,8 +63097,8 @@ Fields
Example
{
"item_id": "4",
- "note": "abc123",
- "templateId": 4
+ "note": "xyz789",
+ "templateId": "4"
}
@@ -62045,7 +63205,7 @@ Example
{
"count": 123,
"from": 123.45,
- "title": "xyz789",
+ "title": "abc123",
"to": 987.65
}
@@ -62090,7 +63250,7 @@ Fields
Example
{
"configurations": ReCaptchaConfiguration,
- "is_enabled": false
+ "is_enabled": true
}
@@ -62168,14 +63328,14 @@ Fields
Example
{
- "badge_position": "abc123",
+ "badge_position": "xyz789",
"language_code": "abc123",
- "minimum_score": 123.45,
+ "minimum_score": 987.65,
"re_captcha_type": "INVISIBLE",
"technical_failure_message": "abc123",
- "theme": "abc123",
+ "theme": "xyz789",
"validation_failure_message": "abc123",
- "website_key": "abc123"
+ "website_key": "xyz789"
}
@@ -62252,12 +63412,12 @@ Fields
Example
{
- "badge_position": "abc123",
+ "badge_position": "xyz789",
"failure_message": "xyz789",
"forms": ["PLACE_ORDER"],
"is_enabled": true,
"language_code": "abc123",
- "minimum_score": 987.65,
+ "minimum_score": 123.45,
"theme": "abc123",
"website_key": "xyz789"
}
@@ -62496,13 +63656,13 @@ Fields
Example
{
- "displayOrder": 987,
- "pageType": "xyz789",
+ "displayOrder": 123,
+ "pageType": "abc123",
"productsView": [ProductView],
"storefrontLabel": "abc123",
"totalProducts": 987,
- "typeId": "xyz789",
- "unitId": "xyz789",
+ "typeId": "abc123",
+ "unitId": "abc123",
"unitName": "xyz789"
}
@@ -62598,7 +63758,7 @@ Example
{
"code": "abc123",
"id": 123,
- "name": "abc123"
+ "name": "xyz789"
}
@@ -62728,8 +63888,8 @@ Fields
Example
{
- "cart_id": "xyz789",
- "coupon_codes": ["abc123"]
+ "cart_id": "abc123",
+ "coupon_codes": ["xyz789"]
}
@@ -62778,8 +63938,8 @@ Fields
Example
{
- "cart_id": "xyz789",
- "gift_card_code": "xyz789"
+ "cart_id": "abc123",
+ "gift_card_code": "abc123"
}
@@ -62900,7 +64060,7 @@ Fields
Example
- {"success": true}
+ {"success": false}
@@ -62988,7 +64148,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"cart_item_uid": "4"
}
@@ -63077,10 +64237,7 @@ Fields
Example
- {
- "quote_item_uids": ["4"],
- "quote_uid": "4"
-}
+ {"quote_item_uids": ["4"], "quote_uid": 4}
@@ -63167,10 +64324,7 @@ Fields
Example
- {
- "item_uids": ["4"],
- "template_id": "4"
-}
+ {"item_uids": [4], "template_id": 4}
@@ -63217,10 +64371,7 @@ Fields
Example
- {
- "products": ["4"],
- "uid": "4"
-}
+ {"products": ["4"], "uid": 4}
@@ -63430,7 +64581,7 @@ Fields
Example
- {"cart_id": "xyz789"}
+ {"cart_id": "abc123"}
@@ -63675,8 +64826,8 @@ Fields
Example
{
- "comment_text": "abc123",
- "contact_email": "abc123",
+ "comment_text": "xyz789",
+ "contact_email": "xyz789",
"items": [RequestReturnItemInput],
"token": "abc123"
}
@@ -63741,8 +64892,8 @@ Example
{
"cart_id": "4",
"comment": NegotiableQuoteCommentInput,
- "is_draft": false,
- "quote_name": "abc123"
+ "is_draft": true,
+ "quote_name": "xyz789"
}
@@ -63824,7 +64975,7 @@ Fields
Example
- {"cart_id": 4}
+ {"cart_id": "4"}
@@ -63884,10 +65035,10 @@ Fields
Example
{
- "comment_text": "xyz789",
- "contact_email": "abc123",
+ "comment_text": "abc123",
+ "contact_email": "xyz789",
"items": [RequestReturnItemInput],
- "order_uid": "4"
+ "order_uid": 4
}
@@ -63951,7 +65102,7 @@ Example
"entered_custom_attributes": [
EnteredCustomAttributeInput
],
- "order_item_uid": "4",
+ "order_item_uid": 4,
"quantity_to_return": 123.45,
"selected_custom_attributes": [
SelectedCustomAttributeInput
@@ -64111,7 +65262,7 @@ Example
"description": "xyz789",
"items": RequistionListItems,
"items_count": 987,
- "name": "xyz789",
+ "name": "abc123",
"uid": 4,
"updated_at": "xyz789"
}
@@ -64265,7 +65416,7 @@ Example
{
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
- "quantity": 123.45,
+ "quantity": 987.65,
"uid": "4"
}
@@ -64335,7 +65486,7 @@ Example
{
"entered_options": [EnteredOptionInput],
"parent_sku": "xyz789",
- "quantity": 987.65,
+ "quantity": 123.45,
"selected_options": ["abc123"],
"sku": "xyz789"
}
@@ -64391,7 +65542,7 @@ Example
{
"items": [RequisitionList],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -64534,14 +65685,14 @@ Example
{
"available_shipping_carriers": [ReturnShippingCarrier],
"comments": [ReturnComment],
- "created_at": "xyz789",
+ "created_at": "abc123",
"customer": ReturnCustomer,
"items": [ReturnItem],
"number": "abc123",
"order": CustomerOrder,
"shipping": ReturnShipping,
"status": "PENDING",
- "uid": 4
+ "uid": "4"
}
@@ -64598,8 +65749,8 @@ Fields
Example
{
- "author_name": "abc123",
- "created_at": "xyz789",
+ "author_name": "xyz789",
+ "created_at": "abc123",
"text": "xyz789",
"uid": 4
}
@@ -64654,8 +65805,8 @@ Fields
Example
{
"email": "abc123",
- "firstname": "abc123",
- "lastname": "abc123"
+ "firstname": "xyz789",
+ "lastname": "xyz789"
}
@@ -64724,7 +65875,7 @@ Example
{
"custom_attributesV2": [AttributeValueInterface],
"order_item": OrderItemInterface,
- "quantity": 123.45,
+ "quantity": 987.65,
"request_quantity": 123.45,
"status": "PENDING",
"uid": "4"
@@ -64829,18 +65980,18 @@ Fields
Example
{
- "code": "4",
- "default_value": "xyz789",
+ "code": 4,
+ "default_value": "abc123",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"input_filter": "NONE",
"is_required": true,
- "is_unique": false,
- "label": "xyz789",
+ "is_unique": true,
+ "label": "abc123",
"multiline_count": 987,
"options": [CustomAttributeOptionInterface],
- "sort_order": 123,
+ "sort_order": 987,
"validate_rules": [ValidationRule]
}
@@ -65047,13 +66198,13 @@ Fields
Example
{
- "city": "abc123",
- "contact_name": "xyz789",
+ "city": "xyz789",
+ "contact_name": "abc123",
"country": Country,
"postcode": "xyz789",
"region": Region,
"street": ["xyz789"],
- "telephone": "xyz789"
+ "telephone": "abc123"
}
@@ -65100,7 +66251,7 @@ Fields
Example
{
- "label": "xyz789",
+ "label": "abc123",
"uid": "4"
}
@@ -65161,7 +66312,7 @@ Example
"carrier": ReturnShippingCarrier,
"status": ReturnShippingTrackingStatus,
"tracking_number": "abc123",
- "uid": "4"
+ "uid": 4
}
@@ -65207,7 +66358,7 @@ Fields
Example
- {"text": "xyz789", "type": "INFORMATION"}
+ {"text": "abc123", "type": "INFORMATION"}
@@ -65427,7 +66578,7 @@ Example
{
"items": [Return],
"page_info": SearchResultPageInfo,
- "total_count": 123
+ "total_count": 987
}
@@ -65468,7 +66619,7 @@ Fields
Example
- {"result": true}
+ {"result": false}
@@ -65626,7 +66777,7 @@ Fields
Example
{
"balance": RewardPointsAmount,
- "change_reason": "xyz789",
+ "change_reason": "abc123",
"date": "xyz789",
"points_change": 123.45
}
@@ -65722,7 +66873,7 @@ Fields
Example
- {"currency_amount": 987.65, "points": 123.45}
+ {"currency_amount": 123.45, "points": 987.65}
@@ -65961,11 +67112,7 @@ Fields
Example
- {
- "count": 123,
- "id": "4",
- "title": "abc123"
-}
+ {"count": 123, "id": 4, "title": "xyz789"}
@@ -66093,12 +67240,12 @@ Fields
Example
{
- "attribute": "xyz789",
+ "attribute": "abc123",
"contains": "xyz789",
- "eq": "abc123",
- "in": ["abc123"],
+ "eq": "xyz789",
+ "in": ["xyz789"],
"range": SearchRangeInput,
- "startsWith": "xyz789"
+ "startsWith": "abc123"
}
@@ -66146,7 +67293,7 @@ Fields
Example
- {"from": 987.65, "to": 987.65}
+ {"from": 987.65, "to": 123.45}
@@ -66196,7 +67343,7 @@ Fields
Example
- {"current_page": 987, "page_size": 987, "total_pages": 987}
+ {"current_page": 987, "page_size": 123, "total_pages": 123}
@@ -66252,8 +67399,8 @@ Fields
Example
{
- "label": "abc123",
- "type": "xyz789",
+ "label": "xyz789",
+ "type": "abc123",
"uid": 4,
"values": [SelectedBundleOptionValue]
}
@@ -66321,7 +67468,7 @@ Example
"original_price": Money,
"priceV2": Money,
"quantity": 123.45,
- "uid": 4
+ "uid": "4"
}
@@ -66378,8 +67525,8 @@ Fields
Example
{
- "configurable_product_option_uid": "4",
- "configurable_product_option_value_uid": 4,
+ "configurable_product_option_uid": 4,
+ "configurable_product_option_value_uid": "4",
"option_label": "xyz789",
"value_label": "abc123"
}
@@ -66431,7 +67578,7 @@ Fields
Example
{
"attribute_code": "xyz789",
- "value": "xyz789"
+ "value": "abc123"
}
@@ -66498,11 +67645,11 @@ Fields
Example
{
- "customizable_option_uid": "4",
- "is_required": true,
+ "customizable_option_uid": 4,
+ "is_required": false,
"label": "xyz789",
"sort_order": 123,
- "type": "xyz789",
+ "type": "abc123",
"values": [SelectedCustomizableOptionValue]
}
@@ -66561,9 +67708,9 @@ Fields
Example
{
"customizable_option_value_uid": 4,
- "label": "xyz789",
+ "label": "abc123",
"price": CartItemSelectedOptionValuePrice,
- "value": "abc123"
+ "value": "xyz789"
}
@@ -66622,8 +67769,8 @@ Example
{
"code": "abc123",
"oope_payment_method_config": OopePaymentMethodConfig,
- "purchase_order_number": "abc123",
- "title": "xyz789"
+ "purchase_order_number": "xyz789",
+ "title": "abc123"
}
@@ -66702,10 +67849,10 @@ Example
{
"additional_data": [ShippingAdditionalData],
"amount": Money,
- "carrier_code": "abc123",
+ "carrier_code": "xyz789",
"carrier_title": "abc123",
- "method_code": "xyz789",
- "method_title": "abc123",
+ "method_code": "abc123",
+ "method_title": "xyz789",
"price_excl_tax": Money,
"price_incl_tax": Money
}
@@ -66847,7 +67994,7 @@ Fields
Example
{
"billing_address": BillingAddressInput,
- "cart_id": "abc123"
+ "cart_id": "xyz789"
}
@@ -66889,6 +68036,51 @@ Fields
Example
{"cart": Cart}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ SetCartAsInactiveOutput
+
+
+
+ Description
+ Sets the cart as inactive
+
+
+
+
+
+ Example
+ {"error": "xyz789", "success": true}
@@ -66935,10 +68127,7 @@ Fields
Example
- {
- "custom_attributes": [CustomAttributeInput],
- "id": "4"
-}
+ {"custom_attributes": [CustomAttributeInput], "id": 4}
@@ -67027,7 +68216,7 @@ Fields
Example
{
"custom_attributes": [CustomAttributeInput],
- "quote_uid": "4"
+ "quote_uid": 4
}
@@ -67137,8 +68326,8 @@ Example
"cart_id": "abc123",
"gift_message": GiftMessageInput,
"gift_receipt_included": true,
- "gift_wrapping_id": "4",
- "printed_card_included": true
+ "gift_wrapping_id": 4,
+ "printed_card_included": false
}
@@ -67227,7 +68416,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"email": "abc123"
}
@@ -67358,7 +68547,7 @@ Fields
Example
{
"billing_address": NegotiableQuoteBillingAddressInput,
- "quote_uid": 4
+ "quote_uid": "4"
}
@@ -67448,7 +68637,7 @@ Fields
Example
{
"payment_method": NegotiableQuotePaymentMethodInput,
- "quote_uid": 4
+ "quote_uid": "4"
}
@@ -67629,7 +68818,7 @@ Fields
Example
{
- "quote_uid": "4",
+ "quote_uid": 4,
"shipping_methods": [ShippingMethodInput]
}
@@ -67769,7 +68958,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"payment_method": PaymentMethodInput
}
@@ -67859,7 +69048,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"shipping_addresses": [ShippingAddressInput]
}
@@ -67949,7 +69138,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"shipping_methods": [ShippingMethodInput]
}
@@ -68039,7 +69228,7 @@ Fields
Example
{
- "email": "abc123",
+ "email": "xyz789",
"name": "xyz789"
}
@@ -68081,7 +69270,7 @@ Fields
Example
- {"is_shared": false}
+ {"is_shared": true}
@@ -68129,7 +69318,7 @@ Fields
Example
{
- "message": "xyz789",
+ "message": "abc123",
"name": "xyz789"
}
@@ -68244,9 +69433,9 @@ Example
{
"id": 4,
"order_item": OrderItemInterface,
- "product_name": "xyz789",
+ "product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "xyz789",
+ "product_sku": "abc123",
"quantity_shipped": 987.65
}
@@ -68341,11 +69530,11 @@ Possible Types
Example
{
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
"product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
+ "product_sku": "abc123",
"quantity_shipped": 123.45
}
@@ -68399,8 +69588,8 @@ Fields
Example
{
"carrier": "xyz789",
- "number": "abc123",
- "title": "abc123"
+ "number": "xyz789",
+ "title": "xyz789"
}
@@ -68449,7 +69638,7 @@ Fields
Example
{
- "key": "xyz789",
+ "key": "abc123",
"value": "xyz789"
}
@@ -68512,9 +69701,9 @@ Fields
Example
{
"address": CartAddressInput,
- "customer_address_id": 123,
+ "customer_address_id": 987,
"customer_notes": "abc123",
- "pickup_location_code": "xyz789"
+ "pickup_location_code": "abc123"
}
@@ -68669,25 +69858,25 @@ Example
{
"available_shipping_methods": [AvailableShippingMethod],
"cart_items_v2": [CartItemInterface],
- "city": "abc123",
+ "city": "xyz789",
"company": "xyz789",
"country": CartAddressCountry,
"custom_attributes": [AttributeValueInterface],
"customer_notes": "abc123",
"fax": "xyz789",
- "firstname": "abc123",
- "id": 123,
+ "firstname": "xyz789",
+ "id": 987,
"lastname": "abc123",
- "middlename": "abc123",
+ "middlename": "xyz789",
"pickup_location_code": "abc123",
- "postcode": "abc123",
+ "postcode": "xyz789",
"prefix": "abc123",
"region": CartAddressRegion,
"same_as_billing": false,
"selected_shipping_method": SelectedShippingMethod,
"street": ["abc123"],
- "suffix": "xyz789",
- "telephone": "xyz789",
+ "suffix": "abc123",
+ "telephone": "abc123",
"uid": "abc123",
"vat_id": "abc123"
}
@@ -68975,16 +70164,16 @@ Example
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "is_available": false,
- "max_qty": 123.45,
+ "is_available": true,
+ "max_qty": 987.65,
"min_qty": 123.45,
"not_available_message": "abc123",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
- "quantity": 123.45,
- "uid": "4"
+ "quantity": 987.65,
+ "uid": 4
}
@@ -69239,46 +70428,46 @@ filters
Example
{
- "canonical_url": "abc123",
+ "canonical_url": "xyz789",
"categories": [CategoryInterface],
- "country_of_manufacture": "xyz789",
+ "country_of_manufacture": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
- "gift_message_available": false,
- "gift_wrapping_available": true,
+ "gift_message_available": true,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
"image": ProductImage,
"is_returnable": "xyz789",
"manufacturer": 987,
- "max_sale_qty": 987.65,
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
- "meta_description": "abc123",
- "meta_keyword": "abc123",
+ "meta_description": "xyz789",
+ "meta_keyword": "xyz789",
"meta_title": "xyz789",
"min_sale_qty": 123.45,
- "name": "xyz789",
- "new_from_date": "abc123",
- "new_to_date": "xyz789",
- "only_x_left_in_stock": 123.45,
+ "name": "abc123",
+ "new_from_date": "xyz789",
+ "new_to_date": "abc123",
+ "only_x_left_in_stock": 987.65,
"options": [CustomizableOptionInterface],
"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",
+ "sku": "abc123",
"small_image": ProductImage,
"special_price": 987.65,
"special_to_date": "xyz789",
"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": 987.65
}
@@ -69476,8 +70665,8 @@ linkTypes
Example
{
- "addToCartAllowed": false,
- "inStock": true,
+ "addToCartAllowed": true,
+ "inStock": false,
"lowStock": false,
"attributes": [ProductViewAttribute],
"description": "abc123",
@@ -69486,18 +70675,18 @@ Example
"videos": [ProductViewVideo],
"inputOptions": [ProductViewInputOption],
"lastModifiedAt": "2007-12-03T10:15:30Z",
- "metaDescription": "abc123",
+ "metaDescription": "xyz789",
"metaKeyword": "xyz789",
- "metaTitle": "xyz789",
- "name": "xyz789",
+ "metaTitle": "abc123",
+ "name": "abc123",
"price": ProductViewPrice,
"shortDescription": "xyz789",
"sku": "abc123",
"externalId": "xyz789",
"url": "xyz789",
- "urlKey": "abc123",
+ "urlKey": "xyz789",
"links": [ProductViewLink],
- "queryType": "xyz789",
+ "queryType": "abc123",
"visibility": "xyz789"
}
@@ -69558,8 +70747,8 @@ Example
{
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
- "quantity": 123.45,
- "uid": 4
+ "quantity": 987.65,
+ "uid": "4"
}
@@ -69629,10 +70818,10 @@ Example
{
"added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
- "id": "4",
+ "description": "xyz789",
+ "id": 4,
"product": ProductInterface,
- "quantity": 123.45
+ "quantity": 987.65
}
@@ -69773,12 +70962,12 @@ Fields
Example
{
"button_styles": ButtonStyles,
- "code": "abc123",
- "display_message": false,
+ "code": "xyz789",
+ "display_message": true,
"display_venmo": true,
"is_visible": false,
"message_styles": MessageStyles,
- "payment_intent": "xyz789",
+ "payment_intent": "abc123",
"sdk_params": [SDKParams],
"sort_order": "abc123",
"title": "xyz789"
@@ -70251,7 +71440,7 @@ Example
{
"attribute": "abc123",
"frontendInput": "xyz789",
- "label": "abc123",
+ "label": "xyz789",
"numeric": true
}
@@ -71016,52 +72205,52 @@ Example
"allow_gift_receipt": "abc123",
"allow_gift_wrapping_on_order": "abc123",
"allow_gift_wrapping_on_order_items": "abc123",
- "allow_items": "abc123",
- "allow_order": "xyz789",
- "allow_printed_card": "xyz789",
- "autocomplete_on_storefront": false,
- "base_currency_code": "abc123",
+ "allow_items": "xyz789",
+ "allow_order": "abc123",
+ "allow_printed_card": "abc123",
+ "autocomplete_on_storefront": true,
+ "base_currency_code": "xyz789",
"base_link_url": "xyz789",
- "base_media_url": "abc123",
+ "base_media_url": "xyz789",
"base_static_url": "abc123",
- "base_url": "abc123",
- "cart_expires_in_days": 987,
- "cart_gift_wrapping": "abc123",
- "cart_merge_preference": "abc123",
- "cart_printed_card": "abc123",
- "cart_summary_display_quantity": 123,
- "catalog_default_sort_by": "abc123",
+ "base_url": "xyz789",
+ "cart_expires_in_days": 123,
+ "cart_gift_wrapping": "xyz789",
+ "cart_merge_preference": "xyz789",
+ "cart_printed_card": "xyz789",
+ "cart_summary_display_quantity": 987,
+ "catalog_default_sort_by": "xyz789",
"category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"category_url_suffix": "abc123",
"check_money_order_enable_for_specific_countries": true,
"check_money_order_enabled": true,
- "check_money_order_make_check_payable_to": "abc123",
- "check_money_order_max_order_total": "abc123",
- "check_money_order_min_order_total": "abc123",
+ "check_money_order_make_check_payable_to": "xyz789",
+ "check_money_order_max_order_total": "xyz789",
+ "check_money_order_min_order_total": "xyz789",
"check_money_order_new_order_status": "abc123",
- "check_money_order_payment_from_specific_countries": "xyz789",
- "check_money_order_send_check_to": "xyz789",
- "check_money_order_sort_order": 123,
+ "check_money_order_payment_from_specific_countries": "abc123",
+ "check_money_order_send_check_to": "abc123",
+ "check_money_order_sort_order": 987,
"check_money_order_title": "abc123",
"configurable_product_image": "ITSELF",
"configurable_thumbnail_source": "abc123",
"contact_enabled": false,
"countries_with_required_region": "abc123",
- "create_account_confirmation": true,
- "customer_access_token_lifetime": 987.65,
+ "create_account_confirmation": false,
+ "customer_access_token_lifetime": 123.45,
"default_country": "abc123",
- "default_display_currency_code": "xyz789",
- "display_product_prices_in_catalog": 987,
- "display_shipping_prices": 123,
- "display_state_if_optional": true,
- "enable_multiple_wishlists": "abc123",
- "fixed_product_taxes_apply_tax_to_fpt": true,
- "fixed_product_taxes_display_prices_in_emails": 123,
+ "default_display_currency_code": "abc123",
+ "display_product_prices_in_catalog": 123,
+ "display_shipping_prices": 987,
+ "display_state_if_optional": false,
+ "enable_multiple_wishlists": "xyz789",
+ "fixed_product_taxes_apply_tax_to_fpt": false,
+ "fixed_product_taxes_display_prices_in_emails": 987,
"fixed_product_taxes_display_prices_in_product_lists": 987,
"fixed_product_taxes_display_prices_in_sales_modules": 987,
"fixed_product_taxes_display_prices_on_product_view_page": 123,
- "fixed_product_taxes_enable": true,
- "fixed_product_taxes_include_fpt_in_subtotal": true,
+ "fixed_product_taxes_enable": false,
+ "fixed_product_taxes_include_fpt_in_subtotal": false,
"graphql_share_customer_group": true,
"grid_per_page": 987,
"grid_per_page_values": "abc123",
@@ -71069,83 +72258,83 @@ Example
"is_checkout_agreements_enabled": true,
"is_default_store": false,
"is_default_store_group": true,
- "is_guest_checkout_enabled": false,
+ "is_guest_checkout_enabled": true,
"is_negotiable_quote_active": false,
- "is_one_page_checkout_enabled": false,
+ "is_one_page_checkout_enabled": true,
"is_requisition_list_active": "xyz789",
- "list_mode": "abc123",
- "list_per_page": 123,
+ "list_mode": "xyz789",
+ "list_per_page": 987,
"list_per_page_values": "abc123",
"locale": "abc123",
- "magento_reward_general_is_enabled": "xyz789",
- "magento_reward_general_is_enabled_on_front": "xyz789",
+ "magento_reward_general_is_enabled": "abc123",
+ "magento_reward_general_is_enabled_on_front": "abc123",
"magento_reward_general_min_points_balance": "xyz789",
"magento_reward_general_publish_history": "abc123",
"magento_reward_points_invitation_customer": "xyz789",
"magento_reward_points_invitation_customer_limit": "xyz789",
- "magento_reward_points_invitation_order": "abc123",
+ "magento_reward_points_invitation_order": "xyz789",
"magento_reward_points_invitation_order_limit": "xyz789",
"magento_reward_points_newsletter": "xyz789",
- "magento_reward_points_order": "abc123",
- "magento_reward_points_register": "xyz789",
- "magento_reward_points_review": "xyz789",
+ "magento_reward_points_order": "xyz789",
+ "magento_reward_points_register": "abc123",
+ "magento_reward_points_review": "abc123",
"magento_reward_points_review_limit": "abc123",
- "magento_wishlist_general_is_enabled": "abc123",
+ "magento_wishlist_general_is_enabled": "xyz789",
"max_items_in_order_summary": 123,
- "maximum_number_of_wishlists": "xyz789",
+ "maximum_number_of_wishlists": "abc123",
"minicart_display": false,
- "minicart_max_items": 123,
- "minimum_password_length": "xyz789",
- "newsletter_enabled": true,
- "optional_zip_countries": "xyz789",
+ "minicart_max_items": 987,
+ "minimum_password_length": "abc123",
+ "newsletter_enabled": false,
+ "optional_zip_countries": "abc123",
"order_cancellation_enabled": true,
"order_cancellation_reasons": [CancellationReason],
"orders_invoices_credit_memos_display_full_summary": false,
- "orders_invoices_credit_memos_display_grandtotal": false,
+ "orders_invoices_credit_memos_display_grandtotal": true,
"orders_invoices_credit_memos_display_price": 123,
"orders_invoices_credit_memos_display_shipping_amount": 123,
"orders_invoices_credit_memos_display_subtotal": 123,
"orders_invoices_credit_memos_display_zero_tax": false,
"printed_card_priceV2": Money,
"product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
- "product_url_suffix": "abc123",
+ "product_url_suffix": "xyz789",
"quickorder_active": false,
- "required_character_classes_number": "xyz789",
- "returns_enabled": "abc123",
+ "required_character_classes_number": "abc123",
+ "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_printed_card": "xyz789",
"secure_base_link_url": "abc123",
- "secure_base_media_url": "abc123",
- "secure_base_static_url": "abc123",
- "secure_base_url": "xyz789",
- "share_active_segments": true,
- "share_applied_cart_rule": false,
- "shopping_cart_display_full_summary": true,
+ "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": false,
"shopping_cart_display_grand_total": true,
- "shopping_cart_display_price": 123,
- "shopping_cart_display_shipping": 123,
- "shopping_cart_display_subtotal": 123,
+ "shopping_cart_display_price": 987,
+ "shopping_cart_display_shipping": 987,
+ "shopping_cart_display_subtotal": 987,
"shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
"shopping_cart_display_zero_tax": false,
"store_code": "4",
"store_group_code": 4,
- "store_group_name": "abc123",
+ "store_group_name": "xyz789",
"store_name": "abc123",
"store_sort_order": 987,
"timezone": "abc123",
- "title_separator": "xyz789",
+ "title_separator": "abc123",
"use_store_in_url": true,
"website_code": "4",
"website_name": "abc123",
- "weight_unit": "abc123",
- "zero_subtotal_enable_for_specific_countries": true,
- "zero_subtotal_enabled": false,
+ "weight_unit": "xyz789",
+ "zero_subtotal_enable_for_specific_countries": false,
+ "zero_subtotal_enabled": true,
"zero_subtotal_new_order_status": "xyz789",
- "zero_subtotal_payment_action": "abc123",
+ "zero_subtotal_payment_action": "xyz789",
"zero_subtotal_payment_from_specific_countries": "abc123",
- "zero_subtotal_sort_order": 123,
+ "zero_subtotal_sort_order": 987,
"zero_subtotal_title": "abc123"
}
@@ -71241,14 +72430,14 @@ Fields
Example
{
- "comment": "xyz789",
- "max_order_commitment": 987,
- "min_order_commitment": 123,
+ "comment": "abc123",
+ "max_order_commitment": 123,
+ "min_order_commitment": 987,
"name": "xyz789",
"reference_document_links": [
NegotiableQuoteTemplateReferenceDocumentLinkInput
],
- "template_id": "4"
+ "template_id": 4
}
@@ -71397,7 +72586,7 @@ Fields
Example
- {"depth": 987, "startLevel": 987}
+ {"depth": 123, "startLevel": 987}
@@ -71460,7 +72649,7 @@ Possible Types
Example
- {"value": "xyz789"}
+ {"value": "abc123"}
@@ -71728,8 +72917,8 @@ Fields
Example
{
- "cartId": "xyz789",
- "id": "abc123"
+ "cartId": "abc123",
+ "id": "xyz789"
}
@@ -71782,8 +72971,8 @@ Fields
Example
{
"amount": Money,
- "rate": 123.45,
- "title": "xyz789"
+ "rate": 987.65,
+ "title": "abc123"
}
@@ -72566,8 +73755,8 @@ Example
"dynamic_attributes": [
GiftRegistryDynamicAttributeInput
],
- "email": "abc123",
- "firstname": "abc123",
+ "email": "xyz789",
+ "firstname": "xyz789",
"gift_registry_registrant_uid": "4",
"lastname": "abc123"
}
@@ -72919,10 +74108,10 @@ Example
"applies_to": [4],
"approvers": ["4"],
"condition": CreatePurchaseOrderApprovalRuleConditionInput,
- "description": "xyz789",
+ "description": "abc123",
"name": "abc123",
"status": "ENABLED",
- "uid": "4"
+ "uid": 4
}
@@ -73035,8 +74224,8 @@ Example
{
"entered_options": [EnteredOptionInput],
"item_id": 4,
- "quantity": 987.65,
- "selected_options": ["abc123"]
+ "quantity": 123.45,
+ "selected_options": ["xyz789"]
}
@@ -73169,7 +74358,7 @@ Fields
Example
{
"name": "xyz789",
- "uid": 4,
+ "uid": "4",
"visibility": "PUBLIC"
}
@@ -73225,7 +74414,7 @@ Fields
Example
{
- "currentPage": 123,
+ "currentPage": 987,
"pageSize": 123,
"sort": [CompaniesSortInput]
}
@@ -73428,7 +74617,7 @@ Fields
Example
- {"purchase_order_uids": ["4"]}
+ {"purchase_order_uids": [4]}
@@ -73772,9 +74961,9 @@ Fields
Example
{
- "payment_source": "xyz789",
- "payments_order_id": "xyz789",
- "paypal_order_id": "abc123",
+ "payment_source": "abc123",
+ "payments_order_id": "abc123",
+ "paypal_order_id": "xyz789",
"public_hash": "xyz789"
}
@@ -74032,16 +75221,16 @@ Example
"customizable_options": [SelectedCustomizableOption],
"discount": [Discount],
"errors": [CartItemError],
- "is_available": true,
- "max_qty": 123.45,
- "min_qty": 987.65,
- "not_available_message": "abc123",
+ "is_available": false,
+ "max_qty": 987.65,
+ "min_qty": 123.45,
+ "not_available_message": "xyz789",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
- "quantity": 987.65,
- "uid": 4
+ "quantity": 123.45,
+ "uid": "4"
}
@@ -74291,46 +75480,46 @@ filters
Example
{
- "canonical_url": "xyz789",
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "country_of_manufacture": "xyz789",
+ "country_of_manufacture": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
- "gift_message_available": false,
- "gift_wrapping_available": true,
+ "gift_message_available": true,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
"image": ProductImage,
"is_returnable": "xyz789",
"manufacturer": 123,
- "max_sale_qty": 987.65,
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"meta_description": "xyz789",
- "meta_keyword": "abc123",
- "meta_title": "xyz789",
+ "meta_keyword": "xyz789",
+ "meta_title": "abc123",
"min_sale_qty": 123.45,
"name": "abc123",
"new_from_date": "xyz789",
- "new_to_date": "abc123",
- "only_x_left_in_stock": 123.45,
+ "new_to_date": "xyz789",
+ "only_x_left_in_stock": 987.65,
"options": [CustomizableOptionInterface],
- "options_container": "xyz789",
+ "options_container": "abc123",
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
"quantity": 123.45,
"related_products": [ProductInterface],
"short_description": ComplexTextValue,
- "sku": "abc123",
+ "sku": "xyz789",
"small_image": ProductImage,
- "special_price": 987.65,
+ "special_price": 123.45,
"special_to_date": "abc123",
"stock_status": "IN_STOCK",
- "swatch_image": "xyz789",
+ "swatch_image": "abc123",
"thumbnail": ProductImage,
"uid": "4",
"upsell_products": [ProductInterface],
- "url_key": "abc123"
+ "url_key": "xyz789"
}
@@ -74390,8 +75579,8 @@ Example
{
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
- "quantity": 123.45,
- "uid": "4"
+ "quantity": 987.65,
+ "uid": 4
}
@@ -74459,7 +75648,7 @@ Fields
Example
{
- "added_at": "abc123",
+ "added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
"id": 4,
@@ -74651,11 +75840,11 @@ pageSizeExample
{
"id": 4,
- "items_count": 123,
+ "items_count": 987,
"items_v2": WishlistItems,
"name": "abc123",
- "sharing_code": "xyz789",
- "updated_at": "abc123",
+ "sharing_code": "abc123",
+ "updated_at": "xyz789",
"visibility": "PUBLIC"
}
@@ -74716,7 +75905,7 @@ Example
"code": "PRODUCT_NOT_FOUND",
"message": "abc123",
"wishlistId": "4",
- "wishlistItemId": 4
+ "wishlistItemId": "4"
}
@@ -74835,7 +76024,7 @@ Fields
Example
{
- "quantity": 123.45,
+ "quantity": 987.65,
"wishlist_item_id": "4"
}
@@ -74904,8 +76093,8 @@ Fields
Example
{
"entered_options": [EnteredOptionInput],
- "parent_sku": "abc123",
- "quantity": 987.65,
+ "parent_sku": "xyz789",
+ "quantity": 123.45,
"selected_options": [4],
"sku": "xyz789"
}
@@ -75022,10 +76211,10 @@ Possible Types
Example
{
- "added_at": "xyz789",
+ "added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
- "id": "4",
+ "description": "xyz789",
+ "id": 4,
"product": ProductInterface,
"quantity": 123.45
}
@@ -75075,7 +76264,10 @@ Fields
Example
- {"quantity": 987.65, "wishlist_item_id": 4}
+ {
+ "quantity": 123.45,
+ "wishlist_item_id": "4"
+}
@@ -75141,7 +76333,7 @@ Fields
Example
{
- "description": "abc123",
+ "description": "xyz789",
"entered_options": [EnteredOptionInput],
"quantity": 123.45,
"selected_options": ["4"],
@@ -75244,6 +76436,198 @@ Values
Example
"PUBLIC"
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ finishUploadInput
+
+
+
+ Fields
+
+
+
+ Input Field
+ Description
+
+
+
+
+
+ key - String!
+
+ The unique key identifier from the upload
+
+
+
+ media_resource_type - MediaResourceType!
+
+ The type of media resource being uploaded
+
+
+
+
+
+
+
+ Example
+ {
+ "key": "xyz789",
+ "media_resource_type": "CUSTOMER_ATTRIBUTE_FILE"
+}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ finishUploadOutput
+
+
+
+
+
+
+ Example
+ {
+ "key": "xyz789",
+ "message": "xyz789",
+ "success": false
+}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ initiateUploadInput
+
+
+
+ Fields
+
+
+
+ Input Field
+ Description
+
+
+
+
+
+ key - String!
+
+ The name of the file to be uploaded, cannot contain slashes
+
+
+
+ media_resource_type - MediaResourceType!
+
+ The type of media resource being uploaded
+
+
+
+
+
+
+
+ Example
+ {
+ "key": "xyz789",
+ "media_resource_type": "CUSTOMER_ATTRIBUTE_FILE"
+}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ initiateUploadOutput
+
+
+
+
+
+
+ Example
+ {
+ "expires_at": "abc123",
+ "key": "abc123",
+ "upload_url": "xyz789"
+}