Skip to main content
POST
Buy a shipping label

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

orderId
string<uuid>
required

Order to quote a label for.

Body

application/json
shipmentId
string
required

The shipmentId the label rates call returned.

Required string length: 1 - 255
rateId
string
required

A rate id from the same label rates call. The same id returns the same label.

Required string length: 1 - 255
items
object[] | null

Items in this package; send the same items you asked rates for. Omit for everything not yet shipped.

Minimum array length: 1

Response

Buy a shipping label

object
enum<string>
required
Available options:
shipping_label
id
string<uuid>
required
orderId
string<uuid>
required
fulfillmentId
string<uuid> | null
required

The package this label ships; null for a return label.

direction
enum<string>
required
Available options:
outbound,
return
carrier
string
required
service
string
required
amount
integer
required

Postage paid, in minor units.

currencyCode
string
required
trackingNumber
string | null
required
status
enum<string>
required
Available options:
purchased,
voidRequested,
voided,
voidRejected
labelUrl
string | null
required

A short-lived signed link to the label PDF.

createdAt
string
required