From 9982f2607376d3e5db3b60ecf81c5c8727fdacf2 Mon Sep 17 00:00:00 2001 From: Sathiya Prakash <50226394+sathiyaaa@users.noreply.github.com> Date: Fri, 11 Dec 2020 09:25:27 +0530 Subject: [PATCH 01/13] Added documentation for copy, move and delete requisition list items mutations (#8202) * Added documentation for copy, move and remove requisition list items mutations * fixed json format * arranged the attributes alphabetically * added backticks and spaces as mentioned * Update src/guides/v2.4/graphql/mutations/copy-items-between-requisition-list.md Co-authored-by: Yaroslav Rogoza * modified attribute name * Modified the documentation according to the schema change * Apply suggestions from code review Co-authored-by: Kevin Harper * modified as per review comments * removed a period * added a missing attribute * added the attributes alphabetically * deleted extra line * modified a description * modified the uid's and item uid's Co-authored-by: Yaroslav Rogoza Co-authored-by: Kevin Harper --- src/_data/toc/graphql.yml | 15 +++ src/_includes/graphql/requisition-list.md | 10 ++ .../copy-items-between-requisition-lists.md | 96 ++++++++++++++++ .../delete-requisition-list-items.md | 81 ++++++++++++++ .../move-items-between-requisition-lists.md | 105 ++++++++++++++++++ 5 files changed, 307 insertions(+) create mode 100644 src/_includes/graphql/requisition-list.md create mode 100644 src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md create mode 100644 src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md create mode 100644 src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md diff --git a/src/_data/toc/graphql.yml b/src/_data/toc/graphql.yml index 4dc3eeca68e..2524c90a987 100644 --- a/src/_data/toc/graphql.yml +++ b/src/_data/toc/graphql.yml @@ -210,6 +210,11 @@ pages: - label: changeCustomerPassword mutation url: /graphql/mutations/change-customer-password.html + - label: copyItemsBetweenRequisitionLists mutation + url: /graphql/mutations/copy-items-between-requisition-lists.html + edition: b2b-only + exclude_versions: [ "2.3" ] + - label: copyProductsToWishlist mutation url: /graphql/mutations/copy-products-to-wishlist.html edition: ee-only @@ -293,6 +298,11 @@ pages: - label: deleteCustomerAddress mutation url: /graphql/mutations/delete-customer-address.html + - label: deleteRequisitionListItems mutation + url: /graphql/mutations/delete-requisition-list-items.html + edition: b2b-only + exclude_versions: [ "2.3" ] + - label: deleteWishlist mutation url: /graphql/mutations/delete-wishlist.html edition: ee-only @@ -324,6 +334,11 @@ pages: edition: ee-only exclude_versions: ["2.3"] + - label: moveItemsBetweenRequisitionLists mutation + url: /graphql/mutations/move-items-between-requisition-lists.html + edition: b2b-only + exclude_versions: [ "2.3" ] + - label: placeOrder mutation url: /graphql/mutations/place-order.html diff --git a/src/_includes/graphql/requisition-list.md b/src/_includes/graphql/requisition-list.md new file mode 100644 index 00000000000..4b9a8c73727 --- /dev/null +++ b/src/_includes/graphql/requisition-list.md @@ -0,0 +1,10 @@ +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 diff --git a/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md b/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md new file mode 100644 index 00000000000..cde7d55a517 --- /dev/null +++ b/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md @@ -0,0 +1,96 @@ +--- +group: graphql +title: copyItemsBetweenRequisitionLists mutation +b2b_only: true +contributor_name: EY +--- +The `copyItemsBetweenRequisitionLists` mutation copies items from one requisition list to another. + +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 { + copyItemsBetweenRequisitionLists( + sourceRequisitionListUid: ID!, + destinationRequisitionListUid: ID, + requisitionListItem: CopyItemsBetweenRequisitionListsInput + ) { + CopyItemsFromRequisitionListsOutput + } +} +``` + +## Example usage + +The following example copies items from one requisition list to another. + +**Request:** + +``` graphql +mutation { + copyItemsBetweenRequisitionLists( + sourceRequisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz", + destinationRequisitionListUid: "W16uZmlndXJhYmxlLakzLzUz", + requisitionListItemUids: ["2","3"] + ) { + requisition_list { + uid + items_count + } + } +} +``` + +**Response:** + +``` json +{ + "data": { + "copyItemsBetweenRequisitionLists": { + "requisition_list": { + "uid": "W16uZmlndXJhYmxlLakzLzUz", + "items_count": 2 + } + } + } +} +``` + +## Input attributes + +The `copyItemsBetweenRequisitionLists` mutation requires the following input. + +Attribute | Data Type | Description +--- | --- | --- +`destinationRequisitionListUid`| ID | The unique ID of the destination requisition list. If null, a new requisition list will be created +`requisitionListItem`| [[CopyItemsBetweenRequisitionListsInput](#CopyItemsBetweenRequisitionListsInput)] | An array of selected requisition list items that are to be copied +`sourceRequisitionListUid`| ID! | The unique ID of the source requisition list + +## Output attributes + +The `copyItemsBetweenRequisitionLists` mutation returns the requisition list object to which the products were copied to. + +Attribute | Data Type | Description +--- | --- | --- +`requisition_list` | [[RequisitionList](#RequisitionList)] | The destination requisition list after the items were copied + +### CopyItemsBetweenRequisitionListsInput attributes {#CopyItemsBetweenRequisitionListsInput} + +The `CopyItemsBetweenRequisitionListsInput` type contains the list of products to copy from one requisition list to other. + +Attribute | Data Type | Description +--- | --- | --- +`requisitionListItemUids` | [ID!]! | An array of IDs representing products copied from one requisition list to another + +### RequisitionList attributes {#RequisitionList} +{% include graphql/requisition-list.md %} + +## Related topics + +* [moveItemsBetweenRequisitionLists mutation]({{page.baseurl}}/graphql/mutations/move-items-between-requisition-lists.html) +* [deleteRequisitionListItems mutation]({{page.baseurl}}/graphql/mutations/delete-requisition-list-items.html) \ No newline at end of file diff --git a/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md b/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md new file mode 100644 index 00000000000..9b38496c119 --- /dev/null +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md @@ -0,0 +1,81 @@ +--- +group: graphql +title: deleteRequisitionListItems mutation +b2b_only: true +contributor_name: EY +--- +The `deleteRequisitionListItems` mutation removes items from the specified requisiton list for the logged in customer. + +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 { + deleteRequisitionListItems( + requisitionListUid: ID! + requisitionListItemUids: [ID!]! + ) { + DeleteRequisitionListItemsOutput + } +} +``` +## Example usage + +The following example removes the specified items from the requisition list. + +**Request:** + +``` graphql +mutation { + deleteRequisitionListItems( + requisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz", + requisitionListItemUids: ["2","3"] + ) { + requisition_list { + uid + items_count + } + } +} +``` + +**Response:** + +``` json +{ + "data": { + "deleteRequisitionListItems": { + "requisition_list": { + "uid": "Y29uZmlndXJhYmxlLzkzLzUz", + "items_count": 0 + } + } + } +} +``` + +## Input attributes + +The `deleteRequisitionListItems` mutation requires the following input. + +Attribute | Data Type | Description +--- | --- | --- +`requisitionListItemUids`| [ID!]! | An array of UIDs representing products to be removed from the requisition list +`requisitionListUid`| ID! | The unique ID of the requisition list + +## Output attributes + +The `deleteRequisitionListItems` object returns the requisition list after the deletion of items. + +Attribute | Data Type | Description +--- | --- | --- +`requisition_list` | RequisitionList | The requisition list after removing items + +## Related topics + +* [renameRequisitionList mutation]({{page.baseurl}}/graphql/mutations/rename-requisition-list.html) +* [deleteRequisitionList mutation]({{page.baseurl}}/graphql/mutations/delete-requisition-list.html) \ No newline at end of file diff --git a/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md b/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md new file mode 100644 index 00000000000..a5abbe3bf2f --- /dev/null +++ b/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md @@ -0,0 +1,105 @@ +--- +group: graphql +title: moveItemsBetweenRequisitionLists mutation +b2b_only: true +contributor_name: EY +--- +The `moveItemsBetweenRequisitionLists` mutation moves items from one requisition list to another. + +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 { + moveItemsBetweenRequisitionLists( + sourceRequisitionListUid: ID! + destinationRequisitionListUid: ID + requisitionListItem: MoveItemsBetweenRequisitionListsInput + ) { + MoveItemsBetweenRequisitionListsOutput + } +} +``` + +## Example usage + +The following example moves items from one requisition list to another. + +**Request:** + +``` graphql +mutation { + moveItemsBetweenRequisitionLists( + sourceRequisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz" + destinationRequisitionListUid: "W16uZmlndXJhYmxlLakzLzUz" + requisitionListItemUids: ["2","3"] + ) { + source_requisition_list { + uid + items_count + } + destination_requisition_list { + uid + items_count + } + } +} +``` + +**Response:** + +``` json +{ + "data": { + "moveItemsBetweenRequisitionLists": { + "source_requisition_list": { + "uid": "Y29uZmlndXJhYmxlLzkzLzUz", + "items_count": 0 + }, + "destination_requisition_list": { + "uid": "W16uZmlndXJhYmxlLakzLzUz", + "items_count": 2 + } + } + } +} +``` + +## Input attributes + +The `moveItemsBetweenRequisitionLists` mutation requires the following input. + +Attribute | Data Type | Description +--- | --- | --- +`destinationRequisitionListUid`| ID! | The unique ID of the destination requisition list. If null, a new requisition list will be created +`requisitionListItem`| [[MoveItemsBetweenRequisitionListsInput](#MoveItemsBetweenRequisitionListsInput)] | An array of selected requisition list items that are to be moved from the source to the destination list +`sourceRequisitionListUid`| ID! | The unique ID of the source requisition list + +## Output attributes + +The `moveItemsBetweenRequisitionLists` object returns the source requisition list and the destination requisition list object. + +Attribute | Data Type | Description +--- | --- | --- +`destination_requisition_list` | [[RequisitionList](#RequisitionList)] | The destination requisition list after moving items +`source_requisition_list` | [[RequisitionList](#RequisitionList)] | The source requisition list after moving items + +### MoveItemsBetweenRequisitionListsInput attributes {#MoveItemsBetweenRequisitionListsInput} + +The `MoveItemsBetweenRequisitionListsInput` type contains the list of products to move from one requisition list to other. + +Attribute | Data Type | Description +--- | --- | --- +`requisitionListItemUids` | [ID!]! | An array of IDs representing products moved from one requisition list to another + +### RequisitionList attributes {#RequisitionList} +{% include graphql/requisition-list.md %} + +## Related topics + +* [copyItemsBetweenRequisitionLists mutation]({{page.baseurl}}/graphql/mutations/copy-items-between-requisition-lists.html) +* [deleteRequisitionListItems mutation]({{page.baseurl}}/graphql/mutations/delete-requisition-list-items.html) \ No newline at end of file From 56f00357b5315d6bee6bff67c56e89b87aa9b06d Mon Sep 17 00:00:00 2001 From: chiranjeevi <52098385+chiranjeevi-cj@users.noreply.github.com> Date: Wed, 16 Dec 2020 10:03:03 +0530 Subject: [PATCH 02/13] 8341 requisition list mutations (#8354) * Added documentation for requisition list mutation * Added quotes to the status * removed cart object in clearCustomerCart input attributes table * Followed the standards and changed the anchor names * Update src/_includes/graphql/requisition-list.md Co-authored-by: Yaroslav Rogoza * Apply suggestions from code review Co-authored-by: Yaroslav Rogoza * arranged the attributes in alphabetical order and added uid in requisition list * removed blank space * Apply suggestions from code review Co-authored-by: Kevin Harper * updated the updateRequisitionListItems mutation * Delete requisition-list.md * updated the files * Update add-requisition-list-items-to-cart.md * Update clear-customer-cart.md * Update update-requisition-list-items.md Co-authored-by: Yaroslav Rogoza Co-authored-by: Kevin Harper --- src/_data/toc/graphql.yml | 17 +++ .../add-products-to-requisition-list.md | 101 ++++++++++++++++ .../add-requisition-list-items-to-cart.md | 98 ++++++++++++++++ .../graphql/mutations/clear-customer-cart.md | 75 ++++++++++++ .../update-requisition-list-items.md | 111 ++++++++++++++++++ 5 files changed, 402 insertions(+) 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 2524c90a987..a500de1f29e 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,11 @@ pages: - label: changeCustomerPassword mutation url: /graphql/mutations/change-customer-password.html + - label: clearCustomerCart mutation + url: /graphql/mutations/clear-customer-cart.html + edition: b2b-only + exclude_versions: [ "2.3" ] + - label: copyItemsBetweenRequisitionLists mutation url: /graphql/mutations/copy-items-between-requisition-lists.html edition: b2b-only @@ -464,6 +477,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/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..91f8f9c4c5f --- /dev/null +++ b/src/guides/v2.4/graphql/mutations/add-products-to-requisition-list.md @@ -0,0 +1,101 @@ +--- +group: graphql +title: addProductsToRequisitionList mutation +b2b_only: true +contributor_name: EY +--- +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). + +{:.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 a requisition list. + +**Request:** + +``` graphql +mutation { + addProductsToRequisitionList( + requisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz" + requisitionListItems: [ + { + sku: "sku" + quantity: 1 + selected_options: ["Y29uZmlndXJhYmxlLzkzLzUz","Y29uZmlndXJhYmxlLzE0NC8xNzE="] + } + ] + ) { + 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 +--- | --- | --- +`requisitionListItems`| [[RequisitionListItemsInput](#RequisitionListItemsInput)!]! | An array of products to be added to the requisition list +`requisitionListUid`| ID! | The unique ID of the requisition list + +### RequisitionListItemsInput attributes {#RequisitionListItemsInput} + +The `RequisitionListItemsInput` type contains the list of products to add to a requisition list. + +Attribute | Data Type | Description +--- | --- | --- +`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 +`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. + +{% 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 new file mode 100644 index 00000000000..c9c845c3197 --- /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 the 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 items to the cart. + +**Request:** + +``` graphql +mutation { + addRequisitionListItemsToCart + ( + requisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz" + requisitionListItemUids: ["1","2"] + ) { + status + } +} +``` + +**Response:** + +``` json +{ + "data": { + "addRequisitionListItemsToCart": { + "status": "true" + } + } +} +``` + +## Input attributes + +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 + +## Output attributes + +The `addRequisitionListItemsToCart` object returns the status, cart and errors object. + +Attribute | Data Type | Description +--- | --- | --- +`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} + +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 Error type + +### AddRequisitionListItemToCartUserErrorType {#AddRequisitionListItemToCartUserErrorType} + +Type | Description +--- | --- +`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} + +The `Cart` object can contain the following attributes. + +{% include graphql/cart-object-24.md %} 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..cfde63030aa --- /dev/null +++ b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md @@ -0,0 +1,75 @@ +--- +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 clears the customer's cart. + +**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 + +## Output attributes + +The `clearCustomerCart` object returns the status and cart object. + +Attribute | Data Type | Description +--- | --- | --- +`cart` | [Cart](#CartObject) | The cart after clearing items +`status` | Boolean! | The requisition list after the items were added + +### Cart object {#CartObject} + +The `Cart` object can contain the following attributes. + +{% 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 new file mode 100644 index 00000000000..e7db747f3b5 --- /dev/null +++ b/src/guides/v2.4/graphql/mutations/update-requisition-list-items.md @@ -0,0 +1,111 @@ +--- +group: graphql +title: updateRequisitionListItems mutation +b2b_only: true +contributor_name: EY +--- +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). + +{:.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 updates the quantity of an item in a requisition list. + +**Request:** + +``` graphql +mutation { + updateRequisitionListItems( + requisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz", + requisitionListItems: [ + { + item_id: "W29uZmlndXJhYmxlLzkzLzUz" + quantity: 2 + } + ] + ) { + requisition_list { + uid + items_count + items { + items { + uid + quantity + } + } + } + } +} +``` + +**Response:** + +``` json +{ + "data": { + "updateRequisitionListItems": { + "requisition_list": { + "uid": "1", + "items_count": 1, + "items": { + "items": { + "uid": "1", + "quantity": 2 + } + } + } + } + } +} +``` + +## Input attributes + +The `updateRequisitionListItems` mutation requires the following input. + +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 + +### UpdateRequisitionListItemsInput attributes {#UpdateRequisitionListItemsInput} + +The `UpdateRequisitionListItemsInput` type contains the list of products to be updated in the requisition list. + +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 + +## 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. + +{% include graphql/requisition-list.md %} From 95d845b99e5e646a05d155d199aad8ac52541fbe Mon Sep 17 00:00:00 2001 From: Dinesh V B <71248239+dineshvb@users.noreply.github.com> Date: Thu, 17 Dec 2020 08:10:50 +0530 Subject: [PATCH 03/13] issue-8376-made the requested changes (#8381) * issue-8376-made the requested changes * issue-8376-made some small changes * issue-8376-made the requested changes * Update create-requisition-list.md * Update update-requisition-list.md * Update delete-requisition-list.md Co-authored-by: Kevin Harper --- src/_data/toc/graphql.yml | 10 ++--- .../mutations/create-requisition-list.md | 25 ++++++----- .../delete-requisition-list-items.md | 2 +- .../mutations/delete-requisition-list.md | 34 +++++++++++---- ...ion-list.md => update-requisition-list.md} | 41 ++++++++++--------- 5 files changed, 67 insertions(+), 45 deletions(-) rename src/guides/v2.4/graphql/mutations/{rename-requisition-list.md => update-requisition-list.md} (60%) diff --git a/src/_data/toc/graphql.yml b/src/_data/toc/graphql.yml index a500de1f29e..e98641b423a 100644 --- a/src/_data/toc/graphql.yml +++ b/src/_data/toc/graphql.yml @@ -382,11 +382,6 @@ pages: url: /graphql/mutations/remove-store-credit.html edition: ee-only - - label: renameRequisitionList mutation - url: /graphql/mutations/rename-requisition-list.html - edition: b2b-only - exclude_versions: [ "2.3" ] - - label: reorderItems mutation url: /graphql/mutations/reorder-items.html exclude_versions: ["2.3"] @@ -477,6 +472,11 @@ pages: url: /graphql/mutations/update-products-in-wishlist.html exclude_versions: ["2.3"] + - label: updateRequisitionList mutation + url: /graphql/mutations/update-requisition-list.html + edition: b2b-only + exclude_versions: [ "2.3" ] + - label: updateRequisitionListItems mutation url: /graphql/mutations/update-requisition-list-items.html exclude_versions: [ "2.3" ] diff --git a/src/guides/v2.4/graphql/mutations/create-requisition-list.md b/src/guides/v2.4/graphql/mutations/create-requisition-list.md index a9dfa774315..bda0fa4fbf8 100644 --- a/src/guides/v2.4/graphql/mutations/create-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/create-requisition-list.md @@ -33,11 +33,12 @@ The following example creates the `Frequently Ordered Products` requisition list ```graphql mutation { - createRequisitionList( - name: "Frequently Ordered Products", + createRequisitionList(input:{ + name: "Frequently Ordered Products" description: "Frequently ordered products list" + } ) { - list { + requisition_list { uid name description @@ -52,9 +53,9 @@ mutation { { "data": { "createRequisitionList": { - "list": { - "uid": "4", - "name": "Frequently Ordered Products", + "requisition_list": { + "uid": "Mw==" + "name": "Frequently Ordered Products" "description": "Frequently ordered products list" } } @@ -73,15 +74,17 @@ Attribute | Data Type | Description ## Output attributes -The `createRequisitionListOutput` object returns the `uid` of the new requisition list as well as the input attributes. +The `createRequisitionList` mutation returns the new requisition list. Attribute | Data Type | Description --- | --- | --- -`description` | String | The requisition list description -`name` | String! | The requisition list name -`uid` | ID! | The ID of the new requisition list +`requisition_list` | [[RequisitionList](#RequisitionList)] | The created requisition list + +### RequisitionList attributes {#RequisitionList} + +{% include graphql/requisition-list.md %} ## Related topics -* [renameRequisitionList mutation]({{page.baseurl}}/graphql/mutations/rename-requisition-list.html) +* [updateRequisitionList mutation]({{page.baseurl}}/graphql/mutations/update-requisition-list.html) * [deleteRequisitionList mutation]({{page.baseurl}}/graphql/mutations/delete-requisition-list.html) diff --git a/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md b/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md index 9b38496c119..6015f1a1d80 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md @@ -77,5 +77,5 @@ Attribute | Data Type | Description ## Related topics -* [renameRequisitionList mutation]({{page.baseurl}}/graphql/mutations/rename-requisition-list.html) +* [updateRequisitionList mutation]({{page.baseurl}}/graphql/mutations/update-requisition-list.html) * [deleteRequisitionList mutation]({{page.baseurl}}/graphql/mutations/delete-requisition-list.html) \ No newline at end of file diff --git a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md index f19af8edc63..3a0e4f443f5 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md @@ -5,6 +5,7 @@ b2b_only: true contributor_name: Zilker Technology contributor_link: https://www.ztech.io/ --- + The `deleteRequisitionList` mutation deletes a requisition list of the logged in customer. This mutation requires a valid [customer authentication token]({{page.baseurl}}/graphql/mutations/generate-customer-token.html). @@ -14,7 +15,7 @@ This mutation requires a valid [customer authentication token]({{page.baseurl}}/ ```graphql mutation { deleteRequisitionList( - uid: ID! + requisitionListUid: ID! ) { deleteRequisitionListOutput } @@ -23,16 +24,21 @@ mutation { ## Example usage -The following example deletes the requisition list with `uid` 4. +The following example deletes a requisition list. **Request:** ```graphql mutation { deleteRequisitionList( - uid: "4" + requisitionListUid: "Mw==" ) { - result + status + requisition_list { + uid + name + description + } } } ``` @@ -43,7 +49,12 @@ mutation { { "data": { "deleteRequisitionList": { - "result": true + "status": true, + "requisition_list": { + "uid": "Mw==" + "name": "Frequently Ordered Products" + "description": "Frequently ordered products list" + } } } } @@ -55,17 +66,22 @@ The `deleteRequisitionList` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- -`uid` | ID! | The ID of the requisition list to delete +`requisitionListUid` | ID! | The ID of the requisition list to delete ## Output attributes -The `deleteRequisitionListOutput` object returns the `uid` of the new requisition list as well as the input attributes. +The `deleteRequisitionList` mutation returns the status of the operation, and the requisition list, if it was successfully deleted. Attribute | Data Type | Description --- | --- | --- -`result` | Boolean | Indicates whether the requisition list was deleted +`requisition_list` | [[RequisitionList](#RequisitionList)] | Details about the deleted requisition list +`status` | Boolean | Indicates whether the request to delete the requisition list was successful + +### RequisitionList attributes {#RequisitionList} + +{% include graphql/requisition-list.md %} ## Related topics * [createRequisitionList mutation]({{page.baseurl}}/graphql/mutations/create-requisition-list.html) -* [renameRequisitionList mutation]({{page.baseurl}}/graphql/mutations/rename-requisition-list.html) +* [updateRequisitionList mutation]({{page.baseurl}}/graphql/mutations/update-requisition-list.html) diff --git a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md b/src/guides/v2.4/graphql/mutations/update-requisition-list.md similarity index 60% rename from src/guides/v2.4/graphql/mutations/rename-requisition-list.md rename to src/guides/v2.4/graphql/mutations/update-requisition-list.md index 36d5fe9969d..c30a222dc46 100644 --- a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/update-requisition-list.md @@ -1,11 +1,11 @@ --- group: graphql -title: renameRequisitionList mutation +title: updateRequisitionList mutation b2b_only: true contributor_name: Zilker Technology contributor_link: https://www.ztech.io/ --- -The `renameRequisitionList` mutation updates the name and, optionally, the description of a requisition list. +The `updateRequisitionList` mutation updates the name and, optionally, the description of a requisition list. This mutation requires a valid [customer authentication token]({{page.baseurl}}/graphql/mutations/generate-customer-token.html). @@ -13,12 +13,12 @@ This mutation requires a valid [customer authentication token]({{page.baseurl}}/ ```graphql mutation { - renameRequisitionList( - uid: ID! + updateRequisitionList( + requisitionListUid: ID! name: String! description: String ) { - renameRequisitionListOutput + updateRequisitionListOutput } } ``` @@ -31,12 +31,13 @@ The following example renames the `Frequently Ordered Products` requisition list ```graphql mutation { - renameRequisitionList( - uid: "4" - name: "Frequently Ordered Essential Products", + updateRequisitionList(input:{ + name: "Frequently Ordered Essential Products" description: "Frequently ordered essential products list" + } + requisitionListUid: "Mw==" ) { - list { + requisition_list { uid name description @@ -50,10 +51,10 @@ mutation { ```json { "data": { - "renameRequisitionList": { - "list": { - "uid": "4", - "name": "Frequently Ordered Essential Products", + "updateRequisitionList": { + "requisition_list": { + "uid": "Mw==" + "name": "Frequently Ordered Essential Products" "description": "Frequently ordered essential products list" } } @@ -63,23 +64,25 @@ mutation { ## Input attributes -The `renameRequisitionList` mutation requires the following input. +The `updateRequisitionList` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- `description`| String | Description of the customer's requisition list `name` | String! | The name of the customer's requisition list -`uid` | ID! | The ID of the new requisition list +`requisitionListUid` | ID! | The ID of the new requisition list ## Output attributes -The `renameRequisitionListOutput` object returns the `uid` of the new requisition list as well as the input attributes. +The `updateRequisitionList` mutation returns the new requisition list after updating a list. Attribute | Data Type | Description --- | --- | --- -`description` | String | The requisition list description -`name` | String! | The requisition list name -`uid` | ID! | The ID of the new requisition list +`requisition_list` | [[RequisitionList](#RequisitionList)] | The updated requisition list + +### RequisitionList attributes {#RequisitionList} + +{% include graphql/requisition-list.md %} ## Related topics From 3fbf9cab8d7e3f9929e4b98ce116a978279b64b3 Mon Sep 17 00:00:00 2001 From: Kevin Harper Date: Thu, 17 Dec 2020 17:43:28 -0600 Subject: [PATCH 04/13] GraphQL: Requisition list updates (#8408) * GraphQL: Non-mutation requisition list updates * review draft * Designate topic as B2B only --- src/_data/toc/graphql.yml | 9 + src/_includes/graphql/customer-output-24.md | 10 +- src/_includes/graphql/requisition-list.md | 12 +- .../requisition-list-item-interface.md | 159 ++++++++++++++++++ src/guides/v2.4/graphql/queries/customer.md | 47 +++--- 5 files changed, 212 insertions(+), 25 deletions(-) create mode 100644 src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md diff --git a/src/_data/toc/graphql.yml b/src/_data/toc/graphql.yml index e98641b423a..0ebaa090d30 100644 --- a/src/_data/toc/graphql.yml +++ b/src/_data/toc/graphql.yml @@ -183,6 +183,7 @@ pages: - label: addProductsToRequisitionList mutation url: /graphql/mutations/add-products-to-requisition-list.html + edition: ee-only exclude_versions: [ "2.3" ] - label: addProductsToWishlist mutation @@ -191,6 +192,7 @@ pages: - label: addRequisitionListItemsToCart mutation url: /graphql/mutations/add-requisition-list-items-to-cart.html + edition: ee-only exclude_versions: [ "2.3" ] - label: addSimpleProductsToCart mutation @@ -479,6 +481,7 @@ pages: - label: updateRequisitionListItems mutation url: /graphql/mutations/update-requisition-list-items.html + edition: ee-only exclude_versions: [ "2.3" ] - label: updateWishlist mutation @@ -533,10 +536,16 @@ pages: url: /graphql/interfaces/order-item-interface.html exclude_versions: ["2.3"] + - label: RequisitionListItemInterface attributes and implementations + url: /graphql/interfaces/requisition-list-item-interface.html + edition: b2b-only + exclude_versions: ["2.3"] + - label: ShipmentItemInterface attributes and implementations url: /graphql/interfaces/shipment-item-interface.html exclude_versions: ["2.3"] + - label: Payment methods children: diff --git a/src/_includes/graphql/customer-output-24.md b/src/_includes/graphql/customer-output-24.md index cfa9c27d7f1..86d1b745930 100644 --- a/src/_includes/graphql/customer-output-24.md +++ b/src/_includes/graphql/customer-output-24.md @@ -21,23 +21,25 @@ Attribute | Data Type | Description `firstname` | String | The customer's first name `gender` | Int | The customer's gender (Male - 1, Female - 2) `group_id` | Int | Deprecated. This attribute is not applicable for GraphQL. The group assigned to the user. Default values are 0 (Not logged in), 1 (General), 2 (Wholesale), and 3 (Retailer) -`id` | Int | Deprecated. This attribute is not applicable for GraphQL.The ID assigned to the customer +`id` | Int | Deprecated. This attribute is not applicable for GraphQL. The ID assigned to the customer `is_subscribed` | Boolean | Indicates whether the customer is subscribed to the company's newsletter `lastname` | String | The customer's family name `middlename` |String | The customer's middle name -`orders()` | {{ customeroutput_text }} | A list of the customer's placed orders{{ crossref_text }} +`orders(filter CustomerOrdersFilterInput, currentPage = 1 Int, pageSize = 20 Int)` | {{ customeroutput_text }} | A list of the customer's placed orders{{ crossref_text }} `prefix` | String | An honorific, such as Dr., Mr., or Mrs. `reviews(pageSize: Int = 20 currentPage: Int = 1)` | ProductReviews! | The list of reviews of the product `reward_points` | RewardPoints | Details about the customer's reward points `suffix` | String | A value such as Sr., Jr., or III `taxvat` | String | The customer's Tax/VAT number (for corporate customers) -`wishlist` | Wishlist! | Contains the contents of the customer's wish lists +`wishlist` | Wishlist! | Deprecated. Use `wishlist_v2` instead. Contains the contents of the customer's wish lists +`wishlist_v2(id ID!)` | Wishlist | Retrieve the specified wish list identified by the unique ID for a Wishlist object -For B2B, company users can have the following attributes. +For B2B, company administrators and users can have the following attributes. Attribute | Data Type | Description --- | --- | --- `job_title` | String | The job title for a B2B company user +`requisition_lists (pageSize = 20 Int, currentPage = 1 Int, filter RequisitionListFilterInput)` | RequisitionLists | Contains the customer's requisition lists `role`| CompanyRole | The role name and permissions assigned to the company user `status` | CompanyUserStatusEnum | Indicates whether the company user is ACTIVE or INACTIVE `team` | CompanyTeam | The team the company user is assigned to diff --git a/src/_includes/graphql/requisition-list.md b/src/_includes/graphql/requisition-list.md index 4b9a8c73727..912553db1bc 100644 --- a/src/_includes/graphql/requisition-list.md +++ b/src/_includes/graphql/requisition-list.md @@ -3,8 +3,18 @@ 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` | [RequistionListItems](#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 + +### RequistionListItems attributes {#RequistionListItems} + +The `RequistionListItems` object contains the following attributes. + +Attribute | Data Type | Description +--- | --- | --- +`items` | [RequisitionListItemInterface]! | An array of items in the requisition list +`page_info` | SearchResultPageInfo | Contains pagination metadata +`total_pages` | Int! | The number of pages returned diff --git a/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md b/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md new file mode 100644 index 00000000000..8515d594c72 --- /dev/null +++ b/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md @@ -0,0 +1,159 @@ +--- +group: graphql +title: RequisitionListItemInterface attributes and implementations +--- + +`RequisitionListItemInterface` provides details about items in a requisition list. It has the following implementations: + +* [`BundleRequisitionListItem`](#BundleRequisitionListItem) +* [`ConfigurableRequisitionListItem`](#ConfigurableRequisitionListItem) +* [`DownloadableRequisitionListItem`](#DownloadableRequisitionListItem) +* [`GiftCardRequisitionListItem`](#GiftCardRequisitionListItem) +* [`SimpleRequisitionListItem`](#SimpleRequisitionListItem) +* [`VirtualRequisitionListItem`](#VirtualRequisitionListItem) + +{:.bs-callout-info} +There is not an implementation for grouped products. The items within a grouped product are managed individually. + +## Attributes + +The `RequisitionListItemInterface` defines the following attributes. + +Attribute | Data Type | Description +--- | --- | --- +`customizable_options`: [SelectedCustomizableOption] | Selected custom options for an item in the requisition list +`product` | [ProductInterface!]({{page.baseurl}}/graphql/interfaces/product-interface.html) | Contains details about an item added to a requisition list +`quantity` | Float! | The amount added +`uid` | ID! | The unique ID for the requisition list item + +## Implementations + +### BundleRequisitionListItem attributes {#BundleRequisitionListItem} + +The `BundleRequisitionListItem` implementation adds the following attribute. + +Attribute | Data Type | Description +--- | --- | --- +`bundle_options`| [SelectedBundleOption]! | An array of selected options for a bundle product + +### ConfigurableRequisitionListItem attributes {#ConfigurableRequisitionListItem} + +The `ConfigurableRequisitionListItem` implementation adds the following attribute. + +Attribute | Data Type | Description +--- | --- | --- +`configurable_options`| [SelectedConfigurableOption] | Selected configurable options for an item in the requisition list + +### DownloadableRequisitionListItem attributes {#DownloadableRequisitionListItem} + +The `ConfigurableRequisitionListItem` implementation adds the following attributes. + +Attribute | Data Type | Description +--- | --- | --- +`links`| [DownloadableProductLinks] | An array of links for downloadable products in the requisition list +`samples` | [DownloadableProductSamples] An array of links to downloadable product samples + +### GiftCardRequisitionListItem attributes {#GiftCardRequisitionListItem} + +The `GiftCardRequisitionListItem` implementation adds the following attributes. + +Attribute | Data Type | Description +--- | --- | --- +`gift_card_options` | GiftCardOptions! | An array that defines gift card properties + +#### GiftCardOptions attributes {#GiftCardOptions} + +The GiftCardOptions object provides details about a gift card. All attributes are optional for a requisition list. + +Attribute | Data Type | Description +--- | --- | --- +`amount`| Money | The amount and currency of the gift card +`custom_giftcard_amount` | Money | The custom amount and currency of the gift card +`message` | String | A message to the recipient +`recipient_email` | String | The name of the person receiving the gift card +`sender_email` | String | The email address of the person sending the gift card +`sender_name` | String | The name of the person sending the gift card + +### SimpleRequisitionListItem attributes {#SimpleRequisitionListItem} + +The SimpleRequisitionListItem data type does not provide additional attributes to the `RequisitionListItemInterface`. + +### VirtualRequisitionListItem attributes {#VirtualRequisitionListItem} + +The VirtualRequisitionListItem data type does not provide additional attributes to the `RequisitionListItemInterface`. + +## Example usage + +The following mutation adds a product to a requisition list and returns information about the products in the list. + +**Request:** + +```graphql +mutation { + addProductsToRequisitionList( + requisitionListUid: "Mg==" + requisitionListItems: [ + { + sku: "MS10" + quantity: 1 + selected_options: ["Y29uZmlndXJhYmxlLzkzLzUw","Y29uZmlndXJhYmxlLzE2MC8xNjg"] + } + ] + ) { + requisition_list { + uid + items { + items { + ... on RequisitionListItemInterface { + uid + product { + uid + sku + name + } + quantity + } + } + } + items_count + } + } +} +``` + +**Response:** + +```json +{ + "data": { + "addProductsToRequisitionList": { + "requisition_list": { + "uid": "Mg==", + "items": { + "items": [ + { + "uid": "Mg==", + "product": { + "uid": "MTA=", + "sku": "24-WB05", + "name": "Savvy Shoulder Tote" + }, + "quantity": 1 + }, + { + "uid": "Mw==", + "product": { + "uid": "NTk2", + "sku": "MS10", + "name": "Logan HeatTec® Tee" + }, + "quantity": 1 + } + ] + }, + "items_count": 2 + } + } + } +} +``` diff --git a/src/guides/v2.4/graphql/queries/customer.md b/src/guides/v2.4/graphql/queries/customer.md index 78807350083..1ffa0e39179 100644 --- a/src/guides/v2.4/graphql/queries/customer.md +++ b/src/guides/v2.4/graphql/queries/customer.md @@ -629,26 +629,6 @@ Attribute | Data Type | Description {% include graphql/product-review.md %} -### Wishlist attributes {#Wishlist} - -Attribute | Data type | Description ---- | --- | --- -`items` | [[WishlistItem](#wishlistitem)] | An array of items in the customer's wish list -`items_count` | Int | The number of items in the wish list -`id` | ID | The unique identifier of the wish list -`sharing_code` | String | An encrypted code that Magento uses to link to the wish list -`updated_at` | String | The time of the last modification to the wish list - -#### WishlistItem attributes {#wishlistitem} - -Attribute | Data type | Description ---- | --- | --- -`added_at` | String | The time when the customer added the item to the wish list -`description` | String | The customer's comment about this item -`id` | Int | The wish list item ID -`product` | [ProductInterface]({{ page.baseurl }}/graphql/interfaces/product-interface.html) | The ProductInterface contains attributes that are common to all types of products. Note that descriptions may not be available for custom and EAV attributes -`qty` | Float | The quantity of this wish list item - ### Store credit attributes In {{site.data.var.ee}}, the merchant can assign store credit to customers. Magento maintains the history of all changes to the balance of store credit available to the customer. The customer must be logged in to access the store credit history and balance. @@ -694,6 +674,33 @@ Attribute | Data Type | Description {% include graphql/wishlist.md %} +## B2B output attributes {#B2b} + +If B2B is installed the `Customer` object can contain additional information. + +### RequisitionListFilterInput attributes {#RequisitionListFilterInput} + +The `RequisitionListFilterInput` object defines filters that limit the number of requisition lists returned. + +Attribute | Data Type | Description +--- | --- | --- +`name` | FilterMatchTypeInput | Filter by the display name of the requisition list +`uids` | FilterEqualTypeInput | Filter requisition lists by one or more requisition list IDs + +### RequisitionList attributes {#RequisitionList} + +{% include graphql/requisition-list.md %} + +### RequisitionLists attributes {#RequisitionList} + +The RequisitionLists object contains an array of requisition lists. + +Attribute | Data Type | Description +--- | --- | --- +`items` | [[RequisitionList]](#RequisitionList) | An array of requisition lists +`page_info` | SearchResultPageInfo | Contains pagination metadata +`total_count` | Int | The number of returned requisition lists + ## Related topics * [isEmailAvailable query]({{page.baseurl}}/graphql/queries/is-email-available.html) From 3f4e853837065cd84208e9dcc7e434e4c0eb1a25 Mon Sep 17 00:00:00 2001 From: Kevin Harper Date: Thu, 17 Dec 2020 23:39:54 -0600 Subject: [PATCH 05/13] Update StoreConfig attribute name --- src/_includes/graphql/store-config.md | 2 +- .../v2.4/graphql/mutations/add-products-to-requisition-list.md | 2 +- .../graphql/mutations/add-requisition-list-items-to-cart.md | 2 +- src/guides/v2.4/graphql/mutations/clear-customer-cart.md | 2 +- .../graphql/mutations/copy-items-between-requisition-lists.md | 2 +- src/guides/v2.4/graphql/mutations/create-requisition-list.md | 2 +- .../v2.4/graphql/mutations/delete-requisition-list-items.md | 2 +- .../graphql/mutations/move-items-between-requisition-lists.md | 2 +- .../v2.4/graphql/mutations/update-requisition-list-items.md | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/_includes/graphql/store-config.md b/src/_includes/graphql/store-config.md index 854e25a997c..43a531adb4f 100644 --- a/src/_includes/graphql/store-config.md +++ b/src/_includes/graphql/store-config.md @@ -16,7 +16,6 @@ Attribute | Data Type | Description | Default or example value `base_media_url` | String | The fully-qualified URL that specifies the location of user media files | `http://magentohost.example.com/pub/media/` `base_static_url` | String | The fully-qualified URL that specifies the location of static view files | `http://magentohost.example.com/pub/static/` `base_url` | String | The store's fully-qualified base URL | `http://magentohost.example.com/` -`btob_website_configuration_requisition_list_active` | String | Indicates if requisition lists are enabled. Possible values: 1 (Yes) and 0 (No) | 0 `cart_gift_wrapping` | String | Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No) | 1 `cart_printed_card` | String | Indicates if printed card prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No) | 1 `catalog_default_sort_by` | String | The default sort order of the search results list | `position` @@ -40,6 +39,7 @@ Attribute | Data Type | Description | Default or example value `head_shortcut_icon` | String | Uploads the small graphic image that appears in the address bar and tab of the browser | null `header_logo_src` | String | The path to the logo that appears in the header | null `id` | Int | The ID number assigned to the store | `1` +`is_requisition_list_active` | String | Indicates if requisition lists are enabled. Possible values: 1 (Yes) and 0 (No) | 0 `list_mode` | String | The format of the search results list | `grid-list` `list_per_page` | Int | The default number of products per page in List View | `10` `list_per_page_values` | String | A list of numbers that define how many products can be displayed in List View | `5,10,15,20,25` 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 91f8f9c4c5f..0359b4e7424 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 @@ -9,7 +9,7 @@ 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). {:.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. +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are supported. ## Syntax 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 c9c845c3197..82abe1b2bc1 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 @@ -9,7 +9,7 @@ The `addRequisitionListItemsToCart` mutation adds requisition list items to the 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. +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are supported. ## Syntax 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 cfde63030aa..635cfaa8960 100644 --- a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md +++ b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md @@ -9,7 +9,7 @@ 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. +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are supported. ## Syntax diff --git a/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md b/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md index cde7d55a517..cd1d9d07b9c 100644 --- a/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md +++ b/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md @@ -9,7 +9,7 @@ The `copyItemsBetweenRequisitionLists` mutation copies items from one requisitio 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. +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are supported. ## Syntax diff --git a/src/guides/v2.4/graphql/mutations/create-requisition-list.md b/src/guides/v2.4/graphql/mutations/create-requisition-list.md index bda0fa4fbf8..28ba3566733 100644 --- a/src/guides/v2.4/graphql/mutations/create-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/create-requisition-list.md @@ -10,7 +10,7 @@ The `createRequisitionList` mutation creates a requisition list for the logged i 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. +Use the [`storeConfig` query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are supported. ## Syntax diff --git a/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md b/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md index 6015f1a1d80..0c7702e6612 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md @@ -9,7 +9,7 @@ The `deleteRequisitionListItems` mutation removes items from the specified requi 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. +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are supported. ## Syntax diff --git a/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md b/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md index a5abbe3bf2f..9a39175bd0e 100644 --- a/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md +++ b/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md @@ -9,7 +9,7 @@ The `moveItemsBetweenRequisitionLists` mutation moves items from one requisition 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. +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are supported. ## Syntax 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 e7db747f3b5..36160bebc50 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 @@ -9,7 +9,7 @@ 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). {:.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. +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are supported. ## Syntax From ea1050318a415d40b5141bba079e7661ed7e64fb Mon Sep 17 00:00:00 2001 From: Kevin Harper Date: Fri, 18 Dec 2020 16:11:16 -0600 Subject: [PATCH 06/13] Update examples --- .../add-products-to-requisition-list.md | 38 +++++++++++-- .../add-requisition-list-items-to-cart.md | 55 ++++++++++++++++--- .../copy-items-between-requisition-lists.md | 20 ++++--- .../delete-requisition-list-items.md | 10 ++-- .../move-items-between-requisition-lists.md | 29 ++++++---- .../update-requisition-list-items.md | 47 ++++++++++------ 6 files changed, 146 insertions(+), 53 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 0359b4e7424..aba601f623f 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,17 +33,30 @@ The following example adds products to a requisition list. ``` graphql mutation { addProductsToRequisitionList( - requisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz" + requisitionListUid: "Mg==" requisitionListItems: [ { - sku: "sku" + sku: "MS10" quantity: 1 - selected_options: ["Y29uZmlndXJhYmxlLzkzLzUz","Y29uZmlndXJhYmxlLzE0NC8xNzE="] + selected_options: ["Y29uZmlndXJhYmxlLzkzLzUw","Y29uZmlndXJhYmxlLzE2MC8xNjg"] } ] ) { requisition_list { uid + items { + items { + ... on RequisitionListItemInterface { + uid + product { + uid + sku + name + } + quantity + } + } + } items_count } } @@ -57,9 +70,22 @@ mutation { "data": { "addProductsToRequisitionList": { "requisition_list": { - "uid": "1", - "items_count": 1 - } + "uid": "Mg==", + "items": { + "items": [ + { + "uid": "Mw==", + "product": { + "uid": "NTk2", + "sku": "MS10", + "name": "Logan HeatTec® Tee" + }, + "quantity": 1 + } + ] + }, + "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 82abe1b2bc1..66357d9d5a9 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 @@ -32,13 +32,24 @@ The following example adds items to the cart. ``` graphql mutation { - addRequisitionListItemsToCart - ( - requisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz" - requisitionListItemUids: ["1","2"] - ) { - status - } + addRequisitionListItemsToCart ( + requisitionListUid: "Mg==" + requisitionListItemUids: + ["Mw==", "Ng==", "Nw=="] + ) + { + status + cart { + items { + uid + product { + uid + sku + name + } + } + } + } } ``` @@ -48,7 +59,35 @@ mutation { { "data": { "addRequisitionListItemsToCart": { - "status": "true" + "status": true, + "cart": { + "items": [ + { + "uid": "NQ==", + "product": { + "uid": "NTk2", + "sku": "MS10", + "name": "Logan HeatTec® Tee" + } + }, + { + "uid": "Nw==", + "product": { + "uid": "MTI=", + "sku": "24-WB03", + "name": "Driven Backpack" + } + }, + { + "uid": "OA==", + "product": { + "uid": "Mg==", + "sku": "24-MB04", + "name": "Strive Shoulder Pack" + } + } + ] + } } } } diff --git a/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md b/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md index cd1d9d07b9c..15fcf3bfd06 100644 --- a/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md +++ b/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md @@ -27,19 +27,24 @@ mutation { ## Example usage -The following example copies items from one requisition list to another. +The following example copies an item from one requisition list to another. **Request:** ``` graphql mutation { copyItemsBetweenRequisitionLists( - sourceRequisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz", - destinationRequisitionListUid: "W16uZmlndXJhYmxlLakzLzUz", - requisitionListItemUids: ["2","3"] + sourceRequisitionListUid: "Mg==", + destinationRequisitionListUid: "Mw==", + requisitionListItem: { + requisitionListItemUids: [ + "Nw==" + ] + } ) { requisition_list { uid + name items_count } } @@ -53,9 +58,10 @@ mutation { "data": { "copyItemsBetweenRequisitionLists": { "requisition_list": { - "uid": "W16uZmlndXJhYmxlLakzLzUz", - "items_count": 2 - } + "uid": "Mw==", + "name": "Rarely ordered items", + "items_count": 3 + } } } } diff --git a/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md b/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md index 0c7702e6612..a2012d88f99 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md @@ -32,8 +32,8 @@ The following example removes the specified items from the requisition list. ``` graphql mutation { deleteRequisitionListItems( - requisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz", - requisitionListItemUids: ["2","3"] + requisitionListUid: "Mg==", + requisitionListItemUids: ["NA==","NQ=="] ) { requisition_list { uid @@ -50,9 +50,9 @@ mutation { "data": { "deleteRequisitionListItems": { "requisition_list": { - "uid": "Y29uZmlndXJhYmxlLzkzLzUz", - "items_count": 0 - } + "uid": "Mg==", + "items_count": 1 + } } } } diff --git a/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md b/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md index 9a39175bd0e..6030be21c29 100644 --- a/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md +++ b/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md @@ -27,23 +27,28 @@ mutation { ## Example usage -The following example moves items from one requisition list to another. +The following example moves an item from one requisition list to another. **Request:** ``` graphql mutation { moveItemsBetweenRequisitionLists( - sourceRequisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz" - destinationRequisitionListUid: "W16uZmlndXJhYmxlLakzLzUz" - requisitionListItemUids: ["2","3"] - ) { + sourceRequisitionListUid: "Mg==" + destinationRequisitionListUid: "Mw==" + requisitionListItem: { + requisitionListItemUids: + ["MTI="] + } + ) { source_requisition_list { uid + name items_count } destination_requisition_list { uid + name items_count } } @@ -57,13 +62,15 @@ mutation { "data": { "moveItemsBetweenRequisitionLists": { "source_requisition_list": { - "uid": "Y29uZmlndXJhYmxlLzkzLzUz", - "items_count": 0 - }, + "uid": "Mg==", + "name": "Frequently Ordered Products", + "items_count": 3 + }, "destination_requisition_list": { - "uid": "W16uZmlndXJhYmxlLakzLzUz", - "items_count": 2 - } + "uid": "Mw==", + "name": "Rarely ordered items", + "items_count": 2 + } } } } 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 36160bebc50..2eac7c8acee 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,21 +33,27 @@ The following example updates the quantity of an item in a requisition list. ``` graphql mutation { updateRequisitionListItems( - requisitionListUid: "Y29uZmlndXJhYmxlLzkzLzUz", - requisitionListItems: [ - { - item_id: "W29uZmlndXJhYmxlLzkzLzUz" - quantity: 2 - } - ] - ) { + requisitionListUid: "Mg==", + requisitionListItems: [ + { + item_id: "Mw==" + quantity: 2 + } + ] + ){ requisition_list { uid + name items_count items { items { + uid + quantity + product { uid - quantity + name + sku + } } } } @@ -58,19 +64,28 @@ mutation { **Response:** ``` json +{ { "data": { "updateRequisitionListItems": { "requisition_list": { - "uid": "1", - "items_count": 1, - "items": { - "items": { - "uid": "1", - "quantity": 2 + "uid": "Mg==", + "name": "Frequently Ordered Products", + "items_count": 1, + "items": { + "items": [ + { + "uid": "Mw==", + "quantity": 2, + "product": { + "uid": "NTk2", + "name": "Logan HeatTec® Tee", + "sku": "MS10" + } } - } + ] } + } } } } From 9a6136ee46c1feb82072b71c763a363d96c2ebb5 Mon Sep 17 00:00:00 2001 From: Kevin Harper Date: Mon, 21 Dec 2020 11:36:29 -0600 Subject: [PATCH 07/13] Update deleteReqList output --- .../graphql/mutations/delete-requisition-list.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md index 3a0e4f443f5..6bda61616b5 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md @@ -6,7 +6,7 @@ contributor_name: Zilker Technology contributor_link: https://www.ztech.io/ --- -The `deleteRequisitionList` mutation deletes a requisition list of the logged in customer. +The `deleteRequisitionList` mutation deletes a requisition list of the logged in customer. The response can include any remaining requisition lists. This mutation requires a valid [customer authentication token]({{page.baseurl}}/graphql/mutations/generate-customer-token.html). @@ -37,7 +37,6 @@ mutation { requisition_list { uid name - description } } } @@ -50,10 +49,9 @@ mutation { "data": { "deleteRequisitionList": { "status": true, - "requisition_list": { - "uid": "Mw==" - "name": "Frequently Ordered Products" - "description": "Frequently ordered products list" + "requisition_lists": { + "uid": "Mg==" + "name": "Rarely ordered items" } } } @@ -74,7 +72,7 @@ The `deleteRequisitionList` mutation returns the status of the operation, and th Attribute | Data Type | Description --- | --- | --- -`requisition_list` | [[RequisitionList](#RequisitionList)] | Details about the deleted requisition list +`requisition_lists` | [[RequisitionList](#RequisitionList)] | Contains the customer's remaining requisition lists `status` | Boolean | Indicates whether the request to delete the requisition list was successful ### RequisitionList attributes {#RequisitionList} From b3cc0e8e84020eb7b38f39e9df8e85b5e06f2c6c Mon Sep 17 00:00:00 2001 From: Kevin Harper Date: Mon, 21 Dec 2020 11:38:32 -0600 Subject: [PATCH 08/13] Update deleteReqList output --- src/guides/v2.4/graphql/mutations/delete-requisition-list.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md index 6bda61616b5..8bd24b4380c 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md @@ -50,7 +50,7 @@ mutation { "deleteRequisitionList": { "status": true, "requisition_lists": { - "uid": "Mg==" + "uid": "Mg==", "name": "Rarely ordered items" } } From 869ef8434f0527caa4e2764a0ce24d03cb07ee6a Mon Sep 17 00:00:00 2001 From: Kevin Harper Date: Mon, 21 Dec 2020 14:05:06 -0600 Subject: [PATCH 09/13] Fit & finish --- src/_data/toc/graphql.yml | 22 +++++++++---------- src/_includes/graphql/requisition-list.md | 2 +- .../requisition-list-item-interface.md | 2 +- .../add-products-to-requisition-list.md | 4 +--- .../add-requisition-list-items-to-cart.md | 2 +- .../graphql/mutations/clear-customer-cart.md | 4 ++-- .../copy-items-between-requisition-lists.md | 14 ++++++------ .../mutations/create-requisition-list.md | 2 +- .../delete-requisition-list-items.md | 7 ++++-- .../mutations/delete-requisition-list.md | 3 +++ .../move-items-between-requisition-lists.md | 17 +++++++------- .../update-requisition-list-items.md | 4 +--- .../mutations/update-requisition-list.md | 3 +++ 13 files changed, 46 insertions(+), 40 deletions(-) diff --git a/src/_data/toc/graphql.yml b/src/_data/toc/graphql.yml index 0ebaa090d30..2b035e252a0 100644 --- a/src/_data/toc/graphql.yml +++ b/src/_data/toc/graphql.yml @@ -183,7 +183,7 @@ pages: - label: addProductsToRequisitionList mutation url: /graphql/mutations/add-products-to-requisition-list.html - edition: ee-only + edition: b2b-only exclude_versions: [ "2.3" ] - label: addProductsToWishlist mutation @@ -192,7 +192,7 @@ pages: - label: addRequisitionListItemsToCart mutation url: /graphql/mutations/add-requisition-list-items-to-cart.html - edition: ee-only + edition: b2b-only exclude_versions: [ "2.3" ] - label: addSimpleProductsToCart mutation @@ -313,24 +313,24 @@ pages: - label: deleteCustomerAddress mutation url: /graphql/mutations/delete-customer-address.html + - label: deleteRequisitionList mutation + url: /graphql/mutations/delete-requisition-list.html + edition: b2b-only + exclude_versions: [ "2.3" ] + - label: deleteRequisitionListItems mutation url: /graphql/mutations/delete-requisition-list-items.html edition: b2b-only exclude_versions: [ "2.3" ] + - label: deletePaymentToken mutation + url: /graphql/mutations/delete-payment-token.html + - label: deleteWishlist mutation url: /graphql/mutations/delete-wishlist.html edition: ee-only exclude_versions: ["2.3"] - - label: deletePaymentToken mutation - url: /graphql/mutations/delete-payment-token.html - - - label: deleteRequisitionList mutation - url: /graphql/mutations/delete-requisition-list.html - edition: b2b-only - exclude_versions: [ "2.3" ] - - label: generateCustomerToken mutation url: /graphql/mutations/generate-customer-token.html @@ -481,7 +481,7 @@ pages: - label: updateRequisitionListItems mutation url: /graphql/mutations/update-requisition-list-items.html - edition: ee-only + edition: b2b-only exclude_versions: [ "2.3" ] - label: updateWishlist mutation diff --git a/src/_includes/graphql/requisition-list.md b/src/_includes/graphql/requisition-list.md index 912553db1bc..1dd3af89119 100644 --- a/src/_includes/graphql/requisition-list.md +++ b/src/_includes/graphql/requisition-list.md @@ -15,6 +15,6 @@ The `RequistionListItems` object contains the following attributes. Attribute | Data Type | Description --- | --- | --- -`items` | [RequisitionListItemInterface]! | An array of items in the requisition list +`items` | [[RequisitionListItemInterface]!]({{page.baseurl}}/graphql/interfaces/requisition-list-item-interface.html) | An array of items in the requisition list `page_info` | SearchResultPageInfo | Contains pagination metadata `total_pages` | Int! | The number of pages returned diff --git a/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md b/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md index 8515d594c72..254d036493a 100644 --- a/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md +++ b/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md @@ -21,7 +21,7 @@ The `RequisitionListItemInterface` defines the following attributes. Attribute | Data Type | Description --- | --- | --- -`customizable_options`: [SelectedCustomizableOption] | Selected custom options for an item in the requisition list +`customizable_options` | [SelectedCustomizableOption] | Selected custom options for an item in the requisition list `product` | [ProductInterface!]({{page.baseurl}}/graphql/interfaces/product-interface.html) | Contains details about an item added to a requisition list `quantity` | Float! | The amount added `uid` | ID! | The unique ID for the requisition list item 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 aba601f623f..be0e6146e4e 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 @@ -9,7 +9,7 @@ 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). {:.bs-callout-info} -Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are supported. +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are enabled. ## Syntax @@ -122,6 +122,4 @@ Attribute | Data Type | Description ### RequisitionList attributes {#RequisitionList} -The `RequisitionList` object can contain the following attributes. - {% 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 66357d9d5a9..584e5ebf107 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 @@ -9,7 +9,7 @@ The `addRequisitionListItemsToCart` mutation adds requisition list items to the 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 `is_requisition_list_active` attribute to determine whether requisition lists are supported. +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are enabled. ## Syntax 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 635cfaa8960..bff9cd560be 100644 --- a/src/guides/v2.4/graphql/mutations/clear-customer-cart.md +++ b/src/guides/v2.4/graphql/mutations/clear-customer-cart.md @@ -9,7 +9,7 @@ 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 `is_requisition_list_active` attribute to determine whether requisition lists are supported. +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are enabled. ## Syntax @@ -32,7 +32,7 @@ The following example clears the customer's cart. ``` graphql mutation { clearCustomerCart( - cartUid: "1" + cartUid: "8k0Q4MpH2IGahWrTRtqM61YV2MtLPApz" ) { status } diff --git a/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md b/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md index 15fcf3bfd06..8b73a04bda0 100644 --- a/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md +++ b/src/guides/v2.4/graphql/mutations/copy-items-between-requisition-lists.md @@ -9,7 +9,7 @@ The `copyItemsBetweenRequisitionLists` mutation copies items from one requisitio 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 `is_requisition_list_active` attribute to determine whether requisition lists are supported. +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are enabled. ## Syntax @@ -77,21 +77,21 @@ Attribute | Data Type | Description `requisitionListItem`| [[CopyItemsBetweenRequisitionListsInput](#CopyItemsBetweenRequisitionListsInput)] | An array of selected requisition list items that are to be copied `sourceRequisitionListUid`| ID! | The unique ID of the source requisition list -## Output attributes +### CopyItemsBetweenRequisitionListsInput attributes {#CopyItemsBetweenRequisitionListsInput} -The `copyItemsBetweenRequisitionLists` mutation returns the requisition list object to which the products were copied to. +The `CopyItemsBetweenRequisitionListsInput` type contains the list of products to copy from one requisition list to other. Attribute | Data Type | Description --- | --- | --- -`requisition_list` | [[RequisitionList](#RequisitionList)] | The destination requisition list after the items were copied +`requisitionListItemUids` | [ID!]! | An array of IDs representing products copied from one requisition list to another -### CopyItemsBetweenRequisitionListsInput attributes {#CopyItemsBetweenRequisitionListsInput} +## Output attributes -The `CopyItemsBetweenRequisitionListsInput` type contains the list of products to copy from one requisition list to other. +The `copyItemsBetweenRequisitionLists` mutation returns the requisition list object to which the products were copied to. Attribute | Data Type | Description --- | --- | --- -`requisitionListItemUids` | [ID!]! | An array of IDs representing products copied from one requisition list to another +`requisition_list` | [[RequisitionList](#RequisitionList)] | The destination requisition list after the items were copied ### RequisitionList attributes {#RequisitionList} {% include graphql/requisition-list.md %} diff --git a/src/guides/v2.4/graphql/mutations/create-requisition-list.md b/src/guides/v2.4/graphql/mutations/create-requisition-list.md index 28ba3566733..65463fba9d9 100644 --- a/src/guides/v2.4/graphql/mutations/create-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/create-requisition-list.md @@ -10,7 +10,7 @@ The `createRequisitionList` mutation creates a requisition list for the logged i 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 `is_requisition_list_active` attribute to determine whether requisition lists are supported. +Use the [`storeConfig` query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are enabled. ## Syntax diff --git a/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md b/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md index a2012d88f99..bb0ae5d55ab 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md @@ -9,7 +9,7 @@ The `deleteRequisitionListItems` mutation removes items from the specified requi 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 `is_requisition_list_active` attribute to determine whether requisition lists are supported. +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are enabled. ## Syntax @@ -73,8 +73,11 @@ The `deleteRequisitionListItems` object returns the requisition list after the d Attribute | Data Type | Description --- | --- | --- -`requisition_list` | RequisitionList | The requisition list after removing items +`requisition_list` | [RequisitionList](#RequisitionList) | The requisition list after removing items +### RequisitionList attributes {#RequisitionList} + +{% include graphql/requisition-list.md %} ## Related topics * [updateRequisitionList mutation]({{page.baseurl}}/graphql/mutations/update-requisition-list.html) diff --git a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md index 8bd24b4380c..9ed60399d78 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md @@ -10,6 +10,9 @@ The `deleteRequisitionList` mutation deletes a requisition list of the logged in 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 `is_requisition_list_active` attribute to determine whether requisition lists are enabled. + ## Syntax ```graphql diff --git a/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md b/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md index 6030be21c29..18e7d7cae47 100644 --- a/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md +++ b/src/guides/v2.4/graphql/mutations/move-items-between-requisition-lists.md @@ -9,7 +9,7 @@ The `moveItemsBetweenRequisitionLists` mutation moves items from one requisition 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 `is_requisition_list_active` attribute to determine whether requisition lists are supported. +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are enabled. ## Syntax @@ -86,24 +86,25 @@ Attribute | Data Type | Description `requisitionListItem`| [[MoveItemsBetweenRequisitionListsInput](#MoveItemsBetweenRequisitionListsInput)] | An array of selected requisition list items that are to be moved from the source to the destination list `sourceRequisitionListUid`| ID! | The unique ID of the source requisition list -## Output attributes +### MoveItemsBetweenRequisitionListsInput attributes {#MoveItemsBetweenRequisitionListsInput} -The `moveItemsBetweenRequisitionLists` object returns the source requisition list and the destination requisition list object. +The `MoveItemsBetweenRequisitionListsInput` type contains the list of products to move from one requisition list to other. Attribute | Data Type | Description --- | --- | --- -`destination_requisition_list` | [[RequisitionList](#RequisitionList)] | The destination requisition list after moving items -`source_requisition_list` | [[RequisitionList](#RequisitionList)] | The source requisition list after moving items +`requisitionListItemUids` | [ID!]! | An array of IDs representing products moved from one requisition list to another -### MoveItemsBetweenRequisitionListsInput attributes {#MoveItemsBetweenRequisitionListsInput} +## Output attributes -The `MoveItemsBetweenRequisitionListsInput` type contains the list of products to move from one requisition list to other. +The `moveItemsBetweenRequisitionLists` object returns the source requisition list and the destination requisition list object. Attribute | Data Type | Description --- | --- | --- -`requisitionListItemUids` | [ID!]! | An array of IDs representing products moved from one requisition list to another +`destination_requisition_list` | [[RequisitionList](#RequisitionList)] | The destination requisition list after moving items +`source_requisition_list` | [[RequisitionList](#RequisitionList)] | The source requisition list after moving items ### RequisitionList attributes {#RequisitionList} + {% include graphql/requisition-list.md %} ## Related topics 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 2eac7c8acee..c1ae269d1cb 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 @@ -9,7 +9,7 @@ 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). {:.bs-callout-info} -Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are supported. +Use the [storeConfig query]({{page.baseurl}}/graphql/queries/store-config.html) with the `is_requisition_list_active` attribute to determine whether requisition lists are enabled. ## Syntax @@ -121,6 +121,4 @@ Attribute | Data Type | Description ### RequisitionList attributes {#RequisitionList} -The `RequisitionList` object can contain the following attributes. - {% include graphql/requisition-list.md %} diff --git a/src/guides/v2.4/graphql/mutations/update-requisition-list.md b/src/guides/v2.4/graphql/mutations/update-requisition-list.md index c30a222dc46..eb3d9b59bb1 100644 --- a/src/guides/v2.4/graphql/mutations/update-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/update-requisition-list.md @@ -9,6 +9,9 @@ The `updateRequisitionList` mutation updates the name and, optionally, the descr 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 `is_requisition_list_active` attribute to determine whether requisition lists are enabled. + ## Syntax ```graphql From 4ae201323441621f46fb882c93fddaaddbc95ea4 Mon Sep 17 00:00:00 2001 From: Kevin Harper Date: Mon, 21 Dec 2020 16:06:49 -0600 Subject: [PATCH 10/13] Reviewer comments --- .../v2.4/graphql/interfaces/requisition-list-item-interface.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md b/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md index 254d036493a..8bc89446414 100644 --- a/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md +++ b/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md @@ -1,6 +1,7 @@ --- group: graphql title: RequisitionListItemInterface attributes and implementations +b2b_only: true --- `RequisitionListItemInterface` provides details about items in a requisition list. It has the following implementations: @@ -55,7 +56,7 @@ Attribute | Data Type | Description ### GiftCardRequisitionListItem attributes {#GiftCardRequisitionListItem} -The `GiftCardRequisitionListItem` implementation adds the following attributes. +The `GiftCardRequisitionListItem` implementation adds the following attribute. Attribute | Data Type | Description --- | --- | --- From 95d05d0826b242caa41c43cdf0f61a4822cad605 Mon Sep 17 00:00:00 2001 From: Kevin Harper Date: Tue, 22 Dec 2020 09:20:50 -0600 Subject: [PATCH 11/13] Corrected deleteReqList output --- .../requisition-list-item-interface.md | 2 +- .../mutations/delete-requisition-list.md | 28 ++++++++++++++----- 2 files changed, 22 insertions(+), 8 deletions(-) diff --git a/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md b/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md index 8bc89446414..b9566135787 100644 --- a/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md +++ b/src/guides/v2.4/graphql/interfaces/requisition-list-item-interface.md @@ -52,7 +52,7 @@ The `ConfigurableRequisitionListItem` implementation adds the following attribut Attribute | Data Type | Description --- | --- | --- `links`| [DownloadableProductLinks] | An array of links for downloadable products in the requisition list -`samples` | [DownloadableProductSamples] An array of links to downloadable product samples +`samples` | [DownloadableProductSamples] | An array of links to downloadable product samples ### GiftCardRequisitionListItem attributes {#GiftCardRequisitionListItem} diff --git a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md index 9ed60399d78..9871bdca2bc 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md @@ -37,9 +37,11 @@ mutation { requisitionListUid: "Mw==" ) { status - requisition_list { - uid - name + requisition_lists { + items { + uid + name + } } } } @@ -53,8 +55,10 @@ mutation { "deleteRequisitionList": { "status": true, "requisition_lists": { - "uid": "Mg==", - "name": "Rarely ordered items" + "items": { + "uid": "Mg==", + "name": "Rarely ordered items" + } } } } @@ -71,13 +75,23 @@ Attribute | Data Type | Description ## Output attributes -The `deleteRequisitionList` mutation returns the status of the operation, and the requisition list, if it was successfully deleted. +The `deleteRequisitionList` mutation returns the status of the operation and any undeleted requisition lists. Attribute | Data Type | Description --- | --- | --- -`requisition_lists` | [[RequisitionList](#RequisitionList)] | Contains the customer's remaining requisition lists +`requisition_lists` | [[RequisitionLists](#RequisitionLists)] | Contains the customer's remaining requisition lists `status` | Boolean | Indicates whether the request to delete the requisition list was successful +### RequisitionLists attributes {#RequisitionLists} + +The RequisitionLists object contains array of requisition list items and pagination information. + +Attribute | Data Type | Description +--- | --- | --- +`items` | [[RequisitionList](#RequisitionList)] | An array of requisition lists +`page_info` | SearchResultPageInfo | Contains pagination metadata +`total_count` | Int | The number of returned requisition lists + ### RequisitionList attributes {#RequisitionList} {% include graphql/requisition-list.md %} From c9c1257a884cc42a6e1035914cdc20f6fef0e231 Mon Sep 17 00:00:00 2001 From: Kevin Harper Date: Tue, 22 Dec 2020 13:44:47 -0600 Subject: [PATCH 12/13] Update rel notes --- .../graphql/mutations/delete-requisition-list.md | 12 ++++++++---- src/guides/v2.4/release-notes/commerce-2-4-2.md | 6 +++--- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md index 9871bdca2bc..71a0bd591d8 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md @@ -38,6 +38,7 @@ mutation { ) { status requisition_lists { + total_count items { uid name @@ -55,10 +56,13 @@ mutation { "deleteRequisitionList": { "status": true, "requisition_lists": { - "items": { - "uid": "Mg==", - "name": "Rarely ordered items" - } + "total_count": 1 + "items": [ + { + "uid": "Mg==", + "name": "Frequently Ordered Products" + } + ] } } } diff --git a/src/guides/v2.4/release-notes/commerce-2-4-2.md b/src/guides/v2.4/release-notes/commerce-2-4-2.md index c996893f273..d0776ce91f7 100644 --- a/src/guides/v2.4/release-notes/commerce-2-4-2.md +++ b/src/guides/v2.4/release-notes/commerce-2-4-2.md @@ -93,9 +93,9 @@ This release adds GraphQL coverage for the following features: * Added support for returned merchandise authorizations (RMA) * Added support for the following B2B features: - * Companies, including administrators, users, roles, and structure - * Company credit - * [Create]({{ page.baseurl }}/graphql/mutations/create-requisition-list.html), [delete]({{ page.baseurl }}/graphql/mutations/delete-requisition-list.html), and update requisition lists + * Companies. You can add company [administrators]({{page.baseurl}}/graphql/mutations/create-company.html), [users]({{page.baseurl}}/graphql/mutations/create-company-user.html), [roles]({{page.baseurl}}/graphql/mutations/create-company-role.html), and [teams]({{page.baseurl}}//graphql/mutations/create-company-team.html). + * Company credit. The [company query]({{page.baseurl}}/graphql/queries/company.html) includes details about the company's credit history. + * Requisition lists. You can [create]({{page.baseurl}}/graphql/mutations/create-requisition-list.html), [delete]({{ page.baseurl }}/graphql/mutations/delete-requisition-list.html), and [update]({{page.baseurl}}/graphql/mutations/update-requisition-list.html) requisition lists. Support also includes the ability to [add]({{page.baseurl}}/graphql/mutations/add-products-to-requisition-list.html), [update]({{page.baseurl}}/graphql/mutations/update-products-in-wishlist.html), [delete]({{page.baseurl}}/graphql/mutations/delete-requisition-list-items.html), [copy]({{page.baseurl}}/graphql/mutations/copy-items-between-requisition-lists.html), and [move]({{page.baseurl}}/graphql/mutations/move-items-between-requisition-lists.html) items within a requisition list as well as add requisition list items [into the cart]({{page.baseurl}}/graphql/mutations/add-requisition-list-items-to-cart.html). See the [GraphQL Developer Guide]({{page.baseurl}}/graphql/) for details on these enhancements. From 65638a2c9e338c77a4b571b4f9071bdc33d67a42 Mon Sep 17 00:00:00 2001 From: Kevin Harper Date: Tue, 22 Dec 2020 18:34:19 -0600 Subject: [PATCH 13/13] linting --- src/guides/v2.4/release-notes/commerce-2-4-2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/guides/v2.4/release-notes/commerce-2-4-2.md b/src/guides/v2.4/release-notes/commerce-2-4-2.md index d0776ce91f7..bd995ffdbeb 100644 --- a/src/guides/v2.4/release-notes/commerce-2-4-2.md +++ b/src/guides/v2.4/release-notes/commerce-2-4-2.md @@ -93,7 +93,7 @@ This release adds GraphQL coverage for the following features: * Added support for returned merchandise authorizations (RMA) * Added support for the following B2B features: - * Companies. You can add company [administrators]({{page.baseurl}}/graphql/mutations/create-company.html), [users]({{page.baseurl}}/graphql/mutations/create-company-user.html), [roles]({{page.baseurl}}/graphql/mutations/create-company-role.html), and [teams]({{page.baseurl}}//graphql/mutations/create-company-team.html). + * Companies. You can add company [administrators]({{page.baseurl}}/graphql/mutations/create-company.html), [users]({{page.baseurl}}/graphql/mutations/create-company-user.html), [roles]({{page.baseurl}}/graphql/mutations/create-company-role.html), and [teams]({{page.baseurl}}/graphql/mutations/create-company-team.html). * Company credit. The [company query]({{page.baseurl}}/graphql/queries/company.html) includes details about the company's credit history. * Requisition lists. You can [create]({{page.baseurl}}/graphql/mutations/create-requisition-list.html), [delete]({{ page.baseurl }}/graphql/mutations/delete-requisition-list.html), and [update]({{page.baseurl}}/graphql/mutations/update-requisition-list.html) requisition lists. Support also includes the ability to [add]({{page.baseurl}}/graphql/mutations/add-products-to-requisition-list.html), [update]({{page.baseurl}}/graphql/mutations/update-products-in-wishlist.html), [delete]({{page.baseurl}}/graphql/mutations/delete-requisition-list-items.html), [copy]({{page.baseurl}}/graphql/mutations/copy-items-between-requisition-lists.html), and [move]({{page.baseurl}}/graphql/mutations/move-items-between-requisition-lists.html) items within a requisition list as well as add requisition list items [into the cart]({{page.baseurl}}/graphql/mutations/add-requisition-list-items-to-cart.html).