diff --git a/spectaql/schema_saas.json b/spectaql/schema_saas.json index 33e49382e..50bda78d9 100644 --- a/spectaql/schema_saas.json +++ b/spectaql/schema_saas.json @@ -7450,6 +7450,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "related_products", "description": "An array of products to be displayed in a Related Products block.", @@ -7466,6 +7482,59 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "ship_bundle_items", "description": "Indicates whether to ship bundle items together or individually.", @@ -19384,6 +19453,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "related_products", "description": "An array of products to be displayed in a Related Products block.", @@ -19400,6 +19485,59 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", @@ -22753,6 +22891,118 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "CreateProductReviewInput", + "description": "Defines a new product review.", + "fields": null, + "inputFields": [ + { + "name": "nickname", + "description": "The customer's nickname. Defaults to the customer name, if logged in.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "ratings", + "description": "The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductReviewRatingInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "sku", + "description": "The SKU of the reviewed product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "summary", + "description": "The summary (title) of the review.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "text", + "description": "The review text.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateProductReviewOutput", + "description": "Contains the completed product review.", + "fields": [ + { + "name": "review", + "description": "Product review details.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReview", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "CreatePurchaseOrderApprovalRuleConditionAmountInput", @@ -26032,6 +26282,43 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "reviews", + "description": "Contains the customer's product reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "reward_points", "description": "Customer reward points details.", @@ -32624,6 +32911,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "related_products", "description": "An array of products to be displayed in a Related Products block.", @@ -32640,6 +32943,59 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", @@ -36637,6 +36993,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "related_products", "description": "An array of products to be displayed in a Related Products block.", @@ -36653,6 +37025,59 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", @@ -39780,6 +40205,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "related_products", "description": "An array of products to be displayed in a Related Products block.", @@ -39796,6 +40237,59 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", @@ -42452,6 +42946,18 @@ "description": "Customer image resource type for customer address", "isDeprecated": false, "deprecationReason": null + }, + { + "name": "RMA_ATTRIBUTE_FILE", + "description": "RMA return item file resource type", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RMA_ATTRIBUTE_IMAGE", + "description": "RMA return item image resource type", + "isDeprecated": false, + "deprecationReason": null } ], "possibleTypes": null @@ -44392,6 +44898,37 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "createProductReview", + "description": "Create a product review for the specified product.", + "args": [ + { + "name": "input", + "description": "An input object that contains the details necessary to create a product review.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreateProductReviewInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CreateProductReviewOutput", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "createPurchaseOrderApprovalRule", "description": "Create a purchase order approval rule.", @@ -57311,6 +57848,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "related_products", "description": "An array of products to be displayed in a Related Products block.", @@ -57327,6 +57880,59 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", @@ -57958,6 +58564,399 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "ProductReview", + "description": "Contains details of a product review.", + "fields": [ + { + "name": "average_rating", + "description": "The average of all ratings for this product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "The date the review was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nickname", + "description": "The customer's nickname. Defaults to the customer name, if logged in.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The reviewed product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ratings_breakdown", + "description": "An array of ratings by rating category, such as quality, price, and value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviewRating", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "summary", + "description": "The summary (title) of the review.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "text", + "description": "The review text.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductReviewRating", + "description": "Contains data about a single aspect of a product review.", + "fields": [ + { + "name": "name", + "description": "The label assigned to an aspect of a product that is being rated, such as quality or price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The rating value given by customer. By default, possible values range from 1 to 5.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductReviewRatingInput", + "description": "Contains the reviewer's rating for a single aspect of a review.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "An encoded rating ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value_id", + "description": "An encoded rating value ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductReviewRatingMetadata", + "description": "Contains details about a single aspect of a product review.", + "fields": [ + { + "name": "id", + "description": "An encoded rating ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The label assigned to an aspect of a product that is being rated, such as quality or price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "List of product review ratings sorted by position.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviewRatingValueMetadata", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductReviewRatingsMetadata", + "description": "Contains an array of metadata about each aspect of a product review.", + "fields": [ + { + "name": "items", + "description": "An array of product reviews sorted by position.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviewRatingMetadata", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductReviewRatingValueMetadata", + "description": "Contains details about a single value in a product review.", + "fields": [ + { + "name": "value", + "description": "A ratings scale, such as the number of stars awarded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value_id", + "description": "An encoded rating value ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductReviews", + "description": "Contains an array of product reviews.", + "fields": [ + { + "name": "items", + "description": "An array of product reviews.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReview", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Metadata for pagination rendering.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "ProductSearchItem", @@ -64053,6 +65052,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "productReviewRatingsMetadata", + "description": "Return the active ratings attributes and the values each rating can have.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviewRatingsMetadata", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "recaptchaFormConfig", "description": null, @@ -73429,6 +74444,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "related_products", "description": "An array of products to be displayed in a Related Products block.", @@ -73445,6 +74476,59 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", @@ -75061,6 +76145,30 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "is_pickup_location_active", + "description": "Whether the source is an active in-store pickup location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Display name of the source, for labelling a store or warehouse.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "sku", "description": "The product SKU the availability applies to.", @@ -75221,6 +76329,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "allow_guests_to_write_product_reviews", + "description": "Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "allow_items", "description": "The value of the Allow Gift Messages for Order Items option", @@ -76517,6 +77637,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "product_reviews_enabled", + "description": "Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "product_url_suffix", "description": "The suffix applied to product pages, such as `.htm` or `.html`.", @@ -80418,6 +81550,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "related_products", "description": "An array of products to be displayed in a Related Products block.", @@ -80434,6 +81582,59 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", diff --git a/src/openapi/accs-schema.yaml b/src/openapi/accs-schema.yaml index 940f0a644..b5e2c5adc 100644 --- a/src/openapi/accs-schema.yaml +++ b/src/openapi/accs-schema.yaml @@ -3165,6 +3165,70 @@ definitions: - search_criteria - total_count type: object + customer-company-data-company-role-interface: + description: A company role assigned to a customer, as returned by the companyRoles + REST endpoint. + properties: + company_id: + description: The id of the company the role belongs to. + type: integer + id: + description: The role id. + type: integer + permissions: + description: The ACL permissions granted by the role. + items: + "$ref": "#/definitions/customer-company-data-company-role-permission-interface" + type: array + role_name: + description: The role name. + type: string + required: + - id + - company_id + - role_name + - permissions + type: object + customer-company-data-company-role-permission-interface: + description: A single ACL permission entry within a company role, as returned + by the companyRoles REST endpoint. Deliberately omits `role_id` (present on + the underlying `Magento\Company\Api\Data\PermissionInterface`) since it's redundant + with the enclosing `CompanyRoleInterface::getId()`, and omits its own permission + id since no caller identifies a permission entry by id — `resource_id` already + does that within a role. + properties: + permission: + description: The permission value ("allow" or "deny"). + type: string + resource_id: + description: The ACL resource id the permission applies to. + type: string + required: + - resource_id + - permission + type: object + customer-company-data-company-role-search-results-interface: + description: Search results wrapper for the companyRoles REST endpoint. Left untyped + (no native return/param types), matching vendor's own `SearchResultsInterface` + and every `*SearchResultsInterface` in Commerce core — required for compatibility + with `Magento\Framework\Api\SearchResults`, whose inherited `getItems()`/`setItems()` + predate PHP return types. + properties: + items: + description: Company roles. + items: + "$ref": "#/definitions/customer-company-data-company-role-interface" + type: array + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + description: Total count. + type: integer + required: + - items + - search_criteria + - total_count + type: object customer-data-address-extension-interface: description: ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface type: object @@ -18408,6 +18472,83 @@ paths: tags: - customers/{customerId}/companies/{companyId} summary: customers/{customerId}/companies/{companyId} + "/V1/customers/{customerId}/companyRoles": + get: + consumes: + - application/json + - application/xml + description: 'Get the company roles assigned to the given customer, filtered/paged + per $searchCriteria. Returns one entry per company assignment in which the + customer holds a role — not one per company assignment: a company the customer + is assigned to but holds no role in contributes no entry at all. Returns an + empty result when the customer is not a member of any company, holds no role + in any of them, or when none of their companies/roles match $searchCriteria''s + filters. Supported filter fields: `company_id`, `company_name` (restrict which + companies are considered), and `resource_id`, `permission` (restrict each + matching role''s permissions — a role left with no permissions after that + narrowing is dropped from the result entirely). A single filter group (its + filters are OR''d together) must not mix company fields with permission fields + — throws otherwise. Supported condition types: `eq` and `in` on every field, + plus `like` (SQL-style `%`/`_` wildcards) on `company_name`. Sortable fields: + `id`, `company_id`, `role_name` — applied to the result items themselves, + after filtering and before paging (there''s no sortable field within `permissions`).' + operationId: GetV1CustomersCustomerIdCompanyRoles + parameters: + - in: path + name: customerId + required: true + type: integer + - description: Field + in: query + name: searchCriteria[filterGroups][0][filters][0][field] + type: string + - description: Value + in: query + name: searchCriteria[filterGroups][0][filters][0][value] + type: string + - description: Condition type + in: query + name: searchCriteria[filterGroups][0][filters][0][conditionType] + type: string + - description: Sorting field. + in: query + name: searchCriteria[sortOrders][0][field] + type: string + - description: Sorting direction. + in: query + name: searchCriteria[sortOrders][0][direction] + type: string + - description: Page size. + in: query + name: searchCriteria[pageSize] + type: integer + - description: Current page. + in: query + name: searchCriteria[currentPage] + type: integer + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-company-data-company-role-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + tags: + - customers/{customerId}/companyRoles + summary: customers/{customerId}/companyRoles "/V1/customers/{customerId}/confirm": get: consumes: @@ -32033,6 +32174,7 @@ tags: - name: customers/{customerId}/carts - name: customers/{customerId}/companies - name: customers/{customerId}/companies/{companyId} +- name: customers/{customerId}/companyRoles - name: customers/{customerId}/confirm - name: customers/{customerId}/permissions/readonly - name: customers/{customerId}/shippingAddress @@ -32487,6 +32629,7 @@ x-tagGroups: - customers/{customerId}/carts - customers/{customerId}/companies - customers/{customerId}/companies/{companyId} + - customers/{customerId}/companyRoles - customers/{customerId}/confirm - customers/{customerId}/permissions/readonly - customers/{customerId}/shippingAddress diff --git a/src/pages/includes/autogenerated/graphql-api-saas-mutations.md b/src/pages/includes/autogenerated/graphql-api-saas-mutations.md index bf4a582a9..ceee81245 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-mutations.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-mutations.md @@ -119,12 +119,12 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 987, - "name": "xyz789", + "min_order_commitment": 123, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -136,7 +136,7 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu ], "status": "abc123", "template_id": "4", - "total_quantity": 987.65, + "total_quantity": 123.45, "uid": "4", "updated_at": "abc123" } @@ -350,9 +350,9 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "data": { "addProductsToCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -505,10 +505,7 @@ mutation addProductsToWishlist( ##### Variables ```json -{ - "wishlistId": "4", - "wishlistItems": [WishlistItemInput] -} +{"wishlistId": 4, "wishlistItems": [WishlistItemInput]} ``` ##### Response @@ -662,10 +659,7 @@ mutation addRequisitionListItemsToCart( ##### Variables ```json -{ - "requisitionListUid": 4, - "requisitionListItemUids": ["4"] -} +{"requisitionListUid": 4, "requisitionListItemUids": [4]} ``` ##### Response @@ -678,7 +672,7 @@ mutation addRequisitionListItemsToCart( AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": true + "status": false } } } @@ -816,7 +810,7 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{"wishlistId": 4, "wishlistItemIds": ["4"]} +{"wishlistId": "4", "wishlistItemIds": [4]} ``` ##### Response @@ -828,7 +822,7 @@ mutation addWishlistItemsToCart( "add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": false, + "status": true, "wishlist": Wishlist } } @@ -1163,7 +1157,7 @@ mutation assignCompareListToCustomer($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -1173,7 +1167,7 @@ mutation assignCompareListToCustomer($uid: ID!) { "data": { "assignCompareListToCustomer": { "compare_list": CompareList, - "result": true + "result": false } } } @@ -1286,12 +1280,12 @@ mutation assignCustomerToGuestCart($cart_id: String!) { "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "has_available_free_gifts": true, + "has_available_free_gifts": false, "id": "4", "is_virtual": true, "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, + "printed_card_included": false, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], @@ -1380,14 +1374,14 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "cancelNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "expiration_date": "abc123", + "created_at": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 123, + "max_order_commitment": 987, "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], @@ -1395,7 +1389,7 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], @@ -1613,6 +1607,9 @@ mutation changeCustomerPassword( returns { ...ReturnsFragment } + reviews { + ...ProductReviewsFragment + } reward_points { ...RewardPointsFragment } @@ -1647,8 +1644,8 @@ mutation changeCustomerPassword( ```json { - "currentPassword": "abc123", - "newPassword": "xyz789" + "currentPassword": "xyz789", + "newPassword": "abc123" } ``` @@ -1661,29 +1658,29 @@ mutation changeCustomerPassword( "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, "admin_assistance_actions": AdminAssistanceActions, - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "companies": UserCompaniesOutput, "company_hierarchy": [CompanyHierarchy], "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "default_billing": "xyz789", "default_shipping": "abc123", - "email": "abc123", - "firstname": "xyz789", + "email": "xyz789", + "firstname": "abc123", "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "id": 4, - "is_subscribed": false, + "id": "4", + "is_subscribed": true, "job_title": "xyz789", "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "orders": CustomerOrders, - "prefix": "abc123", + "prefix": "xyz789", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, @@ -1694,14 +1691,15 @@ mutation changeCustomerPassword( "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, + "reviews": ProductReviews, "reward_points": RewardPoints, "role": CompanyRole, "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": "4", - "suffix": "abc123", - "taxvat": "abc123", + "suffix": "xyz789", + "taxvat": "xyz789", "team": CompanyTeam, "telephone": "abc123", "wishlist_v2": Wishlist, @@ -2381,25 +2379,25 @@ mutation createCompanyAddress($input: CompanyAddressInput!) { "address_type": "BILLING", "city": "xyz789", "company": "xyz789", - "company_id": 4, + "company_id": "4", "country_code": "AF", "custom_attributes": [AttributeValueInterface], "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", "firstname": "abc123", - "id": 4, - "is_default": false, + "id": "4", + "is_default": true, "lastname": "xyz789", "middlename": "abc123", "nickname": "xyz789", "postcode": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 123, "street": ["xyz789"], "suffix": "abc123", "telephone": "xyz789", - "vat_id": "abc123" + "vat_id": "xyz789" } } } @@ -2647,22 +2645,22 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "default_billing": true, + "default_billing": false, "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "abc123", - "firstname": "xyz789", - "id": 123, - "lastname": "xyz789", - "middlename": "xyz789", + "firstname": "abc123", + "id": 987, + "lastname": "abc123", + "middlename": "abc123", "postcode": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 123, + "region_id": 987, "street": ["abc123"], "suffix": "abc123", - "telephone": "abc123", - "uid": "4", + "telephone": "xyz789", + "uid": 4, "vat_id": "abc123" } } @@ -2833,7 +2831,7 @@ mutation createPaymentLink( ```json { "cartId": "abc123", - "recipientEmail": "abc123" + "recipientEmail": "xyz789" } ``` @@ -2844,7 +2842,7 @@ mutation createPaymentLink( "data": { "createPaymentLink": { "expiresAt": "xyz789", - "payUrl": "abc123", + "payUrl": "xyz789", "token": "abc123" } } @@ -2893,11 +2891,11 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { { "data": { "createPaymentOrder": { - "amount": 987.65, - "currency_code": "xyz789", + "amount": 123.45, + "currency_code": "abc123", "id": "abc123", - "mp_order_id": "xyz789", - "status": "xyz789" + "mp_order_id": "abc123", + "status": "abc123" } } } @@ -2905,6 +2903,50 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { +### createProductReview + +Create a product review for the specified product. + +**Response:** [`CreateProductReviewOutput!`](/reference/graphql/saas/types-c-e.md#createproductreviewoutput) + +#### Arguments + +| Name | Description | +|------|-------------| +| `input` - [`CreateProductReviewInput!`](/reference/graphql/saas/types-c-e.md#createproductreviewinput) | An input object that contains the details necessary to create a product review. | + +#### Example + +##### Query + +```graphql +mutation createProductReview($input: CreateProductReviewInput!) { + createProductReview(input: $input) { + review { + ...ProductReviewFragment + } + } +} +``` + +##### Variables + +```json +{"input": CreateProductReviewInput} +``` + +##### Response + +```json +{ + "data": { + "createProductReview": {"review": ProductReview} + } +} +``` + + + ### createPurchaseOrderApprovalRule Create a purchase order approval rule. @@ -2959,13 +3001,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "xyz789", - "created_by": "abc123", - "description": "xyz789", + "created_at": "abc123", + "created_by": "xyz789", + "description": "abc123", "name": "xyz789", "status": "ENABLED", "uid": 4, - "updated_at": "abc123" + "updated_at": "xyz789" } } } @@ -3059,7 +3101,7 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) "data": { "createVaultCardPaymentToken": { "payment_source": PaymentSourceOutput, - "vault_token_id": "abc123" + "vault_token_id": "xyz789" } } } @@ -3176,7 +3218,7 @@ mutation deleteCompanyAddress($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response @@ -3214,13 +3256,13 @@ mutation deleteCompanyRole($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response ```json -{"data": {"deleteCompanyRole": {"success": false}}} +{"data": {"deleteCompanyRole": {"success": true}}} ``` @@ -3252,13 +3294,13 @@ mutation deleteCompanyTeam($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response ```json -{"data": {"deleteCompanyTeam": {"success": false}}} +{"data": {"deleteCompanyTeam": {"success": true}}} ``` @@ -3290,13 +3332,13 @@ mutation deleteCompanyUserV2($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response ```json -{"data": {"deleteCompanyUserV2": {"success": false}}} +{"data": {"deleteCompanyUserV2": {"success": true}}} ``` @@ -3328,7 +3370,7 @@ mutation deleteCompareList($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -3358,7 +3400,7 @@ mutation deleteCustomer { ##### Response ```json -{"data": {"deleteCustomer": true}} +{"data": {"deleteCustomer": false}} ``` @@ -3398,7 +3440,7 @@ mutation deleteCustomerAddress($id: Int!) { ##### Response ```json -{"data": {"deleteCustomerAddress": true}} +{"data": {"deleteCustomerAddress": false}} ``` @@ -3434,7 +3476,7 @@ mutation deleteCustomerAddressV2($uid: ID!) { ##### Response ```json -{"data": {"deleteCustomerAddressV2": false}} +{"data": {"deleteCustomerAddressV2": true}} ``` @@ -3712,7 +3754,10 @@ mutation deleteRequisitionListItems( ##### Variables ```json -{"requisitionListUid": 4, "requisitionListItemUids": [4]} +{ + "requisitionListUid": "4", + "requisitionListItemUids": ["4"] +} ``` ##### Response @@ -3759,7 +3804,7 @@ mutation deleteWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": 4} +{"wishlistId": "4"} ``` ##### Response @@ -3768,7 +3813,7 @@ mutation deleteWishlist($wishlistId: ID!) { { "data": { "deleteWishlist": { - "status": true, + "status": false, "wishlists": [Wishlist] } } @@ -3878,11 +3923,11 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "additional_data": [ShippingAdditionalData], "amount": Money, "available": false, - "carrier_code": "xyz789", + "carrier_code": "abc123", "carrier_title": "xyz789", "error_message": "abc123", - "method_code": "xyz789", - "method_title": "xyz789", + "method_code": "abc123", + "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money } @@ -3973,7 +4018,7 @@ mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInpu "data": { "exchangeExternalCustomerToken": { "customer": Customer, - "token": "abc123" + "token": "xyz789" } } } @@ -4071,9 +4116,9 @@ mutation finishUpload($input: finishUploadInput!) { { "data": { "finishUpload": { - "key": "xyz789", + "key": "abc123", "message": "xyz789", - "success": true + "success": false } } } @@ -4171,7 +4216,7 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! { "data": { "generateCustomerTokenAsAdmin": { - "customer_token": "xyz789" + "customer_token": "abc123" } } } @@ -4305,7 +4350,7 @@ mutation initiateUpload($input: initiateUploadInput!) { "initiateUpload": { "expires_at": "abc123", "key": "xyz789", - "upload_url": "xyz789" + "upload_url": "abc123" } } } @@ -4402,8 +4447,8 @@ mutation mergeCarts( ```json { - "source_cart_id": "abc123", - "destination_cart_id": "xyz789" + "source_cart_id": "xyz789", + "destination_cart_id": "abc123" } ``` @@ -4426,18 +4471,18 @@ mutation mergeCarts( "custom_attributes": [CustomAttribute], "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "has_available_free_gifts": false, + "has_available_free_gifts": true, "id": 4, - "is_virtual": false, + "is_virtual": true, "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -4485,10 +4530,7 @@ mutation moveCartItemsToGiftRegistry( ##### Variables ```json -{ - "cartUid": "4", - "giftRegistryUid": "4" -} +{"cartUid": "4", "giftRegistryUid": 4} ``` ##### Response @@ -4551,7 +4593,7 @@ mutation moveItemsBetweenRequisitionLists( ```json { "sourceRequisitionListUid": "4", - "destinationRequisitionListUid": 4, + "destinationRequisitionListUid": "4", "requisitionListItem": MoveItemsBetweenRequisitionListsInput } ``` @@ -4663,7 +4705,7 @@ mutation moveProductsBetweenWishlists( ```json { - "sourceWishlistUid": "4", + "sourceWishlistUid": 4, "destinationWishlistUid": 4, "wishlistItems": [WishlistItemMoveInput] } @@ -4762,15 +4804,15 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "openNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", + "created_at": "abc123", "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -4782,7 +4824,7 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, + "template_id": "4", "total_quantity": 987.65, "uid": 4, "updated_at": "xyz789" @@ -5068,7 +5110,7 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "data": { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, - "code": "abc123", + "code": "xyz789", "expiration_date": "xyz789" } } @@ -5274,7 +5316,7 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": "4"} +{"giftRegistryUid": 4} ``` ##### Response @@ -5377,7 +5419,10 @@ mutation removeGiftRegistryRegistrants( ##### Variables ```json -{"giftRegistryUid": 4, "registrantsUid": [4]} +{ + "giftRegistryUid": "4", + "registrantsUid": ["4"] +} ``` ##### Response @@ -5558,7 +5603,7 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "abc123", - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, @@ -5576,8 +5621,8 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": 4, + "status": "abc123", + "template_id": "4", "total_quantity": 123.45, "uid": 4, "updated_at": "abc123" @@ -5634,7 +5679,7 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -5681,7 +5726,7 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{"wishlistId": 4, "wishlistItemsIds": ["4"]} +{"wishlistId": "4", "wishlistItemsIds": [4]} ``` ##### Response @@ -5955,7 +6000,7 @@ mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) { { "data": { "requestGuestOrderCancel": { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -6134,11 +6179,11 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "requestNegotiableQuoteTemplateFromQuote": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "expiration_date": "xyz789", + "created_at": "abc123", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, @@ -6153,10 +6198,10 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": 4, - "total_quantity": 987.65, - "uid": 4, + "status": "xyz789", + "template_id": "4", + "total_quantity": 123.45, + "uid": "4", "updated_at": "xyz789" } } @@ -6190,13 +6235,13 @@ mutation requestPasswordResetEmail($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"requestPasswordResetEmail": false}} +{"data": {"requestPasswordResetEmail": true}} ``` @@ -6276,7 +6321,7 @@ mutation resendConfirmationEmail($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -6323,7 +6368,7 @@ mutation resetPassword( ```json { - "email": "abc123", + "email": "xyz789", "resetPasswordToken": "abc123", "newPassword": "xyz789" } @@ -6332,7 +6377,7 @@ mutation resetPassword( ##### Response ```json -{"data": {"resetPassword": false}} +{"data": {"resetPassword": true}} ``` @@ -6358,7 +6403,7 @@ mutation revokeCustomerToken { ##### Response ```json -{"data": {"revokeCustomerToken": {"result": true}}} +{"data": {"revokeCustomerToken": {"result": false}}} ``` @@ -6527,7 +6572,7 @@ mutation setCartAsInactive($cartId: String!) { "data": { "setCartAsInactive": { "error": "abc123", - "success": false + "success": true } } } @@ -6957,24 +7002,24 @@ mutation setDefaultCompanyAddress($id: ID!) { "address_type": "BILLING", "city": "abc123", "company": "abc123", - "company_id": "4", + "company_id": 4, "country_code": "AF", "custom_attributes": [AttributeValueInterface], "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", - "firstname": "xyz789", - "id": 4, - "is_default": true, + "fax": "abc123", + "firstname": "abc123", + "id": "4", + "is_default": false, "lastname": "xyz789", "middlename": "abc123", "nickname": "xyz789", "postcode": "abc123", "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 123, + "region_id": 987, "street": ["xyz789"], - "suffix": "abc123", - "telephone": "xyz789", + "suffix": "xyz789", + "telephone": "abc123", "vat_id": "abc123" } } @@ -7364,15 +7409,15 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "setNegotiableQuoteTemplateShippingAddress": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "created_at": "xyz789", "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, - "is_virtual": true, + "is_min_max_qty_used": true, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 123, + "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -7385,7 +7430,7 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem ], "status": "xyz789", "template_id": 4, - "total_quantity": 123.45, + "total_quantity": 987.65, "uid": "4", "updated_at": "abc123" } @@ -7563,29 +7608,29 @@ mutation setQuoteTemplateExpirationDate($input: QuoteTemplateExpirationDateInput "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "xyz789", - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 987, - "name": "xyz789", + "max_order_commitment": 123, + "min_order_commitment": 123, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "abc123", + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "abc123", "template_id": 4, "total_quantity": 123.45, - "uid": 4, - "updated_at": "abc123" + "uid": "4", + "updated_at": "xyz789" } } } @@ -7674,7 +7719,7 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, @@ -7689,11 +7734,11 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": "4", + "status": "abc123", + "template_id": 4, "total_quantity": 987.65, - "uid": 4, - "updated_at": "xyz789" + "uid": "4", + "updated_at": "abc123" } } } @@ -7819,7 +7864,7 @@ mutation shareGiftRegistry( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "sender": ShareGiftRegistrySenderInput, "invitees": [ShareGiftRegistryInviteeInput] } @@ -7828,7 +7873,7 @@ mutation shareGiftRegistry( ##### Response ```json -{"data": {"shareGiftRegistry": {"is_shared": true}}} +{"data": {"shareGiftRegistry": {"is_shared": false}}} ``` @@ -7917,7 +7962,7 @@ mutation shareRequisitionListByToken($requisitionListUid: ID!) { { "data": { "shareRequisitionListByToken": { - "token": "xyz789" + "token": "abc123" } } } @@ -8003,21 +8048,21 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "abc123", - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 123, + "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], @@ -8060,7 +8105,7 @@ mutation subscribeEmailToNewsletter($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -8108,8 +8153,8 @@ mutation subscribeProductAlertPrice($input: ProductAlertPriceInput!) { { "data": { "subscribeProductAlertPrice": { - "message": "abc123", - "success": false + "message": "xyz789", + "success": true } } } @@ -8154,7 +8199,7 @@ mutation subscribeProductAlertStock($input: ProductAlertStockInput!) { { "data": { "subscribeProductAlertStock": { - "message": "abc123", + "message": "xyz789", "success": true } } @@ -8282,8 +8327,8 @@ mutation unsubscribeProductAlertPrice($input: ProductAlertPriceInput!) { { "data": { "unsubscribeProductAlertPrice": { - "message": "abc123", - "success": true + "message": "xyz789", + "success": false } } } @@ -8316,8 +8361,8 @@ mutation unsubscribeProductAlertPriceAll { { "data": { "unsubscribeProductAlertPriceAll": { - "message": "abc123", - "success": false + "message": "xyz789", + "success": true } } } @@ -8362,8 +8407,8 @@ mutation unsubscribeProductAlertStock($input: ProductAlertStockInput!) { { "data": { "unsubscribeProductAlertStock": { - "message": "abc123", - "success": true + "message": "xyz789", + "success": false } } } @@ -8397,7 +8442,7 @@ mutation unsubscribeProductAlertStockAll { "data": { "unsubscribeProductAlertStockAll": { "message": "xyz789", - "success": true + "success": false } } } @@ -8556,7 +8601,10 @@ mutation updateCompanyAddress( ##### Variables ```json -{"id": 4, "input": CompanyAddressUpdateInput} +{ + "id": "4", + "input": CompanyAddressUpdateInput +} ``` ##### Response @@ -8566,24 +8614,24 @@ mutation updateCompanyAddress( "data": { "updateCompanyAddress": { "address_type": "BILLING", - "city": "xyz789", - "company": "xyz789", - "company_id": "4", + "city": "abc123", + "company": "abc123", + "company_id": 4, "country_code": "AF", "custom_attributes": [AttributeValueInterface], "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", - "firstname": "xyz789", - "id": 4, + "fax": "xyz789", + "firstname": "abc123", + "id": "4", "is_default": true, "lastname": "xyz789", "middlename": "xyz789", "nickname": "xyz789", "postcode": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 987, - "street": ["xyz789"], + "region_id": 123, + "street": ["abc123"], "suffix": "xyz789", "telephone": "abc123", "vat_id": "xyz789" @@ -8867,7 +8915,7 @@ mutation updateCustomerAddress( { "data": { "updateCustomerAddress": { - "city": "xyz789", + "city": "abc123", "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], @@ -8875,14 +8923,14 @@ mutation updateCustomerAddress( "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", - "firstname": "abc123", - "id": 123, + "firstname": "xyz789", + "id": 987, "lastname": "xyz789", - "middlename": "abc123", - "postcode": "xyz789", - "prefix": "xyz789", + "middlename": "xyz789", + "postcode": "abc123", + "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 123, + "region_id": 987, "street": ["xyz789"], "suffix": "xyz789", "telephone": "abc123", @@ -8969,22 +9017,22 @@ mutation updateCustomerAddressV2( "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "default_billing": false, - "default_shipping": true, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", - "firstname": "xyz789", + "firstname": "abc123", "id": 987, - "lastname": "xyz789", - "middlename": "xyz789", + "lastname": "abc123", + "middlename": "abc123", "postcode": "abc123", - "prefix": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 987, - "street": ["xyz789"], - "suffix": "abc123", + "street": ["abc123"], + "suffix": "xyz789", "telephone": "abc123", "uid": 4, - "vat_id": "abc123" + "vat_id": "xyz789" } } } @@ -9119,7 +9167,7 @@ mutation updateGiftRegistry( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "giftRegistry": UpdateGiftRegistryInput } ``` @@ -9380,7 +9428,7 @@ mutation updateProductsInWishlist( ```json { - "wishlistId": "4", + "wishlistId": 4, "wishlistItems": [WishlistItemUpdateInput] } ``` @@ -9456,11 +9504,11 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "xyz789", "created_by": "abc123", - "description": "abc123", + "description": "xyz789", "name": "xyz789", "status": "ENABLED", - "uid": 4, - "updated_at": "xyz789" + "uid": "4", + "updated_at": "abc123" } } } @@ -9561,7 +9609,7 @@ mutation updateRequisitionListItems( ```json { - "requisitionListUid": "4", + "requisitionListUid": 4, "requisitionListItems": [ UpdateRequisitionListItemsInput ] @@ -9634,7 +9682,7 @@ mutation updateWishlist( { "data": { "updateWishlist": { - "name": "xyz789", + "name": "abc123", "uid": "4", "visibility": "PUBLIC" } diff --git a/src/pages/includes/autogenerated/graphql-api-saas-queries.md b/src/pages/includes/autogenerated/graphql-api-saas-queries.md index 5b698bf21..dcf118ba2 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-queries.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-queries.md @@ -187,6 +187,7 @@ query availableStores($useCurrentGroup: Boolean) { allow_gift_receipt allow_gift_wrapping_on_order allow_gift_wrapping_on_order_items + allow_guests_to_write_product_reviews allow_items allow_order allow_printed_card @@ -289,6 +290,7 @@ query availableStores($useCurrentGroup: Boolean) { } product_alert_allow_stock product_fixed_product_tax_display_setting + product_reviews_enabled product_url_suffix quickorder_active quote_minimum_amount @@ -357,75 +359,76 @@ query availableStores($useCurrentGroup: Boolean) { { "allow_company_registration": true, "allow_gift_receipt": "abc123", - "allow_gift_wrapping_on_order": "abc123", + "allow_gift_wrapping_on_order": "xyz789", "allow_gift_wrapping_on_order_items": "abc123", - "allow_items": "xyz789", - "allow_order": "xyz789", + "allow_guests_to_write_product_reviews": "xyz789", + "allow_items": "abc123", + "allow_order": "abc123", "allow_printed_card": "abc123", - "autocomplete_on_storefront": true, - "base_currency_code": "abc123", - "base_link_url": "abc123", - "base_media_url": "xyz789", - "base_static_url": "xyz789", + "autocomplete_on_storefront": false, + "base_currency_code": "xyz789", + "base_link_url": "xyz789", + "base_media_url": "abc123", + "base_static_url": "abc123", "base_url": "abc123", "cart_expires_in_days": 123, "cart_gift_wrapping": "xyz789", - "cart_merge_preference": "xyz789", + "cart_merge_preference": "abc123", "cart_printed_card": "abc123", "cart_summary_display_quantity": 123, - "catalog_default_sort_by": "xyz789", + "catalog_default_sort_by": "abc123", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "category_url_suffix": "xyz789", + "category_url_suffix": "abc123", "check_money_order_enable_for_specific_countries": false, - "check_money_order_enabled": true, + "check_money_order_enabled": false, "check_money_order_make_check_payable_to": "abc123", - "check_money_order_max_order_total": "xyz789", - "check_money_order_min_order_total": "abc123", + "check_money_order_max_order_total": "abc123", + "check_money_order_min_order_total": "xyz789", "check_money_order_new_order_status": "xyz789", "check_money_order_payment_from_specific_countries": "abc123", - "check_money_order_send_check_to": "xyz789", - "check_money_order_sort_order": 987, - "check_money_order_title": "abc123", + "check_money_order_send_check_to": "abc123", + "check_money_order_sort_order": 123, + "check_money_order_title": "xyz789", "company_credit_enabled": true, - "company_enabled": false, + "company_enabled": true, "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "xyz789", - "contact_enabled": true, + "contact_enabled": false, "countries_with_required_region": "abc123", "create_account_confirmation": true, "customer_access_token_lifetime": 987.65, - "default_country": "abc123", + "default_country": "xyz789", "default_display_currency_code": "abc123", - "display_product_prices_in_catalog": 987, + "display_product_prices_in_catalog": 123, "display_shipping_prices": 987, - "display_state_if_optional": true, + "display_state_if_optional": false, "enable_multiple_wishlists": "abc123", "fixed_product_taxes_apply_tax_to_fpt": false, - "fixed_product_taxes_display_prices_in_emails": 123, + "fixed_product_taxes_display_prices_in_emails": 987, "fixed_product_taxes_display_prices_in_product_lists": 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_include_fpt_in_subtotal": false, "graphql_share_customer_group": false, "grid_per_page": 123, - "grid_per_page_values": "xyz789", + "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", - "is_checkout_agreements_enabled": false, - "is_default_store": true, - "is_default_store_group": false, - "is_guest_checkout_enabled": false, + "is_checkout_agreements_enabled": true, + "is_default_store": false, + "is_default_store_group": true, + "is_guest_checkout_enabled": true, "is_negotiable_quote_active": false, "is_one_page_checkout_enabled": false, - "is_requisition_list_active": "xyz789", + "is_requisition_list_active": "abc123", "list_mode": "abc123", "list_per_page": 987, "list_per_page_values": "abc123", - "locale": "xyz789", - "magento_reward_general_is_enabled": "abc123", + "locale": "abc123", + "magento_reward_general_is_enabled": "xyz789", "magento_reward_general_is_enabled_on_front": "xyz789", - "magento_reward_general_min_points_balance": "xyz789", - "magento_reward_general_publish_history": "xyz789", + "magento_reward_general_min_points_balance": "abc123", + "magento_reward_general_publish_history": "abc123", "magento_reward_points_invitation_customer": "abc123", "magento_reward_points_invitation_customer_limit": "abc123", "magento_reward_points_invitation_order": "abc123", @@ -434,16 +437,16 @@ query availableStores($useCurrentGroup: Boolean) { "magento_reward_points_order": "xyz789", "magento_reward_points_register": "xyz789", "magento_reward_points_review": "xyz789", - "magento_reward_points_review_limit": "xyz789", - "magento_wishlist_general_is_enabled": "abc123", - "max_items_in_order_summary": 987, + "magento_reward_points_review_limit": "abc123", + "magento_wishlist_general_is_enabled": "xyz789", + "max_items_in_order_summary": 123, "maximum_number_of_wishlists": "abc123", "minicart_display": true, "minicart_max_items": 987, - "minimum_password_length": "xyz789", + "minimum_password_length": "abc123", "newsletter_enabled": false, - "optional_zip_countries": "abc123", - "order_cancellation_enabled": false, + "optional_zip_countries": "xyz789", + "order_cancellation_enabled": true, "order_cancellation_reasons": [ CancellationReason ], @@ -451,62 +454,63 @@ query availableStores($useCurrentGroup: Boolean) { "orders_invoices_credit_memos_display_grandtotal": true, "orders_invoices_credit_memos_display_price": 987, "orders_invoices_credit_memos_display_shipping_amount": 987, - "orders_invoices_credit_memos_display_subtotal": 123, - "orders_invoices_credit_memos_display_zero_tax": true, + "orders_invoices_credit_memos_display_subtotal": 987, + "orders_invoices_credit_memos_display_zero_tax": false, "persistent_enabled": true, "persistent_options_wishlist": false, - "persistent_shopping_cart": true, + "persistent_shopping_cart": false, "printed_card_priceV2": Money, - "product_alert_allow_stock": false, + "product_alert_allow_stock": true, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_url_suffix": "abc123", - "quickorder_active": false, - "quote_minimum_amount": 123.45, + "product_reviews_enabled": "xyz789", + "product_url_suffix": "xyz789", + "quickorder_active": true, + "quote_minimum_amount": 987.65, "quote_minimum_amount_message": "abc123", - "required_character_classes_number": "abc123", + "required_character_classes_number": "xyz789", "requisition_list_share_link_validity_days": 987, - "requisition_list_share_max_recipients": 123, - "requisition_list_share_storefront_path": "xyz789", - "requisition_list_sharing_enabled": false, + "requisition_list_share_max_recipients": 987, + "requisition_list_share_storefront_path": "abc123", + "requisition_list_sharing_enabled": true, "returns_enabled": "xyz789", - "root_category_uid": 4, + "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "sales_gift_wrapping": "abc123", - "sales_printed_card": "abc123", + "sales_gift_wrapping": "xyz789", + "sales_printed_card": "xyz789", "secure_base_link_url": "abc123", - "secure_base_media_url": "abc123", + "secure_base_media_url": "xyz789", "secure_base_static_url": "abc123", "secure_base_url": "xyz789", "share_active_segments": false, "share_applied_cart_rule": true, "share_customer_accounts_scope": 123, - "shopping_assistance_checkbox_title": "xyz789", - "shopping_assistance_checkbox_tooltip": "abc123", + "shopping_assistance_checkbox_title": "abc123", + "shopping_assistance_checkbox_tooltip": "xyz789", "shopping_assistance_enabled": true, "shopping_cart_display_full_summary": true, "shopping_cart_display_grand_total": false, - "shopping_cart_display_price": 987, - "shopping_cart_display_shipping": 987, - "shopping_cart_display_subtotal": 987, + "shopping_cart_display_price": 123, + "shopping_cart_display_shipping": 123, + "shopping_cart_display_subtotal": 123, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": true, - "store_code": "4", - "store_group_code": "4", - "store_group_name": "xyz789", + "store_code": 4, + "store_group_code": 4, + "store_group_name": "abc123", "store_name": "abc123", "store_sort_order": 123, "timezone": "xyz789", "title_separator": "xyz789", "use_store_in_url": true, - "website_code": "4", + "website_code": 4, "website_name": "xyz789", "weight_unit": "xyz789", - "zero_subtotal_enable_for_specific_countries": true, + "zero_subtotal_enable_for_specific_countries": false, "zero_subtotal_enabled": false, "zero_subtotal_new_order_status": "abc123", "zero_subtotal_payment_action": "xyz789", - "zero_subtotal_payment_from_specific_countries": "xyz789", - "zero_subtotal_sort_order": 987, + "zero_subtotal_payment_from_specific_countries": "abc123", + "zero_subtotal_sort_order": 123, "zero_subtotal_title": "xyz789" } ] @@ -621,16 +625,16 @@ query cart($cart_id: String!) { "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "has_available_free_gifts": true, - "id": "4", - "is_virtual": true, + "has_available_free_gifts": false, + "id": 4, + "is_virtual": false, "itemsV2": CartItems, "prices": CartPrices, "printed_card_included": true, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -689,8 +693,8 @@ query categories( ```json { - "ids": ["xyz789"], - "roles": ["xyz789"], + "ids": ["abc123"], + "roles": ["abc123"], "subtree": Subtree } ``` @@ -705,17 +709,17 @@ query categories( "availableSortBy": ["xyz789"], "children": ["xyz789"], "defaultSortBy": "xyz789", - "id": 4, + "id": "4", "level": 987, - "name": "xyz789", + "name": "abc123", "parentId": "xyz789", - "position": 987, + "position": 123, "path": "xyz789", - "roles": ["abc123"], + "roles": ["xyz789"], "urlKey": "xyz789", "urlPath": "xyz789", - "count": 987, - "title": "xyz789" + "count": 123, + "title": "abc123" } ] } @@ -755,11 +759,11 @@ query checkoutAgreements { "data": { "checkoutAgreements": [ { - "agreement_id": 987, + "agreement_id": 123, "checkbox_text": "xyz789", - "content": "abc123", + "content": "xyz789", "content_height": "abc123", - "is_html": true, + "is_html": false, "mode": "AUTO", "name": "abc123" } @@ -791,13 +795,7 @@ query commerceOptimizer { ##### Response ```json -{ - "data": { - "commerceOptimizer": { - "priceBookId": "4" - } - } -} +{"data": {"commerceOptimizer": {"priceBookId": 4}}} ``` @@ -906,10 +904,10 @@ query company { "default_billing_address": CompanyAddress, "default_shipping_address": CompanyAddress, "email": "abc123", - "id": 4, + "id": "4", "legal_address": CompanyLegalAddress, "legal_name": "abc123", - "name": "xyz789", + "name": "abc123", "payment_methods": ["xyz789"], "reseller_id": "abc123", "role": CompanyRole, @@ -920,7 +918,7 @@ query company { "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } } } @@ -962,7 +960,7 @@ query compareList($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -974,7 +972,7 @@ query compareList($uid: ID!) { "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -1017,9 +1015,9 @@ query countries { "available_regions": [Region], "full_name_english": "abc123", "full_name_locale": "abc123", - "id": "xyz789", + "id": "abc123", "three_letter_abbreviation": "xyz789", - "two_letter_abbreviation": "abc123" + "two_letter_abbreviation": "xyz789" } ] } @@ -1062,7 +1060,7 @@ query country($id: String) { ##### Variables ```json -{"id": "xyz789"} +{"id": "abc123"} ``` ##### Response @@ -1072,11 +1070,11 @@ query country($id: String) { "data": { "country": { "available_regions": [Region], - "full_name_english": "abc123", + "full_name_english": "xyz789", "full_name_locale": "abc123", - "id": "abc123", + "id": "xyz789", "three_letter_abbreviation": "xyz789", - "two_letter_abbreviation": "abc123" + "two_letter_abbreviation": "xyz789" } } } @@ -1116,12 +1114,12 @@ query currency { "data": { "currency": { "available_currency_codes": [ - "xyz789" + "abc123" ], "base_currency_code": "abc123", - "base_currency_symbol": "abc123", + "base_currency_symbol": "xyz789", "default_display_currency_code": "xyz789", - "default_display_currency_symbol": "xyz789", + "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } } @@ -1267,6 +1265,9 @@ query customer { returns { ...ReturnsFragment } + reviews { + ...ProductReviewsFragment + } reward_points { ...RewardPointsFragment } @@ -1306,47 +1307,48 @@ query customer { "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, "admin_assistance_actions": AdminAssistanceActions, - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "companies": UserCompaniesOutput, "company_hierarchy": [CompanyHierarchy], "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", - "created_at": "xyz789", + "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "default_billing": "xyz789", - "default_shipping": "abc123", - "email": "xyz789", - "firstname": "abc123", + "default_shipping": "xyz789", + "email": "abc123", + "firstname": "xyz789", "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, "id": "4", "is_subscribed": false, - "job_title": "abc123", + "job_title": "xyz789", "lastname": "xyz789", "middlename": "abc123", "orders": CustomerOrders, - "prefix": "abc123", + "prefix": "xyz789", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, "purchase_orders_enabled": true, - "quote_enabled": true, + "quote_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, + "reviews": ProductReviews, "reward_points": RewardPoints, "role": CompanyRole, "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": 4, - "suffix": "abc123", - "taxvat": "abc123", + "structure_id": "4", + "suffix": "xyz789", + "taxvat": "xyz789", "team": CompanyTeam, "telephone": "xyz789", "wishlist_v2": Wishlist, @@ -1447,20 +1449,20 @@ query customerCart { ], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "has_available_free_gifts": true, - "id": "4", + "has_available_free_gifts": false, + "id": 4, "is_virtual": false, "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -1523,7 +1525,7 @@ query customerGroup { ##### Response ```json -{"data": {"customerGroup": {"uid": "4"}}} +{"data": {"customerGroup": {"uid": 4}}} ``` @@ -1587,7 +1589,7 @@ query customerSegments($cartId: String!) { ##### Variables ```json -{"cartId": "xyz789"} +{"cartId": "abc123"} ``` ##### Response @@ -1718,7 +1720,7 @@ query getPaymentOrder( "id": "xyz789", "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, - "status": "abc123" + "status": "xyz789" } } } @@ -1845,8 +1847,8 @@ query giftCardAccount($input: GiftCardAccountInput!) { "data": { "giftCardAccount": { "balance": Money, - "code": "xyz789", - "expiration_date": "xyz789" + "code": "abc123", + "expiration_date": "abc123" } } } @@ -1964,7 +1966,7 @@ query giftRegistryEmailSearch($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -1974,12 +1976,12 @@ query giftRegistryEmailSearch($email: String!) { "data": { "giftRegistryEmailSearch": [ { - "event_date": "abc123", - "event_title": "abc123", - "gift_registry_uid": "4", + "event_date": "xyz789", + "event_title": "xyz789", + "gift_registry_uid": 4, "location": "abc123", - "name": "abc123", - "type": "xyz789" + "name": "xyz789", + "type": "abc123" } ] } @@ -2020,7 +2022,7 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": "4"} +{"giftRegistryUid": 4} ``` ##### Response @@ -2030,12 +2032,12 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "data": { "giftRegistryIdSearch": [ { - "event_date": "abc123", + "event_date": "xyz789", "event_title": "xyz789", "gift_registry_uid": 4, "location": "abc123", "name": "xyz789", - "type": "xyz789" + "type": "abc123" } ] } @@ -2087,8 +2089,8 @@ query giftRegistryTypeSearch( ```json { - "firstName": "xyz789", - "lastName": "abc123", + "firstName": "abc123", + "lastName": "xyz789", "giftRegistryTypeUid": 4 } ``` @@ -2100,11 +2102,11 @@ query giftRegistryTypeSearch( "data": { "giftRegistryTypeSearch": [ { - "event_date": "xyz789", - "event_title": "xyz789", - "gift_registry_uid": "4", + "event_date": "abc123", + "event_title": "abc123", + "gift_registry_uid": 4, "location": "xyz789", - "name": "xyz789", + "name": "abc123", "type": "xyz789" } ] @@ -2147,7 +2149,7 @@ query giftRegistryTypes { GiftRegistryDynamicAttributeMetadataInterface ], "label": "xyz789", - "uid": 4 + "uid": "4" } ] } @@ -2269,9 +2271,9 @@ query guestOrder($input: GuestOrderInformationInput!) { "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", "invoices": [Invoice], @@ -2279,9 +2281,9 @@ query guestOrder($input: GuestOrderInformationInput!) { "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, - "number": "abc123", - "order_date": "abc123", - "order_status_change_date": "abc123", + "number": "xyz789", + "order_date": "xyz789", + "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], "printed_card_included": false, "returns": Returns, @@ -2401,7 +2403,7 @@ query guestOrderByToken($input: OrderTokenInput!) { { "data": { "guestOrderByToken": { - "admin_assisted_order": 987, + "admin_assisted_order": 123, "applied_coupons": [AppliedCoupon], "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], @@ -2413,7 +2415,7 @@ query guestOrderByToken($input: OrderTokenInput!) { "customer_info": OrderCustomerInfo, "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": 4, "invoices": [Invoice], @@ -2422,15 +2424,15 @@ query guestOrderByToken($input: OrderTokenInput!) { "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, "number": "abc123", - "order_date": "xyz789", - "order_status_change_date": "xyz789", + "order_date": "abc123", + "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "xyz789", - "status": "abc123", + "shipping_method": "abc123", + "status": "xyz789", "token": "abc123", "total": OrderTotal } @@ -2467,13 +2469,13 @@ query isCompanyAdminEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response ```json -{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}} +{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}} ``` @@ -2511,7 +2513,7 @@ query isCompanyEmailAvailable($email: String!) { ##### Response ```json -{"data": {"isCompanyEmailAvailable": {"is_email_available": false}}} +{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}} ``` @@ -2549,7 +2551,7 @@ query isCompanyRoleNameAvailable($name: String!) { ##### Response ```json -{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}} +{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}} ``` @@ -2581,7 +2583,7 @@ query isCompanyUserEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -2625,7 +2627,7 @@ query isEmailAvailable($email: String!) { ##### Response ```json -{"data": {"isEmailAvailable": {"is_email_available": true}}} +{"data": {"isEmailAvailable": {"is_email_available": false}}} ``` @@ -2667,7 +2669,7 @@ query isSubscribedProductAlertPrice($input: ProductAlertPriceInput!) { { "data": { "isSubscribedProductAlertPrice": { - "isSubscribed": true, + "isSubscribed": false, "message": "abc123" } } @@ -2714,7 +2716,7 @@ query isSubscribedProductAlertStock($input: ProductAlertStockInput!) { "data": { "isSubscribedProductAlertStock": { "isSubscribed": true, - "message": "abc123" + "message": "xyz789" } } } @@ -2808,12 +2810,12 @@ query negotiableQuote($uid: ID!) { "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "created_at": "xyz789", "custom_attributes": [CustomAttribute], "email": "abc123", "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "name": "abc123", "order": CustomerOrder, @@ -2825,9 +2827,9 @@ query negotiableQuote($uid: ID!) { ], "status": "SUBMITTED", "template_id": 4, - "template_name": "abc123", - "total_quantity": 123.45, - "uid": 4, + "template_name": "xyz789", + "total_quantity": 987.65, + "uid": "4", "updated_at": "xyz789" } } @@ -2902,7 +2904,7 @@ query negotiableQuoteTemplate($templateId: ID!) { ##### Variables ```json -{"templateId": 4} +{"templateId": "4"} ``` ##### Response @@ -2917,23 +2919,23 @@ query negotiableQuoteTemplate($templateId: ID!) { "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, - "is_virtual": true, + "is_min_max_qty_used": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, - "min_order_commitment": 987, + "max_order_commitment": 987, + "min_order_commitment": 123, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "abc123", + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": 4, + "template_id": "4", "total_quantity": 123.45, "uid": 4, "updated_at": "xyz789" @@ -3119,7 +3121,7 @@ query payByLinkCart($token: String!) { ##### Variables ```json -{"token": "abc123"} +{"token": "xyz789"} ``` ##### Response @@ -3128,7 +3130,7 @@ query payByLinkCart($token: String!) { { "data": { "payByLinkCart": { - "masked_cart_id": "abc123" + "masked_cart_id": "xyz789" } } } @@ -3206,7 +3208,41 @@ query pickupLocations( "pickupLocations": { "items": [PickupLocation], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 + } + } +} +``` + + + +### productReviewRatingsMetadata + +Return the active ratings attributes and the values each rating can have. + +**Response:** [`ProductReviewRatingsMetadata!`](/reference/graphql/saas/types-k-p.md#productreviewratingsmetadata) + +#### Example + +##### Query + +```graphql +query productReviewRatingsMetadata { + productReviewRatingsMetadata { + items { + ...ProductReviewRatingMetadataFragment + } + } +} +``` + +##### Response + +```json +{ + "data": { + "productReviewRatingsMetadata": { + "items": [ProductReviewRatingMetadata] } } } @@ -3279,7 +3315,7 @@ query productSearch( "current_page": 1, "filter": [SearchClauseInput], "page_size": 20, - "phrase": "xyz789", + "phrase": "abc123", "sort": [ProductSearchSortInput] } ``` @@ -3293,9 +3329,9 @@ query productSearch( "facets": [Aggregation], "items": [ProductSearchItem], "page_info": SearchResultPageInfo, - "related_terms": ["abc123"], - "suggestions": ["xyz789"], - "total_count": 987, + "related_terms": ["xyz789"], + "suggestions": ["abc123"], + "total_count": 123, "warnings": [ProductSearchWarning] } } @@ -3377,26 +3413,26 @@ query products($skus: [String]) { { "addToCartAllowed": false, "inStock": false, - "lowStock": true, + "lowStock": false, "attributes": [ProductViewAttribute], - "description": "xyz789", + "description": "abc123", "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", "metaDescription": "xyz789", "metaKeyword": "abc123", - "metaTitle": "abc123", + "metaTitle": "xyz789", "name": "xyz789", - "shortDescription": "xyz789", + "shortDescription": "abc123", "inputOptions": [ProductViewInputOption], "sku": "abc123", - "externalId": "abc123", + "externalId": "xyz789", "externalIds": [ExternalId], - "url": "xyz789", - "urlKey": "abc123", + "url": "abc123", + "urlKey": "xyz789", "links": [ProductViewLink], - "queryType": "xyz789", + "queryType": "abc123", "visibility": "abc123" } ] @@ -3444,7 +3480,7 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { "data": { "recaptchaFormConfig": { "configurations": ReCaptchaConfiguration, - "is_enabled": true + "is_enabled": false } } } @@ -3536,11 +3572,11 @@ query recaptchaV3Config { "data": { "recaptchaV3Config": { "badge_position": "abc123", - "failure_message": "xyz789", + "failure_message": "abc123", "forms": ["PLACE_ORDER"], "is_enabled": false, - "language_code": "abc123", - "minimum_score": 123.45, + "language_code": "xyz789", + "minimum_score": 987.65, "theme": "abc123", "website_key": "abc123" } @@ -3606,8 +3642,8 @@ query recommendations( ```json { - "cartSkus": ["abc123"], - "category": "abc123", + "cartSkus": ["xyz789"], + "category": "xyz789", "currentSku": "abc123", "currentProduct": CurrentProductInput, "pageType": "CMS", @@ -3774,7 +3810,7 @@ query refineProduct( ```json { "optionIds": ["abc123"], - "sku": "abc123" + "sku": "xyz789" } ``` @@ -3784,23 +3820,23 @@ query refineProduct( { "data": { "refineProduct": { - "addToCartAllowed": true, - "inStock": false, + "addToCartAllowed": false, + "inStock": true, "lowStock": true, "attributes": [ProductViewAttribute], - "description": "abc123", - "id": "4", + "description": "xyz789", + "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", "metaDescription": "xyz789", - "metaKeyword": "abc123", + "metaKeyword": "xyz789", "metaTitle": "xyz789", - "name": "abc123", + "name": "xyz789", "shortDescription": "xyz789", "inputOptions": [ProductViewInputOption], - "sku": "xyz789", - "externalId": "xyz789", + "sku": "abc123", + "externalId": "abc123", "externalIds": [ExternalId], "url": "xyz789", "urlKey": "abc123", @@ -3844,7 +3880,7 @@ query sharedRequisitionList($token: String!) { ##### Variables ```json -{"token": "xyz789"} +{"token": "abc123"} ``` ##### Response @@ -3854,7 +3890,7 @@ query sharedRequisitionList($token: String!) { "data": { "sharedRequisitionList": { "requisition_list": RequisitionList, - "sender_name": "xyz789" + "sender_name": "abc123" } } } @@ -3903,9 +3939,9 @@ query sourceAvailability( ```json { - "skus": ["xyz789"], - "source_codes": ["abc123"], - "only_in_stock": false + "skus": ["abc123"], + "source_codes": ["xyz789"], + "only_in_stock": true } ``` @@ -3943,6 +3979,7 @@ query storeConfig { allow_gift_receipt allow_gift_wrapping_on_order allow_gift_wrapping_on_order_items + allow_guests_to_write_product_reviews allow_items allow_order allow_printed_card @@ -4045,6 +4082,7 @@ query storeConfig { } product_alert_allow_stock product_fixed_product_tax_display_setting + product_reviews_enabled product_url_suffix quickorder_active quote_minimum_amount @@ -4105,153 +4143,155 @@ query storeConfig { "data": { "storeConfig": { "allow_company_registration": false, - "allow_gift_receipt": "abc123", - "allow_gift_wrapping_on_order": "xyz789", + "allow_gift_receipt": "xyz789", + "allow_gift_wrapping_on_order": "abc123", "allow_gift_wrapping_on_order_items": "abc123", + "allow_guests_to_write_product_reviews": "xyz789", "allow_items": "abc123", - "allow_order": "xyz789", - "allow_printed_card": "xyz789", + "allow_order": "abc123", + "allow_printed_card": "abc123", "autocomplete_on_storefront": true, "base_currency_code": "abc123", - "base_link_url": "abc123", + "base_link_url": "xyz789", "base_media_url": "abc123", "base_static_url": "xyz789", "base_url": "abc123", "cart_expires_in_days": 123, - "cart_gift_wrapping": "abc123", + "cart_gift_wrapping": "xyz789", "cart_merge_preference": "xyz789", "cart_printed_card": "xyz789", "cart_summary_display_quantity": 123, - "catalog_default_sort_by": "xyz789", + "catalog_default_sort_by": "abc123", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "category_url_suffix": "xyz789", - "check_money_order_enable_for_specific_countries": false, - "check_money_order_enabled": true, + "check_money_order_enable_for_specific_countries": true, + "check_money_order_enabled": false, "check_money_order_make_check_payable_to": "xyz789", - "check_money_order_max_order_total": "abc123", + "check_money_order_max_order_total": "xyz789", "check_money_order_min_order_total": "abc123", "check_money_order_new_order_status": "xyz789", - "check_money_order_payment_from_specific_countries": "abc123", - "check_money_order_send_check_to": "abc123", + "check_money_order_payment_from_specific_countries": "xyz789", + "check_money_order_send_check_to": "xyz789", "check_money_order_sort_order": 987, "check_money_order_title": "xyz789", - "company_credit_enabled": false, - "company_enabled": false, + "company_credit_enabled": true, + "company_enabled": true, "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "xyz789", "contact_enabled": false, - "countries_with_required_region": "abc123", - "create_account_confirmation": false, - "customer_access_token_lifetime": 123.45, - "default_country": "abc123", + "countries_with_required_region": "xyz789", + "create_account_confirmation": true, + "customer_access_token_lifetime": 987.65, + "default_country": "xyz789", "default_display_currency_code": "abc123", - "display_product_prices_in_catalog": 123, - "display_shipping_prices": 123, - "display_state_if_optional": false, + "display_product_prices_in_catalog": 987, + "display_shipping_prices": 987, + "display_state_if_optional": true, "enable_multiple_wishlists": "xyz789", "fixed_product_taxes_apply_tax_to_fpt": true, "fixed_product_taxes_display_prices_in_emails": 987, - "fixed_product_taxes_display_prices_in_product_lists": 123, - "fixed_product_taxes_display_prices_in_sales_modules": 123, - "fixed_product_taxes_display_prices_on_product_view_page": 123, - "fixed_product_taxes_enable": true, + "fixed_product_taxes_display_prices_in_product_lists": 987, + "fixed_product_taxes_display_prices_in_sales_modules": 987, + "fixed_product_taxes_display_prices_on_product_view_page": 987, + "fixed_product_taxes_enable": false, "fixed_product_taxes_include_fpt_in_subtotal": false, - "graphql_share_customer_group": true, - "grid_per_page": 987, + "graphql_share_customer_group": false, + "grid_per_page": 123, "grid_per_page_values": "xyz789", "grouped_product_image": "ITSELF", "is_checkout_agreements_enabled": false, - "is_default_store": false, - "is_default_store_group": false, + "is_default_store": true, + "is_default_store_group": true, "is_guest_checkout_enabled": true, - "is_negotiable_quote_active": false, - "is_one_page_checkout_enabled": false, + "is_negotiable_quote_active": true, + "is_one_page_checkout_enabled": true, "is_requisition_list_active": "xyz789", "list_mode": "xyz789", - "list_per_page": 123, + "list_per_page": 987, "list_per_page_values": "abc123", "locale": "xyz789", - "magento_reward_general_is_enabled": "abc123", - "magento_reward_general_is_enabled_on_front": "abc123", + "magento_reward_general_is_enabled": "xyz789", + "magento_reward_general_is_enabled_on_front": "xyz789", "magento_reward_general_min_points_balance": "xyz789", - "magento_reward_general_publish_history": "abc123", - "magento_reward_points_invitation_customer": "xyz789", + "magento_reward_general_publish_history": "xyz789", + "magento_reward_points_invitation_customer": "abc123", "magento_reward_points_invitation_customer_limit": "xyz789", "magento_reward_points_invitation_order": "xyz789", - "magento_reward_points_invitation_order_limit": "xyz789", - "magento_reward_points_newsletter": "xyz789", - "magento_reward_points_order": "xyz789", + "magento_reward_points_invitation_order_limit": "abc123", + "magento_reward_points_newsletter": "abc123", + "magento_reward_points_order": "abc123", "magento_reward_points_register": "abc123", - "magento_reward_points_review": "xyz789", - "magento_reward_points_review_limit": "xyz789", - "magento_wishlist_general_is_enabled": "abc123", - "max_items_in_order_summary": 987, + "magento_reward_points_review": "abc123", + "magento_reward_points_review_limit": "abc123", + "magento_wishlist_general_is_enabled": "xyz789", + "max_items_in_order_summary": 123, "maximum_number_of_wishlists": "abc123", - "minicart_display": false, - "minicart_max_items": 987, + "minicart_display": true, + "minicart_max_items": 123, "minimum_password_length": "xyz789", - "newsletter_enabled": false, - "optional_zip_countries": "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_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": true, + "orders_invoices_credit_memos_display_zero_tax": false, "persistent_enabled": false, - "persistent_options_wishlist": true, - "persistent_shopping_cart": true, + "persistent_options_wishlist": false, + "persistent_shopping_cart": false, "printed_card_priceV2": Money, - "product_alert_allow_stock": false, + "product_alert_allow_stock": true, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", + "product_reviews_enabled": "abc123", "product_url_suffix": "abc123", - "quickorder_active": true, + "quickorder_active": false, "quote_minimum_amount": 987.65, - "quote_minimum_amount_message": "abc123", + "quote_minimum_amount_message": "xyz789", "required_character_classes_number": "abc123", "requisition_list_share_link_validity_days": 987, "requisition_list_share_max_recipients": 987, "requisition_list_share_storefront_path": "abc123", - "requisition_list_sharing_enabled": false, - "returns_enabled": "abc123", - "root_category_uid": "4", + "requisition_list_sharing_enabled": true, + "returns_enabled": "xyz789", + "root_category_uid": 4, "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "sales_gift_wrapping": "xyz789", - "sales_printed_card": "abc123", - "secure_base_link_url": "xyz789", - "secure_base_media_url": "xyz789", - "secure_base_static_url": "xyz789", + "sales_printed_card": "xyz789", + "secure_base_link_url": "abc123", + "secure_base_media_url": "abc123", + "secure_base_static_url": "abc123", "secure_base_url": "abc123", - "share_active_segments": true, + "share_active_segments": false, "share_applied_cart_rule": false, "share_customer_accounts_scope": 123, "shopping_assistance_checkbox_title": "xyz789", "shopping_assistance_checkbox_tooltip": "xyz789", "shopping_assistance_enabled": false, - "shopping_cart_display_full_summary": false, + "shopping_cart_display_full_summary": true, "shopping_cart_display_grand_total": false, "shopping_cart_display_price": 123, "shopping_cart_display_shipping": 987, "shopping_cart_display_subtotal": 123, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", - "shopping_cart_display_zero_tax": false, - "store_code": "4", - "store_group_code": "4", + "shopping_cart_display_zero_tax": true, + "store_code": 4, + "store_group_code": 4, "store_group_name": "xyz789", "store_name": "xyz789", "store_sort_order": 987, - "timezone": "abc123", - "title_separator": "xyz789", + "timezone": "xyz789", + "title_separator": "abc123", "use_store_in_url": false, - "website_code": "4", + "website_code": 4, "website_name": "abc123", - "weight_unit": "xyz789", + "weight_unit": "abc123", "zero_subtotal_enable_for_specific_countries": false, - "zero_subtotal_enabled": false, - "zero_subtotal_new_order_status": "abc123", - "zero_subtotal_payment_action": "xyz789", + "zero_subtotal_enabled": true, + "zero_subtotal_new_order_status": "xyz789", + "zero_subtotal_payment_action": "abc123", "zero_subtotal_payment_from_specific_countries": "abc123", "zero_subtotal_sort_order": 123, "zero_subtotal_title": "abc123" @@ -4305,7 +4345,7 @@ query variants( ```json { "sku": "xyz789", - "optionIds": ["abc123"], + "optionIds": ["xyz789"], "pageSize": 987, "cursor": "xyz789" } @@ -4318,7 +4358,7 @@ query variants( "data": { "variants": { "variants": [ProductViewVariant], - "cursor": "abc123" + "cursor": "xyz789" } } } diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md b/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md index 3b8bd5daf..cb35b3bd8 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md @@ -13,7 +13,7 @@ Specifies the quote template id to accept quote template. #### Example ```json -{"template_id": "4"} +{"template_id": 4} ``` @@ -94,9 +94,9 @@ Defines a new registrant. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "email": "xyz789", - "firstname": "xyz789", - "lastname": "xyz789" + "email": "abc123", + "firstname": "abc123", + "lastname": "abc123" } ``` @@ -156,7 +156,7 @@ Contains products to add to an existing compare list. #### Example ```json -{"products": [4], "uid": "4"} +{"products": [4], "uid": 4} ``` @@ -302,7 +302,7 @@ Contains details about why an attempt to add items to the requistion list failed ```json { - "message": "xyz789", + "message": "abc123", "type": "OUT_OF_STOCK" } ``` @@ -348,7 +348,7 @@ Output of the request to add items in a requisition list to the cart. AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": true + "status": false } ``` @@ -368,10 +368,7 @@ Defines a return comment. #### Example ```json -{ - "comment_text": "abc123", - "return_uid": "4" -} +{"comment_text": "abc123", "return_uid": 4} ``` @@ -410,8 +407,8 @@ Defines tracking information to be added to the return. ```json { - "carrier_uid": "4", - "return_uid": 4, + "carrier_uid": 4, + "return_uid": "4", "tracking_number": "abc123" } ``` @@ -459,7 +456,7 @@ Contains the resultant wish list and any error information. "add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": true, + "status": false, "wishlist": Wishlist } ``` @@ -483,7 +480,7 @@ A single admin assistance action performed on behalf of the customer. ```json { "action": "abc123", - "date": "abc123", + "date": "xyz789", "details": "abc123" } ``` @@ -508,7 +505,7 @@ Paginated admin assistance actions for the customer. { "items": [AdminAssistanceAction], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -531,9 +528,9 @@ A bucket that contains information for each filterable option ```json { - "attribute": "xyz789", + "attribute": "abc123", "buckets": [Bucket], - "title": "xyz789", + "title": "abc123", "type": "INTELLIGENT" } ``` @@ -580,9 +577,9 @@ Identifies the data type of the aggregation ```json { "button_styles": ButtonStyles, - "code": "abc123", + "code": "xyz789", "is_visible": true, - "payment_intent": "xyz789", + "payment_intent": "abc123", "payment_source": "abc123", "sdk_params": [SDKParams], "sort_order": "xyz789", @@ -608,9 +605,9 @@ Apple Pay inputs ```json { - "payment_source": "xyz789", + "payment_source": "abc123", "payments_order_id": "xyz789", - "paypal_order_id": "xyz789" + "paypal_order_id": "abc123" } ``` @@ -629,7 +626,7 @@ Contains the applied coupon code. #### Example ```json -{"code": "xyz789"} +{"code": "abc123"} ``` @@ -652,7 +649,7 @@ Contains an applied gift card with applied and remaining balance. ```json { "applied_balance": Money, - "code": "abc123", + "code": "xyz789", "current_balance": Money, "expiration_date": "xyz789" } @@ -677,8 +674,8 @@ The rule that was applied to this product ```json { "action_type": "BOOST", - "rule_id": "abc123", - "rule_name": "abc123" + "rule_id": "xyz789", + "rule_name": "xyz789" } ``` @@ -722,7 +719,7 @@ Contains the applied and current balances. { "applied_balance": Money, "current_balance": Money, - "enabled": true + "enabled": false } ``` @@ -744,7 +741,7 @@ Specifies the coupon code to apply to the cart. ```json { "cart_id": "xyz789", - "coupon_code": "xyz789" + "coupon_code": "abc123" } ``` @@ -804,7 +801,7 @@ Apply coupons to the cart. ```json { "cart_id": "abc123", - "coupon_codes": ["xyz789"], + "coupon_codes": ["abc123"], "type": "APPEND" } ``` @@ -826,8 +823,8 @@ Defines the input required to run the `applyGiftCardToCart` mutation. ```json { - "cart_id": "xyz789", - "gift_card_code": "abc123" + "cart_id": "abc123", + "gift_card_code": "xyz789" } ``` @@ -867,7 +864,7 @@ Contains applied gift cards with gift card code and amount. ```json { "applied_balance": Money, - "code": "abc123" + "code": "xyz789" } ``` @@ -904,7 +901,7 @@ Defines the input required to run the `applyStoreCreditToCart` mutation. #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -941,7 +938,7 @@ AreaInput defines the parameters which will be used for filter by specified loca #### Example ```json -{"radius": 987, "search_term": "xyz789"} +{"radius": 123, "search_term": "xyz789"} ``` @@ -966,11 +963,11 @@ Contains information about an asset image. ```json { "asset_image": ProductMediaGalleryEntriesAssetImage, - "disabled": true, + "disabled": false, "label": "xyz789", - "position": 123, - "types": ["abc123"], - "url": "abc123" + "position": 987, + "types": ["xyz789"], + "url": "xyz789" } ``` @@ -996,11 +993,11 @@ Contains information about an asset video. ```json { "asset_video": ProductMediaGalleryEntriesAssetVideo, - "disabled": false, - "label": "abc123", + "disabled": true, + "label": "xyz789", "position": 987, "types": ["xyz789"], - "url": "abc123" + "url": "xyz789" } ``` @@ -1020,7 +1017,10 @@ Defines the input schema for assigning a child company to a parent company. #### Example ```json -{"child_company_id": 4, "parent_company_id": 4} +{ + "child_company_id": "4", + "parent_company_id": 4 +} ``` @@ -1057,7 +1057,7 @@ Contains the results of the request to assign a compare list. #### Example ```json -{"compare_list": CompareList, "result": false} +{"compare_list": CompareList, "result": true} ``` @@ -1099,10 +1099,10 @@ List of all entity types. Populated by the modules introducing EAV entities. ```json { - "attribute_type": "abc123", + "attribute_type": "xyz789", "code": 4, "url": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -1137,14 +1137,14 @@ An input object that specifies the filters used for attributes. "is_filterable": false, "is_filterable_in_search": true, "is_html_allowed_on_front": false, - "is_searchable": false, + "is_searchable": true, "is_used_for_customer_segment": true, "is_used_for_price_rules": false, - "is_used_for_promo_rules": false, + "is_used_for_promo_rules": true, "is_visible_in_advanced_search": false, - "is_visible_on_front": false, - "is_wysiwyg_enabled": false, - "used_in_product_listing": true + "is_visible_on_front": true, + "is_wysiwyg_enabled": true, + "used_in_product_listing": false } ``` @@ -1198,10 +1198,10 @@ EAV attribute frontend input types. ```json { - "attribute_type": "abc123", - "code": "4", - "url": "xyz789", - "value": "xyz789" + "attribute_type": "xyz789", + "code": 4, + "url": "abc123", + "value": "abc123" } ``` @@ -1223,7 +1223,7 @@ Defines the attribute characteristics to search for the `attribute_code` and `en ```json { "attribute_code": "abc123", - "entity_type": "xyz789" + "entity_type": "abc123" } ``` @@ -1242,7 +1242,7 @@ Specifies selected option for a select or multiselect attribute value. #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -1269,14 +1269,14 @@ Base EAV implementation of CustomAttributeMetadataInterface. ```json { - "code": 4, + "code": "4", "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "is_required": false, - "is_unique": false, - "label": "xyz789", + "is_unique": true, + "label": "abc123", "options": [CustomAttributeOptionInterface] } ``` @@ -1366,7 +1366,7 @@ Base EAV implementation of CustomAttributeOptionInterface. { "is_default": true, "label": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -1386,7 +1386,7 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { "label": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -1412,7 +1412,7 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { "label": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -1478,9 +1478,9 @@ Specifies the value for attribute. ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "selected_options": [AttributeInputSelectedOption], - "value": "abc123" + "value": "xyz789" } ``` @@ -1510,7 +1510,7 @@ Specifies the value for attribute. ```json { - "attribute_type": "abc123", + "attribute_type": "xyz789", "code": "4" } ``` @@ -1591,7 +1591,7 @@ Defines the code and symbol of a currency that can be used for purchase orders. #### Example ```json -{"code": "AFN", "symbol": "abc123"} +{"code": "AFN", "symbol": "xyz789"} ``` @@ -1614,11 +1614,11 @@ A free-gift cart price rule that has not yet had a gift added because the custom ```json { - "available_skus": ["xyz789"], - "gift_qty": 123, + "available_skus": ["abc123"], + "gift_qty": 987, "products": [ProductInterface], "rule_id": 987, - "rule_label": "xyz789" + "rule_label": "abc123" } ``` @@ -1641,10 +1641,10 @@ Describes a payment method that the shopper can use to pay for the order. ```json { - "code": "xyz789", + "code": "abc123", "is_deferred": false, "oope_payment_method_config": OopePaymentMethodConfig, - "title": "xyz789" + "title": "abc123" } ``` @@ -1677,9 +1677,9 @@ Contains details about the possible shipping methods and carriers. "amount": Money, "available": false, "carrier_code": "xyz789", - "carrier_title": "xyz789", - "error_message": "abc123", - "method_code": "xyz789", + "carrier_title": "abc123", + "error_message": "xyz789", + "method_code": "abc123", "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money @@ -1726,11 +1726,11 @@ Defines the billing address. ```json { "address": CartAddressInput, - "company_address_id": "4", + "company_address_id": 4, "customer_address_id": 987, "customer_address_uid": 4, "same_as_shipping": true, - "use_for_shipping": false + "use_for_shipping": true } ``` @@ -1755,9 +1755,9 @@ The billing address information ```json { - "address_line_1": "xyz789", + "address_line_1": "abc123", "address_line_2": "xyz789", - "city": "xyz789", + "city": "abc123", "country_code": "abc123", "postal_code": "xyz789", "region": "abc123" @@ -1798,16 +1798,16 @@ Contains details about the billing address. ```json { - "city": "abc123", + "city": "xyz789", "company": "xyz789", - "company_address_id": 4, + "company_address_id": "4", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": 4, "fax": "abc123", - "firstname": "xyz789", + "firstname": "abc123", "id": 987, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", "postcode": "abc123", "prefix": "abc123", @@ -1816,7 +1816,7 @@ Contains details about the billing address. "suffix": "xyz789", "telephone": "abc123", "uid": 4, - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -1854,9 +1854,9 @@ Contains details about an individual category that comprises a breadcrumb. { "category_level": 123, "category_name": "xyz789", - "category_uid": 4, + "category_uid": "4", "category_url_key": "abc123", - "category_url_path": "xyz789" + "category_url_path": "abc123" } ``` @@ -1938,17 +1938,17 @@ An implementation for bundle product cart items. "is_available": true, "is_free_gift": true, "is_salable": false, - "max_qty": 123.45, - "min_qty": 987.65, + "max_qty": 987.65, + "min_qty": 123.45, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], - "not_available_message": "abc123", + "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 } ``` @@ -1983,8 +1983,8 @@ Defines bundle product options for `CreditMemoItemInterface`. "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 987.65 + "product_sku": "xyz789", + "quantity_refunded": 123.45 } ``` @@ -2019,8 +2019,8 @@ Defines bundle product options for `InvoiceItemInterface`. "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 987.65 + "product_sku": "xyz789", + "quantity_invoiced": 123.45 } ``` @@ -2048,12 +2048,12 @@ Defines an individual item within a bundle product. ```json { "options": [BundleItemOption], - "position": 123, + "position": 987, "price_range": PriceRange, "required": true, - "sku": "xyz789", - "title": "abc123", - "type": "abc123", + "sku": "abc123", + "title": "xyz789", + "type": "xyz789", "uid": "4" } ``` @@ -2082,14 +2082,14 @@ Defines the characteristics that comprise a specific bundle item and its options ```json { - "can_change_quantity": false, + "can_change_quantity": true, "is_default": true, "label": "xyz789", "position": 123, "price": 987.65, "price_type": "FIXED", "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "uid": 4 } ``` @@ -2140,27 +2140,27 @@ Defines bundle product options for `OrderItemInterface`. "discounts": [Discount], "eligible_for_return": false, "entered_options": [OrderItemOption], - "free_gift_label": "abc123", + "free_gift_label": "xyz789", "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "parent_sku": "abc123", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "product_type": "xyz789", - "product_url_key": "abc123", + "product_type": "abc123", + "product_url_key": "xyz789", "quantity_canceled": 123.45, - "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, + "quantity_invoiced": 987.65, + "quantity_ordered": 987.65, "quantity_refunded": 987.65, - "quantity_return_requested": 987.65, - "quantity_returned": 987.65, + "quantity_return_requested": 123.45, + "quantity_returned": 123.45, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -2208,7 +2208,10 @@ Defines basic features of a bundle product and contains multiple BundleItems. | `price_view` - [`PriceViewEnum`](/reference/graphql/saas/types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | | `product_links` - [`[ProductLinksInterface]`](/reference/graphql/saas/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | | `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Quantity of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The average of all the ratings given to the product. | | `related_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `review_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/saas/types-k-p.md#productreviews) | The list of products reviews. | | `ship_bundle_items` - [`ShipBundleItemsEnum`](/reference/graphql/saas/types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | | `short_description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | | `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | @@ -2234,24 +2237,24 @@ Defines basic features of a bundle product and contains multiple BundleItems. "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "dynamic_price": true, - "dynamic_sku": false, + "dynamic_sku": true, "dynamic_weight": false, "gift_message_available": true, - "gift_wrapping_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "abc123", + "is_returnable": "xyz789", "items": [BundleItem], "manufacturer": 123, "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], - "meta_description": "abc123", + "meta_description": "xyz789", "meta_keyword": "abc123", - "meta_title": "xyz789", - "min_sale_qty": 987.65, - "name": "abc123", + "meta_title": "abc123", + "min_sale_qty": 123.45, + "name": "xyz789", "new_from_date": "abc123", - "new_to_date": "abc123", + "new_to_date": "xyz789", "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "xyz789", @@ -2261,19 +2264,22 @@ Defines basic features of a bundle product and contains multiple BundleItems. "price_view": "PRICE_RANGE", "product_links": [ProductLinksInterface], "quantity": 987.65, + "rating_summary": 123.45, "related_products": [ProductInterface], + "review_count": 123, + "reviews": ProductReviews, "ship_bundle_items": "TOGETHER", "short_description": ComplexTextValue, "sku": "abc123", "small_image": ProductImage, - "special_price": 987.65, + "special_price": 123.45, "special_to_date": "abc123", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, "uid": "4", "upsell_products": [ProductInterface], - "url_key": "abc123", + "url_key": "xyz789", "weight": 987.65 } ``` @@ -2302,8 +2308,8 @@ Contains details about bundle products added to a requisition list. "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, - "sku": "xyz789", + "quantity": 987.65, + "sku": "abc123", "uid": 4 } ``` @@ -2331,12 +2337,12 @@ Defines bundle product options for `ShipmentItemInterface`. ```json { "bundle_options": [ItemSelectedBundleOption], - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 987.65 + "product_sku": "abc123", + "quantity_shipped": 123.45 } ``` @@ -2362,13 +2368,13 @@ Defines bundle product options for `WishlistItemInterface`. ```json { - "added_at": "xyz789", + "added_at": "abc123", "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": 4, + "description": "abc123", + "id": "4", "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -2392,13 +2398,13 @@ Defines bundle product options for `WishlistItemInterface`. ```json { - "color": "xyz789", - "height": 123, - "label": "abc123", - "layout": "abc123", + "color": "abc123", + "height": 987, + "label": "xyz789", + "layout": "xyz789", "shape": "abc123", "tagline": false, - "use_default_height": true + "use_default_height": false } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md b/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md index 371417ebf..040e4cf58 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md @@ -16,7 +16,7 @@ Specifies the quote template id of the quote template to cancel ```json { "cancellation_comment": "xyz789", - "template_id": "4" + "template_id": 4 } ``` @@ -36,7 +36,7 @@ Specifies the quote template id of the quote template to cancel ```json { "code": "ORDER_CANCELLATION_DISABLED", - "message": "xyz789" + "message": "abc123" } ``` @@ -77,10 +77,7 @@ Defines the order to cancel. #### Example ```json -{ - "order_id": "4", - "reason": "xyz789" -} +{"order_id": 4, "reason": "abc123"} ``` @@ -101,7 +98,7 @@ Contains the updated customer order and error message if any. ```json { - "error": "abc123", + "error": "xyz789", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -120,7 +117,7 @@ Contains the updated customer order and error message if any. #### Example ```json -{"description": "xyz789"} +{"description": "abc123"} ``` @@ -144,9 +141,9 @@ Contains the updated customer order and error message if any. { "authentication_result": AuthenticationResult, "bin_details": CardBin, - "card_expiry_month": "xyz789", - "card_expiry_year": "xyz789", - "last_digits": "abc123", + "card_expiry_month": "abc123", + "card_expiry_year": "abc123", + "last_digits": "xyz789", "name": "abc123" } ``` @@ -207,7 +204,7 @@ The card payment source information ```json { - "brand": "abc123", + "brand": "xyz789", "expiry": "abc123", "last_digits": "xyz789" } @@ -294,7 +291,7 @@ Contains details the country in a billing or shipping address. ```json { - "code": "xyz789", + "code": "abc123", "label": "xyz789" } ``` @@ -332,22 +329,22 @@ Defines the billing or shipping address to be applied to the cart. ```json { "city": "xyz789", - "company": "xyz789", - "country_code": "xyz789", + "company": "abc123", + "country_code": "abc123", "custom_attributes": [AttributeValueInput], "fax": "abc123", - "firstname": "abc123", + "firstname": "xyz789", "lastname": "xyz789", "middlename": "xyz789", "postcode": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "region": "xyz789", - "region_id": 123, + "region_id": 987, "save_in_address_book": true, "street": ["abc123"], "suffix": "xyz789", "telephone": "abc123", - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -398,17 +395,17 @@ Defines the billing or shipping address to be applied to the cart. "customer_address_uid": "4", "fax": "xyz789", "firstname": "abc123", - "id": 123, - "lastname": "xyz789", + "id": 987, + "lastname": "abc123", "middlename": "xyz789", - "postcode": "abc123", + "postcode": "xyz789", "prefix": "xyz789", "region": CartAddressRegion, - "street": ["abc123"], - "suffix": "xyz789", + "street": ["xyz789"], + "suffix": "abc123", "telephone": "abc123", "uid": "4", - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -453,7 +450,7 @@ Defines a cart custom attributes. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "custom_attributes": [CustomAttributeInput] } ``` @@ -493,8 +490,8 @@ Defines a cart item custom attributes. ```json { - "cart_id": "xyz789", - "cart_item_id": "xyz789", + "cart_id": "abc123", + "cart_item_id": "abc123", "custom_attributes": [CustomAttributeInput] } ``` @@ -555,7 +552,7 @@ Defines an item to be added to the cart. ```json { "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", + "parent_sku": "abc123", "quantity": 123.45, "selected_options": [4], "sku": "xyz789" @@ -610,20 +607,20 @@ An interface for products in a cart. "custom_attributes": [CustomAttribute], "discount": [Discount], "errors": [CartItemError], - "is_available": false, + "is_available": true, "is_free_gift": true, - "is_salable": true, + "is_salable": false, "max_qty": 987.65, "min_qty": 987.65, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], - "not_available_message": "xyz789", + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, "quantity": 123.45, - "uid": 4 + "uid": "4" } ``` @@ -711,7 +708,7 @@ A single item to be updated. ```json { - "cart_item_uid": "4", + "cart_item_uid": 4, "customizable_options": [CustomizableOptionInput], "gift_message": GiftMessageInput, "gift_wrapping_id": "4", @@ -737,7 +734,7 @@ A single item to be updated. { "items": [CartItemInterface], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -811,7 +808,7 @@ Contains tax information about an item in the cart. ```json { "amount": Money, - "label": "abc123" + "label": "xyz789" } ``` @@ -921,7 +918,7 @@ Swatch attribute metadata. { "apply_to": ["SIMPLE"], "code": 4, - "default_value": "xyz789", + "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", "frontend_class": "abc123", "frontend_input": "BOOLEAN", @@ -929,18 +926,18 @@ Swatch attribute metadata. "is_filterable": true, "is_filterable_in_search": true, "is_html_allowed_on_front": true, - "is_required": true, + "is_required": false, "is_searchable": false, - "is_unique": true, + "is_unique": false, "is_used_for_price_rules": false, "is_used_for_promo_rules": false, "is_visible_in_advanced_search": true, - "is_visible_on_front": true, + "is_visible_on_front": false, "is_wysiwyg_enabled": false, - "label": "abc123", + "label": "xyz789", "options": [CustomAttributeOptionInterface], "swatch_input_type": "BOOLEAN", - "update_product_preview_image": true, + "update_product_preview_image": false, "use_product_image_for_swatch": false, "used_in_product_listing": false } @@ -965,7 +962,7 @@ New category bucket for federation ```json { - "count": 987, + "count": 123, "id": "4", "path": "abc123", "title": "abc123" @@ -1040,31 +1037,31 @@ Contains the full set of attributes that can be returned in a category search. ```json { - "available_sort_by": ["abc123"], + "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", + "canonical_url": "abc123", "children_count": "abc123", - "custom_layout_update_file": "xyz789", - "default_sort_by": "abc123", + "custom_layout_update_file": "abc123", + "default_sort_by": "xyz789", "description": "abc123", "display_mode": "xyz789", - "filter_price_range": 987.65, + "filter_price_range": 123.45, "image": "xyz789", "include_in_menu": 987, "is_anchor": 987, - "landing_page": 987, - "level": 123, + "landing_page": 123, + "level": 987, "meta_description": "xyz789", - "meta_keywords": "xyz789", + "meta_keywords": "abc123", "meta_title": "xyz789", - "name": "xyz789", - "path": "abc123", - "path_in_store": "xyz789", + "name": "abc123", + "path": "xyz789", + "path_in_store": "abc123", "position": 123, "product_count": 987, "uid": "4", - "url_key": "xyz789", - "url_path": "xyz789" + "url_key": "abc123", + "url_path": "abc123" } ``` @@ -1111,28 +1108,28 @@ Contains the hierarchy of categories. "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], "canonical_url": "xyz789", - "children_count": "xyz789", + "children_count": "abc123", "custom_layout_update_file": "xyz789", "default_sort_by": "xyz789", "description": "abc123", "display_mode": "xyz789", - "filter_price_range": 987.65, + "filter_price_range": 123.45, "image": "xyz789", "include_in_menu": 987, - "is_anchor": 987, + "is_anchor": 123, "landing_page": 987, "level": 123, "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "xyz789", - "name": "xyz789", - "path": "abc123", + "meta_keywords": "xyz789", + "meta_title": "abc123", + "name": "abc123", + "path": "xyz789", "path_in_store": "abc123", "position": 123, - "product_count": 123, - "uid": "4", - "url_key": "xyz789", - "url_path": "xyz789" + "product_count": 987, + "uid": 4, + "url_key": "abc123", + "url_path": "abc123" } ``` @@ -1168,15 +1165,15 @@ Represents a category. Contains information about a category, including the cate "availableSortBy": ["xyz789"], "children": ["abc123"], "defaultSortBy": "abc123", - "id": "4", + "id": 4, "level": 987, "name": "xyz789", "parentId": "xyz789", - "position": 987, + "position": 123, "path": "xyz789", - "roles": ["abc123"], + "roles": ["xyz789"], "urlKey": "xyz789", - "urlPath": "abc123", + "urlPath": "xyz789", "count": 987, "title": "abc123" } @@ -1213,14 +1210,14 @@ Base interface defining essential category fields shared across all category vie ```json { "availableSortBy": ["abc123"], - "defaultSortBy": "abc123", + "defaultSortBy": "xyz789", "id": "4", - "level": 123, - "name": "abc123", - "path": "abc123", + "level": 987, + "name": "xyz789", + "path": "xyz789", "roles": ["abc123"], - "urlKey": "xyz789", - "urlPath": "abc123" + "urlKey": "abc123", + "urlPath": "xyz789" } ``` @@ -1247,12 +1244,12 @@ Defines details about an individual checkout agreement. ```json { "agreement_id": 987, - "checkbox_text": "xyz789", + "checkbox_text": "abc123", "content": "xyz789", - "content_height": "abc123", - "is_html": true, + "content_height": "xyz789", + "is_html": false, "mode": "AUTO", - "name": "abc123" + "name": "xyz789" } ``` @@ -1295,7 +1292,7 @@ An error encountered while adding an item to the cart. { "code": "REORDER_NOT_AVAILABLE", "message": "xyz789", - "path": ["xyz789"] + "path": ["abc123"] } ``` @@ -1335,7 +1332,7 @@ Contains details about errors encountered when a customer clear cart. #### Example ```json -{"message": "abc123", "type": "NOT_FOUND"} +{"message": "xyz789", "type": "NOT_FOUND"} ``` @@ -1372,7 +1369,7 @@ Assigns a specific `cart_id` to the empty cart. #### Example ```json -{"uid": "4"} +{"uid": 4} ``` @@ -1413,7 +1410,7 @@ Output of the request to clear the customer cart. #### Example ```json -{"cart": Cart, "status": false} +{"cart": Cart, "status": true} ``` @@ -1452,7 +1449,7 @@ Contains details about a failed close operation on a negotiable quote. ```json { "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -1488,7 +1485,7 @@ Defines the negotiable quotes to mark as closed. #### Example ```json -{"quote_uids": [4]} +{"quote_uids": ["4"]} ``` @@ -1530,7 +1527,7 @@ Contains the closed negotiable quotes and other negotiable quotes the company us #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -1548,7 +1545,7 @@ Commerce Optimizer entities #### Example ```json -{"priceBookId": 4} +{"priceBookId": "4"} ``` @@ -1643,13 +1640,13 @@ Contains the output schema for a company. "custom_attributes": [CustomAttribute], "default_billing_address": CompanyAddress, "default_shipping_address": CompanyAddress, - "email": "abc123", + "email": "xyz789", "id": "4", "legal_address": CompanyLegalAddress, "legal_name": "xyz789", - "name": "abc123", + "name": "xyz789", "payment_methods": ["xyz789"], - "reseller_id": "abc123", + "reseller_id": "xyz789", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -1658,7 +1655,7 @@ Contains the output schema for a company. "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } ``` @@ -1682,8 +1679,8 @@ Contains details about the access control list settings of a resource. ```json { "children": [CompanyAclResource], - "id": 4, - "sort_order": 987, + "id": "4", + "sort_order": 123, "text": "abc123" } ``` @@ -1730,17 +1727,17 @@ Contains details about the access control list settings of a resource. "country_code": "AF", "custom_attributes": [AttributeValueInterface], "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", - "firstname": "abc123", - "id": 4, - "is_default": true, + "fax": "abc123", + "firstname": "xyz789", + "id": "4", + "is_default": false, "lastname": "abc123", "middlename": "xyz789", "nickname": "xyz789", - "postcode": "xyz789", - "prefix": "xyz789", + "postcode": "abc123", + "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 987, + "region_id": 123, "street": ["abc123"], "suffix": "abc123", "telephone": "abc123", @@ -1786,18 +1783,18 @@ Defines the input schema for creating a company address. "company": "abc123", "country_code": "AF", "custom_attributes": [AttributeValueInput], - "fax": "abc123", - "firstname": "abc123", + "fax": "xyz789", + "firstname": "xyz789", "is_default": true, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "abc123", - "nickname": "abc123", - "postcode": "abc123", + "nickname": "xyz789", + "postcode": "xyz789", "prefix": "abc123", "region": CustomerAddressRegionInput, "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", + "suffix": "abc123", + "telephone": "xyz789", "vat_id": "abc123" } ``` @@ -1851,23 +1848,23 @@ Defines the input schema for updating a company address. The address type cannot ```json { - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "country_code": "AF", "custom_attributes": [AttributeValueInput], "fax": "xyz789", - "firstname": "abc123", - "is_default": false, - "lastname": "xyz789", + "firstname": "xyz789", + "is_default": true, + "lastname": "abc123", "middlename": "abc123", - "nickname": "abc123", + "nickname": "xyz789", "postcode": "abc123", "prefix": "abc123", "region": CustomerAddressRegionInput, "street": ["xyz789"], - "suffix": "xyz789", + "suffix": "abc123", "telephone": "xyz789", - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -1891,7 +1888,7 @@ Contains a paginated list of company addresses. { "items": [CompanyAddress], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -1919,10 +1916,10 @@ Defines the input schema for creating a company administrator. { "custom_attributes": [AttributeValueInput], "email": "abc123", - "firstname": "xyz789", - "gender": 123, - "job_title": "xyz789", - "lastname": "abc123", + "firstname": "abc123", + "gender": 987, + "job_title": "abc123", + "lastname": "xyz789", "telephone": "xyz789" } ``` @@ -1969,9 +1966,9 @@ The minimal required information to identify and display the company. ```json { - "id": "4", + "id": 4, "is_admin": true, - "legal_name": "xyz789", + "legal_name": "abc123", "name": "abc123", "status": "PENDING" } @@ -2025,7 +2022,7 @@ Defines the input schema for creating a new company. "company_email": "abc123", "company_name": "abc123", "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "xyz789", + "legal_name": "abc123", "reseller_id": "xyz789", "vat_tax_id": "abc123" } @@ -2052,7 +2049,7 @@ Contains company credit balances and limits. { "available_credit": Money, "credit_limit": Money, - "exceed_limit": true, + "exceed_limit": false, "outstanding_balance": Money } ``` @@ -2077,7 +2074,7 @@ Contains details about prior company credit operations. { "items": [CompanyCreditOperation], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -2101,7 +2098,7 @@ Defines a filter for narrowing the results of a credit history search. { "custom_reference_number": "abc123", "operation_type": "ALLOCATION", - "updated_by": "xyz789" + "updated_by": "abc123" } ``` @@ -2128,7 +2125,7 @@ Contains details about a single company credit operation. { "amount": Money, "balance": CompanyCredit, - "custom_reference_number": "xyz789", + "custom_reference_number": "abc123", "date": "abc123", "type": "ALLOCATION", "updated_by": CompanyCreditOperationUser @@ -2172,7 +2169,7 @@ Defines the administrator or company user that submitted a company credit operat #### Example ```json -{"name": "xyz789", "type": "CUSTOMER"} +{"name": "abc123", "type": "CUSTOMER"} ``` @@ -2233,7 +2230,7 @@ Defines the input schema for accepting the company invitation. ```json { "code": "abc123", - "role_id": 4, + "role_id": "4", "user": CompanyInvitationUserInput } ``` @@ -2278,9 +2275,9 @@ Company user attributes in the invitation. { "company_id": 4, "customer_id": "4", - "job_title": "abc123", + "job_title": "xyz789", "status": "ACTIVE", - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -2305,11 +2302,11 @@ Contains details about the address where the company is registered to conduct bu ```json { - "city": "xyz789", + "city": "abc123", "country_code": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegion, - "street": ["xyz789"], + "street": ["abc123"], "telephone": "xyz789" } ``` @@ -2337,10 +2334,10 @@ Defines the input schema for defining a company's legal address. { "city": "abc123", "country_id": "AF", - "postcode": "abc123", + "postcode": "xyz789", "region": CustomerAddressRegionInput, - "street": ["abc123"], - "telephone": "abc123" + "street": ["xyz789"], + "telephone": "xyz789" } ``` @@ -2365,12 +2362,12 @@ Defines the input schema for updating a company's legal address. ```json { - "city": "abc123", + "city": "xyz789", "country_id": "AF", "postcode": "abc123", "region": CustomerAddressRegionInput, - "street": ["xyz789"], - "telephone": "abc123" + "street": ["abc123"], + "telephone": "xyz789" } ``` @@ -2396,7 +2393,7 @@ Contails details about a single role. "id": 4, "name": "xyz789", "permissions": [CompanyAclResource], - "users_count": 987 + "users_count": 123 } ``` @@ -2442,7 +2439,7 @@ Defines the input schema for updating a company role. { "id": "4", "name": "abc123", - "permissions": ["abc123"] + "permissions": ["xyz789"] } ``` @@ -2489,8 +2486,8 @@ Contains details about a company sales representative. ```json { "email": "abc123", - "firstname": "abc123", - "lastname": "abc123" + "firstname": "xyz789", + "lastname": "xyz789" } ``` @@ -2612,8 +2609,8 @@ Describes a company team. ```json { - "description": "xyz789", - "id": "4", + "description": "abc123", + "id": 4, "name": "abc123", "structure_id": "4" } @@ -2638,8 +2635,8 @@ Defines the input schema for creating a company team. ```json { "description": "xyz789", - "name": "abc123", - "target_id": "4" + "name": "xyz789", + "target_id": 4 } ``` @@ -2689,7 +2686,7 @@ Defines the input schema for updating a company. ```json { "company_email": "abc123", - "company_name": "abc123", + "company_name": "xyz789", "legal_address": CompanyLegalAddressUpdateInput, "legal_name": "abc123", "reseller_id": "abc123", @@ -2722,12 +2719,12 @@ Defines the input schema for creating a company user. { "email": "xyz789", "firstname": "xyz789", - "job_title": "abc123", - "lastname": "xyz789", - "role_id": "4", + "job_title": "xyz789", + "lastname": "abc123", + "role_id": 4, "status": "ACTIVE", - "target_id": "4", - "telephone": "xyz789" + "target_id": 4, + "telephone": "abc123" } ``` @@ -2773,14 +2770,14 @@ Defines the input schema for updating a company user. ```json { - "email": "xyz789", - "firstname": "xyz789", + "email": "abc123", + "firstname": "abc123", "id": 4, "job_title": "abc123", "lastname": "xyz789", "role_id": 4, "status": "ACTIVE", - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -2868,7 +2865,7 @@ Defines an object used to iterate through items for product comparisons. { "attributes": [ProductAttribute], "product": ProductInterface, - "uid": "4" + "uid": 4 } ``` @@ -2892,7 +2889,7 @@ Contains iterable information such as the array of items, the count, and attribu ```json { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], "uid": "4" } @@ -2915,7 +2912,7 @@ Update the quote and complete the order ```json { - "cartId": "xyz789", + "cartId": "abc123", "id": "xyz789" } ``` @@ -2961,8 +2958,8 @@ Represents all product types, except simple products. Complex product prices are ```json { "addToCartAllowed": true, - "inStock": true, - "lowStock": false, + "inStock": false, + "lowStock": true, "attributes": [ProductViewAttribute], "description": "abc123", "id": "4", @@ -2970,20 +2967,20 @@ Represents all product types, except simple products. Complex product prices are "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", "metaDescription": "xyz789", - "metaKeyword": "abc123", - "metaTitle": "abc123", - "name": "xyz789", + "metaKeyword": "xyz789", + "metaTitle": "xyz789", + "name": "abc123", "inputOptions": [ProductViewInputOption], "options": [ProductViewOption], "priceRange": ProductViewPriceRange, - "shortDescription": "abc123", - "sku": "xyz789", + "shortDescription": "xyz789", + "sku": "abc123", "externalId": "abc123", "externalIds": [ExternalId], "url": "abc123", "urlKey": "abc123", "links": [ProductViewLink], - "queryType": "abc123", + "queryType": "xyz789", "visibility": "xyz789" } ``` @@ -3046,9 +3043,9 @@ Contains details about a configurable product attribute option. ```json { "code": "abc123", - "label": "abc123", - "uid": "4", - "value_index": 123 + "label": "xyz789", + "uid": 4, + "value_index": 987 } ``` @@ -3092,7 +3089,7 @@ An implementation for configurable product cart items. ```json { "available_gift_wrapping": [GiftWrapping], - "backorder_message": "xyz789", + "backorder_message": "abc123", "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "custom_attributes": [CustomAttribute], @@ -3103,9 +3100,9 @@ An implementation for configurable product cart items. "gift_wrapping": GiftWrapping, "is_available": false, "is_free_gift": true, - "is_salable": false, - "max_qty": 123.45, - "min_qty": 123.45, + "is_salable": true, + "max_qty": 987.65, + "min_qty": 987.65, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], "not_available_message": "xyz789", @@ -3113,8 +3110,8 @@ An implementation for configurable product cart items. "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "quantity": 123.45, + "uid": 4 } ``` @@ -3135,8 +3132,8 @@ Describes configurable options that have been selected and can be selected as a ```json { - "attribute_code": "xyz789", - "option_value_uids": [4] + "attribute_code": "abc123", + "option_value_uids": ["4"] } ``` @@ -3180,26 +3177,26 @@ Describes configurable options that have been selected and can be selected as a { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], - "free_gift_label": "abc123", + "free_gift_label": "xyz789", "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_type": "abc123", + "product_sku": "abc123", + "product_type": "xyz789", "product_url_key": "xyz789", "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, + "quantity_invoiced": 123.45, "quantity_ordered": 123.45, "quantity_refunded": 123.45, - "quantity_return_requested": 987.65, - "quantity_returned": 123.45, + "quantity_return_requested": 123.45, + "quantity_returned": 987.65, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "abc123" @@ -3246,7 +3243,10 @@ Defines basic features of a configurable product and its simple product variants | `price_tiers` - [`[TierPrice]`](/reference/graphql/saas/types-t-z.md#tierprice) | An array of `TierPrice` objects. | | `product_links` - [`[ProductLinksInterface]`](/reference/graphql/saas/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | | `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Quantity of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The average of all the ratings given to the product. | | `related_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `review_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/saas/types-k-p.md#productreviews) | The list of products reviews. | | `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | | `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | | `small_image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | @@ -3265,15 +3265,15 @@ Defines basic features of a configurable product and its simple product variants ```json { - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], "configurable_options": [ConfigurableProductOptions], "configurable_product_options_selection": ConfigurableProductOptionsSelection, - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": false, + "gift_message_available": true, "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, @@ -3282,11 +3282,11 @@ Defines basic features of a configurable product and its simple product variants "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "meta_description": "xyz789", - "meta_keyword": "abc123", - "meta_title": "abc123", + "meta_keyword": "xyz789", + "meta_title": "xyz789", "min_sale_qty": 123.45, "name": "abc123", - "new_from_date": "abc123", + "new_from_date": "xyz789", "new_to_date": "abc123", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], @@ -3294,8 +3294,11 @@ Defines basic features of a configurable product and its simple product variants "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, + "rating_summary": 123.45, "related_products": [ProductInterface], + "review_count": 987, + "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, @@ -3304,9 +3307,9 @@ Defines basic features of a configurable product and its simple product variants "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, - "uid": 4, + "uid": "4", "upsell_products": [ProductInterface], - "url_key": "xyz789", + "url_key": "abc123", "variants": [ConfigurableVariant], "weight": 987.65 } @@ -3331,8 +3334,8 @@ Contains details about configurable product options. ```json { - "attribute_code": "xyz789", - "label": "abc123", + "attribute_code": "abc123", + "label": "xyz789", "uid": "4", "values": [ConfigurableProductOptionValue] } @@ -3358,9 +3361,9 @@ Defines a value for a configurable product option. ```json { - "is_available": false, + "is_available": true, "is_use_default": false, - "label": "abc123", + "label": "xyz789", "swatch": SwatchDataInterface, "uid": 4 } @@ -3390,10 +3393,10 @@ Defines configurable attributes for the specified product. { "attribute_code": "abc123", "attribute_uid": 4, - "label": "xyz789", + "label": "abc123", "position": 123, "uid": "4", - "use_default": false, + "use_default": true, "values": [ConfigurableProductOptionsValues] } ``` @@ -3447,9 +3450,9 @@ Contains the index number assigned to a configurable product option. ```json { - "default_label": "xyz789", + "default_label": "abc123", "label": "abc123", - "store_label": "abc123", + "store_label": "xyz789", "swatch_data": SwatchDataInterface, "uid": "4", "use_default_value": false @@ -3480,9 +3483,9 @@ Contains details about configurable products added to a requisition list. "configurable_options": [SelectedConfigurableOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, - "sku": "abc123", - "uid": "4" + "quantity": 123.45, + "sku": "xyz789", + "uid": 4 } ``` @@ -3535,7 +3538,7 @@ A configurable product wish list item. "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "id": 4, "product": ProductInterface, "quantity": 987.65 @@ -3557,8 +3560,8 @@ A configurable product wish list item. ```json { - "confirmation_key": "abc123", - "order_id": 4 + "confirmation_key": "xyz789", + "order_id": "4" } ``` @@ -3579,8 +3582,8 @@ Contains details about a customer email address to confirm. ```json { - "confirmation_key": "abc123", - "email": "xyz789" + "confirmation_key": "xyz789", + "email": "abc123" } ``` @@ -3642,8 +3645,8 @@ List of account confirmation statuses. { "comment": "abc123", "email": "abc123", - "name": "abc123", - "telephone": "xyz789" + "name": "xyz789", + "telephone": "abc123" } ``` @@ -3746,7 +3749,7 @@ Contains the source and target wish lists after copying products. { "available_regions": [Region], "full_name_english": "abc123", - "full_name_locale": "xyz789", + "full_name_locale": "abc123", "id": "abc123", "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "abc123" @@ -4131,9 +4134,9 @@ Defines a new gift registry. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "event_name": "xyz789", - "gift_registry_type_uid": "4", - "message": "abc123", + "event_name": "abc123", + "gift_registry_type_uid": 4, + "message": "xyz789", "privacy_settings": "PRIVATE", "registrants": [AddGiftRegistryRegistrantInput], "shipping_address": GiftRegistryShippingAddressInput, @@ -4209,8 +4212,8 @@ Result of createPaymentLink. ```json { - "expiresAt": "abc123", - "payUrl": "abc123", + "expiresAt": "xyz789", + "payUrl": "xyz789", "token": "abc123" } ``` @@ -4263,16 +4266,62 @@ Contains payment order details that are used while processing the payment order ```json { - "amount": 123.45, + "amount": 987.65, "currency_code": "xyz789", "id": "xyz789", "mp_order_id": "abc123", - "status": "abc123" + "status": "xyz789" +} +``` + + + +### CreateProductReviewInput + +Defines a new product review. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `nickname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `ratings` - [`[ProductReviewRatingInput]!`](/reference/graphql/saas/types-k-p.md#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | +| `sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the reviewed product. | +| `summary` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The review text. | + +#### Example + +```json +{ + "nickname": "abc123", + "ratings": [ProductReviewRatingInput], + "sku": "abc123", + "summary": "abc123", + "text": "xyz789" } ``` +### CreateProductReviewOutput + +Contains the completed product review. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `review` - [`ProductReview!`](/reference/graphql/saas/types-k-p.md#productreview) | Product review details. | + +#### Example + +```json +{"review": ProductReview} +``` + + + ### CreatePurchaseOrderApprovalRuleConditionAmountInput Specifies the amount and currency to evaluate. @@ -4312,7 +4361,7 @@ Defines a set of conditions that apply to a rule. "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, "attribute": "GRAND_TOTAL", "operator": "MORE_THAN", - "quantity": 987 + "quantity": 123 } ``` @@ -4333,8 +4382,8 @@ An input object that identifies and describes a new requisition list. ```json { - "description": "xyz789", - "name": "xyz789" + "description": "abc123", + "name": "abc123" } ``` @@ -4396,7 +4445,7 @@ The vault token id and information about the payment source ```json { "payment_source": PaymentSourceOutput, - "vault_token_id": "abc123" + "vault_token_id": "xyz789" } ``` @@ -4456,7 +4505,7 @@ Defines the name and visibility of a new wish list. #### Example ```json -{"name": "abc123", "visibility": "PUBLIC"} +{"name": "xyz789", "visibility": "PUBLIC"} ``` @@ -4500,9 +4549,9 @@ Contains credit memo details. { "comments": [SalesCommentItem], "custom_attributes": [CustomAttribute], - "id": "4", + "id": 4, "items": [CreditMemoItemInterface], - "number": "abc123", + "number": "xyz789", "total": CreditMemoTotal } ``` @@ -4524,7 +4573,7 @@ Defines a credit memo item's custom attributes. ```json { - "credit_memo_id": "xyz789", + "credit_memo_id": "abc123", "custom_attributes": [CustomAttributeInput] } ``` @@ -4554,7 +4603,7 @@ Defines a credit memo item's custom attributes. "discounts": [Discount], "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", "quantity_refunded": 123.45 @@ -4619,9 +4668,9 @@ Credit memo item details. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", "quantity_refunded": 987.65 @@ -4704,8 +4753,8 @@ Contains credit memo price details. "available_currency_codes": ["abc123"], "base_currency_code": "xyz789", "base_currency_symbol": "xyz789", - "default_display_currency_code": "xyz789", - "default_display_currency_symbol": "xyz789", + "default_display_currency_code": "abc123", + "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } ``` @@ -4912,7 +4961,7 @@ Attributes of the product currently being viewed on PDP #### Example ```json -{"sku": "xyz789", "price": 987.65} +{"sku": "abc123", "price": 123.45} ``` @@ -4932,8 +4981,8 @@ Specifies the custom attribute code and value. ```json { - "attribute_code": "abc123", - "value": "abc123" + "attribute_code": "xyz789", + "value": "xyz789" } ``` @@ -4955,7 +5004,7 @@ Defines a custom attribute. ```json { "attribute_code": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -4992,14 +5041,14 @@ An interface containing fields that define the EAV attribute. ```json { - "code": "4", + "code": 4, "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", "frontend_class": "abc123", "frontend_input": "BOOLEAN", "is_required": false, "is_unique": true, - "label": "xyz789", + "label": "abc123", "options": [CustomAttributeOptionInterface] } ``` @@ -5027,7 +5076,7 @@ An interface containing fields that define the EAV attribute. ```json { "is_default": false, - "label": "abc123", + "label": "xyz789", "value": "abc123" } ``` @@ -5050,7 +5099,7 @@ A simple key value object. ```json { "key": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -5070,7 +5119,7 @@ A simple key value object. ```json { "type": "UNKNOWN_CUSTOMOPERATOR_TYPE", - "value": ["abc123"] + "value": ["xyz789"] } ``` @@ -5137,6 +5186,7 @@ Defines the customer name, addresses, and other details. | `requisition_lists` - [`RequisitionLists`](/reference/graphql/saas/types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | | `return` - [`Return`](/reference/graphql/saas/types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | | `returns` - [`Returns`](/reference/graphql/saas/types-q-s.md#returns) | Information about the customer's return requests. | +| `reviews` - [`ProductReviews!`](/reference/graphql/saas/types-k-p.md#productreviews) | Contains the customer's product reviews. | | `reward_points` - [`RewardPoints`](/reference/graphql/saas/types-q-s.md#rewardpoints) | Customer reward points details. | | `role` - [`CompanyRole`](#companyrole) | The role name and permissions assigned to the company user. | | `segments` - [`[CustomerSegmentStorefront]`](#customersegmentstorefront) | Customer segments associated with the current customer | @@ -5164,42 +5214,43 @@ Defines the customer name, addresses, and other details. "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "abc123", - "default_billing": "abc123", + "date_of_birth": "xyz789", + "default_billing": "xyz789", "default_shipping": "abc123", "email": "xyz789", - "firstname": "xyz789", - "gender": 987, + "firstname": "abc123", + "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "id": "4", - "is_subscribed": true, + "id": 4, + "is_subscribed": false, "job_title": "abc123", "lastname": "abc123", "middlename": "abc123", "orders": CustomerOrders, - "prefix": "abc123", + "prefix": "xyz789", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": true, - "quote_enabled": true, + "purchase_orders_enabled": false, + "quote_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, + "reviews": ProductReviews, "reward_points": RewardPoints, "role": CompanyRole, "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", - "suffix": "xyz789", + "structure_id": 4, + "suffix": "abc123", "taxvat": "abc123", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist_v2": Wishlist, "wishlists": [Wishlist] } @@ -5241,27 +5292,27 @@ Contains detailed information about a customer's billing or shipping address. ```json { - "city": "abc123", + "city": "xyz789", "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "default_billing": false, - "default_shipping": false, + "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", - "firstname": "xyz789", - "id": 987, - "lastname": "xyz789", + "firstname": "abc123", + "id": 123, + "lastname": "abc123", "middlename": "abc123", "postcode": "abc123", - "prefix": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 987, - "street": ["xyz789"], - "suffix": "xyz789", + "region_id": 123, + "street": ["abc123"], + "suffix": "abc123", "telephone": "xyz789", - "uid": "4", - "vat_id": "xyz789" + "uid": 4, + "vat_id": "abc123" } ``` @@ -5283,7 +5334,7 @@ Specifies the attribute code and value of a customer address attribute. ```json { "attribute_code": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -5319,23 +5370,23 @@ Contains details about a billing or shipping address. ```json { - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInput], - "default_billing": false, - "default_shipping": false, + "default_billing": true, + "default_shipping": true, "fax": "abc123", "firstname": "xyz789", - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "abc123", + "lastname": "abc123", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegionInput, - "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "abc123", - "vat_id": "abc123" + "street": ["abc123"], + "suffix": "abc123", + "telephone": "xyz789", + "vat_id": "xyz789" } ``` @@ -5359,7 +5410,7 @@ Defines the customer's state or province. { "region": "abc123", "region_code": "abc123", - "region_id": 123 + "region_id": 987 } ``` @@ -5381,9 +5432,9 @@ Defines the customer's state or province. ```json { - "region": "abc123", + "region": "xyz789", "region_code": "xyz789", - "region_id": 123 + "region_id": 987 } ``` @@ -5405,7 +5456,7 @@ Defines the customer's state or province. { "items": [CustomerAddress], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -5437,18 +5488,18 @@ Customer attribute metadata. ```json { - "code": "4", + "code": 4, "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": false, + "is_required": true, "is_unique": false, - "label": "xyz789", - "multiline_count": 123, + "label": "abc123", + "multiline_count": 987, "options": [CustomAttributeOptionInterface], - "sort_order": 987, + "sort_order": 123, "validate_rules": [ValidationRule] } ``` @@ -5481,19 +5532,19 @@ An input object for creating a customer. ```json { - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "custom_attributes": [AttributeValueInput], "date_of_birth": "abc123", - "email": "abc123", + "email": "xyz789", "firstname": "xyz789", - "gender": 123, + "gender": 987, "is_subscribed": true, "lastname": "xyz789", "middlename": "xyz789", - "password": "xyz789", + "password": "abc123", "prefix": "abc123", "suffix": "xyz789", - "taxvat": "abc123" + "taxvat": "xyz789" } ``` @@ -5558,7 +5609,7 @@ Data of customer group. #### Example ```json -{"uid": 4} +{"uid": "4"} ``` @@ -5608,35 +5659,35 @@ Contains details about each of the customer's orders. ```json { - "admin_assisted_order": 123, + "admin_assisted_order": 987, "applied_coupons": [AppliedCoupon], "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "xyz789", + "carrier": "abc123", "comments": [SalesCommentItem], "credit_memos": [CreditMemo], "custom_attributes": [CustomAttribute], "customer_info": OrderCustomerInfo, - "email": "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], "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, - "number": "abc123", - "order_date": "abc123", - "order_status_change_date": "xyz789", + "number": "xyz789", + "order_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, - "shipping_method": "xyz789", + "shipping_method": "abc123", "status": "xyz789", "token": "abc123", "total": OrderTotal @@ -5730,7 +5781,7 @@ Identifies the filter to use for filtering orders. "grand_total": FilterRangeTypeInput, "number": FilterStringTypeInput, "order_date": FilterRangeTypeInput, - "search": "xyz789", + "search": "abc123", "status": FilterEqualTypeInput } ``` @@ -5833,7 +5884,7 @@ Lists changes to the amount of store credit available to the customer. { "items": [CustomerStoreCreditHistoryItem], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -5859,7 +5910,7 @@ Contains store credit history information. "action": "abc123", "actual_balance": Money, "balance_change": Money, - "date_time_changed": "xyz789" + "date_time_changed": "abc123" } ``` @@ -5907,17 +5958,17 @@ An input object for updating a customer. ```json { - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "custom_attributes": [AttributeValueInput], - "date_of_birth": "abc123", - "firstname": "abc123", - "gender": 123, + "date_of_birth": "xyz789", + "firstname": "xyz789", + "gender": 987, "is_subscribed": true, - "lastname": "xyz789", - "middlename": "abc123", + "lastname": "abc123", + "middlename": "xyz789", "prefix": "abc123", "suffix": "abc123", - "taxvat": "xyz789" + "taxvat": "abc123" } ``` @@ -5944,9 +5995,9 @@ Contains information about a text area that is defined as part of a customizable { "product_sku": "xyz789", "required": false, - "sort_order": 987, - "title": "abc123", - "uid": "4", + "sort_order": 123, + "title": "xyz789", + "uid": 4, "value": CustomizableAreaValue } ``` @@ -5971,7 +6022,7 @@ Defines the price and sku of a product whose page contains a customized text are ```json { - "max_characters": 987, + "max_characters": 123, "price": 987.65, "price_type": "FIXED", "sku": "xyz789", @@ -5999,10 +6050,10 @@ Contains information about a set of checkbox values that are defined as part of ```json { - "required": false, + "required": true, "sort_order": 987, "title": "abc123", - "uid": "4", + "uid": 4, "value": [CustomizableCheckboxValue] } ``` @@ -6030,12 +6081,12 @@ Defines the price and sku of a product whose page contains a customized set of c ```json { "option_type_id": 987, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", "sku": "abc123", "sort_order": 123, - "title": "abc123", - "uid": "4" + "title": "xyz789", + "uid": 4 } ``` @@ -6060,10 +6111,10 @@ Contains information about a date picker that is defined as part of a customizab ```json { - "product_sku": "xyz789", + "product_sku": "abc123", "required": false, - "sort_order": 123, - "title": "xyz789", + "sort_order": 987, + "title": "abc123", "uid": 4, "value": CustomizableDateValue } @@ -6109,9 +6160,9 @@ Defines the price and sku of a product whose page contains a customized date pic ```json { - "price": 123.45, + "price": 987.65, "price_type": "FIXED", - "sku": "xyz789", + "sku": "abc123", "type": "DATE", "uid": 4 } @@ -6137,8 +6188,8 @@ Contains information about a drop down menu that is defined as part of a customi ```json { - "required": false, - "sort_order": 987, + "required": true, + "sort_order": 123, "title": "abc123", "uid": "4", "value": [CustomizableDropDownValue] @@ -6173,7 +6224,7 @@ Defines the price and sku of a product whose page contains a customized drop dow "sku": "abc123", "sort_order": 987, "title": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -6199,9 +6250,9 @@ Contains information about a text field that is defined as part of a customizabl ```json { "product_sku": "xyz789", - "required": false, + "required": true, "sort_order": 123, - "title": "abc123", + "title": "xyz789", "uid": "4", "value": CustomizableFieldValue } @@ -6228,10 +6279,10 @@ Defines the price and sku of a product whose page contains a customized text fie ```json { "max_characters": 123, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", "sku": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -6256,9 +6307,9 @@ Contains information about a file picker that is defined as part of a customizab ```json { - "product_sku": "abc123", + "product_sku": "xyz789", "required": true, - "sort_order": 987, + "sort_order": 123, "title": "abc123", "uid": "4", "value": CustomizableFileValue @@ -6287,13 +6338,13 @@ Defines the price and sku of a product whose page contains a customized file pic ```json { - "file_extension": "xyz789", - "image_size_x": 987, - "image_size_y": 123, + "file_extension": "abc123", + "image_size_x": 123, + "image_size_y": 987, "price": 123.45, "price_type": "FIXED", - "sku": "xyz789", - "uid": "4" + "sku": "abc123", + "uid": 4 } ``` @@ -6317,8 +6368,8 @@ Contains information about a multiselect that is defined as part of a customizab ```json { - "required": true, - "sort_order": 987, + "required": false, + "sort_order": 123, "title": "abc123", "uid": "4", "value": [CustomizableMultipleValue] @@ -6348,12 +6399,12 @@ Defines the price and sku of a product whose page contains a customized multisel ```json { "option_type_id": 123, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 123, - "title": "abc123", - "uid": 4 + "sku": "abc123", + "sort_order": 987, + "title": "xyz789", + "uid": "4" } ``` @@ -6375,7 +6426,7 @@ Defines a customizable option. ```json { "uid": "4", - "value_string": "xyz789" + "value_string": "abc123" } ``` @@ -6414,7 +6465,7 @@ Contains basic information about a customizable option. It can be implemented by "required": true, "sort_order": 987, "title": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -6467,7 +6518,7 @@ Contains information about a set of radio buttons that are defined as part of a ```json { - "required": true, + "required": false, "sort_order": 123, "title": "xyz789", "uid": "4", @@ -6497,13 +6548,13 @@ Defines the price and sku of a product whose page contains a customized set of r ```json { - "option_type_id": 123, + "option_type_id": 987, "price": 123.45, "price_type": "FIXED", "sku": "abc123", "sort_order": 123, - "title": "abc123", - "uid": "4" + "title": "xyz789", + "uid": 4 } ``` @@ -6534,7 +6585,7 @@ Contains the response to the request to delete the company role. #### Example ```json -{"success": true} +{"success": false} ``` @@ -6570,7 +6621,7 @@ Contains the response to the request to delete the company user. #### Example ```json -{"success": true} +{"success": false} ``` @@ -6588,7 +6639,7 @@ Contains the results of the request to delete a compare list. #### Example ```json -{"result": false} +{"result": true} ``` @@ -6726,7 +6777,7 @@ Indicates whether the request succeeded and returns the remaining customer payme ```json { "customerPaymentTokens": CustomerPaymentTokens, - "result": true + "result": false } ``` @@ -6883,10 +6934,10 @@ Specifies the discount type and value for quote line item. "amount": Money, "applied_to": "ITEM", "coupon": AppliedCoupon, - "is_discounting_locked": false, + "is_discounting_locked": true, "label": "abc123", "type": "abc123", - "value": 123.45 + "value": 987.65 } ``` @@ -6931,15 +6982,15 @@ An implementation for downloadable product cart items. "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "is_available": false, - "is_free_gift": true, - "is_salable": true, + "is_available": true, + "is_free_gift": false, + "is_salable": false, "links": [DownloadableProductLinks], - "max_qty": 987.65, - "min_qty": 123.45, + "max_qty": 123.45, + "min_qty": 987.65, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], - "not_available_message": "xyz789", + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -6977,7 +7028,7 @@ Defines downloadable product options for `CreditMemoItemInterface`. "custom_attributes": [CustomAttribute], "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, @@ -7017,7 +7068,7 @@ Defines downloadable product options for `InvoiceItemInterface`. "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_invoiced": 123.45 } ``` @@ -7041,8 +7092,8 @@ Defines characteristics of the links for downloadable product. ```json { "sort_order": 987, - "title": "xyz789", - "uid": "4" + "title": "abc123", + "uid": 4 } ``` @@ -7089,28 +7140,28 @@ Defines downloadable product options for `OrderItemInterface`. "custom_attributes": [CustomAttribute], "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "free_gift_label": "abc123", "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", "product_type": "abc123", - "product_url_key": "xyz789", - "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, - "quantity_ordered": 987.65, - "quantity_refunded": 987.65, - "quantity_return_requested": 123.45, + "product_url_key": "abc123", + "quantity_canceled": 123.45, + "quantity_invoiced": 987.65, + "quantity_ordered": 123.45, + "quantity_refunded": 123.45, + "quantity_return_requested": 987.65, "quantity_returned": 123.45, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -7156,7 +7207,10 @@ Defines a product that the shopper downloads. | `price_tiers` - [`[TierPrice]`](/reference/graphql/saas/types-t-z.md#tierprice) | An array of `TierPrice` objects. | | `product_links` - [`[ProductLinksInterface]`](/reference/graphql/saas/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | | `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Quantity of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The average of all the ratings given to the product. | | `related_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `review_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/saas/types-k-p.md#productreviews) | The list of products reviews. | | `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | | `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | | `small_image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | @@ -7186,39 +7240,42 @@ Defines a product that the shopper downloads. DownloadableProductSamples ], "gift_message_available": false, - "gift_wrapping_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "xyz789", - "links_purchased_separately": 987, + "is_returnable": "abc123", + "links_purchased_separately": 123, "links_title": "xyz789", - "manufacturer": 123, + "manufacturer": 987, "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "min_sale_qty": 123.45, - "name": "xyz789", - "new_from_date": "abc123", + "meta_description": "abc123", + "meta_keyword": "abc123", + "meta_title": "xyz789", + "min_sale_qty": 987.65, + "name": "abc123", + "new_from_date": "xyz789", "new_to_date": "abc123", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 987.65, + "quantity": 123.45, + "rating_summary": 987.65, "related_products": [ProductInterface], + "review_count": 123, + "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_price": 123.45, - "special_to_date": "abc123", + "special_price": 987.65, + "special_to_date": "xyz789", "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, - "uid": 4, + "uid": "4", "upsell_products": [ProductInterface], "url_key": "abc123" } @@ -7270,11 +7327,11 @@ Defines characteristics of a downloadable product. ```json { - "price": 987.65, + "price": 123.45, "sample_url": "xyz789", - "sort_order": 123, - "title": "xyz789", - "uid": 4 + "sort_order": 987, + "title": "abc123", + "uid": "4" } ``` @@ -7314,9 +7371,9 @@ Defines characteristics of a downloadable product. ```json { - "sample_url": "abc123", - "sort_order": 123, - "title": "abc123" + "sample_url": "xyz789", + "sort_order": 987, + "title": "xyz789" } ``` @@ -7347,7 +7404,7 @@ Contains details about downloadable products added to a requisition list. "product": ProductInterface, "quantity": 123.45, "samples": [DownloadableProductSamples], - "sku": "abc123", + "sku": "xyz789", "uid": 4 } ``` @@ -7375,7 +7432,7 @@ A downloadable product wish list item. ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "abc123", "id": "4", @@ -7402,10 +7459,7 @@ Identifies a quote to be duplicated #### Example ```json -{ - "duplicated_quote_uid": "4", - "quote_uid": "4" -} +{"duplicated_quote_uid": 4, "quote_uid": 4} ``` @@ -7464,7 +7518,10 @@ Defines a customer-entered option. #### Example ```json -{"uid": 4, "value": "abc123"} +{ + "uid": "4", + "value": "abc123" +} ``` @@ -7539,7 +7596,7 @@ Contains details about an address. ```json { "country_code": "AF", - "postcode": "abc123", + "postcode": "xyz789", "region": CustomerAddressRegionInput } ``` @@ -7640,7 +7697,7 @@ Lists the exchange rate. #### Example ```json -{"currency_to": "abc123", "rate": 987.65} +{"currency_to": "xyz789", "rate": 123.45} ``` @@ -7660,8 +7717,8 @@ Represents an external identifier with its origin system ```json { - "id": "abc123", - "origin": "abc123" + "id": "xyz789", + "origin": "xyz789" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md index 4f9674312..f55dd0288 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md @@ -20,11 +20,11 @@ ```json { "code": "xyz789", - "is_visible": false, + "is_visible": true, "payment_intent": "xyz789", "payment_source": "abc123", "sdk_params": [SDKParams], - "sort_order": "abc123", + "sort_order": "xyz789", "three_ds_mode": "OFF", "title": "abc123" } @@ -47,8 +47,8 @@ Fastlane Payment inputs ```json { - "payment_source": "abc123", - "paypal_fastlane_token": "xyz789" + "payment_source": "xyz789", + "paypal_fastlane_token": "abc123" } ``` @@ -93,7 +93,7 @@ Defines a filter that matches the input exactly. ```json { "eq": "abc123", - "in": ["xyz789"] + "in": ["abc123"] } ``` @@ -130,7 +130,7 @@ Defines a filter that performs a fuzzy search. #### Example ```json -{"match": "xyz789", "match_type": "FULL"} +{"match": "abc123", "match_type": "FULL"} ``` @@ -151,7 +151,7 @@ Defines a filter that matches a range of values, such as prices or dates. ```json { "from": "xyz789", - "to": "abc123" + "to": "xyz789" } ``` @@ -213,8 +213,8 @@ Defines a filter for an input string. ```json { - "eq": "xyz789", - "in": ["abc123"], + "eq": "abc123", + "in": ["xyz789"], "match": "abc123" } ``` @@ -248,20 +248,20 @@ Defines the comparison operators that can be used in a filter. ```json { - "eq": "abc123", + "eq": "xyz789", "from": "abc123", "gt": "xyz789", "gteq": "xyz789", "in": ["xyz789"], - "like": "abc123", - "lt": "xyz789", + "like": "xyz789", + "lt": "abc123", "lteq": "abc123", - "moreq": "xyz789", + "moreq": "abc123", "neq": "xyz789", "nin": ["xyz789"], "notnull": "xyz789", - "null": "xyz789", - "to": "abc123" + "null": "abc123", + "to": "xyz789" } ``` @@ -285,7 +285,7 @@ Contains product attributes that can be used for filtering in a `productSearch` ```json { "attribute": "abc123", - "frontendInput": "xyz789", + "frontendInput": "abc123", "label": "abc123", "numeric": false } @@ -344,7 +344,7 @@ The `Float` scalar type represents signed double-precision fractional values as #### Example ```json -987.65 +123.45 ``` @@ -362,7 +362,7 @@ Identifies which customer requires remote shopping assistance. #### Example ```json -{"customer_email": "xyz789"} +{"customer_email": "abc123"} ``` @@ -398,7 +398,7 @@ Specifies the template id, from which to generate quote from. #### Example ```json -{"template_id": "4"} +{"template_id": 4} ``` @@ -416,7 +416,7 @@ Contains the generated negotiable quote id. #### Example ```json -{"negotiable_quote_uid": 4} +{"negotiable_quote_uid": "4"} ``` @@ -456,8 +456,8 @@ Contains details about the gift card account. ```json { "balance": Money, - "code": "xyz789", - "expiration_date": "xyz789" + "code": "abc123", + "expiration_date": "abc123" } ``` @@ -499,11 +499,11 @@ Contains the value of a gift card, the website that generated the card, and rela ```json { - "attribute_id": 123, + "attribute_id": 987, "uid": 4, "value": 123.45, - "website_id": 123, - "website_value": 123.45 + "website_id": 987, + "website_value": 987.65 } ``` @@ -552,18 +552,18 @@ Contains details about a gift card that has been added to a cart. { "amount": Money, "available_gift_wrapping": [GiftWrapping], - "backorder_message": "abc123", + "backorder_message": "xyz789", "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": true, + "is_available": false, "is_free_gift": false, - "is_salable": true, + "is_salable": false, "max_qty": 123.45, - "message": "abc123", + "message": "xyz789", "min_qty": 987.65, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], @@ -573,11 +573,11 @@ Contains details about a gift card that has been added to a cart. "prices": CartItemPrices, "product": ProductInterface, "quantity": 123.45, - "recipient_email": "abc123", + "recipient_email": "xyz789", "recipient_name": "abc123", "sender_email": "abc123", - "sender_name": "abc123", - "uid": "4" + "sender_name": "xyz789", + "uid": 4 } ``` @@ -608,9 +608,9 @@ Contains details about a gift card that has been added to a cart. "gift_card": GiftCardItem, "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_refunded": 987.65 } ``` @@ -642,9 +642,9 @@ Contains details about a gift card that has been added to a cart. "gift_card": GiftCardItem, "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_invoiced": 987.65 } ``` @@ -669,10 +669,10 @@ Contains details about a gift card. ```json { - "message": "xyz789", + "message": "abc123", "recipient_email": "abc123", "recipient_name": "xyz789", - "sender_email": "xyz789", + "sender_email": "abc123", "sender_name": "xyz789" } ``` @@ -703,9 +703,9 @@ Contains details about the sender, recipient, and amount of a gift card. "custom_giftcard_amount": Money, "message": "abc123", "recipient_email": "abc123", - "recipient_name": "abc123", - "sender_email": "xyz789", - "sender_name": "xyz789" + "recipient_name": "xyz789", + "sender_email": "abc123", + "sender_name": "abc123" } ``` @@ -751,21 +751,21 @@ Contains details about the sender, recipient, and amount of a gift card. "discounts": [Discount], "eligible_for_return": true, "entered_options": [OrderItemOption], - "free_gift_label": "xyz789", + "free_gift_label": "abc123", "gift_card": GiftCardItem, "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": "abc123", - "product_url_key": "abc123", - "quantity_canceled": 123.45, - "quantity_invoiced": 987.65, - "quantity_ordered": 987.65, + "product_url_key": "xyz789", + "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, @@ -823,7 +823,10 @@ Defines properties of a gift card. | `price_tiers` - [`[TierPrice]`](/reference/graphql/saas/types-t-z.md#tierprice) | An array of `TierPrice` objects. | | `product_links` - [`[ProductLinksInterface]`](/reference/graphql/saas/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | | `quantity` - [`Float`](#float) | Quantity of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | | `related_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/saas/types-k-p.md#productreviews) | The list of products reviews. | | `short_description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | | `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | | `small_image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | @@ -845,20 +848,20 @@ Defines properties of a gift card. "allow_open_amount": true, "canonical_url": "xyz789", "categories": [CategoryInterface], - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_card_options": [CustomizableOptionInterface], - "gift_message_available": true, + "gift_message_available": false, "gift_wrapping_available": false, "gift_wrapping_price": Money, "giftcard_amounts": [GiftCardAmounts], "giftcard_type": "VIRTUAL", "image": ProductImage, "is_redeemable": false, - "is_returnable": "abc123", - "lifetime": 987, + "is_returnable": "xyz789", + "lifetime": 123, "manufacturer": 123, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], @@ -866,29 +869,32 @@ Defines properties of a gift card. "meta_description": "xyz789", "meta_keyword": "xyz789", "meta_title": "xyz789", - "min_sale_qty": 123.45, - "name": "abc123", + "min_sale_qty": 987.65, + "name": "xyz789", "new_from_date": "abc123", "new_to_date": "xyz789", "only_x_left_in_stock": 987.65, - "open_amount_max": 123.45, - "open_amount_min": 987.65, + "open_amount_max": 987.65, + "open_amount_min": 123.45, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, + "rating_summary": 123.45, "related_products": [ProductInterface], + "review_count": 123, + "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_price": 123.45, - "special_to_date": "abc123", + "special_price": 987.65, + "special_to_date": "xyz789", "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, - "uid": 4, + "uid": "4", "upsell_products": [ProductInterface], "url_key": "abc123", "weight": 987.65 @@ -920,8 +926,8 @@ Contains details about gift cards added to a requisition list. "gift_card_options": GiftCardOptions, "product": ProductInterface, "quantity": 987.65, - "sku": "xyz789", - "uid": 4 + "sku": "abc123", + "uid": "4" } ``` @@ -951,7 +957,7 @@ Contains details about gift cards added to a requisition list. "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_shipped": 123.45 + "quantity_shipped": 987.65 } ``` @@ -997,7 +1003,7 @@ A single gift card added to a wish list. ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "abc123", "gift_card_options": GiftCardOptions, @@ -1025,7 +1031,7 @@ Gift card custom attribute value containing array data. ```json { - "attribute_type": "xyz789", + "attribute_type": "abc123", "code": "4", "options": ["abc123"] } @@ -1049,7 +1055,7 @@ Contains the text of a gift message, its sender, and recipient ```json { - "from": "xyz789", + "from": "abc123", "message": "abc123", "to": "xyz789" } @@ -1140,14 +1146,14 @@ Contains details about a gift registry. "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, "status": "ACTIVE", "type": GiftRegistryType, - "uid": 4 + "uid": "4" } ``` @@ -1168,9 +1174,9 @@ Contains details about a gift registry. ```json { - "code": "4", + "code": 4, "group": "EVENT_INFORMATION", - "label": "abc123", + "label": "xyz789", "value": "abc123" } ``` @@ -1242,7 +1248,7 @@ Defines a dynamic attribute. { "code": "4", "label": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -1266,11 +1272,11 @@ Defines a dynamic attribute. ```json { "attribute_group": "xyz789", - "code": 4, + "code": "4", "input_type": "abc123", - "is_required": true, + "is_required": false, "label": "abc123", - "sort_order": 987 + "sort_order": 123 } ``` @@ -1302,9 +1308,9 @@ Defines a dynamic attribute. "attribute_group": "abc123", "code": "4", "input_type": "abc123", - "is_required": true, - "label": "abc123", - "sort_order": 987 + "is_required": false, + "label": "xyz789", + "sort_order": 123 } ``` @@ -1327,12 +1333,12 @@ Defines a dynamic attribute. ```json { - "created_at": "xyz789", - "note": "xyz789", + "created_at": "abc123", + "note": "abc123", "product": ProductInterface, "quantity": 987.65, - "quantity_fulfilled": 123.45, - "uid": 4 + "quantity_fulfilled": 987.65, + "uid": "4" } ``` @@ -1361,12 +1367,12 @@ Defines a dynamic attribute. ```json { - "created_at": "xyz789", + "created_at": "abc123", "note": "abc123", "product": ProductInterface, "quantity": 987.65, - "quantity_fulfilled": 987.65, - "uid": "4" + "quantity_fulfilled": 123.45, + "uid": 4 } ``` @@ -1393,7 +1399,7 @@ Contains the status and any errors that encountered with the customer's gift reg ```json { - "status": false, + "status": true, "user_errors": [GiftRegistryItemsUserError] } ``` @@ -1514,8 +1520,8 @@ Contains details about a registrant. ], "email": "abc123", "firstname": "abc123", - "lastname": "xyz789", - "uid": 4 + "lastname": "abc123", + "uid": "4" } ``` @@ -1562,12 +1568,12 @@ Contains the results of a gift registry search. ```json { - "event_date": "xyz789", + "event_date": "abc123", "event_title": "xyz789", - "gift_registry_uid": 4, + "gift_registry_uid": "4", "location": "abc123", - "name": "xyz789", - "type": "abc123" + "name": "abc123", + "type": "xyz789" } ``` @@ -1590,7 +1596,7 @@ Defines a shipping address for a gift registry. Specify either `address_data` or ```json { "address_data": CustomerAddressInput, - "address_id": 4, + "address_id": "4", "customer_address_uid": "4" } ``` @@ -1635,7 +1641,7 @@ Contains details about a gift registry type. "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "abc123", + "label": "xyz789", "uid": "4" } ``` @@ -1662,7 +1668,7 @@ Contains details about the selected or available gift wrapping options. "design": "xyz789", "image": GiftWrappingImage, "price": Money, - "uid": 4 + "uid": "4" } ``` @@ -1684,7 +1690,7 @@ Points to an image associated with a gift wrapping option. ```json { "label": "abc123", - "url": "abc123" + "url": "xyz789" } ``` @@ -1705,8 +1711,8 @@ Points to an image associated with a gift wrapping option. ```json { "color": "xyz789", - "height": 987, - "type": "abc123" + "height": 123, + "type": "xyz789" } ``` @@ -1734,15 +1740,15 @@ Points to an image associated with a gift wrapping option. ```json { "button_styles": GooglePayButtonStyles, - "code": "xyz789", + "code": "abc123", "google_pay_mode": "TEST", - "is_visible": true, - "payment_intent": "xyz789", + "is_visible": false, + "payment_intent": "abc123", "payment_source": "abc123", "sdk_params": [SDKParams], "sort_order": "xyz789", "three_ds_mode": "OFF", - "title": "xyz789" + "title": "abc123" } ``` @@ -1827,7 +1833,10 @@ Defines a grouped product, which consists of simple standalone products that are | `price_tiers` - [`[TierPrice]`](/reference/graphql/saas/types-t-z.md#tierprice) | An array of `TierPrice` objects. | | `product_links` - [`[ProductLinksInterface]`](/reference/graphql/saas/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | | `quantity` - [`Float`](#float) | Quantity of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | | `related_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/saas/types-k-p.md#productreviews) | The list of products reviews. | | `short_description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | | `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | | `small_image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | @@ -1845,14 +1854,14 @@ Defines a grouped product, which consists of simple standalone products that are ```json { - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": true, - "gift_wrapping_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", @@ -1862,25 +1871,28 @@ Defines a grouped product, which consists of simple standalone products that are "media_gallery": [MediaGalleryInterface], "meta_description": "abc123", "meta_keyword": "abc123", - "meta_title": "xyz789", - "min_sale_qty": 987.65, - "name": "xyz789", - "new_from_date": "abc123", - "new_to_date": "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, "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "quantity": 123.45, + "rating_summary": 123.45, "related_products": [ProductInterface], + "review_count": 123, + "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, - "special_price": 123.45, + "special_price": 987.65, "special_to_date": "xyz789", "stock_status": "IN_STOCK", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, "uid": "4", "upsell_products": [ProductInterface], @@ -1907,7 +1919,7 @@ Contains information about an individual grouped product item. ```json { - "position": 123, + "position": 987, "product": ProductInterface, "qty": 987.65 } @@ -1934,10 +1946,10 @@ A grouped product wish list item. ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": 4, + "description": "abc123", + "id": "4", "product": ProductInterface, "quantity": 123.45 } @@ -1961,7 +1973,7 @@ Input to retrieve a guest order based on token. ```json { "reason": "xyz789", - "token": "abc123" + "token": "xyz789" } ``` @@ -1983,9 +1995,9 @@ Input to retrieve an order based on details. ```json { - "email": "abc123", - "lastname": "xyz789", - "number": "xyz789" + "email": "xyz789", + "lastname": "abc123", + "number": "abc123" } ``` @@ -2007,8 +2019,8 @@ An object that provides highlighted text for matched words ```json { - "attribute": "xyz789", - "matched_words": ["abc123"], + "attribute": "abc123", + "matched_words": ["xyz789"], "value": "abc123" } ``` @@ -2034,12 +2046,12 @@ Item note data that is added to the negotiable quote history object. ```json { - "created_at": "xyz789", + "created_at": "abc123", "creator_name": "abc123", - "creator_type": "abc123", - "item_id": 123, + "creator_type": "xyz789", + "item_id": 987, "note": "xyz789", - "product_name": "xyz789" + "product_name": "abc123" } ``` @@ -2067,17 +2079,17 @@ Item note data that is added to the negotiable quote history object. ```json { - "cc_vault_code": "xyz789", + "cc_vault_code": "abc123", "code": "abc123", - "is_vault_enabled": false, - "is_visible": false, + "is_vault_enabled": true, + "is_visible": true, "payment_intent": "abc123", - "payment_source": "abc123", + "payment_source": "xyz789", "requires_card_details": true, "sdk_params": [SDKParams], "sort_order": "abc123", "three_ds_mode": "OFF", - "title": "xyz789" + "title": "abc123" } ``` @@ -2105,15 +2117,15 @@ Hosted Fields payment inputs ```json { - "cardBin": "xyz789", + "cardBin": "abc123", "cardExpiryMonth": "xyz789", "cardExpiryYear": "xyz789", - "cardLast4": "abc123", + "cardLast4": "xyz789", "holderName": "abc123", "is_active_payment_token_enabler": false, - "payment_source": "abc123", - "payments_order_id": "abc123", - "paypal_order_id": "abc123" + "payment_source": "xyz789", + "payments_order_id": "xyz789", + "paypal_order_id": "xyz789" } ``` @@ -2145,7 +2157,7 @@ The `ID` scalar type represents a unique identifier, often used to refetch an ob ```json { "thumbnail": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -2268,9 +2280,9 @@ Contains invoice details. { "comments": [SalesCommentItem], "custom_attributes": [CustomAttribute], - "id": "4", + "id": 4, "items": [InvoiceItemInterface], - "number": "xyz789", + "number": "abc123", "total": InvoiceTotal } ``` @@ -2320,11 +2332,11 @@ Defines an invoice custom attributes. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_invoiced": 123.45 } ``` @@ -2348,7 +2360,7 @@ Defines an invoice item custom attributes. ```json { "custom_attributes": [CustomAttributeInput], - "invoice_id": "abc123", + "invoice_id": "xyz789", "invoice_item_id": "abc123" } ``` @@ -2392,7 +2404,7 @@ Contains detailes about invoiced items. "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "quantity_invoiced": 987.65 + "quantity_invoiced": 123.45 } ``` @@ -2463,7 +2475,7 @@ Contains the response of a company admin email validation query. #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2481,7 +2493,7 @@ Contains the response of a company email validation query. #### Example ```json -{"is_email_available": true} +{"is_email_available": false} ``` @@ -2588,7 +2600,7 @@ Response returned when checking whether a customer is subscribed to a product al #### Example ```json -{"isSubscribed": true, "message": "xyz789"} +{"isSubscribed": true, "message": "abc123"} ``` @@ -2613,13 +2625,13 @@ The note object for quote line item. ```json { - "created_at": "xyz789", + "created_at": "abc123", "creator_id": 123, - "creator_name": "xyz789", + "creator_name": "abc123", "creator_type": 123, "negotiable_quote_item_uid": 4, "note": "abc123", - "note_uid": 4 + "note_uid": "4" } ``` @@ -2641,8 +2653,8 @@ A list of options of the selected bundle product. ```json { - "label": "abc123", - "uid": "4", + "label": "xyz789", + "uid": 4, "values": [ItemSelectedBundleOptionValue] } ``` @@ -2670,7 +2682,7 @@ A list of values for the selected bundle product. "price": Money, "product_name": "abc123", "product_sku": "abc123", - "quantity": 123.45, + "quantity": 987.65, "uid": 4 } ``` @@ -2702,7 +2714,7 @@ A JSON scalar ```json { - "key": "abc123", + "key": "xyz789", "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT" } ``` @@ -2723,9 +2735,9 @@ A JSON scalar ```json { - "key": "abc123", + "key": "xyz789", "message": "xyz789", - "success": true + "success": false } ``` @@ -2744,7 +2756,7 @@ A JSON scalar ```json { - "key": "abc123", + "key": "xyz789", "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md b/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md index bf9a6e3d1..5e7c44d73 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md @@ -15,7 +15,7 @@ Contains a key-value pair. ```json { - "name": "abc123", + "name": "xyz789", "value": "xyz789" } ``` @@ -96,7 +96,7 @@ Contains basic information about a product image or video. "disabled": false, "label": "abc123", "position": 123, - "types": ["xyz789"], + "types": ["abc123"], "url": "xyz789" } ``` @@ -116,6 +116,8 @@ Enumeration of media resource types | `CUSTOMER_ATTRIBUTE_IMAGE` | Customer image resource type | | `CUSTOMER_ATTRIBUTE_ADDRESS_FILE` | Customer file resource type for customer address | | `CUSTOMER_ATTRIBUTE_ADDRESS_IMAGE` | Customer image resource type for customer address | +| `RMA_ATTRIBUTE_FILE` | RMA return item file resource type | +| `RMA_ATTRIBUTE_IMAGE` | RMA return item image resource type | #### Example @@ -197,7 +199,7 @@ Contains the customer's gift registry and any errors encountered. ```json { "gift_registry": GiftRegistry, - "status": false, + "status": true, "user_errors": [GiftRegistryItemsUserError] } ``` @@ -217,7 +219,7 @@ An input object that defines the items in a requisition list to be moved. #### Example ```json -{"requisitionListItemUids": ["4"]} +{"requisitionListItemUids": [4]} ``` @@ -259,7 +261,11 @@ Move Line Item to Requisition List. #### Example ```json -{"quote_item_uid": 4, "quote_uid": 4, "requisition_list_uid": 4} +{ + "quote_item_uid": "4", + "quote_uid": "4", + "requisition_list_uid": 4 +} ``` @@ -346,25 +352,25 @@ Contains details about a negotiable quote. "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "created_at": "xyz789", "custom_attributes": [CustomAttribute], "email": "abc123", - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_virtual": false, "items": [CartItemInterface], - "name": "abc123", + "name": "xyz789", "order": CustomerOrder, "prices": CartPrices, "sales_rep_name": "xyz789", "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "SUBMITTED", - "template_id": "4", + "template_id": 4, "template_name": "abc123", "total_quantity": 123.45, - "uid": "4", - "updated_at": "abc123" + "uid": 4, + "updated_at": "xyz789" } ``` @@ -385,8 +391,8 @@ Defines the company's country. ```json { - "code": "abc123", - "label": "xyz789" + "code": "xyz789", + "label": "abc123" } ``` @@ -422,23 +428,23 @@ Defines the billing or shipping address to be applied to the cart. ```json { - "city": "xyz789", + "city": "abc123", "company": "xyz789", "country_code": "xyz789", "custom_attributes": [AttributeValueInput], - "fax": "abc123", - "firstname": "abc123", - "lastname": "abc123", - "middlename": "abc123", + "fax": "xyz789", + "firstname": "xyz789", + "lastname": "xyz789", + "middlename": "xyz789", "postcode": "xyz789", "prefix": "xyz789", - "region": "abc123", + "region": "xyz789", "region_id": 123, "save_in_address_book": false, "street": ["xyz789"], "suffix": "abc123", "telephone": "xyz789", - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -480,21 +486,21 @@ Defines the billing or shipping address to be applied to the cart. ```json { - "city": "abc123", + "city": "xyz789", "company": "xyz789", "company_address_id": 4, "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": "4", - "fax": "abc123", + "customer_address_uid": 4, + "fax": "xyz789", "firstname": "abc123", - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", "postcode": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "region": NegotiableQuoteAddressRegion, - "street": ["xyz789"], - "suffix": "abc123", + "street": ["abc123"], + "suffix": "xyz789", "telephone": "xyz789", "uid": 4, "vat_id": "abc123" @@ -519,9 +525,9 @@ Defines the company's state or province. ```json { - "code": "xyz789", + "code": "abc123", "label": "xyz789", - "region_id": 987 + "region_id": 123 } ``` @@ -556,23 +562,23 @@ Defines the company's state or province. ```json { - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "company_address_id": "4", "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": 4, - "fax": "abc123", + "fax": "xyz789", "firstname": "abc123", "lastname": "xyz789", - "middlename": "xyz789", + "middlename": "abc123", "postcode": "abc123", "prefix": "abc123", "region": NegotiableQuoteAddressRegion, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "abc123", - "uid": "4", + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "xyz789", + "uid": 4, "vat_id": "xyz789" } ``` @@ -599,9 +605,9 @@ Defines the billing address. { "address": NegotiableQuoteAddressInput, "company_address_id": 4, - "customer_address_uid": 4, - "same_as_shipping": false, - "use_for_shipping": true + "customer_address_uid": "4", + "same_as_shipping": true, + "use_for_shipping": false } ``` @@ -653,7 +659,7 @@ Negotiable quote comment file attachment. ```json { "name": "xyz789", - "url": "xyz789" + "url": "abc123" } ``` @@ -733,8 +739,8 @@ Contains custom log entries added by third-party extensions. ```json { "new_value": "xyz789", - "old_value": "abc123", - "title": "abc123" + "old_value": "xyz789", + "title": "xyz789" } ``` @@ -832,9 +838,9 @@ Contains details about a change for a negotiable quote. "author": NegotiableQuoteUser, "change_type": "CREATED", "changes": NegotiableQuoteHistoryChanges, - "created_at": "abc123", + "created_at": "xyz789", "item_note": HistoryItemNoteData, - "uid": 4 + "uid": "4" } ``` @@ -896,7 +902,7 @@ Contains lists of products that have been removed from the catalog and negotiabl ```json { - "products_removed_from_catalog": [4], + "products_removed_from_catalog": ["4"], "products_removed_from_quote": [ProductInterface] } ``` @@ -975,7 +981,7 @@ An error indicating that an operation was attempted on a negotiable quote in an #### Example ```json -{"message": "xyz789"} +{"message": "abc123"} ``` @@ -994,7 +1000,7 @@ Specifies the updated quantity of an item. #### Example ```json -{"quantity": 987.65, "quote_item_uid": "4"} +{"quantity": 123.45, "quote_item_uid": 4} ``` @@ -1014,8 +1020,8 @@ Defines the payment method to be applied to the negotiable quote. ```json { - "code": "abc123", - "purchase_order_number": "xyz789" + "code": "xyz789", + "purchase_order_number": "abc123" } ``` @@ -1038,8 +1044,8 @@ Contains a reference document link for a negotiable quote template. ```json { - "document_identifier": "abc123", - "document_name": "abc123", + "document_identifier": "xyz789", + "document_name": "xyz789", "link_id": "4", "reference_document_url": "abc123" } @@ -1080,24 +1086,24 @@ Contains a reference document link for a negotiable quote template. { "available_shipping_methods": [AvailableShippingMethod], "city": "abc123", - "company": "xyz789", - "company_address_id": "4", + "company": "abc123", + "company_address_id": 4, "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, + "customer_address_uid": "4", "fax": "abc123", "firstname": "abc123", - "lastname": "xyz789", + "lastname": "abc123", "middlename": "abc123", - "postcode": "xyz789", - "prefix": "xyz789", + "postcode": "abc123", + "prefix": "abc123", "region": NegotiableQuoteAddressRegion, "selected_shipping_method": SelectedShippingMethod, "street": ["abc123"], - "suffix": "abc123", - "telephone": "abc123", - "uid": "4", - "vat_id": "abc123" + "suffix": "xyz789", + "telephone": "xyz789", + "uid": 4, + "vat_id": "xyz789" } ``` @@ -1122,8 +1128,8 @@ Defines shipping addresses for the negotiable quote. { "address": NegotiableQuoteAddressInput, "company_address_id": "4", - "customer_address_uid": 4, - "customer_notes": "abc123" + "customer_address_uid": "4", + "customer_notes": "xyz789" } ``` @@ -1227,14 +1233,14 @@ Contains details about a negotiable quote template. { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", + "created_at": "abc123", "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], @@ -1245,10 +1251,10 @@ Contains details about a negotiable quote template. "sales_rep_name": "xyz789", "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "abc123", - "template_id": "4", - "total_quantity": 123.45, + "template_id": 4, + "total_quantity": 987.65, "uid": "4", - "updated_at": "xyz789" + "updated_at": "abc123" } ``` @@ -1310,23 +1316,23 @@ Contains data for a negotiable quote template in a grid. ```json { "activated_at": "xyz789", - "company_name": "abc123", - "created_at": "xyz789", - "expiration_date": "xyz789", + "company_name": "xyz789", + "created_at": "abc123", + "expiration_date": "abc123", "is_min_max_qty_used": true, "last_ordered_at": "xyz789", - "last_shared_at": "xyz789", + "last_shared_at": "abc123", "max_order_commitment": 987, - "min_negotiated_grand_total": 123.45, + "min_negotiated_grand_total": 987.65, "min_order_commitment": 123, "name": "xyz789", "orders_placed": 123, "prices": CartPrices, - "sales_rep_name": "abc123", + "sales_rep_name": "xyz789", "state": "abc123", "status": "xyz789", "submitted_by": "abc123", - "template_id": "4", + "template_id": 4, "uid": 4, "updated_at": "abc123" } @@ -1448,7 +1454,12 @@ Specifies the updated quantity of an item. #### Example ```json -{"item_id": 4, "max_qty": 987.65, "min_qty": 987.65, "quantity": 123.45} +{ + "item_id": "4", + "max_qty": 123.45, + "min_qty": 123.45, + "quantity": 123.45 +} ``` @@ -1470,9 +1481,9 @@ Defines the reference document link to add to a negotiable quote template. ```json { - "document_identifier": "xyz789", + "document_identifier": "abc123", "document_name": "xyz789", - "link_id": "4", + "link_id": 4, "reference_document_url": "abc123" } ``` @@ -1499,7 +1510,7 @@ Defines shipping addresses for the negotiable quote template. "address": NegotiableQuoteAddressInput, "company_address_id": 4, "customer_address_uid": 4, - "customer_notes": "abc123" + "customer_notes": "xyz789" } ``` @@ -1561,7 +1572,7 @@ Contains a list of negotiable templates that match the specified filter. "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } ``` @@ -1622,8 +1633,8 @@ A limited view of a Buyer or Seller in the negotiable quote process. ```json { - "firstname": "xyz789", - "lastname": "abc123" + "firstname": "abc123", + "lastname": "xyz789" } ``` @@ -1649,7 +1660,7 @@ Contains a list of negotiable that match the specified filter. "items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } ``` @@ -1670,7 +1681,7 @@ Contains an error message when an invalid UID was specified. ```json { - "message": "abc123", + "message": "xyz789", "uid": "4" } ``` @@ -1736,7 +1747,7 @@ A single cart item's source nomination. ```json { "cart_item_uid": 4, - "source_code": "xyz789" + "source_code": "abc123" } ``` @@ -1794,7 +1805,7 @@ A custom fee applied to the cart by an out-of-process webhook. { "amount": Money, "code": "xyz789", - "label": "abc123" + "label": "xyz789" } ``` @@ -1813,7 +1824,7 @@ A custom fee applied to the cart by an out-of-process webhook. ```json { - "backend_integration_url": "xyz789", + "backend_integration_url": "abc123", "custom_config": [CustomConfigKeyValue] } ``` @@ -1877,7 +1888,7 @@ Contains the order ID. #### Example ```json -{"order_number": "abc123"} +{"order_number": "xyz789"} ``` @@ -1932,23 +1943,23 @@ Contains detailed information about an order's billing and shipping addresses. ```json { - "city": "abc123", - "company": "abc123", - "company_address_id": "4", + "city": "xyz789", + "company": "xyz789", + "company_address_id": 4, "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "fax": "abc123", "firstname": "xyz789", - "lastname": "xyz789", - "middlename": "xyz789", + "lastname": "abc123", + "middlename": "abc123", "postcode": "abc123", - "prefix": "abc123", - "region": "xyz789", + "prefix": "xyz789", + "region": "abc123", "region_id": 4, - "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "abc123", - "vat_id": "abc123" + "street": ["abc123"], + "suffix": "abc123", + "telephone": "xyz789", + "vat_id": "xyz789" } ``` @@ -1970,11 +1981,11 @@ Contains detailed information about an order's billing and shipping addresses. ```json { - "firstname": "abc123", - "lastname": "abc123", + "firstname": "xyz789", + "lastname": "xyz789", "middlename": "xyz789", - "prefix": "xyz789", - "suffix": "xyz789" + "prefix": "abc123", + "suffix": "abc123" } ``` @@ -2022,20 +2033,20 @@ Contains detailed information about an order's billing and shipping addresses. "free_gift_label": "abc123", "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "prices": OrderItemPrices, "product": ProductInterface, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "product_type": "abc123", + "product_type": "xyz789", "product_url_key": "abc123", "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, + "quantity_invoiced": 987.65, "quantity_ordered": 987.65, - "quantity_refunded": 987.65, - "quantity_return_requested": 987.65, - "quantity_returned": 123.45, + "quantity_refunded": 123.45, + "quantity_return_requested": 123.45, + "quantity_returned": 987.65, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], "status": "abc123" @@ -2093,25 +2104,25 @@ Order item details. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], - "free_gift_label": "abc123", + "free_gift_label": "xyz789", "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "prices": OrderItemPrices, "product": ProductInterface, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "product_type": "xyz789", + "product_type": "abc123", "product_url_key": "abc123", - "quantity_canceled": 123.45, - "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, + "quantity_canceled": 987.65, + "quantity_invoiced": 987.65, + "quantity_ordered": 987.65, "quantity_refunded": 123.45, - "quantity_return_requested": 123.45, - "quantity_returned": 123.45, + "quantity_return_requested": 987.65, + "quantity_returned": 987.65, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], "status": "xyz789" @@ -2136,7 +2147,7 @@ Represents order item options like selected or entered. ```json { "label": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -2197,8 +2208,8 @@ Contains details about the payment method used to pay for the order. ```json { "additional_data": [KeyValue], - "name": "xyz789", - "type": "xyz789" + "name": "abc123", + "type": "abc123" } ``` @@ -2223,9 +2234,9 @@ Contains order shipment details. ```json { "comments": [SalesCommentItem], - "id": 4, + "id": "4", "items": [ShipmentItemInterface], - "number": "abc123", + "number": "xyz789", "tracking": [ShipmentTracking] } ``` @@ -2245,7 +2256,7 @@ Input to retrieve an order based on token. #### Example ```json -{"token": "abc123"} +{"token": "xyz789"} ``` @@ -2353,7 +2364,7 @@ Defines the payment attribute. ```json { "key": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -2388,7 +2399,7 @@ Contains payment fields that are common to all types of payment methods. ```json { - "code": "xyz789", + "code": "abc123", "is_visible": true, "payment_intent": "xyz789", "sdk_params": [SDKParams], @@ -2503,8 +2514,8 @@ Contains the payment order details ```json { - "id": "xyz789", - "mp_order_id": "xyz789", + "id": "abc123", + "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, "status": "abc123" } @@ -2525,7 +2536,7 @@ Contains the payment order details ```json { - "code": "xyz789", + "code": "abc123", "params": [SDKParams] } ``` @@ -2601,8 +2612,8 @@ The stored payment method available to the customer. ```json { - "details": "xyz789", - "payment_method_code": "xyz789", + "details": "abc123", + "payment_method_code": "abc123", "public_hash": "abc123", "type": "card" } @@ -2685,16 +2696,16 @@ Defines Pickup Location information. ```json { - "city": "xyz789", - "contact_name": "abc123", - "country_id": "xyz789", + "city": "abc123", + "contact_name": "xyz789", + "country_id": "abc123", "description": "abc123", "email": "xyz789", - "fax": "abc123", - "latitude": 123.45, + "fax": "xyz789", + "latitude": 987.65, "longitude": 123.45, "name": "abc123", - "phone": "xyz789", + "phone": "abc123", "pickup_location_code": "abc123", "postcode": "xyz789", "region": "xyz789", @@ -2826,7 +2837,7 @@ Specifies the negotiable quote to convert to an order. #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -2887,7 +2898,7 @@ An error encountered while placing an order. ```json { "code": "CART_NOT_FOUND", - "message": "abc123" + "message": "xyz789" } ``` @@ -2962,7 +2973,7 @@ Specifies the quote to be converted to an order. #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -3061,7 +3072,7 @@ Specifies the amount and type of price adjustment. #### Example ```json -{"amount": 987.65, "code": "abc123"} +{"amount": 987.65, "code": "xyz789"} ``` @@ -3083,8 +3094,8 @@ Can be used to retrieve the main price details in case of bundle product ```json { "discount_percentage": 123.45, - "main_final_price": 987.65, - "main_price": 123.45 + "main_final_price": 123.45, + "main_price": 987.65 } ``` @@ -3164,7 +3175,7 @@ Input to identify a product by SKU for a price alert subscription. #### Example ```json -{"sku": "xyz789"} +{"sku": "abc123"} ``` @@ -3182,7 +3193,7 @@ Input to identify a product by SKU for a stock alert subscription. #### Example ```json -{"sku": "xyz789"} +{"sku": "abc123"} ``` @@ -3201,7 +3212,7 @@ Response returned after a product alert subscribe or unsubscribe mutation. #### Example ```json -{"message": "abc123", "success": true} +{"message": "abc123", "success": false} ``` @@ -3222,7 +3233,7 @@ Contains a product attribute code and value. ```json { "code": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -3246,7 +3257,7 @@ Contains a product attribute code and value. "attribute_type": "abc123", "code": "4", "url": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -3288,7 +3299,7 @@ Contains the discount applied to a product price. #### Example ```json -{"amount_off": 987.65, "percent_off": 987.65} +{"amount_off": 123.45, "percent_off": 987.65} ``` @@ -3311,10 +3322,10 @@ Contains product image information, including the image URL and label. ```json { - "disabled": false, - "label": "xyz789", + "disabled": true, + "label": "abc123", "position": 123, - "types": ["abc123"], + "types": ["xyz789"], "url": "xyz789" } ``` @@ -3351,7 +3362,7 @@ Product Information used for Pickup Locations search. #### Example ```json -{"sku": "abc123"} +{"sku": "xyz789"} ``` @@ -3391,7 +3402,10 @@ Contains fields that are common to all types of products. | `price_tiers` - [`[TierPrice]`](/reference/graphql/saas/types-t-z.md#tierprice) | An array of `TierPrice` objects. | | `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | | `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Quantity of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The average of all the ratings given to the product. | | `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | +| `review_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | | `short_description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | | `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | | `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | @@ -3426,17 +3440,17 @@ Contains fields that are common to all types of products. "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", - "manufacturer": 123, + "manufacturer": 987, "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": "xyz789", "new_from_date": "xyz789", @@ -3446,17 +3460,20 @@ Contains fields that are common to all types of products. "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 987.65, + "quantity": 123.45, + "rating_summary": 123.45, "related_products": [ProductInterface], + "review_count": 123, + "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, "special_price": 987.65, - "special_to_date": "abc123", + "special_to_date": "xyz789", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "uid": "4", + "uid": 4, "upsell_products": [ProductInterface], "url_key": "xyz789" } @@ -3484,8 +3501,8 @@ An implementation of `ProductLinksInterface`. { "link_type": "abc123", "linked_product_sku": "abc123", - "linked_product_type": "abc123", - "position": 123, + "linked_product_type": "xyz789", + "position": 987, "sku": "xyz789" } ``` @@ -3518,8 +3535,8 @@ Contains information about linked products, including the link type and product { "link_type": "xyz789", "linked_product_sku": "xyz789", - "linked_product_type": "abc123", - "position": 123, + "linked_product_type": "xyz789", + "position": 987, "sku": "abc123" } ``` @@ -3543,8 +3560,8 @@ Contains basic information about the image asset. ```json { "asset_id": "xyz789", - "media_type": "abc123", - "media_url": "xyz789" + "media_type": "xyz789", + "media_url": "abc123" } ``` @@ -3594,9 +3611,9 @@ Contains a link to a video file and basic information about the video. ```json { "media_type": "abc123", - "video_description": "abc123", - "video_metadata": "xyz789", - "video_provider": "abc123", + "video_description": "xyz789", + "video_metadata": "abc123", + "video_provider": "xyz789", "video_title": "abc123", "video_url": "xyz789" } @@ -3630,6 +3647,168 @@ Represents a product price. +### ProductReview + +Contains details of a product review. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `average_rating` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The average of all ratings for this product. | +| `created_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date the review was created. | +| `nickname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `product` - [`ProductInterface!`](#productinterface) | The reviewed product. | +| `ratings_breakdown` - [`[ProductReviewRating]!`](#productreviewrating) | An array of ratings by rating category, such as quality, price, and value. | +| `summary` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The review text. | + +#### Example + +```json +{ + "average_rating": 123.45, + "created_at": "abc123", + "nickname": "abc123", + "product": ProductInterface, + "ratings_breakdown": [ProductReviewRating], + "summary": "xyz789", + "text": "abc123" +} +``` + + + +### ProductReviewRating + +Contains data about a single aspect of a product review. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The rating value given by customer. By default, possible values range from 1 to 5. | + +#### Example + +```json +{ + "name": "abc123", + "value": "abc123" +} +``` + + + +### ProductReviewRatingInput + +Contains the reviewer's rating for a single aspect of a review. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | An encoded rating ID. | +| `value_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | An encoded rating value ID. | + +#### Example + +```json +{ + "id": "abc123", + "value_id": "xyz789" +} +``` + + + +### ProductReviewRatingMetadata + +Contains details about a single aspect of a product review. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | An encoded rating ID. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `values` - [`[ProductReviewRatingValueMetadata]!`](#productreviewratingvaluemetadata) | List of product review ratings sorted by position. | + +#### Example + +```json +{ + "id": "abc123", + "name": "abc123", + "values": [ProductReviewRatingValueMetadata] +} +``` + + + +### ProductReviewRatingValueMetadata + +Contains details about a single value in a product review. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A ratings scale, such as the number of stars awarded. | +| `value_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | An encoded rating value ID. | + +#### Example + +```json +{ + "value": "xyz789", + "value_id": "xyz789" +} +``` + + + +### ProductReviewRatingsMetadata + +Contains an array of metadata about each aspect of a product review. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[ProductReviewRatingMetadata]!`](#productreviewratingmetadata) | An array of product reviews sorted by position. | + +#### Example + +```json +{"items": [ProductReviewRatingMetadata]} +``` + + + +### ProductReviews + +Contains an array of product reviews. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | + +#### Example + +```json +{ + "items": [ProductReview], + "page_info": SearchResultPageInfo +} +``` + + + ### ProductSearchItem A single product returned by the query @@ -3677,9 +3856,9 @@ Contains the output of a `productSearch` query "facets": [Aggregation], "items": [ProductSearchItem], "page_info": SearchResultPageInfo, - "related_terms": ["xyz789"], + "related_terms": ["abc123"], "suggestions": ["xyz789"], - "total_count": 123, + "total_count": 987, "warnings": [ProductSearchWarning] } ``` @@ -3720,7 +3899,7 @@ Structured warning with code and message for easier client handling ```json { - "code": "xyz789", + "code": "abc123", "message": "abc123" } ``` @@ -3766,10 +3945,10 @@ Contains information about a product video. ```json { "disabled": false, - "label": "abc123", - "position": 123, - "types": ["xyz789"], - "url": "abc123", + "label": "xyz789", + "position": 987, + "types": ["abc123"], + "url": "xyz789", "video_content": ProductMediaGalleryEntriesVideoContent } ``` @@ -3821,23 +4000,23 @@ Defines the product fields available to the SimpleProductView and ComplexProduct { "addToCartAllowed": false, "inStock": true, - "lowStock": false, + "lowStock": true, "attributes": [ProductViewAttribute], - "description": "xyz789", + "description": "abc123", "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", "metaDescription": "abc123", "metaKeyword": "xyz789", - "metaTitle": "abc123", + "metaTitle": "xyz789", "name": "abc123", - "shortDescription": "abc123", + "shortDescription": "xyz789", "inputOptions": [ProductViewInputOption], - "sku": "xyz789", + "sku": "abc123", "externalId": "abc123", "externalIds": [ExternalId], - "url": "abc123", + "url": "xyz789", "urlKey": "xyz789", "links": [ProductViewLink], "queryType": "xyz789", @@ -3865,8 +4044,8 @@ A container for customer-defined attributes that are displayed the storefront. ```json { "label": "xyz789", - "name": "abc123", - "roles": ["xyz789"], + "name": "xyz789", + "roles": ["abc123"], "value": {} } ``` @@ -4078,7 +4257,7 @@ Contains details about a product image. { "label": "xyz789", "roles": ["abc123"], - "url": "xyz789" + "url": "abc123" } ``` @@ -4107,16 +4286,16 @@ Product options provide a way to configure products by making selections of part ```json { - "id": 4, + "id": "4", "title": "xyz789", - "required": false, - "type": "abc123", - "markupAmount": 123.45, - "suffix": "abc123", + "required": true, + "type": "xyz789", + "markupAmount": 987.65, + "suffix": "xyz789", "sortOrder": 123, "range": ProductViewInputOptionRange, "imageSize": ProductViewInputOptionImageSize, - "fileExtensions": "xyz789" + "fileExtensions": "abc123" } ``` @@ -4136,7 +4315,7 @@ Dimensions of the image associated with the input option. #### Example ```json -{"width": 987, "height": 987} +{"width": 987, "height": 123} ``` @@ -4155,7 +4334,7 @@ Lists the value range associated with a `ProductViewInputOption`. For example, i #### Example ```json -{"from": 987.65, "to": 987.65} +{"from": 123.45, "to": 987.65} ``` @@ -4219,10 +4398,10 @@ Product options provide a way to configure products by making selections of part ```json { - "id": "4", - "multi": true, + "id": 4, + "multi": false, "required": false, - "title": "abc123", + "title": "xyz789", "values": [ProductViewOptionValue] } ``` @@ -4253,8 +4432,8 @@ Defines the product fields available to the ProductViewOptionValueProduct and Pr ```json { - "id": "4", - "title": "abc123", + "id": 4, + "title": "xyz789", "inStock": true } ``` @@ -4277,9 +4456,9 @@ An implementation of ProductViewOptionValue for configuration values. ```json { - "id": "4", + "id": 4, "title": "abc123", - "inStock": false + "inStock": true } ``` @@ -4306,10 +4485,10 @@ An implementation of ProductViewOptionValue that adds details about a simple pro ```json { "id": "4", - "isDefault": true, + "isDefault": false, "product": SimpleProductView, "quantity": 987.65, - "canEditQuantity": false, + "canEditQuantity": true, "title": "xyz789", "inStock": false } @@ -4335,11 +4514,11 @@ An implementation of ProductViewOptionValueSwatch for swatches. ```json { - "id": "4", + "id": 4, "title": "abc123", "type": "TEXT", "value": "xyz789", - "inStock": false + "inStock": true } ``` @@ -4365,7 +4544,7 @@ Base product price view. Contains the final price after discounts, the regular p "final": Price, "regular": Price, "tiers": [ProductViewTierPrice], - "roles": ["xyz789"] + "roles": ["abc123"] } ``` @@ -4464,7 +4643,7 @@ Minimum quantity (inclusive) required to activate this tier price. For example, #### Example ```json -{"gte": 123.45, "lt": 123.45} +{"gte": 987.65, "lt": 987.65} ``` @@ -4484,7 +4663,7 @@ Represents a product variant. ```json { - "selections": ["abc123"], + "selections": ["xyz789"], "product": ProductView } ``` @@ -4507,7 +4686,7 @@ Represents the results of a product variant search. ```json { "variants": [ProductViewVariant], - "cursor": "xyz789" + "cursor": "abc123" } ``` @@ -4531,9 +4710,9 @@ Contains details about a product video. For example, a video of the product bein ```json { "preview": ProductViewImage, - "url": "xyz789", + "url": "abc123", "description": "xyz789", - "title": "abc123" + "title": "xyz789" } ``` @@ -4555,7 +4734,7 @@ User purchase history ```json { "date": "2007-12-03T10:15:30Z", - "items": ["xyz789"] + "items": ["abc123"] } ``` @@ -4596,8 +4775,8 @@ Contains details about a purchase order. "order": CustomerOrder, "quote": Cart, "status": "PENDING", - "uid": 4, - "updated_at": "abc123" + "uid": "4", + "updated_at": "xyz789" } ``` @@ -4661,10 +4840,10 @@ Contains details about a single event in the approval flow of the purchase order ```json { "message": "abc123", - "name": "xyz789", - "role": "xyz789", + "name": "abc123", + "role": "abc123", "status": "PENDING", - "updated_at": "xyz789" + "updated_at": "abc123" } ``` @@ -4714,13 +4893,13 @@ Contains details about a purchase order approval rule. "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "xyz789", - "created_by": "abc123", - "description": "xyz789", - "name": "abc123", + "created_at": "abc123", + "created_by": "xyz789", + "description": "abc123", + "name": "xyz789", "status": "ENABLED", - "uid": 4, - "updated_at": "xyz789" + "uid": "4", + "updated_at": "abc123" } ``` @@ -4810,7 +4989,7 @@ Contains approval rule condition details, including the quantity to be evaluated #### Example ```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123} ``` @@ -4835,10 +5014,10 @@ Defines a new purchase order approval rule. ```json { "applies_to": [4], - "approvers": ["4"], + "approvers": [4], "condition": CreatePurchaseOrderApprovalRuleConditionInput, "description": "xyz789", - "name": "abc123", + "name": "xyz789", "status": "ENABLED" } ``` @@ -4946,9 +5125,9 @@ Contains details about a comment. ```json { "author": Customer, - "created_at": "xyz789", - "text": "abc123", - "uid": "4" + "created_at": "abc123", + "text": "xyz789", + "uid": 4 } ``` @@ -4991,8 +5170,8 @@ Contains details about a status change. ```json { - "activity": "xyz789", - "created_at": "abc123", + "activity": "abc123", + "created_at": "xyz789", "message": "xyz789", "uid": 4 } @@ -5064,7 +5243,7 @@ Contains a list of purchase orders. { "items": [PurchaseOrder], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -5131,7 +5310,7 @@ Defines the criteria to use to filter the list of purchase orders. "company_purchase_orders": true, "created_date": FilterRangeTypeInput, "my_approvals": true, - "require_my_approval": false, + "require_my_approval": true, "status": "PENDING" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md b/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md index 04b7c1f13..e28e91062 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md @@ -54,8 +54,8 @@ Sets quote template expiration date. ```json { - "expiration_date": "xyz789", - "template_id": 4 + "expiration_date": "abc123", + "template_id": "4" } ``` @@ -78,9 +78,9 @@ Sets quote item note. ```json { - "item_id": "4", - "item_uid": "4", - "note": "xyz789", + "item_id": 4, + "item_uid": 4, + "note": "abc123", "templateId": "4" } ``` @@ -103,7 +103,7 @@ Contains a notification message for a negotiable quote template. ```json { "message": "xyz789", - "type": "abc123" + "type": "xyz789" } ``` @@ -127,9 +127,9 @@ For use on numeric product fields ```json { "count": 987, - "from": 987.65, + "from": 123.45, "title": "xyz789", - "to": 123.45 + "to": 987.65 } ``` @@ -183,7 +183,7 @@ For use on numeric product fields #### Example ```json -{"from": 987.65, "to": 123.45} +{"from": 123.45, "to": 123.45} ``` @@ -202,7 +202,7 @@ For use on numeric product fields ```json { "configurations": ReCaptchaConfiguration, - "is_enabled": true + "is_enabled": false } ``` @@ -231,7 +231,7 @@ Contains reCAPTCHA form configuration details. { "badge_position": "xyz789", "language_code": "xyz789", - "minimum_score": 987.65, + "minimum_score": 123.45, "re_captcha_type": "INVISIBLE", "technical_failure_message": "xyz789", "theme": "abc123", @@ -263,14 +263,14 @@ Contains reCAPTCHA V3-Invisible configuration details. ```json { - "badge_position": "abc123", - "failure_message": "xyz789", + "badge_position": "xyz789", + "failure_message": "abc123", "forms": ["PLACE_ORDER"], - "is_enabled": false, - "language_code": "abc123", + "is_enabled": true, + "language_code": "xyz789", "minimum_score": 123.45, "theme": "xyz789", - "website_key": "abc123" + "website_key": "xyz789" } ``` @@ -372,11 +372,11 @@ Recommendation Unit containing product and other details "displayOrder": 987, "pageType": "abc123", "productsView": [ProductView], - "storefrontLabel": "abc123", + "storefrontLabel": "xyz789", "totalProducts": 987, - "typeId": "xyz789", - "unitId": "abc123", - "unitName": "abc123", + "typeId": "abc123", + "unitId": "xyz789", + "unitName": "xyz789", "label": "xyz789", "userError": "abc123" } @@ -398,7 +398,7 @@ Recommendations response #### Example ```json -{"results": [RecommendationUnit], "totalResults": 123} +{"results": [RecommendationUnit], "totalResults": 987} ``` @@ -417,7 +417,7 @@ Recommendations response ```json { - "code": "xyz789", + "code": "abc123", "id": 987, "name": "xyz789" } @@ -446,7 +446,7 @@ A single cart item whose source nomination was rejected. "available_qty": 987.65, "cart_item_uid": 4, "code": "UNKNOWN_SOURCE", - "message": "abc123", + "message": "xyz789", "requested_qty": 123.45 } ``` @@ -505,7 +505,7 @@ Remove coupons from the cart. ```json { "cart_id": "abc123", - "coupon_codes": ["abc123"] + "coupon_codes": ["xyz789"] } ``` @@ -526,8 +526,8 @@ Defines the input required to run the `removeGiftCardFromCart` mutation. ```json { - "cart_id": "abc123", - "gift_card_code": "abc123" + "cart_id": "xyz789", + "gift_card_code": "xyz789" } ``` @@ -582,7 +582,7 @@ Contains the results of a request to delete a gift registry. #### Example ```json -{"success": false} +{"success": true} ``` @@ -659,7 +659,7 @@ Defines the items to remove from the specified negotiable quote. #### Example ```json -{"quote_item_uids": [4], "quote_uid": "4"} +{"quote_item_uids": ["4"], "quote_uid": 4} ``` @@ -696,7 +696,7 @@ Defines the items to remove from the specified negotiable quote. #### Example ```json -{"item_uids": [4], "template_id": 4} +{"item_uids": ["4"], "template_id": 4} ``` @@ -715,7 +715,10 @@ Defines which products to remove from a compare list. #### Example ```json -{"products": [4], "uid": 4} +{ + "products": ["4"], + "uid": "4" +} ``` @@ -809,7 +812,7 @@ Defines the input required to run the `removeStoreCreditFromCart` mutation. #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -848,8 +851,8 @@ Sets new name for a negotiable quote. ```json { - "quote_comment": "xyz789", - "quote_name": "abc123", + "quote_comment": "abc123", + "quote_name": "xyz789", "quote_uid": "4" } ``` @@ -914,7 +917,7 @@ Contains information needed to start a return request. ```json { "comment_text": "abc123", - "contact_email": "abc123", + "contact_email": "xyz789", "items": [RequestReturnItemInput], "token": "xyz789" } @@ -942,7 +945,7 @@ Defines properties of a negotiable quote request. "cart_id": "4", "comment": NegotiableQuoteCommentInput, "is_draft": true, - "quote_name": "xyz789" + "quote_name": "abc123" } ``` @@ -979,7 +982,7 @@ Defines properties of a negotiable quote template request. #### Example ```json -{"cart_id": "4"} +{"cart_id": 4} ``` @@ -1001,10 +1004,10 @@ Contains information needed to start a return request. ```json { - "comment_text": "abc123", - "contact_email": "xyz789", + "comment_text": "xyz789", + "contact_email": "abc123", "items": [RequestReturnItemInput], - "order_uid": 4 + "order_uid": "4" } ``` @@ -1030,7 +1033,7 @@ Contains details about an item to be returned. "entered_custom_attributes": [ EnteredCustomAttributeInput ], - "order_item_uid": 4, + "order_item_uid": "4", "quantity_to_return": 987.65, "selected_custom_attributes": [ SelectedCustomAttributeInput @@ -1082,13 +1085,13 @@ Defines the contents of a requisition list. ```json { - "description": "xyz789", + "description": "abc123", "items": RequistionListItems, - "items_count": 123, + "items_count": 987, "name": "xyz789", "requisition_list_items": RequisitionListItems, - "uid": "4", - "updated_at": "abc123" + "uid": 4, + "updated_at": "xyz789" } ``` @@ -1147,9 +1150,9 @@ The interface for requisition list items. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, - "sku": "xyz789", - "uid": "4" + "quantity": 123.45, + "sku": "abc123", + "uid": 4 } ``` @@ -1173,7 +1176,7 @@ Contains an array of items added to a requisition list. { "items": [RequisitionListItemInterface], "page_info": SearchResultPageInfo, - "total_pages": 123 + "total_pages": 987 } ``` @@ -1198,8 +1201,8 @@ Defines the items to add. ```json { "entered_options": [EnteredOptionInput], - "parent_sku": "abc123", - "quantity": 987.65, + "parent_sku": "xyz789", + "quantity": 123.45, "selected_options": ["xyz789"], "sku": "xyz789" } @@ -1263,7 +1266,7 @@ Defines customer requisition lists. "items": [RequisitionList], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } ``` @@ -1287,7 +1290,7 @@ Deprecated. Use RequisitionListItems via requisition_list_items. Will be removed { "items": [RequisitionListItemInterface], "page_info": SearchResultPageInfo, - "total_pages": 987 + "total_pages": 123 } ``` @@ -1318,14 +1321,14 @@ Contains details about a return. { "available_shipping_carriers": [ReturnShippingCarrier], "comments": [ReturnComment], - "created_at": "abc123", + "created_at": "xyz789", "customer": ReturnCustomer, "items": [ReturnItem], "number": "abc123", "order": CustomerOrder, "shipping": ReturnShipping, "status": "PENDING", - "uid": "4" + "uid": 4 } ``` @@ -1348,10 +1351,10 @@ Contains details about a return comment. ```json { - "author_name": "xyz789", + "author_name": "abc123", "created_at": "abc123", - "text": "xyz789", - "uid": 4 + "text": "abc123", + "uid": "4" } ``` @@ -1373,9 +1376,9 @@ The customer information for the return. ```json { - "email": "abc123", - "firstname": "abc123", - "lastname": "xyz789" + "email": "xyz789", + "firstname": "xyz789", + "lastname": "abc123" } ``` @@ -1403,9 +1406,9 @@ Contains details about a product being returned. "custom_attributesV2": [AttributeValueInterface], "order_item": OrderItemInterface, "quantity": 123.45, - "request_quantity": 123.45, + "request_quantity": 987.65, "status": "PENDING", - "uid": 4 + "uid": "4" } ``` @@ -1437,13 +1440,13 @@ Return Item attribute metadata. ```json { - "code": 4, - "default_value": "abc123", + "code": "4", + "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": true, + "is_required": false, "is_unique": false, "label": "xyz789", "multiline_count": 987, @@ -1521,10 +1524,10 @@ Contains details about the shipping address used for receiving returned items. "city": "xyz789", "contact_name": "abc123", "country": Country, - "postcode": "abc123", + "postcode": "xyz789", "region": Region, - "street": ["abc123"], - "telephone": "xyz789" + "street": ["xyz789"], + "telephone": "abc123" } ``` @@ -1544,10 +1547,7 @@ Contains details about the carrier on a return. #### Example ```json -{ - "label": "xyz789", - "uid": "4" -} +{"label": "abc123", "uid": 4} ``` @@ -1571,8 +1571,8 @@ Contains shipping and tracking details. { "carrier": ReturnShippingCarrier, "status": ReturnShippingTrackingStatus, - "tracking_number": "xyz789", - "uid": 4 + "tracking_number": "abc123", + "uid": "4" } ``` @@ -1592,7 +1592,7 @@ Contains the status of a shipment. #### Example ```json -{"text": "abc123", "type": "INFORMATION"} +{"text": "xyz789", "type": "INFORMATION"} ``` @@ -1660,7 +1660,7 @@ Contains a list of customer return requests. { "items": [Return], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -1679,7 +1679,7 @@ Contains the result of a request to revoke a customer token. #### Example ```json -{"result": false} +{"result": true} ``` @@ -1745,8 +1745,8 @@ Contain details about the reward points transaction. ```json { "balance": RewardPointsAmount, - "change_reason": "xyz789", - "date": "xyz789", + "change_reason": "abc123", + "date": "abc123", "points_change": 987.65 } ``` @@ -1789,7 +1789,7 @@ Contains details about customer's reward points rate. #### Example ```json -{"currency_amount": 987.65, "points": 123.45} +{"currency_amount": 123.45, "points": 123.45} ``` @@ -1849,7 +1849,7 @@ Defines the name and value of a SDK parameter ```json { "name": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -1870,7 +1870,7 @@ Contains details about a comment. ```json { - "message": "xyz789", + "message": "abc123", "timestamp": "abc123" } ``` @@ -1892,7 +1892,7 @@ For use on string and other scalar product fields #### Example ```json -{"count": 987, "id": 4, "title": "abc123"} +{"count": 123, "id": 4, "title": "abc123"} ``` @@ -1936,12 +1936,12 @@ A product attribute to filter on ```json { - "attribute": "abc123", - "contains": "abc123", - "eq": "abc123", + "attribute": "xyz789", + "contains": "xyz789", + "eq": "xyz789", "in": ["xyz789"], "range": SearchRangeInput, - "startsWith": "xyz789" + "startsWith": "abc123" } ``` @@ -1981,7 +1981,7 @@ Provides navigation for the query response. #### Example ```json -{"current_page": 987, "page_size": 123, "total_pages": 987} +{"current_page": 123, "page_size": 987, "total_pages": 123} ``` @@ -2003,12 +2003,12 @@ Provides navigation for the query response. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "entered_options": [EnteredOptionInput], - "quantity": 987, + "quantity": 123, "rule_id": 987, "selected_options": [4], - "sku": "abc123" + "sku": "xyz789" } ``` @@ -2048,8 +2048,8 @@ Contains details about a selected bundle option. ```json { "label": "abc123", - "type": "abc123", - "uid": "4", + "type": "xyz789", + "uid": 4, "values": [SelectedBundleOptionValue] } ``` @@ -2103,7 +2103,7 @@ Contains details about a selected configurable option. { "configurable_product_option_uid": 4, "configurable_product_option_value_uid": "4", - "option_label": "abc123", + "option_label": "xyz789", "value_label": "abc123" } ``` @@ -2125,7 +2125,7 @@ Contains details about an attribute the buyer selected. ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "value": "xyz789" } ``` @@ -2151,9 +2151,9 @@ Identifies a customized product that has been placed in a cart. ```json { - "customizable_option_uid": 4, + "customizable_option_uid": "4", "is_required": false, - "label": "abc123", + "label": "xyz789", "sort_order": 123, "type": "xyz789", "values": [SelectedCustomizableOptionValue] @@ -2207,8 +2207,8 @@ Describes the payment method selected by the shopper. { "code": "abc123", "oope_payment_method_config": OopePaymentMethodConfig, - "purchase_order_number": "abc123", - "title": "abc123" + "purchase_order_number": "xyz789", + "title": "xyz789" } ``` @@ -2238,7 +2238,7 @@ Contains details about the selected shipping method and carrier. "additional_data": [ShippingAdditionalData], "amount": Money, "carrier_code": "abc123", - "carrier_title": "abc123", + "carrier_title": "xyz789", "method_code": "xyz789", "method_title": "abc123", "price_excl_tax": Money, @@ -2442,11 +2442,11 @@ Defines the gift options applied to the cart. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "gift_message": GiftMessageInput, "gift_receipt_included": true, - "gift_wrapping_id": "4", - "printed_card_included": false + "gift_wrapping_id": 4, + "printed_card_included": true } ``` @@ -2584,7 +2584,7 @@ Defines the payment method of the specified negotiable quote. ```json { "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -2623,7 +2623,7 @@ Defines the shipping address to assign to the negotiable quote. ```json { - "quote_uid": "4", + "quote_uid": 4, "shipping_addresses": [ NegotiableQuoteShippingAddressInput ] @@ -2665,7 +2665,7 @@ Defines the shipping method to apply to the negotiable quote. ```json { - "quote_uid": 4, + "quote_uid": "4", "shipping_methods": [ShippingMethodInput] } ``` @@ -2706,7 +2706,7 @@ Defines the shipping address to assign to the negotiable quote template. ```json { "shipping_address": NegotiableQuoteTemplateShippingAddressInput, - "template_id": 4 + "template_id": "4" } ``` @@ -2727,7 +2727,7 @@ Input for the setNominatedSourceOnCartItems mutation. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "items": [NominatedSourceItemInput] } ``` @@ -2811,7 +2811,7 @@ Specifies an array of addresses to use for shipping. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "shipping_addresses": [ShippingAddressInput] } ``` @@ -2911,7 +2911,7 @@ Contains the results of a request to share a gift registry. #### Example ```json -{"is_shared": true} +{"is_shared": false} ``` @@ -2995,7 +2995,7 @@ The result of sharing a requisition list by token. #### Example ```json -{"token": "abc123"} +{"token": "xyz789"} ``` @@ -3059,7 +3059,7 @@ Shared requisition list view for a recipient. ```json { "requisition_list": RequisitionList, - "sender_name": "abc123" + "sender_name": "xyz789" } ``` @@ -3103,10 +3103,10 @@ Defines whether bundle items must be shipped together. { "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", - "quantity_shipped": 987.65 + "quantity_shipped": 123.45 } ``` @@ -3144,7 +3144,7 @@ Order shipment item details. "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_shipped": 123.45 + "quantity_shipped": 987.65 } ``` @@ -3167,10 +3167,10 @@ Contains order shipment tracking details. ```json { - "carrier": "xyz789", + "carrier": "abc123", "number": "abc123", - "title": "abc123", - "tracking_url": "xyz789" + "title": "xyz789", + "tracking_url": "abc123" } ``` @@ -3191,7 +3191,7 @@ A simple key value object. ```json { - "key": "abc123", + "key": "xyz789", "value": "xyz789" } ``` @@ -3218,10 +3218,10 @@ Defines a single shipping address. ```json { "address": CartAddressInput, - "company_address_id": "4", - "customer_address_id": 987, - "customer_address_uid": 4, - "customer_notes": "xyz789", + "company_address_id": 4, + "customer_address_id": 123, + "customer_address_uid": "4", + "customer_notes": "abc123", "pickup_location_code": "xyz789" } ``` @@ -3268,29 +3268,29 @@ Contains shipping addresses and methods. { "available_shipping_methods": [AvailableShippingMethod], "cart_items_v2": [CartItemInterface], - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "company_address_id": "4", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, + "customer_address_uid": "4", "customer_notes": "xyz789", - "fax": "xyz789", + "fax": "abc123", "firstname": "abc123", "id": 987, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", - "pickup_location_code": "abc123", + "pickup_location_code": "xyz789", "postcode": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "region": CartAddressRegion, - "same_as_billing": false, + "same_as_billing": true, "selected_shipping_method": SelectedShippingMethod, - "street": ["abc123"], - "suffix": "abc123", + "street": ["xyz789"], + "suffix": "xyz789", "telephone": "abc123", - "uid": 4, - "vat_id": "xyz789" + "uid": "4", + "vat_id": "abc123" } ``` @@ -3357,7 +3357,7 @@ Defines the shipping carrier and method. ```json { - "carrier_code": "abc123", + "carrier_code": "xyz789", "method_code": "xyz789" } ``` @@ -3400,21 +3400,21 @@ An implementation for simple product cart items. ```json { "available_gift_wrapping": [GiftWrapping], - "backorder_message": "abc123", + "backorder_message": "xyz789", "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": true, + "is_available": false, "is_free_gift": true, - "is_salable": true, - "max_qty": 123.45, - "min_qty": 123.45, + "is_salable": false, + "max_qty": 987.65, + "min_qty": 987.65, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], - "not_available_message": "abc123", + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -3462,7 +3462,10 @@ Defines a simple product, which is tangible and is usually sold in single units | `price_tiers` - [`[TierPrice]`](/reference/graphql/saas/types-t-z.md#tierprice) | An array of `TierPrice` objects. | | `product_links` - [`[ProductLinksInterface]`](/reference/graphql/saas/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | | `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Quantity of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The average of all the ratings given to the product. | | `related_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `review_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/saas/types-k-p.md#productreviews) | The list of products reviews. | | `short_description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | | `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | | `small_image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | @@ -3482,44 +3485,47 @@ Defines a simple product, which is tangible and is usually sold in single units { "canonical_url": "xyz789", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": true, - "gift_wrapping_available": true, + "gift_message_available": false, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", "manufacturer": 123, "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], - "meta_description": "abc123", + "meta_description": "xyz789", "meta_keyword": "xyz789", "meta_title": "abc123", - "min_sale_qty": 123.45, - "name": "xyz789", + "min_sale_qty": 987.65, + "name": "abc123", "new_from_date": "xyz789", - "new_to_date": "xyz789", - "only_x_left_in_stock": 987.65, + "new_to_date": "abc123", + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, + "rating_summary": 987.65, "related_products": [ProductInterface], + "review_count": 987, + "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, - "special_price": 987.65, + "special_price": 123.45, "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 } ``` @@ -3565,28 +3571,28 @@ Represents a single-SKU product without selectable variants. Because there are n { "addToCartAllowed": true, "inStock": false, - "lowStock": true, + "lowStock": false, "attributes": [ProductViewAttribute], - "description": "xyz789", - "id": 4, + "description": "abc123", + "id": "4", "images": [ProductViewImage], "videos": [ProductViewVideo], "inputOptions": [ProductViewInputOption], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "xyz789", - "metaKeyword": "xyz789", - "metaTitle": "abc123", + "metaDescription": "abc123", + "metaKeyword": "abc123", + "metaTitle": "xyz789", "name": "xyz789", "price": ProductViewPrice, - "shortDescription": "abc123", - "sku": "abc123", + "shortDescription": "xyz789", + "sku": "xyz789", "externalId": "xyz789", "externalIds": [ExternalId], - "url": "xyz789", + "url": "abc123", "urlKey": "abc123", "links": [ProductViewLink], - "queryType": "xyz789", - "visibility": "xyz789" + "queryType": "abc123", + "visibility": "abc123" } ``` @@ -3612,7 +3618,7 @@ Contains details about simple products added to a requisition list. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "sku": "abc123", "uid": "4" } @@ -3641,10 +3647,10 @@ Contains a simple product wish list item. { "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", + "description": "xyz789", + "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -3689,7 +3695,7 @@ Smart button payment inputs ```json { "payment_source": "abc123", - "payments_order_id": "abc123", + "payments_order_id": "xyz789", "paypal_order_id": "abc123" } ``` @@ -3720,15 +3726,15 @@ Smart button payment inputs { "app_switch_when_available": true, "button_styles": ButtonStyles, - "code": "xyz789", - "display_message": true, - "display_venmo": false, + "code": "abc123", + "display_message": false, + "display_venmo": true, "is_visible": false, "message_styles": MessageStyles, - "payment_intent": "xyz789", + "payment_intent": "abc123", "sdk_params": [SDKParams], - "sort_order": "abc123", - "title": "xyz789" + "sort_order": "xyz789", + "title": "abc123" } ``` @@ -3768,8 +3774,8 @@ Defines a possible sort field. ```json { - "label": "abc123", - "value": "abc123" + "label": "xyz789", + "value": "xyz789" } ``` @@ -3865,9 +3871,9 @@ Contains product attributes that be used for sorting in a `productSearch` query ```json { "attribute": "xyz789", - "frontendInput": "abc123", + "frontendInput": "xyz789", "label": "abc123", - "numeric": false + "numeric": true } ``` @@ -3883,6 +3889,8 @@ Availability of a SKU at a single inventory source. |------------|-------------| | `available_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Saleable quantity at the source, net of open source-level reservations. The exact value is returned only when it is at or below the merchant's storefront display threshold (cataloginventory/options/stock_threshold_qty); above the threshold it is null and only is_in_stock is meaningful. That threshold defaults to 0, so by default every positive quantity is masked to null and is_in_stock is the authoritative signal. | | `is_in_stock` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether the SKU is salable at the source (available quantity greater than zero). | +| `is_pickup_location_active` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Whether the source is an active in-store pickup location. | +| `name` - [`String`](#string) | Display name of the source, for labelling a store or warehouse. | | `sku` - [`String!`](#string) | The product SKU the availability applies to. | | `source_code` - [`String!`](#string) | The inventory source code. | @@ -3891,8 +3899,10 @@ Availability of a SKU at a single inventory source. ```json { "available_qty": 123.45, - "is_in_stock": false, - "sku": "xyz789", + "is_in_stock": true, + "is_pickup_location_active": true, + "name": "xyz789", + "sku": "abc123", "source_code": "xyz789" } ``` @@ -3915,7 +3925,7 @@ For retrieving statistics across multiple buckets ```json { - "max": 987.65, + "max": 123.45, "min": 987.65, "title": "abc123" } @@ -3935,6 +3945,7 @@ Contains information about a store's configuration. | `allow_gift_receipt` - [`String`](#string) | Indicates if the gift sender has the option to send a gift receipt. Possible values: 1 (Yes) and 0 (No). | | `allow_gift_wrapping_on_order` - [`String`](#string) | Indicates whether gift wrapping can be added for the entire order. Possible values: 1 (Yes) and 0 (No). | | `allow_gift_wrapping_on_order_items` - [`String`](#string) | Indicates whether gift wrapping can be added for individual order items. Possible values: 1 (Yes) and 0 (No). | +| `allow_guests_to_write_product_reviews` - [`String`](#string) | Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No). | | `allow_items` - [`String`](#string) | The value of the Allow Gift Messages for Order Items option | | `allow_order` - [`String`](#string) | The value of the Allow Gift Messages on Order Level option | | `allow_printed_card` - [`String`](#string) | Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No). | @@ -4033,6 +4044,7 @@ Contains information about a store's configuration. | `printed_card_priceV2` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The default price of a printed card that accompanies an order. | | `product_alert_allow_stock` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether back-in-stock (Notify Me) product alerts are enabled. Configuration data from catalog/productalert/allow_stock. | | `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/saas/types-f-i.md#fixedproducttaxdisplaysettings) | Corresponds to the 'Display Prices On Product View Page' field in the Admin. It indicates how FPT information is displayed on product pages. | +| `product_reviews_enabled` - [`String`](#string) | Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No). | | `product_url_suffix` - [`String`](#string) | The suffix applied to product pages, such as `.htm` or `.html`. | | `quickorder_active` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether quick order functionality is enabled. | | `quote_minimum_amount` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Minimum order total for quote request. | @@ -4088,155 +4100,157 @@ Contains information about a store's configuration. ```json { "allow_company_registration": true, - "allow_gift_receipt": "abc123", + "allow_gift_receipt": "xyz789", "allow_gift_wrapping_on_order": "xyz789", - "allow_gift_wrapping_on_order_items": "abc123", + "allow_gift_wrapping_on_order_items": "xyz789", + "allow_guests_to_write_product_reviews": "abc123", "allow_items": "abc123", "allow_order": "abc123", - "allow_printed_card": "abc123", - "autocomplete_on_storefront": false, - "base_currency_code": "abc123", + "allow_printed_card": "xyz789", + "autocomplete_on_storefront": true, + "base_currency_code": "xyz789", "base_link_url": "xyz789", "base_media_url": "abc123", "base_static_url": "abc123", - "base_url": "abc123", + "base_url": "xyz789", "cart_expires_in_days": 987, - "cart_gift_wrapping": "abc123", + "cart_gift_wrapping": "xyz789", "cart_merge_preference": "abc123", - "cart_printed_card": "xyz789", - "cart_summary_display_quantity": 123, + "cart_printed_card": "abc123", + "cart_summary_display_quantity": 987, "catalog_default_sort_by": "xyz789", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "category_url_suffix": "xyz789", + "category_url_suffix": "abc123", "check_money_order_enable_for_specific_countries": true, "check_money_order_enabled": true, "check_money_order_make_check_payable_to": "abc123", - "check_money_order_max_order_total": "xyz789", - "check_money_order_min_order_total": "abc123", - "check_money_order_new_order_status": "abc123", - "check_money_order_payment_from_specific_countries": "abc123", - "check_money_order_send_check_to": "abc123", + "check_money_order_max_order_total": "abc123", + "check_money_order_min_order_total": "xyz789", + "check_money_order_new_order_status": "xyz789", + "check_money_order_payment_from_specific_countries": "xyz789", + "check_money_order_send_check_to": "xyz789", "check_money_order_sort_order": 123, "check_money_order_title": "xyz789", "company_credit_enabled": true, - "company_enabled": true, + "company_enabled": false, "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "xyz789", - "contact_enabled": false, - "countries_with_required_region": "abc123", + "contact_enabled": true, + "countries_with_required_region": "xyz789", "create_account_confirmation": false, - "customer_access_token_lifetime": 123.45, + "customer_access_token_lifetime": 987.65, "default_country": "abc123", "default_display_currency_code": "abc123", "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": false, + "display_state_if_optional": false, + "enable_multiple_wishlists": "xyz789", + "fixed_product_taxes_apply_tax_to_fpt": true, "fixed_product_taxes_display_prices_in_emails": 987, - "fixed_product_taxes_display_prices_in_product_lists": 123, + "fixed_product_taxes_display_prices_in_product_lists": 987, "fixed_product_taxes_display_prices_in_sales_modules": 987, "fixed_product_taxes_display_prices_on_product_view_page": 987, - "fixed_product_taxes_enable": true, + "fixed_product_taxes_enable": false, "fixed_product_taxes_include_fpt_in_subtotal": false, - "graphql_share_customer_group": false, + "graphql_share_customer_group": true, "grid_per_page": 123, - "grid_per_page_values": "abc123", + "grid_per_page_values": "xyz789", "grouped_product_image": "ITSELF", - "is_checkout_agreements_enabled": true, + "is_checkout_agreements_enabled": false, "is_default_store": false, "is_default_store_group": true, "is_guest_checkout_enabled": false, - "is_negotiable_quote_active": true, - "is_one_page_checkout_enabled": true, - "is_requisition_list_active": "abc123", + "is_negotiable_quote_active": false, + "is_one_page_checkout_enabled": false, + "is_requisition_list_active": "xyz789", "list_mode": "xyz789", "list_per_page": 123, "list_per_page_values": "xyz789", "locale": "abc123", "magento_reward_general_is_enabled": "abc123", - "magento_reward_general_is_enabled_on_front": "xyz789", - "magento_reward_general_min_points_balance": "abc123", - "magento_reward_general_publish_history": "abc123", + "magento_reward_general_is_enabled_on_front": "abc123", + "magento_reward_general_min_points_balance": "xyz789", + "magento_reward_general_publish_history": "xyz789", "magento_reward_points_invitation_customer": "abc123", - "magento_reward_points_invitation_customer_limit": "xyz789", + "magento_reward_points_invitation_customer_limit": "abc123", "magento_reward_points_invitation_order": "abc123", "magento_reward_points_invitation_order_limit": "xyz789", "magento_reward_points_newsletter": "xyz789", - "magento_reward_points_order": "xyz789", + "magento_reward_points_order": "abc123", "magento_reward_points_register": "xyz789", - "magento_reward_points_review": "xyz789", - "magento_reward_points_review_limit": "abc123", - "magento_wishlist_general_is_enabled": "xyz789", - "max_items_in_order_summary": 123, - "maximum_number_of_wishlists": "xyz789", - "minicart_display": true, + "magento_reward_points_review": "abc123", + "magento_reward_points_review_limit": "xyz789", + "magento_wishlist_general_is_enabled": "abc123", + "max_items_in_order_summary": 987, + "maximum_number_of_wishlists": "abc123", + "minicart_display": false, "minicart_max_items": 123, "minimum_password_length": "abc123", - "newsletter_enabled": false, + "newsletter_enabled": true, "optional_zip_countries": "abc123", - "order_cancellation_enabled": false, + "order_cancellation_enabled": true, "order_cancellation_reasons": [CancellationReason], - "orders_invoices_credit_memos_display_full_summary": false, + "orders_invoices_credit_memos_display_full_summary": true, "orders_invoices_credit_memos_display_grandtotal": true, - "orders_invoices_credit_memos_display_price": 987, + "orders_invoices_credit_memos_display_price": 123, "orders_invoices_credit_memos_display_shipping_amount": 987, "orders_invoices_credit_memos_display_subtotal": 123, - "orders_invoices_credit_memos_display_zero_tax": true, + "orders_invoices_credit_memos_display_zero_tax": false, "persistent_enabled": false, "persistent_options_wishlist": true, "persistent_shopping_cart": true, "printed_card_priceV2": Money, "product_alert_allow_stock": true, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_url_suffix": "abc123", + "product_reviews_enabled": "xyz789", + "product_url_suffix": "xyz789", "quickorder_active": false, - "quote_minimum_amount": 987.65, + "quote_minimum_amount": 123.45, "quote_minimum_amount_message": "xyz789", "required_character_classes_number": "abc123", "requisition_list_share_link_validity_days": 987, - "requisition_list_share_max_recipients": 123, + "requisition_list_share_max_recipients": 987, "requisition_list_share_storefront_path": "xyz789", - "requisition_list_sharing_enabled": false, + "requisition_list_sharing_enabled": true, "returns_enabled": "xyz789", "root_category_uid": 4, "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "sales_gift_wrapping": "abc123", + "sales_gift_wrapping": "xyz789", "sales_printed_card": "abc123", - "secure_base_link_url": "abc123", - "secure_base_media_url": "abc123", - "secure_base_static_url": "abc123", + "secure_base_link_url": "xyz789", + "secure_base_media_url": "xyz789", + "secure_base_static_url": "xyz789", "secure_base_url": "abc123", - "share_active_segments": true, - "share_applied_cart_rule": true, + "share_active_segments": false, + "share_applied_cart_rule": false, "share_customer_accounts_scope": 123, - "shopping_assistance_checkbox_title": "abc123", - "shopping_assistance_checkbox_tooltip": "abc123", + "shopping_assistance_checkbox_title": "xyz789", + "shopping_assistance_checkbox_tooltip": "xyz789", "shopping_assistance_enabled": true, - "shopping_cart_display_full_summary": false, - "shopping_cart_display_grand_total": true, - "shopping_cart_display_price": 987, - "shopping_cart_display_shipping": 987, + "shopping_cart_display_full_summary": true, + "shopping_cart_display_grand_total": false, + "shopping_cart_display_price": 123, + "shopping_cart_display_shipping": 123, "shopping_cart_display_subtotal": 123, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", - "shopping_cart_display_zero_tax": false, + "shopping_cart_display_zero_tax": true, "store_code": "4", - "store_group_code": "4", + "store_group_code": 4, "store_group_name": "xyz789", "store_name": "xyz789", "store_sort_order": 123, - "timezone": "abc123", + "timezone": "xyz789", "title_separator": "abc123", - "use_store_in_url": true, - "website_code": 4, - "website_name": "xyz789", - "weight_unit": "xyz789", + "use_store_in_url": false, + "website_code": "4", + "website_name": "abc123", + "weight_unit": "abc123", "zero_subtotal_enable_for_specific_countries": true, "zero_subtotal_enabled": false, "zero_subtotal_new_order_status": "abc123", "zero_subtotal_payment_action": "xyz789", - "zero_subtotal_payment_from_specific_countries": "abc123", - "zero_subtotal_sort_order": 123, + "zero_subtotal_payment_from_specific_countries": "xyz789", + "zero_subtotal_sort_order": 987, "zero_subtotal_title": "xyz789" } ``` @@ -4376,7 +4390,7 @@ Represents the subtree of the categories to retrieve. #### Example ```json -{"depth": 123, "startLevel": 987} +{"depth": 987, "startLevel": 123} ``` @@ -4400,7 +4414,7 @@ Represents the subtree of the categories to retrieve. #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -4477,7 +4491,7 @@ Synchronizes the payment order details ```json { "cartId": "xyz789", - "id": "xyz789" + "id": "abc123" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md b/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md index 32de9cbc7..a5940f4ad 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md @@ -17,8 +17,8 @@ Contains tax item details. ```json { "amount": Money, - "rate": 123.45, - "title": "abc123" + "rate": 987.65, + "title": "xyz789" } ``` @@ -53,7 +53,7 @@ Contains tax item details. #### Example ```json -{"value": "xyz789"} +{"value": "abc123"} ``` @@ -115,7 +115,7 @@ Defines the input schema for unassigning a child company from its parent company #### Example ```json -{"child_company_id": 4} +{"child_company_id": "4"} ``` @@ -157,12 +157,12 @@ Contains the response to the request to unassign a child company. ```json { - "unitName": "xyz789", - "storefrontLabel": "abc123", - "pagePlacement": "xyz789", - "displayNumber": 123, - "pageType": "xyz789", - "unitStatus": "abc123", + "unitName": "abc123", + "storefrontLabel": "xyz789", + "pagePlacement": "abc123", + "displayNumber": 987, + "pageType": "abc123", + "unitStatus": "xyz789", "typeId": "abc123", "filterRules": [FilterRuleInput] } @@ -186,7 +186,7 @@ Provide either rec unit ids or labels to retrieve rec units ```json { "unitIds": ["xyz789"], - "labels": ["abc123"] + "labels": ["xyz789"] } ``` @@ -207,7 +207,7 @@ Modifies the specified items in the cart. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [CartItemUpdateInput] } ``` @@ -411,8 +411,8 @@ Defines updates to an item in a gift registry. ```json { - "gift_registry_item_uid": "4", - "note": "xyz789", + "gift_registry_item_uid": 4, + "note": "abc123", "quantity": 987.65 } ``` @@ -477,7 +477,7 @@ Defines updates to an existing registrant. GiftRegistryDynamicAttributeInput ], "email": "xyz789", - "firstname": "xyz789", + "firstname": "abc123", "gift_registry_registrant_uid": "4", "lastname": "abc123" } @@ -537,7 +537,7 @@ Specifies the items to update. ```json { "items": [NegotiableQuoteItemQuantityInput], - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -625,13 +625,13 @@ Defines the changes to be made to an approval rule. ```json { - "applies_to": [4], + "applies_to": ["4"], "approvers": ["4"], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "abc123", + "description": "xyz789", "name": "xyz789", "status": "ENABLED", - "uid": 4 + "uid": "4" } ``` @@ -652,7 +652,7 @@ An input object that defines which requistion list characteristics to update. ```json { - "description": "abc123", + "description": "xyz789", "name": "abc123" } ``` @@ -677,7 +677,7 @@ Defines which items in a requisition list to update. ```json { "entered_options": [EnteredOptionInput], - "item_id": 4, + "item_id": "4", "quantity": 123.45, "selected_options": ["xyz789"] } @@ -737,8 +737,8 @@ Contains the name and visibility of an updated wish list. ```json { - "name": "abc123", - "uid": "4", + "name": "xyz789", + "uid": 4, "visibility": "PUBLIC" } ``` @@ -761,7 +761,7 @@ Defines the input for returning matching companies the customer is assigned to. ```json { - "currentPage": 123, + "currentPage": 987, "pageSize": 123, "sort": [CompaniesSortInput] } @@ -975,9 +975,9 @@ Vault payment inputs ```json { - "payment_source": "abc123", - "payments_order_id": "abc123", - "paypal_order_id": "abc123", + "payment_source": "xyz789", + "payments_order_id": "xyz789", + "paypal_order_id": "xyz789", "public_hash": "xyz789" } ``` @@ -1087,7 +1087,7 @@ An implementation for virtual product cart items. "is_free_gift": false, "is_salable": true, "max_qty": 987.65, - "min_qty": 123.45, + "min_qty": 987.65, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], "not_available_message": "abc123", @@ -1095,7 +1095,7 @@ An implementation for virtual product cart items. "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "uid": 4 } ``` @@ -1138,7 +1138,10 @@ Defines a virtual product, which is a non-tangible product that does not require | `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | | `product_links` - [`[ProductLinksInterface]`](/reference/graphql/saas/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | | `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Quantity of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The average of all the ratings given to the product. | | `related_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `review_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/saas/types-k-p.md#productreviews) | The list of products reviews. | | `short_description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | | `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | | `small_image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | @@ -1157,7 +1160,7 @@ Defines a virtual product, which is a non-tangible product that does not require { "canonical_url": "xyz789", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, @@ -1165,36 +1168,39 @@ Defines a virtual product, which is a non-tangible product that does not require "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "xyz789", + "is_returnable": "abc123", "manufacturer": 123, "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], - "meta_description": "abc123", - "meta_keyword": "xyz789", + "meta_description": "xyz789", + "meta_keyword": "abc123", "meta_title": "xyz789", - "min_sale_qty": 123.45, + "min_sale_qty": 987.65, "name": "xyz789", "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "xyz789", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "quantity": 987.65, + "rating_summary": 123.45, "related_products": [ProductInterface], + "review_count": 987, + "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, "special_price": 987.65, - "special_to_date": "abc123", + "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" } ``` @@ -1247,12 +1253,12 @@ Contains a virtual product wish list item. ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -1319,12 +1325,12 @@ Contains a customer wish list. ```json { - "id": "4", - "items_count": 123, + "id": 4, + "items_count": 987, "items_v2": WishlistItems, "name": "abc123", "sharing_code": "xyz789", - "updated_at": "xyz789", + "updated_at": "abc123", "visibility": "PUBLIC" } ``` @@ -1349,9 +1355,9 @@ Contains details about errors encountered when a customer added wish list items ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123", - "wishlistId": "4", - "wishlistItemId": "4" + "message": "xyz789", + "wishlistId": 4, + "wishlistItemId": 4 } ``` @@ -1394,7 +1400,7 @@ Specifies the IDs of items to copy and their quantities. ```json { - "quantity": 123.45, + "quantity": 987.65, "wishlist_item_id": "4" } ``` @@ -1420,9 +1426,9 @@ Defines the items to add to a wish list. ```json { "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 987.65, - "selected_options": [4], + "parent_sku": "abc123", + "quantity": 123.45, + "selected_options": ["4"], "sku": "xyz789" } ``` @@ -1465,7 +1471,7 @@ The interface for wish list items. "description": "abc123", "id": "4", "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -1508,7 +1514,7 @@ Defines updates to items in a wish list. ```json { - "description": "xyz789", + "description": "abc123", "entered_options": [EnteredOptionInput], "quantity": 123.45, "selected_options": ["4"],