batches

Add to a batch

Add a shipment or rate to a batch.

post/v2/batches/{batch_id}/add

Request

  • Base URL: https://api.shipstation.com
  • URL: https://api.shipstation.com/v2/batches/{batch_id}/add
  • Auth: API key in header api-key

Request body

external_batch_idstring

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

batch_notesstring

Add custom messages for a particular batch

shipment_idsSeId[]

Array of shipment IDs used in the batch

rate_idsSeId[]

Array of rate IDs used in the batch

Example request

{
  "external_batch_id": "se-28529731",
  "batch_notes": "This is my batch",
  "shipment_ids": [
    "se-28529731"
  ],
  "rate_ids": [
    "se-28529731"
  ],
  "process_labels": {
    "create_batch_and_process_labels": true,
    "ship_date": "2018-09-23T15:00:00.000Z"
  }
}

Response

The request was successful.

string required

Changes

No recorded changes to this operation across all 1 revision of this API.