reorderItems mutation

The reorderItems mutation allows a logged-in user to add all the products from a previous order into their cart. The Stores > Settings > Sales > Sales > Reorder > Allow Reorder field must be set to Yes to enable reorders. You must provide a customer authorization token with the call.

The mutation returns an error if it cannot add a product to the customer’s cart:

The reorderItems mutation will not add any products to the cart if it encounters the REORDER_NOT_AVAILABLE error. For any other error code, the mutation will add the product to the cart, if possible, and it will continue adding other products, if applicable.

Syntax

mutation: {reorderItems(orderNumber: String!) {ReorderItemsOutput}}

Example usage

In the following example, the customer previously created an order containing the following items:

The customer wants to reorder these items, but the status of some of these items has changed:

• Aeon Capri (WP07-29-Black) is in stock, but fewer than three items are available for sale.
• The Sprite Foam Yoga Brick (24-WG084) is out of stock.

These items will not be added to the cart.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
mutation{
  reorderItems(orderNumber: "000000003"){
    cart {
      id
      items {
        id
        product {
          sku
        }
        quantity
        prices {
          price {
            value
          }
        }
      }
    }
    userInputErrors{
      code
      message
      path
    }
  }
}

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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
{
  "data": {
    "reorderItems": {
      "cart": {
        "id": "LrMHhWHUaOqiBGC6S0KOcnYKsINUHTWz",
        "items": [
          {
            "id": "44",
            "product": {
              "sku": "24-UG07"
            },
            "quantity": 1,
            "prices": {
              "price": {
                "value": 12
              }
            }
          },
          {
            "id": "45",
            "product": {
              "sku": "WS06"
            },
            "quantity": 1,
            "prices": {
              "price": {
                "value": 29
              }
            }
          }
        ]
      },
      "userInputErrors": [
        {
          "code": "NOT_SALABLE",
          "message": "Could not add the product with SKU \"24-WG084\" to the shopping cart: Product that you are trying to add is not available.",
          "path": [
            "orderNumber"
          ]
        },
        {
          "code": "INSUFFICIENT_STOCK",
          "message": "Could not add the product with SKU \"WP07-29-Black\" to the shopping cart: The requested qty is not available",
          "path": [
            "orderNumber"
          ]
        }
      ]
    }
  }
}

Input attributes

The reorderItems mutation requires a valid order number. The customer associated with the authorization token must match the customer who placed the specified order.

Output attributes

The ReorderItemsOutput object contains the following objects:

Cart object

Cart query output provides more information about the Cart object.

userInputErrors object

The userInputErrors object contains an array of errors encountered while attempting to reorder products.

CheckoutUserInputError object

Related topics

• customer query