Skip to main content

Create Box Labels

POST 

/api/amazon/:integrationInstance/draft-inbound-plans/:draft_inbound_plan/shipments/:plan_shipment/labels/box-labels

Generate box (carton) labels for a confirmed shipment via the Amazon Fulfillment Inbound v0 getLabels operation. Requires a shipment confirmation ID — confirm transportation first (422 otherwise). Returns the label document download URL synchronously and records the print in the audit trail.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Fields:

  • page_type (string, required, max 64) — v0 PageType, e.g. PackageLabel_Letter_6, PackageLabel_Thermal, PackageLabel_Plain_Paper
  • label_type (string, optional, max 32, default UNIQUE) — v0 LabelType
  • box_count (integer, optional, nullable, min 1) — number of package labels (v0 NumberOfPackages). Defaults to the number of boxes packed for this shipment when omitted

422 conditions:

  • the shipment has no shipment_confirmation_id yet (transportation not confirmed)
  • Amazon rejects the request or returns no label document (SP-API errors parsed per field)

Returns 404 when the shipment does not belong to the draft inbound plan.

Request

Responses

OK

Response Headers
    Content-Type