Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 95d845b

Browse files
dineshvbkeharper
andauthored
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 <[email protected]>
1 parent 56f0035 commit 95d845b

File tree

5 files changed

+67
-45
lines changed

5 files changed

+67
-45
lines changed

src/_data/toc/graphql.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -382,11 +382,6 @@ pages:
382382
url: /graphql/mutations/remove-store-credit.html
383383
edition: ee-only
384384

385-
- label: renameRequisitionList mutation
386-
url: /graphql/mutations/rename-requisition-list.html
387-
edition: b2b-only
388-
exclude_versions: [ "2.3" ]
389-
390385
- label: reorderItems mutation
391386
url: /graphql/mutations/reorder-items.html
392387
exclude_versions: ["2.3"]
@@ -477,6 +472,11 @@ pages:
477472
url: /graphql/mutations/update-products-in-wishlist.html
478473
exclude_versions: ["2.3"]
479474

475+
- label: updateRequisitionList mutation
476+
url: /graphql/mutations/update-requisition-list.html
477+
edition: b2b-only
478+
exclude_versions: [ "2.3" ]
479+
480480
- label: updateRequisitionListItems mutation
481481
url: /graphql/mutations/update-requisition-list-items.html
482482
exclude_versions: [ "2.3" ]

src/guides/v2.4/graphql/mutations/create-requisition-list.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,12 @@ The following example creates the `Frequently Ordered Products` requisition list
3333

3434
```graphql
3535
mutation {
36-
createRequisitionList(
37-
name: "Frequently Ordered Products",
36+
createRequisitionList(input:{
37+
name: "Frequently Ordered Products"
3838
description: "Frequently ordered products list"
39+
}
3940
) {
40-
list {
41+
requisition_list {
4142
uid
4243
name
4344
description
@@ -52,9 +53,9 @@ mutation {
5253
{
5354
"data": {
5455
"createRequisitionList": {
55-
"list": {
56-
"uid": "4",
57-
"name": "Frequently Ordered Products",
56+
"requisition_list": {
57+
"uid": "Mw=="
58+
"name": "Frequently Ordered Products"
5859
"description": "Frequently ordered products list"
5960
}
6061
}
@@ -73,15 +74,17 @@ Attribute | Data Type | Description
7374

7475
## Output attributes
7576

76-
The `createRequisitionListOutput` object returns the `uid` of the new requisition list as well as the input attributes.
77+
The `createRequisitionList` mutation returns the new requisition list.
7778

7879
Attribute | Data Type | Description
7980
--- | --- | ---
80-
`description` | String | The requisition list description
81-
`name` | String! | The requisition list name
82-
`uid` | ID! | The ID of the new requisition list
81+
`requisition_list` | [[RequisitionList](#RequisitionList)] | The created requisition list
82+
83+
### RequisitionList attributes {#RequisitionList}
84+
85+
{% include graphql/requisition-list.md %}
8386

8487
## Related topics
8588

86-
* [renameRequisitionList mutation]({{page.baseurl}}/graphql/mutations/rename-requisition-list.html)
89+
* [updateRequisitionList mutation]({{page.baseurl}}/graphql/mutations/update-requisition-list.html)
8790
* [deleteRequisitionList mutation]({{page.baseurl}}/graphql/mutations/delete-requisition-list.html)

src/guides/v2.4/graphql/mutations/delete-requisition-list-items.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,5 +77,5 @@ Attribute | Data Type | Description
7777

7878
## Related topics
7979

80-
* [renameRequisitionList mutation]({{page.baseurl}}/graphql/mutations/rename-requisition-list.html)
80+
* [updateRequisitionList mutation]({{page.baseurl}}/graphql/mutations/update-requisition-list.html)
8181
* [deleteRequisitionList mutation]({{page.baseurl}}/graphql/mutations/delete-requisition-list.html)

src/guides/v2.4/graphql/mutations/delete-requisition-list.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ b2b_only: true
55
contributor_name: Zilker Technology
66
contributor_link: https://www.ztech.io/
77
---
8+
89
The `deleteRequisitionList` mutation deletes a requisition list of the logged in customer.
910

1011
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}}/
1415
```graphql
1516
mutation {
1617
deleteRequisitionList(
17-
uid: ID!
18+
requisitionListUid: ID!
1819
) {
1920
deleteRequisitionListOutput
2021
}
@@ -23,16 +24,21 @@ mutation {
2324

2425
## Example usage
2526

26-
The following example deletes the requisition list with `uid` 4.
27+
The following example deletes a requisition list.
2728

2829
**Request:**
2930

3031
```graphql
3132
mutation {
3233
deleteRequisitionList(
33-
uid: "4"
34+
requisitionListUid: "Mw=="
3435
) {
35-
result
36+
status
37+
requisition_list {
38+
uid
39+
name
40+
description
41+
}
3642
}
3743
}
3844
```
@@ -43,7 +49,12 @@ mutation {
4349
{
4450
"data": {
4551
"deleteRequisitionList": {
46-
"result": true
52+
"status": true,
53+
"requisition_list": {
54+
"uid": "Mw=="
55+
"name": "Frequently Ordered Products"
56+
"description": "Frequently ordered products list"
57+
}
4758
}
4859
}
4960
}
@@ -55,17 +66,22 @@ The `deleteRequisitionList` mutation requires the following input.
5566

5667
Attribute | Data Type | Description
5768
--- | --- | ---
58-
`uid` | ID! | The ID of the requisition list to delete
69+
`requisitionListUid` | ID! | The ID of the requisition list to delete
5970

6071
## Output attributes
6172

62-
The `deleteRequisitionListOutput` object returns the `uid` of the new requisition list as well as the input attributes.
73+
The `deleteRequisitionList` mutation returns the status of the operation, and the requisition list, if it was successfully deleted.
6374

6475
Attribute | Data Type | Description
6576
--- | --- | ---
66-
`result` | Boolean | Indicates whether the requisition list was deleted
77+
`requisition_list` | [[RequisitionList](#RequisitionList)] | Details about the deleted requisition list
78+
`status` | Boolean | Indicates whether the request to delete the requisition list was successful
79+
80+
### RequisitionList attributes {#RequisitionList}
81+
82+
{% include graphql/requisition-list.md %}
6783

6884
## Related topics
6985

7086
* [createRequisitionList mutation]({{page.baseurl}}/graphql/mutations/create-requisition-list.html)
71-
* [renameRequisitionList mutation]({{page.baseurl}}/graphql/mutations/rename-requisition-list.html)
87+
* [updateRequisitionList mutation]({{page.baseurl}}/graphql/mutations/update-requisition-list.html)

src/guides/v2.4/graphql/mutations/rename-requisition-list.md renamed to src/guides/v2.4/graphql/mutations/update-requisition-list.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
---
22
group: graphql
3-
title: renameRequisitionList mutation
3+
title: updateRequisitionList mutation
44
b2b_only: true
55
contributor_name: Zilker Technology
66
contributor_link: https://www.ztech.io/
77
---
8-
The `renameRequisitionList` mutation updates the name and, optionally, the description of a requisition list.
8+
The `updateRequisitionList` mutation updates the name and, optionally, the description of a requisition list.
99

1010
This mutation requires a valid [customer authentication token]({{page.baseurl}}/graphql/mutations/generate-customer-token.html).
1111

1212
## Syntax
1313

1414
```graphql
1515
mutation {
16-
renameRequisitionList(
17-
uid: ID!
16+
updateRequisitionList(
17+
requisitionListUid: ID!
1818
name: String!
1919
description: String
2020
) {
21-
renameRequisitionListOutput
21+
updateRequisitionListOutput
2222
}
2323
}
2424
```
@@ -31,12 +31,13 @@ The following example renames the `Frequently Ordered Products` requisition list
3131

3232
```graphql
3333
mutation {
34-
renameRequisitionList(
35-
uid: "4"
36-
name: "Frequently Ordered Essential Products",
34+
updateRequisitionList(input:{
35+
name: "Frequently Ordered Essential Products"
3736
description: "Frequently ordered essential products list"
37+
}
38+
requisitionListUid: "Mw=="
3839
) {
39-
list {
40+
requisition_list {
4041
uid
4142
name
4243
description
@@ -50,10 +51,10 @@ mutation {
5051
```json
5152
{
5253
"data": {
53-
"renameRequisitionList": {
54-
"list": {
55-
"uid": "4",
56-
"name": "Frequently Ordered Essential Products",
54+
"updateRequisitionList": {
55+
"requisition_list": {
56+
"uid": "Mw=="
57+
"name": "Frequently Ordered Essential Products"
5758
"description": "Frequently ordered essential products list"
5859
}
5960
}
@@ -63,23 +64,25 @@ mutation {
6364

6465
## Input attributes
6566

66-
The `renameRequisitionList` mutation requires the following input.
67+
The `updateRequisitionList` mutation requires the following input.
6768

6869
Attribute | Data Type | Description
6970
--- | --- | ---
7071
`description`| String | Description of the customer's requisition list
7172
`name` | String! | The name of the customer's requisition list
72-
`uid` | ID! | The ID of the new requisition list
73+
`requisitionListUid` | ID! | The ID of the new requisition list
7374

7475
## Output attributes
7576

76-
The `renameRequisitionListOutput` object returns the `uid` of the new requisition list as well as the input attributes.
77+
The `updateRequisitionList` mutation returns the new requisition list after updating a list.
7778

7879
Attribute | Data Type | Description
7980
--- | --- | ---
80-
`description` | String | The requisition list description
81-
`name` | String! | The requisition list name
82-
`uid` | ID! | The ID of the new requisition list
81+
`requisition_list` | [[RequisitionList](#RequisitionList)] | The updated requisition list
82+
83+
### RequisitionList attributes {#RequisitionList}
84+
85+
{% include graphql/requisition-list.md %}
8386

8487
## Related topics
8588

0 commit comments

Comments
 (0)