From 4e9a457808ebebd4805fa317be6a513580014f2d Mon Sep 17 00:00:00 2001 From: CJ Date: Tue, 8 Dec 2020 15:51:20 +0530 Subject: [PATCH 01/15] Added documentation for requisition list mutation --- src/_data/toc/graphql.yml | 16 +++ src/_includes/graphql/requisition-list.md | 9 ++ .../add-products-to-requisition-list.md | 102 ++++++++++++++++++ .../add-requisition-list-items-to-cart.md | 98 +++++++++++++++++ .../graphql/mutations/clear-customer-cart.md | 76 +++++++++++++ .../update-requisition-list-items.md | 101 +++++++++++++++++ 6 files changed, 402 insertions(+) create mode 100644 src/_includes/graphql/requisition-list.md create mode 100644 src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md create mode 100644 src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md create mode 100644 src/guides/v2.4/graphql/mutations/clear-customer-cart.md create mode 100644 src/guides/v2.4/graphql/mutations/update-requisition-list-items.md diff --git a/src/_data/toc/graphql.yml b/src/_data/toc/graphql.yml index 4dc3eeca68e..30046bcb732 100644 --- a/src/_data/toc/graphql.yml +++ b/src/_data/toc/graphql.yml @@ -181,10 +181,18 @@ pages: - label: addDownloadableProductsToCart mutation url: /graphql/mutations/add-downloadable-products.html + - label: addProductsToRequisitionList mutation + url: /graphql/mutations/add-products-to-requisition-list.html + exclude_versions: [ "2.3" ] + - label: addProductsToWishlist mutation url: /graphql/mutations/add-products-to-wishlist.html exclude_versions: ["2.3"] + - label: addRequisitionListItemsToCart mutation + url: /graphql/mutations/add-requisition-list-items-to-cart.html + exclude_versions: [ "2.3" ] + - label: addSimpleProductsToCart mutation url: /graphql/mutations/add-simple-products.html @@ -210,6 +218,10 @@ pages: - label: changeCustomerPassword mutation url: /graphql/mutations/change-customer-password.html + - label: clearCustomerCart mutation + url: /graphql/mutations/clear-customer-cart.html + exclude_versions: [ "2.3" ] + - label: copyProductsToWishlist mutation url: /graphql/mutations/copy-products-to-wishlist.html edition: ee-only @@ -449,6 +461,10 @@ pages: url: /graphql/mutations/update-products-in-wishlist.html exclude_versions: ["2.3"] + - label: updateRequisitionListItems mutation + url: /graphql/mutations/update-requisition-list-items.html + exclude_versions: [ "2.3" ] + - label: updateWishlist mutation url: /graphql/mutations/update-wishlist.html edition: ee-only diff --git a/src/_includes/graphql/requisition-list.md b/src/_includes/graphql/requisition-list.md new file mode 100644 index 00000000000..8a13827b10c --- /dev/null +++ b/src/_includes/graphql/requisition-list.md @@ -0,0 +1,9 @@ +The `RequisitionList` object contains the following attributes. + +Attribute | Data Type | Description +--- | --- | --- +`description` | String! | Optional text that describes the requisition list +`items` | RequistionListItems | An array of products added to the requisition list +`items_count` | Int! | The number of items in the list +`name` | String! | The requisition list name +`updated_at` | String | The time of the last modification of the requisition list \ No newline at end of file diff --git a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md new file mode 100644 index 00000000000..d2489c51c0a --- /dev/null +++ b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md @@ -0,0 +1,102 @@ +--- +group: graphql +title: addProductsToRequisitionList mutation +b2b_only: true +contributor_name: EY +--- +The `addProductsToRequisitionList` mutation adds products to requisition list. + +This mutation requires a valid [customer authentication token]({{page.baseurl}}/graphql/mutations/generate-customer-token.html). + +{:.bs-callout-info} +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `btob_website_configuration_requisition_list_active` attribute to determine whether requisition lists are supported. + +## Syntax + +```graphql +mutation { + addProductsToRequisitionList( + requisitionListUid: ID! + requisitionListItems: [RequisitionListItemsInput!]! + ) { + AddProductsToRequisitionListOutput + } +} +``` + +## Example usage + +The following example adds products to requisition list. + +**Request:** + +``` graphql +mutation { + addProductsToRequisitionList( + requisitionListUid: "1", + requisitionListItems: [ + { + sku: "sku" + quantity: 1 + selected_options: ["Y29uZmlndXJhYmxlLzkzLzUz","Y29uZmlndXJhYmxlLzE0NC8xNzE="] + entered_options: ["2","3"] + } + ] + ) { + requisition_list { + uid, + items_count + } + } +} +``` + +**Response:** + +``` json +{ + "data": { + "addProductsToRequisitionList": { + "requisition_list": { + "uid": "1", + "items_count": 1 + } + } + } +} +``` + +## Input attributes + +The `addProductsToRequisitionList` mutation requires the following input. + +Attribute | Data Type | Description +--- | --- | --- +`requisitionListUid`| ID | The unique ID of the requisition list. +`requisitionListItems`| [[RequisitionListItemsInput](#requisitionListItemsInput)] | An array of products to be added to the requisition list. + +## Output attributes + +The `addProductsToRequisitionList` object returns the requisition list object. + +Attribute | Data Type | Description +--- | --- | --- +`requisition_list` | [[RequisitionList](#requisitionList)] | The requisition list after the items were added. + +### RequisitionListItemsInput attributes {#requisitionListItemsInput} + +The `RequisitionListItemsInput` type contains the list of products to add in requisition list. + +Attribute | Data Type | Description +--- | --- | --- +`sku` | String! | The product SKU. +`quantity` | Float | The quantity of the product to add. +`parent_sku` | String | For configurable products, the SKU of the parent product. +`selected_options` | [String!] | An array of selected option IDs. +`entered_options` | [EnteredOptionInput!] | An array of customer entered option IDs. + +### RequisitionList attributes {#requisitionList} + +The `RequisitionList` object can contain the following attributes. + +{% include graphql/requisition-list.md %} \ No newline at end of file diff --git a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md new file mode 100644 index 00000000000..88561376635 --- /dev/null +++ b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md @@ -0,0 +1,98 @@ +--- +group: graphql +title: addRequisitionListItemsToCart mutation +b2b_only: true +contributor_name: EY +--- +The `addRequisitionListItemsToCart` mutation adds requisition list items to cart. + +This mutation requires a valid [customer authentication token]({{page.baseurl}}/graphql/mutations/generate-customer-token.html). + +{:.bs-callout-info} +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `btob_website_configuration_requisition_list_active` attribute to determine whether requisition lists are supported. + +## Syntax + +```graphql +mutation { + addRequisitionListItemsToCart ( + requisitionListUid: ID + requisitionListItemUids: [ID!] + ) { + AddRequisitionListItemsToCartOutput + } +} +``` + +## Example usage + +The following example adds products to requisition list. + +**Request:** + +``` graphql +mutation { + addRequisitionListItemsToCart + ( + requisitionListUid: "1" + requisitionListItemUids: ["1","2"] + ) { + status + } +} +``` + +**Response:** + +``` json +{ + "data": { + "addRequisitionListItemsToCart": { + status: "true" + } + } +} +``` + +## Input attributes + +The `addRequisitionListItemsToCart` mutation requires the following input. + +Attribute | Data Type | Description +--- | --- | --- +`requisitionListUid`| ID | The unique ID of the requisition list. +`requisitionListItemUids`| [ID!] | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. + +## Output attributes + +The `addRequisitionListItemsToCart` object returns the status, cart and errors object. + +Attribute | Data Type | Description +--- | --- | --- +`status` | Boolean! | Indicates whether the attempt to add items to the requisition list was successful. +`add_requisition_list_items_to_cart_user_errors` | [[AddRequisitionListItemToCartUserError!](#addRequisitionListItemToCartUserError)] | Indicates why the attempt to add items to the requistion list was not successful. +`cart` | [Cart](#cartObject) | The cart after adding requisition list items. + +### AddRequisitionListItemToCartUserError attributes {#addRequisitionListItemToCartUserError} + +The `AddRequisitionListItemToCartUserError` type contains the list of errors which indicates why the attempt to add items to the requistion list was not successful. + +Attribute | Data Type | Description +--- | --- | --- +`message` | String! | A description of the error. +`type` | [AddRequisitionListItemToCartUserErrorType!](#addRequisitionListItemToCartUserErrorType) | The user Error type. + +### AddRequisitionListItemToCartUserErrorType {#addRequisitionListItemToCartUserErrorType} + +Type | Description +--- | --- | --- +`OUT_OF_STOCK` | The one of the items is out of stock. +`UNAVAILABLE_SKU` | The one of the items SKU is unavailable. +`OPTIONS_UPDATED` | The options has been updated. +`LOW_QUANTITY` | The one of the item's quantity is low. + +### Cart object {#cartObject} + +The `Cart` object can contain the following attributes. + +{% include graphql/cart-object-24.md %} \ No newline at end of file diff --git a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md new file mode 100644 index 00000000000..3fe7d5701e3 --- /dev/null +++ b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md @@ -0,0 +1,76 @@ +--- +group: graphql +title: clearCustomerCart mutation +b2b_only: true +contributor_name: EY +--- +The `clearCustomerCart` mutation clears the customer's cart. + +This mutation requires a valid [customer authentication token]({{page.baseurl}}/graphql/mutations/generate-customer-token.html). + +{:.bs-callout-info} +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `btob_website_configuration_requisition_list_active` attribute to determine whether requisition lists are supported. + +## Syntax + +```graphql +mutation { + clearCustomerCart( + cartUid: String! + ) { + ClearCustomerCartOutput + } +} +``` + +## Example usage + +The following example adds products to requisition list. + +**Request:** + +``` graphql +mutation { + clearCustomerCart( + cartUid: "1" + ) { + status + } +} +``` + +**Response:** + +``` json +{ + "data": { + "clearCustomerCart": { + status: "true" + } + } +} +``` + +## Input attributes + +The `clearCustomerCart` mutation requires the following input. + +Attribute | Data Type | Description +--- | --- | --- +`cartUid`| String! | Indicates whether cart was cleared. +`cart`| Cart | Indicates whether cart was cleared. + +## Output attributes + +The `clearCustomerCart` object returns the status and cart object. + +Attribute | Data Type | Description +--- | --- | --- +`status` | Boolean! | The requisition list after the items were added. +`cart` | [Cart](#cartObject) | The cart after clearing items. + +### Cart object {#cartObject} + +The `Cart` object can contain the following attributes. + +{% include graphql/cart-object-24.md %} \ No newline at end of file diff --git a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md new file mode 100644 index 00000000000..131c29e5590 --- /dev/null +++ b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md @@ -0,0 +1,101 @@ +--- +group: graphql +title: updateRequisitionListItems mutation +b2b_only: true +contributor_name: EY +--- +The `updateRequisitionListItems` mutation updates products in requisition list. + +This mutation requires a valid [customer authentication token]({{page.baseurl}}/graphql/mutations/generate-customer-token.html). + +{:.bs-callout-info} +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `btob_website_configuration_requisition_list_active` attribute to determine whether requisition lists are supported. + +## Syntax + +```graphql +mutation { + updateRequisitionListItems( + requisitionListUid: ID! + requisitionListItems: [UpdateRequisitionListItemsInput!]! + ) { + UpdateRequisitionListItemsOutput + } +} +``` + +## Example usage + +The following example adds products to requisition list. + +**Request:** + +``` graphql +mutation { + updateRequisitionListItems( + requisitionListUid: "1", + requisitionListItems: [ + { + item_id: "1" + quantity: 2 + selected_options: ["Y29uZmlndXJhYmxlLzkzLzUz","Y29uZmlndXJhYmxlLzE0NC8xNzE="] + entered_options: ["2","3"] + } + ] + ) { + requisition_list { + uid, + items_count + } + } +} +``` + +**Response:** + +``` json +{ + "data": { + "updateRequisitionListItems": { + "requisition_list": { + "uid": "1", + "items_count": 1 + } + } + } +} +``` + +## Input attributes + +The `updateRequisitionListItems` mutation requires the following input. + +Attribute | Data Type | Description +--- | --- | --- +`requisitionListUid`| ID | The unique ID of the requisition list. +`requisitionListItems`| [[UpdateRequisitionListItemsInput](#updateRequisitionListItemsInput)] | An array of products to be updated in the requisition list. + +## Output attributes + +The `updateRequisitionListItems` object returns the requisition list object. + +Attribute | Data Type | Description +--- | --- | --- +`requisition_list` | [[RequisitionList](#requisitionList)] | The requisition list after the items were updated. + +### UpdateRequisitionListItemsInput attributes {#updateRequisitionListItemsInput} + +The `UpdateRequisitionListItemsInput` type contains the list of products to be updated in the requisition list. + +Attribute | Data Type | Description +--- | --- | --- +`item_id` | ID! | The ID of the requisition list item to update. +`quantity` | Float | The new quantity of the item. +`selected_options` | [String!] | An array of selected option IDs. +`entered_options` | [EnteredOptionInput!] | An array of customer entered option IDs. + +### RequisitionList attributes {#requisitionList} + +The `RequisitionList` object can contain the following attributes. + +{% include graphql/requisition-list.md %} \ No newline at end of file From a8cab77930f7835bccbbabcf4142f6f69ca4ffcb Mon Sep 17 00:00:00 2001 From: CJ Date: Tue, 8 Dec 2020 17:36:13 +0530 Subject: [PATCH 02/15] Added quotes to the status --- .../graphql/mutations/add-requisition-list-items-to-cart.md | 2 +- src/guides/v2.4/graphql/mutations/clear-customer-cart.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md index 88561376635..22a0c94ffc5 100644 --- a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md +++ b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md @@ -48,7 +48,7 @@ mutation { { "data": { "addRequisitionListItemsToCart": { - status: "true" + "status": "true" } } } diff --git a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md index 3fe7d5701e3..6402d718622 100644 --- a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md +++ b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md @@ -45,7 +45,7 @@ mutation { { "data": { "clearCustomerCart": { - status: "true" + "status": "true" } } } From e6a856cf8a7736cb4719297b6a4532fe4272a8c0 Mon Sep 17 00:00:00 2001 From: CJ Date: Tue, 8 Dec 2020 19:59:34 +0530 Subject: [PATCH 03/15] removed cart object in clearCustomerCart input attributes table --- src/guides/v2.4/graphql/mutations/clear-customer-cart.md | 1 - 1 file changed, 1 deletion(-) diff --git a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md index 6402d718622..a804aa2047c 100644 --- a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md +++ b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md @@ -58,7 +58,6 @@ The `clearCustomerCart` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- `cartUid`| String! | Indicates whether cart was cleared. -`cart`| Cart | Indicates whether cart was cleared. ## Output attributes From b7d9839a571f18d3c3431cf2814b36c4a6a2b611 Mon Sep 17 00:00:00 2001 From: CJ Date: Wed, 9 Dec 2020 12:09:45 +0530 Subject: [PATCH 04/15] Followed the standards and changed the anchor names --- .../add-products-to-requisition-list.md | 20 ++++++------- .../add-requisition-list-items-to-cart.md | 28 +++++++++---------- .../graphql/mutations/clear-customer-cart.md | 8 +++--- .../update-requisition-list-items.md | 18 ++++++------ 4 files changed, 37 insertions(+), 37 deletions(-) diff --git a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md index d2489c51c0a..1e82f7028a5 100644 --- a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md @@ -72,8 +72,8 @@ The `addProductsToRequisitionList` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- -`requisitionListUid`| ID | The unique ID of the requisition list. -`requisitionListItems`| [[RequisitionListItemsInput](#requisitionListItemsInput)] | An array of products to be added to the requisition list. +`requisitionListUid`| ID | The unique ID of the requisition list +`requisitionListItems`| [[RequisitionListItemsInput](#RequisitionListItemsInput)] | An array of products to be added to the requisition list ## Output attributes @@ -81,21 +81,21 @@ The `addProductsToRequisitionList` object returns the requisition list object. Attribute | Data Type | Description --- | --- | --- -`requisition_list` | [[RequisitionList](#requisitionList)] | The requisition list after the items were added. +`requisition_list` | [[RequisitionList](#RequisitionList)] | The requisition list after the items were added -### RequisitionListItemsInput attributes {#requisitionListItemsInput} +### RequisitionListItemsInput attributes {#RequisitionListItemsInput} The `RequisitionListItemsInput` type contains the list of products to add in requisition list. Attribute | Data Type | Description --- | --- | --- -`sku` | String! | The product SKU. -`quantity` | Float | The quantity of the product to add. -`parent_sku` | String | For configurable products, the SKU of the parent product. -`selected_options` | [String!] | An array of selected option IDs. -`entered_options` | [EnteredOptionInput!] | An array of customer entered option IDs. +`sku` | String! | The product SKU +`quantity` | Float | The quantity of the product to add +`parent_sku` | String | For configurable products, the SKU of the parent product +`selected_options` | [String!] | An array of selected option IDs +`entered_options` | [EnteredOptionInput!] | An array of customer entered option IDs -### RequisitionList attributes {#requisitionList} +### RequisitionList attributes {#RequisitionList} The `RequisitionList` object can contain the following attributes. diff --git a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md index 22a0c94ffc5..7479402288b 100644 --- a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md +++ b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md @@ -60,8 +60,8 @@ The `addRequisitionListItemsToCart` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- -`requisitionListUid`| ID | The unique ID of the requisition list. -`requisitionListItemUids`| [ID!] | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. +`requisitionListUid`| ID | The unique ID of the requisition list +`requisitionListItemUids`| [ID!] | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart ## Output attributes @@ -69,29 +69,29 @@ The `addRequisitionListItemsToCart` object returns the status, cart and errors o Attribute | Data Type | Description --- | --- | --- -`status` | Boolean! | Indicates whether the attempt to add items to the requisition list was successful. -`add_requisition_list_items_to_cart_user_errors` | [[AddRequisitionListItemToCartUserError!](#addRequisitionListItemToCartUserError)] | Indicates why the attempt to add items to the requistion list was not successful. -`cart` | [Cart](#cartObject) | The cart after adding requisition list items. +`status` | Boolean! | Indicates whether the attempt to add items to the requisition list was successful +`add_requisition_list_items_to_cart_user_errors` | [[AddRequisitionListItemToCartUserError!](#AddRequisitionListItemToCartUserError)] | Indicates why the attempt to add items to the requistion list was not successful +`cart` | [Cart](#CartObject) | The cart after adding requisition list items. -### AddRequisitionListItemToCartUserError attributes {#addRequisitionListItemToCartUserError} +### AddRequisitionListItemToCartUserError attributes {#AddRequisitionListItemToCartUserError} The `AddRequisitionListItemToCartUserError` type contains the list of errors which indicates why the attempt to add items to the requistion list was not successful. Attribute | Data Type | Description --- | --- | --- -`message` | String! | A description of the error. -`type` | [AddRequisitionListItemToCartUserErrorType!](#addRequisitionListItemToCartUserErrorType) | The user Error type. +`message` | String! | A description of the error +`type` | [AddRequisitionListItemToCartUserErrorType!](#AddRequisitionListItemToCartUserErrorType) | The Error type -### AddRequisitionListItemToCartUserErrorType {#addRequisitionListItemToCartUserErrorType} +### AddRequisitionListItemToCartUserErrorType {#AddRequisitionListItemToCartUserErrorType} Type | Description --- | --- | --- -`OUT_OF_STOCK` | The one of the items is out of stock. -`UNAVAILABLE_SKU` | The one of the items SKU is unavailable. -`OPTIONS_UPDATED` | The options has been updated. -`LOW_QUANTITY` | The one of the item's quantity is low. +`OUT_OF_STOCK` | The one of the items is out of stock +`UNAVAILABLE_SKU` | The one of the items SKU is unavailable +`OPTIONS_UPDATED` | The options has been updated +`LOW_QUANTITY` | The one of the item's quantity is low -### Cart object {#cartObject} +### Cart object {#CartObject} The `Cart` object can contain the following attributes. diff --git a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md index a804aa2047c..f14b144b87a 100644 --- a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md +++ b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md @@ -57,7 +57,7 @@ The `clearCustomerCart` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- -`cartUid`| String! | Indicates whether cart was cleared. +`cartUid`| String! | Indicates whether cart was cleared ## Output attributes @@ -65,10 +65,10 @@ The `clearCustomerCart` object returns the status and cart object. Attribute | Data Type | Description --- | --- | --- -`status` | Boolean! | The requisition list after the items were added. -`cart` | [Cart](#cartObject) | The cart after clearing items. +`status` | Boolean! | The requisition list after the items were added +`cart` | [Cart](#CartObject) | The cart after clearing items -### Cart object {#cartObject} +### Cart object {#CartObject} The `Cart` object can contain the following attributes. diff --git a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md index 131c29e5590..b425ad57ab2 100644 --- a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md +++ b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md @@ -72,8 +72,8 @@ The `updateRequisitionListItems` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- -`requisitionListUid`| ID | The unique ID of the requisition list. -`requisitionListItems`| [[UpdateRequisitionListItemsInput](#updateRequisitionListItemsInput)] | An array of products to be updated in the requisition list. +`requisitionListUid`| ID | The unique ID of the requisition list +`requisitionListItems`| [[UpdateRequisitionListItemsInput](#UpdateRequisitionListItemsInput)] | An array of products to be updated in the requisition list ## Output attributes @@ -81,20 +81,20 @@ The `updateRequisitionListItems` object returns the requisition list object. Attribute | Data Type | Description --- | --- | --- -`requisition_list` | [[RequisitionList](#requisitionList)] | The requisition list after the items were updated. +`requisition_list` | [[RequisitionList](#RequisitionList)] | The requisition list after the items were updated -### UpdateRequisitionListItemsInput attributes {#updateRequisitionListItemsInput} +### UpdateRequisitionListItemsInput attributes {#UpdateRequisitionListItemsInput} The `UpdateRequisitionListItemsInput` type contains the list of products to be updated in the requisition list. Attribute | Data Type | Description --- | --- | --- -`item_id` | ID! | The ID of the requisition list item to update. -`quantity` | Float | The new quantity of the item. -`selected_options` | [String!] | An array of selected option IDs. -`entered_options` | [EnteredOptionInput!] | An array of customer entered option IDs. +`item_id` | ID! | The ID of the requisition list item to update +`quantity` | Float | The new quantity of the item +`selected_options` | [String!] | An array of selected option IDs +`entered_options` | [EnteredOptionInput!] | An array of customer entered option IDs -### RequisitionList attributes {#requisitionList} +### RequisitionList attributes {#RequisitionList} The `RequisitionList` object can contain the following attributes. From 9522eb41d842380901bf2d9f2f901f8fc7dab35b Mon Sep 17 00:00:00 2001 From: chiranjeevi <52098385+chiranjeevi-cj@users.noreply.github.com> Date: Wed, 9 Dec 2020 15:09:27 +0530 Subject: [PATCH 05/15] Update src/_includes/graphql/requisition-list.md Co-authored-by: Yaroslav Rogoza --- src/_includes/graphql/requisition-list.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/_includes/graphql/requisition-list.md b/src/_includes/graphql/requisition-list.md index 8a13827b10c..17aa7313700 100644 --- a/src/_includes/graphql/requisition-list.md +++ b/src/_includes/graphql/requisition-list.md @@ -2,8 +2,8 @@ The `RequisitionList` object contains the following attributes. Attribute | Data Type | Description --- | --- | --- -`description` | String! | Optional text that describes the requisition list +`description` | String | Optional text that describes the requisition list `items` | RequistionListItems | An array of products added to the requisition list `items_count` | Int! | The number of items in the list `name` | String! | The requisition list name -`updated_at` | String | The time of the last modification of the requisition list \ No newline at end of file +`updated_at` | String | The time of the last modification of the requisition list From 033ecb7d3001bd7bed4ec31f3b53ec421f8a711d Mon Sep 17 00:00:00 2001 From: chiranjeevi <52098385+chiranjeevi-cj@users.noreply.github.com> Date: Wed, 9 Dec 2020 15:11:06 +0530 Subject: [PATCH 06/15] Apply suggestions from code review Co-authored-by: Yaroslav Rogoza --- .../graphql/mutations/add-products-to-requisition-list.md | 6 +++--- .../v2.4/graphql/mutations/update-requisition-list-items.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md index 1e82f7028a5..74ba951f184 100644 --- a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md @@ -72,8 +72,8 @@ The `addProductsToRequisitionList` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- -`requisitionListUid`| ID | The unique ID of the requisition list -`requisitionListItems`| [[RequisitionListItemsInput](#RequisitionListItemsInput)] | An array of products to be added to the requisition list +`requisitionListUid`| ID! | The unique ID of the requisition list +`requisitionListItems`| [[RequisitionListItemsInput](#RequisitionListItemsInput)!]! | An array of products to be added to the requisition list ## Output attributes @@ -99,4 +99,4 @@ Attribute | Data Type | Description The `RequisitionList` object can contain the following attributes. -{% include graphql/requisition-list.md %} \ No newline at end of file +{% include graphql/requisition-list.md %} diff --git a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md index b425ad57ab2..93d44e4a615 100644 --- a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md +++ b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md @@ -72,8 +72,8 @@ The `updateRequisitionListItems` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- -`requisitionListUid`| ID | The unique ID of the requisition list -`requisitionListItems`| [[UpdateRequisitionListItemsInput](#UpdateRequisitionListItemsInput)] | An array of products to be updated in the requisition list +`requisitionListUid`| ID! | The unique ID of the requisition list +`requisitionListItems`| [[UpdateRequisitionListItemsInput](#UpdateRequisitionListItemsInput)!]! | An array of products to be updated in the requisition list ## Output attributes @@ -98,4 +98,4 @@ Attribute | Data Type | Description The `RequisitionList` object can contain the following attributes. -{% include graphql/requisition-list.md %} \ No newline at end of file +{% include graphql/requisition-list.md %} From e96c15691ee88eadab6d30d3a5de621fedb327e3 Mon Sep 17 00:00:00 2001 From: CJ Date: Wed, 9 Dec 2020 15:31:18 +0530 Subject: [PATCH 07/15] arranged the attributes in alphabetical order and added uid in requisition list --- src/_includes/graphql/requisition-list.md | 1 + .../mutations/add-products-to-requisition-list.md | 9 +++++---- .../mutations/add-requisition-list-items-to-cart.md | 8 ++++---- src/guides/v2.4/graphql/mutations/clear-customer-cart.md | 2 +- .../graphql/mutations/update-requisition-list-items.md | 4 ++-- 5 files changed, 13 insertions(+), 11 deletions(-) diff --git a/src/_includes/graphql/requisition-list.md b/src/_includes/graphql/requisition-list.md index 17aa7313700..4b9a8c73727 100644 --- a/src/_includes/graphql/requisition-list.md +++ b/src/_includes/graphql/requisition-list.md @@ -6,4 +6,5 @@ Attribute | Data Type | Description `items` | RequistionListItems | An array of products added to the requisition list `items_count` | Int! | The number of items in the list `name` | String! | The requisition list name +`uid` | ID! | The unique requisition list ID `updated_at` | String | The time of the last modification of the requisition list diff --git a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md index 74ba951f184..86c4ed4f69e 100644 --- a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md @@ -72,8 +72,9 @@ The `addProductsToRequisitionList` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- -`requisitionListUid`| ID! | The unique ID of the requisition list `requisitionListItems`| [[RequisitionListItemsInput](#RequisitionListItemsInput)!]! | An array of products to be added to the requisition list +`requisitionListUid`| ID! | The unique ID of the requisition list + ## Output attributes @@ -89,11 +90,11 @@ The `RequisitionListItemsInput` type contains the list of products to add in req Attribute | Data Type | Description --- | --- | --- -`sku` | String! | The product SKU -`quantity` | Float | The quantity of the product to add +`entered_options` | [EnteredOptionInput!] | An array of customer entered option IDs `parent_sku` | String | For configurable products, the SKU of the parent product +`quantity` | Float | The quantity of the product to add `selected_options` | [String!] | An array of selected option IDs -`entered_options` | [EnteredOptionInput!] | An array of customer entered option IDs +`sku` | String! | The product SKU ### RequisitionList attributes {#RequisitionList} diff --git a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md index 7479402288b..0ae48fb0cf0 100644 --- a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md +++ b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md @@ -60,8 +60,8 @@ The `addRequisitionListItemsToCart` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- -`requisitionListUid`| ID | The unique ID of the requisition list `requisitionListItemUids`| [ID!] | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart +`requisitionListUid`| ID | The unique ID of the requisition list ## Output attributes @@ -69,9 +69,9 @@ The `addRequisitionListItemsToCart` object returns the status, cart and errors o Attribute | Data Type | Description --- | --- | --- -`status` | Boolean! | Indicates whether the attempt to add items to the requisition list was successful `add_requisition_list_items_to_cart_user_errors` | [[AddRequisitionListItemToCartUserError!](#AddRequisitionListItemToCartUserError)] | Indicates why the attempt to add items to the requistion list was not successful `cart` | [Cart](#CartObject) | The cart after adding requisition list items. +`status` | Boolean! | Indicates whether the attempt to add items to the requisition list was successful ### AddRequisitionListItemToCartUserError attributes {#AddRequisitionListItemToCartUserError} @@ -86,10 +86,10 @@ Attribute | Data Type | Description Type | Description --- | --- | --- +`LOW_QUANTITY` | The one of the item's quantity is low +`OPTIONS_UPDATED` | The options has been updated `OUT_OF_STOCK` | The one of the items is out of stock `UNAVAILABLE_SKU` | The one of the items SKU is unavailable -`OPTIONS_UPDATED` | The options has been updated -`LOW_QUANTITY` | The one of the item's quantity is low ### Cart object {#CartObject} diff --git a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md index f14b144b87a..9b3fd95127c 100644 --- a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md +++ b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md @@ -65,8 +65,8 @@ The `clearCustomerCart` object returns the status and cart object. Attribute | Data Type | Description --- | --- | --- -`status` | Boolean! | The requisition list after the items were added `cart` | [Cart](#CartObject) | The cart after clearing items +`status` | Boolean! | The requisition list after the items were added ### Cart object {#CartObject} diff --git a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md index 93d44e4a615..97dc10b5f08 100644 --- a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md +++ b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md @@ -72,8 +72,8 @@ The `updateRequisitionListItems` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- -`requisitionListUid`| ID! | The unique ID of the requisition list `requisitionListItems`| [[UpdateRequisitionListItemsInput](#UpdateRequisitionListItemsInput)!]! | An array of products to be updated in the requisition list +`requisitionListUid`| ID! | The unique ID of the requisition list ## Output attributes @@ -89,10 +89,10 @@ The `UpdateRequisitionListItemsInput` type contains the list of products to be u Attribute | Data Type | Description --- | --- | --- +`entered_options` | [EnteredOptionInput!] | An array of customer entered option IDs `item_id` | ID! | The ID of the requisition list item to update `quantity` | Float | The new quantity of the item `selected_options` | [String!] | An array of selected option IDs -`entered_options` | [EnteredOptionInput!] | An array of customer entered option IDs ### RequisitionList attributes {#RequisitionList} From c1cb3044a3ef0c68bc8bc5fcc97d9e2bd3a73e3a Mon Sep 17 00:00:00 2001 From: CJ Date: Wed, 9 Dec 2020 17:31:13 +0530 Subject: [PATCH 08/15] removed blank space --- src/_includes/graphql/requisition-list.md | 2 +- .../v2.4/graphql/mutations/add-products-to-requisition-list.md | 3 +-- .../v2.4/graphql/mutations/update-requisition-list-items.md | 2 +- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/src/_includes/graphql/requisition-list.md b/src/_includes/graphql/requisition-list.md index 4b9a8c73727..76c97ab1087 100644 --- a/src/_includes/graphql/requisition-list.md +++ b/src/_includes/graphql/requisition-list.md @@ -7,4 +7,4 @@ Attribute | Data Type | Description `items_count` | Int! | The number of items in the list `name` | String! | The requisition list name `uid` | ID! | The unique requisition list ID -`updated_at` | String | The time of the last modification of the requisition list +`updated_at` | String | The time of the last modification of the requisition list \ No newline at end of file diff --git a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md index 86c4ed4f69e..01c3ad3894b 100644 --- a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md @@ -75,7 +75,6 @@ Attribute | Data Type | Description `requisitionListItems`| [[RequisitionListItemsInput](#RequisitionListItemsInput)!]! | An array of products to be added to the requisition list `requisitionListUid`| ID! | The unique ID of the requisition list - ## Output attributes The `addProductsToRequisitionList` object returns the requisition list object. @@ -100,4 +99,4 @@ Attribute | Data Type | Description The `RequisitionList` object can contain the following attributes. -{% include graphql/requisition-list.md %} +{% include graphql/requisition-list.md %} \ No newline at end of file diff --git a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md index 97dc10b5f08..4e54ec5da9c 100644 --- a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md +++ b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md @@ -98,4 +98,4 @@ Attribute | Data Type | Description The `RequisitionList` object can contain the following attributes. -{% include graphql/requisition-list.md %} +{% include graphql/requisition-list.md %} \ No newline at end of file From 1fe7b4e5f4e89632158a5345eb0b50810f0fb551 Mon Sep 17 00:00:00 2001 From: chiranjeevi <52098385+chiranjeevi-cj@users.noreply.github.com> Date: Thu, 10 Dec 2020 11:34:29 +0530 Subject: [PATCH 09/15] Apply suggestions from code review Co-authored-by: Kevin Harper --- .../graphql/mutations/add-products-to-requisition-list.md | 8 ++++---- .../mutations/add-requisition-list-items-to-cart.md | 6 +++--- .../graphql/mutations/update-requisition-list-items.md | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md index 01c3ad3894b..3a2e42ee987 100644 --- a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md @@ -4,7 +4,7 @@ title: addProductsToRequisitionList mutation b2b_only: true contributor_name: EY --- -The `addProductsToRequisitionList` mutation adds products to requisition list. +The `addProductsToRequisitionList` mutation adds products to a requisition list. This mutation requires a valid [customer authentication token]({{page.baseurl}}/graphql/mutations/generate-customer-token.html). @@ -26,7 +26,7 @@ mutation { ## Example usage -The following example adds products to requisition list. +The following example adds products to a requisition list. **Request:** @@ -85,7 +85,7 @@ Attribute | Data Type | Description ### RequisitionListItemsInput attributes {#RequisitionListItemsInput} -The `RequisitionListItemsInput` type contains the list of products to add in requisition list. +The `RequisitionListItemsInput` type contains the list of products to add to a requisition list. Attribute | Data Type | Description --- | --- | --- @@ -99,4 +99,4 @@ Attribute | Data Type | Description The `RequisitionList` object can contain the following attributes. -{% include graphql/requisition-list.md %} \ No newline at end of file +{% include graphql/requisition-list.md %} diff --git a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md index 0ae48fb0cf0..94e8f558d45 100644 --- a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md +++ b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md @@ -4,7 +4,7 @@ title: addRequisitionListItemsToCart mutation b2b_only: true contributor_name: EY --- -The `addRequisitionListItemsToCart` mutation adds requisition list items to cart. +The `addRequisitionListItemsToCart` mutation adds requisition list items to the cart. This mutation requires a valid [customer authentication token]({{page.baseurl}}/graphql/mutations/generate-customer-token.html). @@ -61,7 +61,7 @@ The `addRequisitionListItemsToCart` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- `requisitionListItemUids`| [ID!] | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart -`requisitionListUid`| ID | The unique ID of the requisition list +`requisitionListUid`| ID! | The unique ID of the requisition list ## Output attributes @@ -95,4 +95,4 @@ Type | Description The `Cart` object can contain the following attributes. -{% include graphql/cart-object-24.md %} \ No newline at end of file +{% include graphql/cart-object-24.md %} diff --git a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md index 4e54ec5da9c..e82660aa0f4 100644 --- a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md +++ b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md @@ -26,7 +26,7 @@ mutation { ## Example usage -The following example adds products to requisition list. +The following example updates products in a requisition list. **Request:** @@ -98,4 +98,4 @@ Attribute | Data Type | Description The `RequisitionList` object can contain the following attributes. -{% include graphql/requisition-list.md %} \ No newline at end of file +{% include graphql/requisition-list.md %} From e938a0c9976842a7f6f1a513dc8dd28511cd237f Mon Sep 17 00:00:00 2001 From: CJ Date: Thu, 10 Dec 2020 12:29:54 +0530 Subject: [PATCH 10/15] updated the updateRequisitionListItems mutation --- .../add-products-to-requisition-list.md | 2 +- .../add-requisition-list-items-to-cart.md | 2 +- .../update-requisition-list-items.md | 20 ++++++++++++++----- 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md index 3a2e42ee987..ac7537b06fa 100644 --- a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md @@ -44,7 +44,7 @@ mutation { ] ) { requisition_list { - uid, + uid items_count } } diff --git a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md index 94e8f558d45..6fff70d7588 100644 --- a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md +++ b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md @@ -26,7 +26,7 @@ mutation { ## Example usage -The following example adds products to requisition list. +The following example adds items to the cart. **Request:** diff --git a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md index e82660aa0f4..2d570408035 100644 --- a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md +++ b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md @@ -26,7 +26,7 @@ mutation { ## Example usage -The following example updates products in a requisition list. +The following example updates the specified product's quantity in the requisition list. **Request:** @@ -38,14 +38,18 @@ mutation { { item_id: "1" quantity: 2 - selected_options: ["Y29uZmlndXJhYmxlLzkzLzUz","Y29uZmlndXJhYmxlLzE0NC8xNzE="] - entered_options: ["2","3"] } ] ) { requisition_list { - uid, + uid items_count + items { + items { + uid + quantity + } + } } } } @@ -59,7 +63,13 @@ mutation { "updateRequisitionListItems": { "requisition_list": { "uid": "1", - "items_count": 1 + "items_count": 1, + "items": { + "items": { + "uid": "1", + "quantity": 2 + } + } } } } From 5213cd5e40910f217d39fc48541e97f68db88188 Mon Sep 17 00:00:00 2001 From: chiranjeevi <52098385+chiranjeevi-cj@users.noreply.github.com> Date: Fri, 11 Dec 2020 09:34:46 +0530 Subject: [PATCH 11/15] Delete requisition-list.md --- src/_includes/graphql/requisition-list.md | 10 ---------- 1 file changed, 10 deletions(-) delete mode 100644 src/_includes/graphql/requisition-list.md diff --git a/src/_includes/graphql/requisition-list.md b/src/_includes/graphql/requisition-list.md deleted file mode 100644 index 76c97ab1087..00000000000 --- a/src/_includes/graphql/requisition-list.md +++ /dev/null @@ -1,10 +0,0 @@ -The `RequisitionList` object contains the following attributes. - -Attribute | Data Type | Description ---- | --- | --- -`description` | String | Optional text that describes the requisition list -`items` | RequistionListItems | An array of products added to the requisition list -`items_count` | Int! | The number of items in the list -`name` | String! | The requisition list name -`uid` | ID! | The unique requisition list ID -`updated_at` | String | The time of the last modification of the requisition list \ No newline at end of file From db46ee0569b3648fea575c8263505025d4435c44 Mon Sep 17 00:00:00 2001 From: CJ Date: Mon, 14 Dec 2020 12:02:00 +0530 Subject: [PATCH 12/15] updated the files --- .../add-products-to-requisition-list.md | 19 +++++++++--------- .../add-requisition-list-items-to-cart.md | 4 ++-- .../graphql/mutations/clear-customer-cart.md | 2 +- .../update-requisition-list-items.md | 20 +++++++++---------- 4 files changed, 22 insertions(+), 23 deletions(-) diff --git a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md index ac7537b06fa..91f8f9c4c5f 100644 --- a/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md @@ -33,13 +33,12 @@ The following example adds products to a requisition list. ``` graphql mutation { addProductsToRequisitionList( - requisitionListUid: "1", + requisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz" requisitionListItems: [ { sku: "sku" quantity: 1 selected_options: ["Y29uZmlndXJhYmxlLzkzLzUz","Y29uZmlndXJhYmxlLzE0NC8xNzE="] - entered_options: ["2","3"] } ] ) { @@ -75,14 +74,6 @@ Attribute | Data Type | Description `requisitionListItems`| [[RequisitionListItemsInput](#RequisitionListItemsInput)!]! | An array of products to be added to the requisition list `requisitionListUid`| ID! | The unique ID of the requisition list -## Output attributes - -The `addProductsToRequisitionList` object returns the requisition list object. - -Attribute | Data Type | Description ---- | --- | --- -`requisition_list` | [[RequisitionList](#RequisitionList)] | The requisition list after the items were added - ### RequisitionListItemsInput attributes {#RequisitionListItemsInput} The `RequisitionListItemsInput` type contains the list of products to add to a requisition list. @@ -95,6 +86,14 @@ Attribute | Data Type | Description `selected_options` | [String!] | An array of selected option IDs `sku` | String! | The product SKU +## Output attributes + +The `addProductsToRequisitionList` object returns the requisition list object. + +Attribute | Data Type | Description +--- | --- | --- +`requisition_list` | [[RequisitionList](#RequisitionList)] | The requisition list after the items were added + ### RequisitionList attributes {#RequisitionList} The `RequisitionList` object can contain the following attributes. diff --git a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md index 6fff70d7588..570eb5a565b 100644 --- a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md +++ b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md @@ -34,7 +34,7 @@ The following example adds items to the cart. mutation { addRequisitionListItemsToCart ( - requisitionListUid: "1" + requisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz" requisitionListItemUids: ["1","2"] ) { status @@ -85,7 +85,7 @@ Attribute | Data Type | Description ### AddRequisitionListItemToCartUserErrorType {#AddRequisitionListItemToCartUserErrorType} Type | Description ---- | --- | --- +--- | --- `LOW_QUANTITY` | The one of the item's quantity is low `OPTIONS_UPDATED` | The options has been updated `OUT_OF_STOCK` | The one of the items is out of stock diff --git a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md index 9b3fd95127c..b910795cb8d 100644 --- a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md +++ b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md @@ -25,7 +25,7 @@ mutation { ## Example usage -The following example adds products to requisition list. +The following example clear's the customer's cart. **Request:** diff --git a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md index 2d570408035..4e1ea37756e 100644 --- a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md +++ b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md @@ -33,10 +33,10 @@ The following example updates the specified product's quantity in the requisitio ``` graphql mutation { updateRequisitionListItems( - requisitionListUid: "1", + requisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz", requisitionListItems: [ { - item_id: "1" + item_id: "W29uZmlndXJhYmxlLzkzLzUz" quantity: 2 } ] @@ -85,14 +85,6 @@ Attribute | Data Type | Description `requisitionListItems`| [[UpdateRequisitionListItemsInput](#UpdateRequisitionListItemsInput)!]! | An array of products to be updated in the requisition list `requisitionListUid`| ID! | The unique ID of the requisition list -## Output attributes - -The `updateRequisitionListItems` object returns the requisition list object. - -Attribute | Data Type | Description ---- | --- | --- -`requisition_list` | [[RequisitionList](#RequisitionList)] | The requisition list after the items were updated - ### UpdateRequisitionListItemsInput attributes {#UpdateRequisitionListItemsInput} The `UpdateRequisitionListItemsInput` type contains the list of products to be updated in the requisition list. @@ -104,6 +96,14 @@ Attribute | Data Type | Description `quantity` | Float | The new quantity of the item `selected_options` | [String!] | An array of selected option IDs +## Output attributes + +The `updateRequisitionListItems` object returns the requisition list object. + +Attribute | Data Type | Description +--- | --- | --- +`requisition_list` | [[RequisitionList](#RequisitionList)] | The requisition list after the items were updated + ### RequisitionList attributes {#RequisitionList} The `RequisitionList` object can contain the following attributes. From 448213c3341ecde2f0999bd42c6a98e1404f116a Mon Sep 17 00:00:00 2001 From: Kevin Harper Date: Tue, 15 Dec 2020 22:24:15 -0600 Subject: [PATCH 13/15] Update add-requisition-list-items-to-cart.md --- .../mutations/add-requisition-list-items-to-cart.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md index 570eb5a565b..c9c845c3197 100644 --- a/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md +++ b/src/guides/v2.4/graphql/mutations/add-requisition-list-items-to-cart.md @@ -86,10 +86,10 @@ Attribute | Data Type | Description Type | Description --- | --- -`LOW_QUANTITY` | The one of the item's quantity is low -`OPTIONS_UPDATED` | The options has been updated -`OUT_OF_STOCK` | The one of the items is out of stock -`UNAVAILABLE_SKU` | The one of the items SKU is unavailable +`LOW_QUANTITY` | The quantity of one of the items is low +`OPTIONS_UPDATED` | The options have been updated +`OUT_OF_STOCK` | One of the items is out of stock +`UNAVAILABLE_SKU` | One of the items SKU is unavailable ### Cart object {#CartObject} From 56c9d43d4e21960f65b38aee2ad751546344efea Mon Sep 17 00:00:00 2001 From: Kevin Harper Date: Tue, 15 Dec 2020 22:25:25 -0600 Subject: [PATCH 14/15] Update clear-customer-cart.md --- src/guides/v2.4/graphql/mutations/clear-customer-cart.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md index b910795cb8d..cfde63030aa 100644 --- a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md +++ b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md @@ -25,7 +25,7 @@ mutation { ## Example usage -The following example clear's the customer's cart. +The following example clears the customer's cart. **Request:** @@ -72,4 +72,4 @@ Attribute | Data Type | Description The `Cart` object can contain the following attributes. -{% include graphql/cart-object-24.md %} \ No newline at end of file +{% include graphql/cart-object-24.md %} From 463a25bad225a9705169e7d9aecc9e2a8f53eb4c Mon Sep 17 00:00:00 2001 From: Kevin Harper Date: Tue, 15 Dec 2020 22:27:36 -0600 Subject: [PATCH 15/15] Update update-requisition-list-items.md --- .../v2.4/graphql/mutations/update-requisition-list-items.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md index 4e1ea37756e..e7db747f3b5 100644 --- a/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md +++ b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md @@ -4,7 +4,7 @@ title: updateRequisitionListItems mutation b2b_only: true contributor_name: EY --- -The `updateRequisitionListItems` mutation updates products in requisition list. +The `updateRequisitionListItems` mutation updates products in a requisition list. This mutation requires a valid [customer authentication token]({{page.baseurl}}/graphql/mutations/generate-customer-token.html). @@ -26,7 +26,7 @@ mutation { ## Example usage -The following example updates the specified product's quantity in the requisition list. +The following example updates the quantity of an item in a requisition list. **Request:**