ShipmentApi

Commit Shipments

Commits the specified shipments and returns their labels.Committed shipments are marked as ready for processing and dispatch.

post/commitshipments

Query parameters

skipimportboolean

When true, skips committing the shipment — only generates and returns the label without marking the shipment as committed.

layoutidinteger

Label layout ID override. Defaults to the authenticated customer's preferred layout when omitted.

skipdocumentboolean

When true, skips shipment document generation.

dataonlyboolean

When true, returns commit result data without generating labels.

includereturnlabelboolean

When true, includes a return label alongside the outbound shipment label (use in only 2C operations).

Request body

integer[] required

Response

OK

status'OK' | 'Error' | 'ValidationFailed'

0 = OK, 1 = Error, 2 = ValidationFailed

dataICommitShipmentResult[] nullable
labelsbase64string nullable
returnLabelsbase64string nullable
numberOfLabelsinteger nullable
traceIDstring nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.