shipments

Split a shipment

Changed on

Move items from a shipment into one or more new shipments. Each entry in shipments creates one new shipment holding the items and quantities listed for it. Items and quantities that you don't list stay on the original shipment.

Each new shipment is based on the original shipment and stays linked to the same sales order, so the order source keeps getting shipment notifications after the split.

To split a shipment:

  • It must have a shipment_status of pending, awaiting_payment, or on_hold.
  • It must be linked to a sales order. Check sales_order_ids on the shipment.
  • It can't come from a marketplace that supplies its own shipping labels.
  • All of the items you move must belong to the same sales order. To move items from more than one sales order, make one request for each sales order.
  • At least one item must stay on the original shipment.

Get the item_id values from the items array of the shipment, using Get shipment by id.

post/v1/shipments/{shipment_id}/split

Request

  • Base URL: https://api.shipengine.com
  • URL: https://api.shipengine.com/v1/shipments/{shipment_id}/split
  • Auth: API key in header API-Key

Request body

Example request

{
  "shipments": [
    {
      "items": [
        {
          "item_id": "1402291169813",
          "quantity": 1
        }
      ]
    }
  ]
}

Response

The shipment was split.

shipment_idstring

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

new_shipment_idsSeId[]

The new shipments, in the same order as the shipments array in the request

Example response

{
  "shipment_id": "se-28529731",
  "new_shipment_ids": [
    "se-202902301"
  ]
}

Changes