addRequisitionListItemsToCart mutation
Magento Commerce for B2B only
The addRequisitionListItemsToCart
mutation adds requisition list items to the cart. The requisition list does not change after adding items to the cart.
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 {
addRequisitionListItemsToCart (
requisitionListUid: ID
requisitionListItemUids: [ID!]
) {
AddRequisitionListItemsToCartOutput
}
}
Example usage
The following example adds items to the cart.
Request:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
mutation {
addRequisitionListItemsToCart (
requisitionListUid: "Mg=="
requisitionListItemUids:
["Mw==", "Ng==", "Nw=="]
)
{
status
cart {
items {
uid
product {
uid
sku
name
}
}
}
}
}
Response:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
"data": {
"addRequisitionListItemsToCart": {
"status": true,
"cart": {
"items": [
{
"uid": "NQ==",
"product": {
"uid": "NTk2",
"sku": "MS10",
"name": "Logan HeatTec® Tee"
}
},
{
"uid": "Nw==",
"product": {
"uid": "MTI=",
"sku": "24-WB03",
"name": "Driven Backpack"
}
},
{
"uid": "OA==",
"product": {
"uid": "Mg==",
"sku": "24-MB04",
"name": "Strive Shoulder Pack"
}
}
]
}
}
}
}
Input attributes
The addRequisitionListItemsToCart
mutation requires the following input.
Attribute | Data Type | Description |
---|---|---|
requisitionListItemUids |
[ID!] | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart |
requisitionListUid |
ID! | The unique ID of the requisition list |
Output attributes
The addRequisitionListItemsToCart
object returns the status, cart and errors object.
Attribute | Data Type | Description |
---|---|---|
add_requisition_list_items_to_cart_user_errors |
[AddRequisitionListItemToCartUserError!] | Indicates why the attempt to add items to the requisition list was not successful |
cart |
Cart | The cart after adding requisition list items |
status |
Boolean! | Indicates whether the attempt to add items to the requisition list was successful |
AddRequisitionListItemToCartUserError attributes
The AddRequisitionListItemToCartUserError
type contains the list of errors that describe why the attempt to add items to the requistion list was not successful.
Attribute | Data Type | Description |
---|---|---|
message |
String! | A description of the error |
type |
AddRequisitionListItemToCartUserErrorType! | The error type |
AddRequisitionListItemToCartUserErrorType
The AddRequisitionListItemToCartUserErrorType object can be one of the following values.
Type | Description |
---|---|
LOW_QUANTITY |
The quantity of one of the items is low |
OPTIONS_UPDATED |
The options have been updated |
OUT_OF_STOCK |
One of the items is out of stock |
UNAVAILABLE_SKU |
One of the items is unavailable |
Cart object
The Cart
object can contain the following attributes.
Attribute | Data Type | Description |
---|---|---|
applied_coupon |
AppliedCoupon |
Deprecated. Use applied_coupons instead |
applied_coupons |
[AppliedCoupon ] |
An array of AppliedCoupon objects. Each object contains the code text attribute, which specifies the coupon code |
applied_gift_cards |
[AppliedGiftCard ] |
An array of AppliedGiftCard objects. An AppliedGiftCard object contains the code text attribute, which specifies the gift card code. applied_gift_cards is a Commerce-only attribute, defined in the GiftCardAccountGraphQl module |
applied_reward_points |
RewardPointsAmount |
The amount of reward points applied to the cart |
applied_store_credit |
AppliedStoreCredit |
Contains store credit information applied to the cart. applied_store_credit is a Commerce-only attribute, defined in the CustomerBalanceGraphQl module |
available_gift_wrappings |
[GiftWrapping]! | The list of available gift wrapping options for the cart |
available_payment_methods |
[AvailablePaymentMethod] | Available payment methods |
billing_address |
BillingCartAddress | Contains the billing address specified in the customer’s cart |
email |
String | The customer’s email address |
gift_message |
GiftMessage | A gift message added to the cart |
gift_receipt_included |
Boolean! | Indicates if the customer requested a gift receipt for the cart |
gift_wrapping |
GiftWrapping | The selected gift wrapping for the cart |
id |
ID! | The unique ID of the cart |
is_virtual |
Boolean! | Indicates whether the cart contains only virtual products |
items |
[CartItemInterface] | Contains the items in the customer’s cart |
prices |
CartPrices | Contains subtotals and totals |
printed_card_included |
Boolean! | Indicates if the customer requested a printed card for the cart |
selected_payment_method |
SelectedPaymentMethod | Selected payment method |
shipping_addresses |
[ShippingCartAddress]! | Contains one or more shipping addresses |
total_quantity |
Float! | Total Quantity of products in the cart |