Get Labels By Tracking Number

Get shipping labels by tracking number.

POST /commerce/catalog/storefront/shipping/get-labels

Error

A valid request URL is required to generate request examples

200

{
  "packageLabels": [
    {
      "label": {
        "imageData": "aSDinaTvuI8gbWludGxpZnk=",
        "imageFormat": "<string>",
        "labelUrl": "<string>"
      },
      "trackingNumber": "<string>"
    }
  ],
  "trackingNumber": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/json

carrierId · string | null

labelFormat · string | null

packageTrackingNumber · string | null

trackingNumber · string | null

Response

200

application/json

OK

packageLabels · object[] | null

Show child attributes

trackingNumber · string | null