updateRequisitionList mutation

The updateRequisitionList mutation updates the name and, optionally, the description of a requisition list.

This mutation requires a valid customer authentication token.

Use the storeConfig query with the is_requisition_list_active attribute to determine whether requisition lists are enabled.

Syntax

1
2
3
4
5
6
7
8
9
mutation {
  updateRequisitionList(
    requisitionListUid: ID!
    name: String!
    description: String
  ) {
    updateRequisitionListOutput
  }
}

Example usage

The following example renames the Frequently Ordered Products requisition list and updates its description.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
mutation {
  updateRequisitionList(input:{
    name: "Frequently Ordered Essential Products"
    description: "Frequently ordered essential products list"
  }
    requisitionListUid: "Mw=="
  ) {
    requisition_list {
      uid
      name
      description
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
{
  "data": {
    "updateRequisitionList": {
      "requisition_list": {
          "uid": "Mw=="
          "name": "Frequently Ordered Essential Products"
          "description": "Frequently ordered essential products list"
        }
    }
  }
}

Input attributes

The updateRequisitionList mutation requires the following input.

Output attributes

The updateRequisitionList mutation returns the new requisition list after updating a list.

RequisitionList attributes

The RequisitionList object contains the following attributes.

RequistionListItems attributes

The RequistionListItems object contains the following attributes.

Related topics

• createRequisitionList mutation
• deleteRequisitionList mutation