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

carrierAccountNumber · string | null

Optional shipper-provided carrier account number. When provided, postage is billed to this account using SENDER billing via EasyPost options.payment, overriding any stored-credential billing for this request. Not persisted in Kibo; masked (last 4) in logs.

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

externalOrderId · string | null

Optional external (non-Kibo) order identifier to print on the label. Mapped into EasyPost PrintCustom reference lines alongside ReferenceNotes and CustomerReferences, within the 3-line carrier capacity.

fulfillmentMethod · string | null

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

hazmatClassification · string | null

Optional hazardous-materials classification (pass-through string). Conveyed to the carrier via EasyPost options.hazmat. The system maintains no hazmat taxonomy; unsupported values are rejected by EasyPost and surfaced as an error. Never inferred or defaulted.

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.

referenceNotes · string | null

Optional freeform reference notes to print on the label. Mapped into EasyPost PrintCustom reference lines alongside ExternalOrderId and CustomerReferences, within the 3-line carrier capacity. Truncated on overflow with a warning.

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

OK

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