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

updateRequisitionList mutation

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

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 {
  updateRequisitionList(
    requisitionListUid: ID!
    name: String!
    description: String
  ) {
    updateRequisitionListOutput
  }
}

Reference

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

Example usage

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

Request:

mutation {
  updateRequisitionList(input:{
    name: "Frequently Ordered Essential Products"
    description: "Frequently ordered essential products list"
  }
    requisitionListUid: "Mw=="
  ) {
    requisition_list {
      uid
      name
      description
    }
  }
}

Response:

{
  "data": {
    "updateRequisitionList": {
      "requisition_list": {
          "uid": "Mw=="
          "name": "Frequently Ordered Essential Products"
          "description": "Frequently ordered essential products list"
        }
    }
  }
}

data-slots=text

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