Get Labels

Get Shipping Label for the Service Type Requested

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

Error

A valid request URL is required to generate request examples

200

{
  "customAttributes": [
    {
      "childAttributes": "<array>",
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "isSuccessful": true,
  "messages": [
    {
      "code": "<string>",
      "message": "<string>",
      "source": "<string>"
    }
  ],
  "packageResponses": [
    {
      "customAttributes": [
        {
          "childAttributes": "<array>",
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "id": "<string>",
      "integratorId": "<string>",
      "label": {
        "imageData": "aSDinaTvuI8gbWludGxpZnk=",
        "imageFormat": "<string>",
        "labelUrl": "<string>"
      },
      "trackingNumber": "<string>"
    }
  ],
  "shippingTotal": {
    "currencyCode": "<string>",
    "value": 123
  },
  "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

consolidationReferences · object[] | null

Consolidation references for Order Number, Shipment Number and Order Id

Show child attributes

customAttributes · object[] | null

Carrier specific options

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

Show child attributes

customerReferences · object[] | null

Show child attributes

fulfillmentMethod · string | null

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

isoCurrencyCode · string | null

labelFormat · string | null

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

relatedOrderId · string | null

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

relatedOrderNumber · integer<int32> | null

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

relatedShipmentNumber · integer<int32> | null

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

shipment · object

Show child attributes

shipmentRequestType · string | null

Selected Shipment Request Type.

shippingServiceType · string | null

Selected Shipping Service 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.

Response

200

application/json

Success

customAttributes · object[] | null

Show child attributes

isSuccessful · boolean

messages · object[] | null

Show child attributes

packageResponses · object[] | null

Show child attributes

shippingTotal · object

Show child attributes

trackingNumber · string | null