updateRequisitionList mutation

Magento Commerce for B2B only

The content on this page is for Magento Commerce for B2B only. Learn more

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.

Attribute Data Type Description
description String Description of the customer’s requisition list
name String! The name of the customer’s requisition list
requisitionListUid ID! The ID of the new requisition list

Output attributes

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

Attribute Data Type Description
requisition_list [RequisitionList] The updated requisition list

RequisitionList attributes

The RequisitionList object contains the following attributes.

Attribute Data Type Description
description String Optional text that describes the requisition list
items RequistionListItems An array of products added to the requisition list
items_count Int! The number of items in the list
name String! The requisition list name
uid ID! The unique requisition list ID
updated_at String The time of the last modification of the requisition list

RequistionListItems attributes

The RequistionListItems object contains the following attributes.

Attribute Data Type Description
items [RequisitionListItemInterface]! An array of items in the requisition list
page_info SearchResultPageInfo Contains pagination metadata
total_pages Int! The number of pages returned