deleteRequisitionList mutation

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.

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
mutation {
  deleteRequisitionList(
    requisitionListUid: ID!
  ) {
    deleteRequisitionListOutput
  }
}

Example usage

The following example deletes a requisition list.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
mutation {
  deleteRequisitionList(
    requisitionListUid: "Mw=="
  ) {
    status
    requisition_lists {
      total_count
      items {
        uid
        name
      }
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "data": {
    "deleteRequisitionList": {
      "status": true,
      "requisition_lists": {
        "total_count": 1
        "items": [
          {
            "uid": "Mg==",
            "name": "Frequently Ordered Products"
          }
        ]
      }
    }
  }
}

Input attributes

The deleteRequisitionList mutation requires the following input.

Output attributes

The deleteRequisitionList mutation returns the status of the operation and any undeleted requisition lists.

RequisitionLists attributes

The RequisitionLists object contains array of requisition list items and pagination information.

RequisitionList attributes

The RequisitionList object contains the following attributes.

RequistionListItems attributes

The RequistionListItems object contains the following attributes.

Related topics

• createRequisitionList mutation
• updateRequisitionList mutation