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

addProductsToRequisitionList mutation

The addProductsToRequisitionList mutation adds products to 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 {
  addProductsToRequisitionList(
    requisitionListUid: ID!
    requisitionListItems: [RequisitionListItemsInput!]!
  ) {
    AddProductsToRequisitionListOutput
  }
}

Reference

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

Example usage

The following example adds products to a requisition list.

Request:

mutation {
  addProductsToRequisitionList(
      requisitionListUid: "Mg=="
      requisitionListItems: [
        {
            sku: "MS10"
            quantity: 1
            selected_options: ["Y29uZmlndXJhYmxlLzkzLzUw","Y29uZmlndXJhYmxlLzE2MC8xNjg"]
        }
      ]
    ) {
    requisition_list {
      uid
      items {
        items {
          ... on RequisitionListItemInterface {
            uid
            product {
              uid
              sku
              name
            }
            quantity
          }
        }
      }
      items_count
    }
  }
}

Response:

{
  "data": {
    "addProductsToRequisitionList": {
      "requisition_list": {
        "uid": "Mg==",
        "items": {
          "items": [
            {
              "uid": "Mw==",
              "product": {
                "uid": "NTk2",
                "sku": "MS10",
                "name": "Logan  HeatTec® Tee"
              },
              "quantity": 1
            }
          ]
        },
        "items_count": `
      }
    }
  }
}
data-slots=text
data-backgroundcolor=gray
Thanks to EY for contributing this topic!