POST
/
labels
curl --request POST \
  --url https://api.loopreturns.com/api/v1/labels \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '{
  "label_request_id": "67329889100573",
  "tracking_number": "9400136105440512280610",
  "carrier": "usps",
  "label_url": "https://s3.amazonaws.com/example-bucket/label.pdf",
  "qrcode_url": "https://s3.amazonaws.com/example-bucket/qrcode.pdf",
  "rate": {
    "amount": 50000,
    "currency_code": "USD"
  }
}'
{
  "id": "67329889100573",
  "tracking_number": "9400136105440512280610",
  "carrier": "usps",
  "label_url": "https://s3.amazonaws.com/example-bucket/label.pdf",
  "qrcode_url": "https://s3.amazonaws.com/example-bucket/qrcode.pdf",
  "rate": {
    "amount": 50000,
    "currency_code": "USD"
  },
  "status": "new",
  "created_at": "2023-04-25T13:25:00-05:00"
}

Authorizations

​
X-Authorization
string
header
required

API Scope: "Developer Tools"

Body

application/json
​
label_request_id
string
required

The label request id this label applies to.

Example:

"67329889100573"

​
tracking_number
string
required

The tracking number associated with the label.

Maximum length: 256
Example:

"9400136105440512280610"

​
carrier
string
required

The carrier associated with the label.

Maximum length: 32
Example:

"usps"

​
label_url
string
required

The URL containing the printable PDF of the labels.

Maximum length: 2048
Example:

"https://s3.amazonaws.com/example-bucket/label.pdf"

​
rate
object
required
Example:
{ "amount": 50000, "currency_code": "USD" }
​
qrcode_url
string

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

Maximum length: 512
Example:

"https://s3.amazonaws.com/example-bucket/qrcode.pdf"

Response

200
application/json
OK
​
id
string

The id of the Label you created.

Example:

"67329889100573"

​
tracking_number
string

The tracking number associated with the label.

Example:

"9400136105440512280610"

​
carrier
string

The carrier associated with the label.

Example:

"usps"

​
label_url
string

The URL containing the printable PDF of the labels.

Example:

"https://s3.amazonaws.com/example-bucket/label.pdf"

​
qrcode_url
string

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

Example:

"https://s3.amazonaws.com/example-bucket/qrcode.pdf"

​
rate
object
Example:
{ "amount": 50000, "currency_code": "USD" }
​
status
string

The status of the label.

Example:

"new"

​
created_at
string

The date the label was created.

Example:

"2023-04-25T13:25:00-05:00"

Create a label request errorUpdate Label Status