Step 9. Create a shipment

Order processing tutorial

To create a shipment, you need the order_item_id of each item to be shipped. Since the Sprite Yoga Companion Kit is a bundle item, you only need to include the top-level order_item_id (5). The order_item_id for the Radiant Tee-M-Orange is 3.

To create a partial shipment, specify only those order_item_ids that are to be shipped now.

If the call is successful on a full shipment, Magento changes the status of an order to Complete.

Endpoint:

POST <host>/rest/<store_code>/V1/order/3/ship

where 3 is the order id.

Headers:

Content-Type: application/json

Authorization: Bearer <administrator token>

Payload:

The notify field is used to trigger Magento to send the shipment email. The tracks array optionally allows you to include one or more tracking numbers for the shipment.

Show code sample
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "items": [
    {
      "order_item_id": 3,
      "qty": 1
    },
    {
      "order_item_id": 5,
      "qty": 1
    },
    {
      "order_item_id": 11,
      "qty": 1
    }
  ],
  "notify": true,
  "tracks": [
    {
      "track_number": "1Y-9876543210",
      "title": "United Parcel Service",
      "carrier_code": "ups"
    }
  ]
}

Response:

A shipment ID, such as 3.

Verify this step

Log in to Admin. Click Sales > Shipments. The shipment is displayed in the grid. Then click Sales > Orders. The order status is Complete.