createRequisitionList mutation

The createRequisitionList mutation creates a requisition list for the logged in customer.

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
mutation {
  createRequisitionList(
    name: String!
    description: String
  ) {
    CreateRequisitionListOutput
  }
}

Example usage

The following example creates the Frequently Ordered Products requisition list.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
mutation {
  createRequisitionList(input:{
    name: "Frequently Ordered Products"
    description: "Frequently ordered products list"
  }
  ) {
    requisition_list {
      uid
      name
      description
    }
  }
}

Response:

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

Input attributes

The createRequisitionList mutation requires the following input.

Output attributes

The createRequisitionList mutation returns the new requisition list.

RequisitionList attributes

The RequisitionList object contains the following attributes.

RequistionListItems attributes

The RequistionListItems object contains the following attributes.

Related topics

• updateRequisitionList mutation
• deleteRequisitionList mutation