Skip to main content
POST
/
labels
Create Label
curl --request POST \
  --url https://api.loopreturns.com/api/v1/labels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label_request_id": 123,
  "tracking_number": "<string>",
  "carrier": "<string>",
  "label_url": "<string>",
  "rate": {
    "amount": 123,
    "currency_code": "USD"
  },
  "tracking_url": "<string>",
  "qrcode_url": "<string>"
}
'
{
  "id": "<string>",
  "tracking_number": "<string>",
  "tracking_url": "<string>",
  "carrier": "<string>",
  "label_url": "<string>",
  "qrcode_url": "<string>",
  "rate": {
    "amount": 123,
    "currency_code": "USD"
  },
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
label_request_id
integer
required

The label request id this label applies to.

tracking_number
string
required

The tracking number associated with the label.

Maximum string length: 256
carrier
string
required

The carrier associated with the label.

Maximum string length: 32
label_url
string
required

The URL containing the printable PDF of the labels.

Maximum string length: 2048
rate
object
required
tracking_url
string | null

The tracking URL associated with the label.

Maximum string length: 2048
qrcode_url
string

The QR Code URL containing the printable PDF of the labels.

Maximum string length: 512

Response

OK

id
string

The id of the label you created.

tracking_number
string

The tracking number associated with the label.

tracking_url
string

The tracking URL associated with the label.

carrier
string

The carrier associated with the label.

label_url
string

The URL containing the printable PDF of the labels.

qrcode_url
string

The QR Code URL containing the printable PDF of the labels.

rate
object
status
string

The status of the label.

created_at
string<date-time>

The date the label was created.