Create a Batch of Labels

Create a batch of labels.

Required authorization scopes: public.batch:write, public.label:write

Labels confirm a shipment created with the Shipment API. Calling Batch Labels will confirm shipments with selected courier service and begin generating the label and shipping documents if your account balance is sufficient.

You can enter a courier_service_id to assign a specific courier service in case your shipment has no assigned courier yet, or you need to overwrite the one suggested by default. Your shipment will be confirmed. If there is no assigned courier service and you leave the courier_service_id field blank, we will automatically assign the best value for money courier to your shipment.

Asynchronous response

The label and shipping documents will be generated asynchronously. If you specified a Callback URL through the Easyship dashboard, this URL will be called when the documents are ready. Whilst these documents are being generated, the label_state will be set to pending. The possible states are not_created, pending, failed and generated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Batch Labels Create

shipments
array of objects
required
length between 1 and 1000
shipments*

Shipment

string
required

Readable identifier prefixed with ES (Easyship) and destination country code

uuid

Courier service ID in case you need to overwrite the one suggested by default

Responses

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json