From 607c885795605c02decca1b755a47dd3cb337f28 Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Tue, 20 Oct 2020 19:16:48 +0530 Subject: [PATCH 01/12] added create, rename, delete lists --- src/_data/toc/graphql.yml | 15 ++++ .../mutations/create-requisition-list.md | 86 ++++++++++++++++++ .../mutations/delete-requisition-list.md | 74 +++++++++++++++ .../mutations/rename-requisition-list.md | 89 +++++++++++++++++++ 4 files changed, 264 insertions(+) create mode 100644 src/guides/v2.4/graphql/mutations/create-requisition-list.md create mode 100644 src/guides/v2.4/graphql/mutations/delete-requisition-list.md create mode 100644 src/guides/v2.4/graphql/mutations/rename-requisition-list.md diff --git a/src/_data/toc/graphql.yml b/src/_data/toc/graphql.yml index 839b454eb9b..93fd4ea21db 100644 --- a/src/_data/toc/graphql.yml +++ b/src/_data/toc/graphql.yml @@ -400,6 +400,21 @@ pages: edition: ee-only exclude_versions: ["2.3"] + - label: createRequisitionList mutation + url: /graphql/mutations/create-requisition-list.html + edition: b2b-only + exclude_versions: [ "2.3" ] + + - label: renameRequisitionList mutation + url: /graphql/mutations/rename-requisition-list.html + edition: b2b-only + exclude_versions: [ "2.3" ] + + - label: deleteRequisitionList mutation + url: /graphql/mutations/delete-requisition-list.html + edition: b2b-only + exclude_versions: [ "2.3" ] + - label: Interfaces children: - label: Product interface implementations diff --git a/src/guides/v2.4/graphql/mutations/create-requisition-list.md b/src/guides/v2.4/graphql/mutations/create-requisition-list.md new file mode 100644 index 00000000000..20cffc7c2d5 --- /dev/null +++ b/src/guides/v2.4/graphql/mutations/create-requisition-list.md @@ -0,0 +1,86 @@ +--- +group: graphql +title: createRequisitionList mutation +b2b_only: true +--- +The `createRequisitionList` mutation creates a requisition 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 following attributes to determine whether requisition lists are supported: + +* `btob_website_configuration_requisition_list_active` + +## Syntax + +```graphql +mutation { + createRequisitionList( + name: String! + description: String + ) { + CreateRequisitionListOutput + } +} +``` + +## Example usage + +The following example creates the `Frequently Ordered Products` requisition list. + +**Request:** + +``` graphql +mutation { + createRequisitionList( + name: "Frequently Ordered Products", + description: "Frequently ordered products list" + ) { + list { + uid + name + description + } +} +``` + +**Response:** + +```json +{ + "data": { + "createRequisitionList": { + "list": { + "uid": "4", + "name": "Frequently Ordered Products", + "description": "Frequently ordered products list" + } + } + } +} +``` + +## Input attributes + +The `createRequisitionList` mutation requires the following input. + +Attribute | Data Type | Description +--- | --- | --- +`name` | String! | The name of the customer's requisition list +`description`| String | Description of the customer's requisition list + +## Output attributes + +The `createRequisitionListOutput` object returns the `uid` of the new requisition list as well as the input attributes. + +Attribute | Data Type | Description +--- | --- | --- +`name` | String! | The requisition list name +`uid` | ID! | The ID of the new requisition list +`description` | String | The requisition list description + +## Related topics + +* [renameRequisitionList mutation]({{page.baseurl}}/graphql/mutations/rename-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.md b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md new file mode 100644 index 00000000000..fefae985aff --- /dev/null +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md @@ -0,0 +1,74 @@ +--- +group: graphql +title: deleteRequisitionList mutation +b2b_only: true +--- +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). + +{:.bs-callout-info} +Use the [`storeConfig` query]({{page.baseurl}}/graphql/queries/store-config.html) with the following attributes to determine whether requisition lists are supported: + +* `btob_website_configuration_requisition_list_active` + +## Syntax + +```graphql +mutation { + deleteRequisitionList( + uid: ID! + ) { + deleteRequisitionListOutput + } +} +``` + +## Example usage + +The following example deletes the requisition list with uid 4. + +**Request:** + +``` graphql +mutation { + deleteRequisitionList( + uid: 4 + ) { + result + } +} +``` + +**Response:** + +```json +{ + "data": { + "deleteRequisitionList": { + "result": true + } + } +} +``` + +## Input attributes + +The `deleteRequisitionList` mutation requires the following input. + +Attribute | Data Type | Description +--- | --- | --- +`uid` | ID! | The ID of the new requisition list + +## Output attributes + +The `deleteRequisitionListOutput` object returns the `uid` of the new requisition list as well as the input attributes. + +Attribute | Data Type | Description +--- | --- | --- +`result` | Boolean | Requisition list deleted or not + +## Related topics + +* [createRequisitionList mutation]({{page.baseurl}}/graphql/mutations/create-requisition-list.html) +* [renameRequisitionList mutation]({{page.baseurl}}/graphql/mutations/rename-requisition-list.html) diff --git a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md b/src/guides/v2.4/graphql/mutations/rename-requisition-list.md new file mode 100644 index 00000000000..89acac04281 --- /dev/null +++ b/src/guides/v2.4/graphql/mutations/rename-requisition-list.md @@ -0,0 +1,89 @@ +--- +group: graphql +title: renameRequisitionList mutation +b2b_only: true +--- +The `renameRequisitionList` mutation rename a requisition list of 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 following attributes to determine whether requisition lists are supported: + +* `btob_website_configuration_requisition_list_active` + +## Syntax + +```graphql +mutation { + renameRequisitionList( + uid: ID! + name: String! + description: String + ) { + renameRequisitionListOutput + } +} +``` + +## Example usage + +The following example renames the `Frequently Ordered Products` requisition list. + +**Request:** + +``` graphql +mutation { + renameRequisitionList( + uid: 4 + name: "Frequently Ordered Essential Products", + description: "Frequently ordered essential products list" + ) { + list { + uid + name + description + } +} +``` + +**Response:** + +```json +{ + "data": { + "renameRequisitionList": { + "list": { + "uid": "4", + "name": "Frequently Ordered Essential Products", + "description": "Frequently ordered essential products list" + } + } + } +} +``` + +## Input attributes + +The `renameRequisitionList` mutation requires the following input. + +Attribute | Data Type | Description +--- | --- | --- +`uid` | ID! | The ID of the new requisition list +`name` | String! | The name of the customer's requisition list +`description`| String | Description of the customer's requisition list + +## Output attributes + +The `renameRequisitionListOutput` object returns the `uid` of the new requisition list as well as the input attributes. + +Attribute | Data Type | Description +--- | --- | --- +`name` | String! | The requisition list name +`uid` | ID! | The ID of the new requisition list +`description` | String | The requisition list description + +## Related topics + +* [createRequisitionList mutation]({{page.baseurl}}/graphql/mutations/create-requisition-list.html) +* [deleteRequisitionList mutation]({{page.baseurl}}/graphql/mutations/delete-requisition-list.html) \ No newline at end of file From 5f79a3f865c66ca8feef7aedd7a662de17def9bd Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Wed, 21 Oct 2020 14:44:52 +0530 Subject: [PATCH 02/12] Update src/guides/v2.4/graphql/mutations/create-requisition-list.md Co-authored-by: Kevin Harper --- src/guides/v2.4/graphql/mutations/create-requisition-list.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 20cffc7c2d5..40cb8aaaf0d 100644 --- a/src/guides/v2.4/graphql/mutations/create-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/create-requisition-list.md @@ -8,7 +8,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 following attributes to determine whether requisition lists are supported: +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. * `btob_website_configuration_requisition_list_active` From e19a4e127f4a651d10648832fb2a8f68703c7b9e Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Wed, 21 Oct 2020 14:45:50 +0530 Subject: [PATCH 03/12] Update src/guides/v2.4/graphql/mutations/create-requisition-list.md Co-authored-by: Kevin Harper --- src/guides/v2.4/graphql/mutations/create-requisition-list.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 40cb8aaaf0d..20075492a26 100644 --- a/src/guides/v2.4/graphql/mutations/create-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/create-requisition-list.md @@ -31,7 +31,7 @@ The following example creates the `Frequently Ordered Products` requisition list **Request:** -``` graphql +```graphql mutation { createRequisitionList( name: "Frequently Ordered Products", From f2cfc27367d090b7a09034c20778ce844b07bb38 Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Wed, 21 Oct 2020 14:47:30 +0530 Subject: [PATCH 04/12] Update src/guides/v2.4/graphql/mutations/delete-requisition-list.md Co-authored-by: Kevin Harper --- 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 fefae985aff..dcca090578a 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md @@ -58,7 +58,7 @@ The `deleteRequisitionList` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- -`uid` | ID! | The ID of the new requisition list +`uid` | ID! | The ID of the requisition list to delete ## Output attributes From a025c035e2a23f9cea2f29ea37bc60d97d2d1119 Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Wed, 21 Oct 2020 14:47:53 +0530 Subject: [PATCH 05/12] Update src/guides/v2.4/graphql/mutations/delete-requisition-list.md Co-authored-by: Kevin Harper --- 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 dcca090578a..94d3c676e5e 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md @@ -66,7 +66,7 @@ The `deleteRequisitionListOutput` object returns the `uid` of the new requisitio Attribute | Data Type | Description --- | --- | --- -`result` | Boolean | Requisition list deleted or not +`result` | Boolean | Indicates whether the requisition list was deleted ## Related topics From f874a50fed0d3d3970ee2b3ecf56c30ee669a029 Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Wed, 21 Oct 2020 14:48:15 +0530 Subject: [PATCH 06/12] Update src/guides/v2.4/graphql/mutations/delete-requisition-list.md Co-authored-by: Kevin Harper --- 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 94d3c676e5e..dcd010d3cc8 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md @@ -26,7 +26,7 @@ mutation { ## Example usage -The following example deletes the requisition list with uid 4. +The following example deletes the requisition list with `uid` 4. **Request:** From 80d4039cf151c30b94a684971198e908dfebb665 Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Wed, 21 Oct 2020 14:48:44 +0530 Subject: [PATCH 07/12] Update src/guides/v2.4/graphql/mutations/rename-requisition-list.md Co-authored-by: Kevin Harper --- src/guides/v2.4/graphql/mutations/rename-requisition-list.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md b/src/guides/v2.4/graphql/mutations/rename-requisition-list.md index 89acac04281..c155165fcb4 100644 --- a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/rename-requisition-list.md @@ -3,7 +3,7 @@ group: graphql title: renameRequisitionList mutation b2b_only: true --- -The `renameRequisitionList` mutation rename a requisition list of the logged in customer. +The `renameRequisitionList` 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). @@ -86,4 +86,4 @@ Attribute | Data Type | Description ## Related topics * [createRequisitionList mutation]({{page.baseurl}}/graphql/mutations/create-requisition-list.html) -* [deleteRequisitionList mutation]({{page.baseurl}}/graphql/mutations/delete-requisition-list.html) \ No newline at end of file +* [deleteRequisitionList mutation]({{page.baseurl}}/graphql/mutations/delete-requisition-list.html) From e81e8464a99dcacb2296c031657753f305009f61 Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Wed, 21 Oct 2020 14:53:35 +0530 Subject: [PATCH 08/12] Update src/guides/v2.4/graphql/mutations/rename-requisition-list.md Co-authored-by: Kevin Harper --- src/guides/v2.4/graphql/mutations/rename-requisition-list.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md b/src/guides/v2.4/graphql/mutations/rename-requisition-list.md index c155165fcb4..2f81e0b6674 100644 --- a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/rename-requisition-list.md @@ -28,7 +28,7 @@ mutation { ## Example usage -The following example renames the `Frequently Ordered Products` requisition list. +The following example renames the `Frequently Ordered Products` requisition list and updates its description. **Request:** From e60017406bb3fe6b1e751700c500c253c5b6743c Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Wed, 21 Oct 2020 14:54:29 +0530 Subject: [PATCH 09/12] Update src/guides/v2.4/graphql/mutations/rename-requisition-list.md Co-authored-by: Kevin Harper --- src/guides/v2.4/graphql/mutations/rename-requisition-list.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md b/src/guides/v2.4/graphql/mutations/rename-requisition-list.md index 2f81e0b6674..f9a05bb0b6c 100644 --- a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/rename-requisition-list.md @@ -32,7 +32,7 @@ The following example renames the `Frequently Ordered Products` requisition list **Request:** -``` graphql +```graphql mutation { renameRequisitionList( uid: 4 From bbcda0643f1cba60780e2cec89d6f11d3d915ab1 Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Wed, 21 Oct 2020 16:09:05 +0530 Subject: [PATCH 10/12] req list added --- src/_data/toc/graphql.yml | 30 +++++++++---------- src/_includes/graphql/store-config.md | 3 +- .../mutations/create-requisition-list.md | 9 +++--- .../mutations/delete-requisition-list.md | 12 ++++---- .../mutations/rename-requisition-list.md | 18 +++++------ 5 files changed, 36 insertions(+), 36 deletions(-) diff --git a/src/_data/toc/graphql.yml b/src/_data/toc/graphql.yml index 93fd4ea21db..4bf3f8da9dc 100644 --- a/src/_data/toc/graphql.yml +++ b/src/_data/toc/graphql.yml @@ -250,6 +250,11 @@ pages: url: /graphql/mutations/create-product-review.html exclude_versions: ["2.3"] + - label: createRequisitionList mutation + url: /graphql/mutations/create-requisition-list.html + edition: b2b-only + exclude_versions: [ "2.3" ] + - label: createWishlist mutation url: /graphql/mutations/create-wishlist.html edition: ee-only @@ -271,6 +276,11 @@ pages: - 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 @@ -315,6 +325,11 @@ 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"] @@ -400,21 +415,6 @@ pages: edition: ee-only exclude_versions: ["2.3"] - - label: createRequisitionList mutation - url: /graphql/mutations/create-requisition-list.html - edition: b2b-only - exclude_versions: [ "2.3" ] - - - label: renameRequisitionList mutation - url: /graphql/mutations/rename-requisition-list.html - edition: b2b-only - exclude_versions: [ "2.3" ] - - - label: deleteRequisitionList mutation - url: /graphql/mutations/delete-requisition-list.html - edition: b2b-only - exclude_versions: [ "2.3" ] - - label: Interfaces children: - label: Product interface implementations diff --git a/src/_includes/graphql/store-config.md b/src/_includes/graphql/store-config.md index f84a8b6594a..5656f22dcca 100644 --- a/src/_includes/graphql/store-config.md +++ b/src/_includes/graphql/store-config.md @@ -16,6 +16,7 @@ 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` @@ -86,7 +87,7 @@ Attribute | Data Type | Description | Default or example value `title_suffix` | String | A suffix that appears after the title to create a two-or three part title | null `website_id` | Integer | The ID number assigned to the parent website | `1` `weight_unit` | String | The weight unit for products | `lbs`, `kgs`, or similar -`welcome` | String | Text that appears in the header of the page and includes the name of customers who are logged in | Default welcome msg! +`welcome` | String | Text that appears in the header of the page and includes the name of customers who are logged in | Default welcome msg ### SendFriendConfiguration attributes {#SendFriendConfiguration} 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 20075492a26..a9dfa774315 100644 --- a/src/guides/v2.4/graphql/mutations/create-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/create-requisition-list.md @@ -2,6 +2,8 @@ group: graphql title: createRequisitionList mutation b2b_only: true +contributor_name: Zilker Technology +contributor_link: https://www.ztech.io/ --- The `createRequisitionList` mutation creates a requisition list for the logged in customer. @@ -10,8 +12,6 @@ This mutation requires a valid [customer authentication token]({{page.baseurl}}/ {:.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. -* `btob_website_configuration_requisition_list_active` - ## Syntax ```graphql @@ -41,6 +41,7 @@ mutation { uid name description + } } } ``` @@ -67,8 +68,8 @@ The `createRequisitionList` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- -`name` | String! | The name of the customer's requisition list `description`| String | Description of the customer's requisition list +`name` | String! | The name of the customer's requisition list ## Output attributes @@ -76,9 +77,9 @@ The `createRequisitionListOutput` object returns the `uid` of the new requisitio 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 -`description` | String | The requisition list description ## Related topics 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 dcd010d3cc8..f1f2c075b2b 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md @@ -2,15 +2,13 @@ group: graphql title: deleteRequisitionList mutation 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). - {:.bs-callout-info} -Use the [`storeConfig` query]({{page.baseurl}}/graphql/queries/store-config.html) with the following attributes to determine whether requisition lists are supported: - -* `btob_website_configuration_requisition_list_active` +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 @@ -30,10 +28,10 @@ The following example deletes the requisition list with `uid` 4. **Request:** -``` graphql +```graphql mutation { deleteRequisitionList( - uid: 4 + uid: "4" ) { result } diff --git a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md b/src/guides/v2.4/graphql/mutations/rename-requisition-list.md index f9a05bb0b6c..29978365f19 100644 --- a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/rename-requisition-list.md @@ -2,15 +2,13 @@ group: graphql title: renameRequisitionList 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. -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 following attributes to determine whether requisition lists are supported: - -* `btob_website_configuration_requisition_list_active` +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 @@ -35,7 +33,7 @@ The following example renames the `Frequently Ordered Products` requisition list ```graphql mutation { renameRequisitionList( - uid: 4 + uid: "4" name: "Frequently Ordered Essential Products", description: "Frequently ordered essential products list" ) { @@ -43,6 +41,7 @@ mutation { uid name description + } } } ``` @@ -69,9 +68,9 @@ The `renameRequisitionList` mutation requires the following input. Attribute | Data Type | Description --- | --- | --- -`uid` | ID! | The ID of the new requisition list -`name` | String! | The name of the customer's requisition list `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 ## Output attributes @@ -79,9 +78,10 @@ The `renameRequisitionListOutput` object returns the `uid` of the new requisitio 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 -`description` | String | The requisition list description + ## Related topics From 9161a5ea9e1651c58eb62fee8cdd24fef1c8ece6 Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Wed, 21 Oct 2020 16:19:29 +0530 Subject: [PATCH 11/12] req list comments fixed --- src/_includes/graphql/store-config.md | 2 +- src/guides/v2.4/graphql/mutations/delete-requisition-list.md | 3 +-- src/guides/v2.4/graphql/mutations/rename-requisition-list.md | 3 +-- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/src/_includes/graphql/store-config.md b/src/_includes/graphql/store-config.md index 5656f22dcca..854e25a997c 100644 --- a/src/_includes/graphql/store-config.md +++ b/src/_includes/graphql/store-config.md @@ -87,7 +87,7 @@ Attribute | Data Type | Description | Default or example value `title_suffix` | String | A suffix that appears after the title to create a two-or three part title | null `website_id` | Integer | The ID number assigned to the parent website | `1` `weight_unit` | String | The weight unit for products | `lbs`, `kgs`, or similar -`welcome` | String | Text that appears in the header of the page and includes the name of customers who are logged in | Default welcome msg +`welcome` | String | Text that appears in the header of the page and includes the name of customers who are logged in | Default welcome msg! ### SendFriendConfiguration attributes {#SendFriendConfiguration} 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 f1f2c075b2b..f19af8edc63 100644 --- a/src/guides/v2.4/graphql/mutations/delete-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/delete-requisition-list.md @@ -7,8 +7,7 @@ contributor_link: https://www.ztech.io/ --- The `deleteRequisitionList` mutation deletes a requisition list of the logged in customer. -{:.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. +This mutation requires a valid [customer authentication token]({{page.baseurl}}/graphql/mutations/generate-customer-token.html). ## Syntax diff --git a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md b/src/guides/v2.4/graphql/mutations/rename-requisition-list.md index 29978365f19..d019c5e89ea 100644 --- a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/rename-requisition-list.md @@ -7,8 +7,7 @@ contributor_link: https://www.ztech.io/ --- The `renameRequisitionList` mutation updates the name and, optionally, the description of a requisition list. -{:.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. +This mutation requires a valid [customer authentication token]({{page.baseurl}}/graphql/mutations/generate-customer-token.html). ## Syntax From 6a221c66be5cd23b3dc700c8010e796ba3b9b00d Mon Sep 17 00:00:00 2001 From: Kevin Harper Date: Wed, 21 Oct 2020 12:58:27 -0500 Subject: [PATCH 12/12] Fix linting error --- src/guides/v2.4/graphql/mutations/rename-requisition-list.md | 1 - 1 file changed, 1 deletion(-) diff --git a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md b/src/guides/v2.4/graphql/mutations/rename-requisition-list.md index d019c5e89ea..36d5fe9969d 100644 --- a/src/guides/v2.4/graphql/mutations/rename-requisition-list.md +++ b/src/guides/v2.4/graphql/mutations/rename-requisition-list.md @@ -81,7 +81,6 @@ Attribute | Data Type | Description `name` | String! | The requisition list name `uid` | ID! | The ID of the new requisition list - ## Related topics * [createRequisitionList mutation]({{page.baseurl}}/graphql/mutations/create-requisition-list.html)