CartonLabelBatch

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

type CartonLabelBatch {
  attachmentQueued: Boolean!
  containerCount: Int!
  fulfillmentId: ID!
  generatedAt: ISO8601DateTime!
  labelPdfBase64: String!
}

Fields

CartonLabelBatch.attachmentQueued ● Boolean! non-null scalar common

Whether filing this batch on the order's documents was queued. Filing is asynchronous and archival, so the document appears shortly after the labels are returned rather than with them.

CartonLabelBatch.containerCount ● Int! non-null scalar common

How many containers were labelled, one page each.

CartonLabelBatch.fulfillmentId ● ID! non-null scalar common

The fulfillment the labels were generated for.

CartonLabelBatch.generatedAt ● ISO8601DateTime! non-null scalar common

When this batch was generated.

CartonLabelBatch.labelPdfBase64 ● String! non-null scalar common

The label PDF, Base64-encoded. Decode to bytes to download or print.

Returned By

generateFulfillmentContainerLabels mutation