Retrieve Multiple Shipping Labels
Use this endpoint to retrieve a PDF of multiple shipping labels after booking multiple shipments.
REST Endpoint
POST /restapi/v1/customers/:customerId/shipments/multiple/labels/:labelImageFormat
Response Status Code
200 OK
Response Content Type
The reponse content type will depend on the labelImageFormat
that was used when the shipment was booked.
If labelImageFormat
was PDF
(or null), the response content type will be application/pdf
.
If labelImageFormat
was EPL2
, the response content type will be application/json
.
If labelImageFormat
was ZPL
, the response content type will be application/json
.
Response JSON Example (EPL2)
{
"labelImageFormat": "EPL2",
"base64Images": [
"....base64 encoded content....",
"....base64 encoded content...."
]
}
Explanation of Response Fields
Field | Type | Description |
---|---|---|
bookNumbers | array | IDs for the requested shipments |