🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

Remove from Batch

Should you need to remove any shipment_ids or rate_ids from a batch before processing the batch, you can do so.

If you are new to batches in ShipStation API, be sure to read the Label Batches overview first.

Requirements

The batch_id of the batch with the shipment you want to remove.
The shipment_ids and/or rate_ids you wish to remove from the batch.

Example Request

POST /v1/batches/:batch_id/remove

1
2
3
4
5
6
7
8
9
10
11
POST /v1/batches/se-1010644/remove HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
  "shipment_ids": [
    "se-2102769"
  ],
  "rate_ids": []
}

If successful, ShipStation API will respond with HTTP Status 204, (No Content).