data-src=../../../../../includes/commerce-only.md

deleteRequisitionList mutation

The deleteRequisitionList mutation deletes a requisition list of the logged in customer. The response can include any remaining requisition lists.

data-variant=info

data-slots=text
Use the storeConfig query with the is_requisition_list_active attribute to determine whether requisition lists are enabled.

This mutation requires a valid customer authentication token.

Syntax

mutation {
  deleteRequisitionList(
    requisitionListUid: ID!
  ) {
    deleteRequisitionListOutput
  }
}

Reference

The deleteRequisitionList reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following example deletes a requisition list.

Request:

mutation {
  deleteRequisitionList(
    requisitionListUid: "Mw=="
  ) {
    status
    requisition_lists {
      total_count
      items {
        uid
        name
      }
    }
  }
}

Response:

{
  "data": {
    "deleteRequisitionList": {
      "status": true,
      "requisition_lists": {
        "total_count": 1
        "items": [
          {
            "uid": "Mg==",
            "name": "Frequently Ordered Products"
          }
        ]
      }
    }
  }
}

data-slots=text

data-backgroundcolor=gray
Thanks to Zilker Technology for contributing this topic!