Skip to main content

generateFulfillmentContainerLabels

Generates retailer-compliant GS1 carton labels for every container on the fulfillment by rendering the sales channel's Orderful label mapping once per container and sending the batch to Orderful. Returns a single PDF holding one page per container and records that labels were generated.

Business Rules​

  • One label per container, ordered by creation, so the printed carton number matches the container order shown in the app.
  • Archived containers are excluded.
  • Every container must carry an SSCC of 18 digits with a valid GS1 check digit; the retailer barcode is that SSCC prefixed with application identifier 00.

Error Scenarios​

  • The order's sales channel has no carton label mapping configured.
  • The order's integration has no Orderful API token.
  • The fulfillment has no containers, or a container has no SSCC.
  • Orderful rejects the label data; the failing field paths are returned.

Permissions Required​

  • orders:update_fulfillment_additional_data permission
generateFulfillmentContainerLabels(
  input: GenerateFulfillmentContainerLabelsInput!
): CartonLabelBatch!

Arguments​

generateFulfillmentContainerLabels.input ● GenerateFulfillmentContainerLabelsInput! non-null input common​

Parameters for GenerateFulfillmentContainerLabels

Type​

CartonLabelBatch object shipments​

A generated batch of retailer carton labels: one PDF holding one page per container.