Sign in

v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB
Label Requests

Create Label

Create a label for a label request.

Required API key scopes

  • Labels (Write)
post/labels

Request body

OR

Example request

{
  "label_request_id": 67329889100573,
  "tracking_number": "9400136105440512280610",
  "tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?strOrigTrackNum=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": 25000,
    "currency_code": "EUR"
  }
}

Response

Created

idinteger required

The id of the label you created.

tracking_numberstring required

The tracking number associated with the label.

tracking_urlstring nullable

The tracking URL associated with the label.

carrierstring required

The carrier associated with the label.

label_urlstring nullable

The URL containing the printable PDF of the labels.

qrcode_urlstring nullable

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

status'queueable' | 'queued' | 'queued_for_purchase' | 'purchase_failed' | 'new' | 'pre_transit' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'available_for_pickup' | 'cancelled' | 'unknown' | 'return_to_sender' | 'failure' | 'error' | 'refund_requested' required

The current status of the label.

created_atstring date-time required

Example response

{
  "id": 67329889100573,
  "tracking_number": "9400136105440512280610",
  "tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?strOrigTrackNum=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": 25000,
    "currency_code": "EUR"
  },
  "status": "new",
  "created_at": "2023-04-25T13:25:00-05:00"
}