Process a Batch

Batch creating labels, requires that you have created a batch and added labels or rates to a batch.

Setting Up Web Hooks will also improve the experience while using batches, since a web hook will be called when a batch is completed.

Depending on how many labels you need to create, you can save a lot of time by using batch label creation. Additionally, you can create multiple batches and request that they be processed at a later time.

Example

POST /v1/batches/:batch_id/process/labels

Copy

HTTPcURLJavaScriptNodeJSPHPPythonRubyC#JavaGoSwiftObjective-CPowerShell

1
2
3
4
5
6
7
8
9
10
POST /v1/batches/se-1010644/process/labels HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
  "ship_date": "2019-07-25T05:00:00.000Z",
  "label_layout": "4x6",
  "label_format": "pdf"
}

If successful, responds with HTTP Status 204, No Content. Otherwise, you will receive a message back from the server with the error.