Skip to main content
POST
/
commerce
/
catalog
/
storefront
/
shipping
/
request-labels
Error
A valid request URL is required to generate request examples
{
  "shippingTotal": {
    "currencyCode": "<string>",
    "value": 123
  },
  "trackingNumber": "<string>",
  "packageResponses": [
    {
      "id": "<string>",
      "trackingNumber": "<string>",
      "label": {
        "imageFormat": "<string>",
        "imageData": "aSDinaTvuI8gbWludGxpZnk=",
        "labelUrl": "<string>"
      },
      "customAttributes": [
        {
          "childAttributes": "<array>",
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "integratorId": "<string>"
    }
  ],
  "customAttributes": [
    {
      "childAttributes": "<array>",
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "messages": [
    {
      "source": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ],
  "isSuccessful": true
}

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
isoCurrencyCode
string | null
shipment
object
customAttributes
object[] | null

Carrier specific options

Ex: RequiresDeliveryConfirmation when using usps with non-express mail service type.

carrierId
string | null
shippingServiceType
string | null

Selected Shipping Service Type.

shipmentRequestType
string | null

Selected Shipment Request Type.

signatureOption
string | null

Specify an optional signature option for this shipment. All packages will inherit this option value automatically. Set this option on the package level to override this value.

labelFormat
string | null

Returns the Label in the requested format. Specify either "LASER" or "THERMAL" format. Actual supported image formats vary by carrier.

customerReferences
object[] | null

The related Order ID for this shipment request. Informational only.

The related Order Number for this shipment request. Informational only.

The related Shipment Number for this shipment request. Informational only.

consolidationReferences
object[] | null

Consolidation references for Order Number, Shipment Number and Order Id

fulfillmentMethod
string | null

Fulfillment method for the shipment. STH / Delivery. Empty will be assumed as STH.

Response

Success

shippingTotal
object
trackingNumber
string | null
packageResponses
object[] | null
customAttributes
object[] | null
messages
object[] | null
isSuccessful
boolean