Skip to main content
GET
Get a label batch

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Replo-Api-Version
enum<string>
required

The public API version to use for this request.

Available options:
2026-11-17

Path Parameters

shippingLabelBatchId
string<uuid>
required

ID of the batch.

Response

Get a label batch

object
enum<string>
required
Available options:
shipping_label_batch
id
string<uuid>
required
status
enum<string>
required

Labels are bought in the background; poll until done.

Available options:
pending,
purchasing,
completed,
partiallyFailed
labels
object[]
required
failures
object[]
required

Orders that got no label, and why.

createdAt
string
required