Add To A Batch

tip

Requirements

Please make sure you read the Using Batches documentation first.

Using batches requires an understanding of creating a shipment, getting shipping rates, and a basic understanding of carrier services.

Batches must be shipped from the same warehouse.

When you add to a batch you must be explicit with what you want.

  1. Be explicit when you create a shipment, and specify your carrier_id and service_code.
  2. Be explicit with rates when you add to a batch request by providing the rate_id you received when getting rates.

Example

POST /v1/batches/:batch_id/add

curl -iX POST https://api.shipengine.com/v1/batches/se-1010644/add \
-H 'Content-Type: application/json' \
-H 'API-Key: __YOUR_API_KEY_HERE__' \
-d '
{
  "shipment_ids": [
    "se-2102769"
  ],
  "rate_ids": []
}'

If successful, responds with HTTP Status 204, No Content.