Outbound Order Packing Slips
Endpoints related to Outbound Order Packing Slips.
Download outbound order packing slip
Returns the outbound order packing slip PDF from persisted server data.
Query template (required) and optional consignmentItemId — see OutboundOrderPackingSlipPrintRequest in components.
Synchronous 200 returns PDF bytes in the response body.
path Parameters
tenantIdTenant ID. Can be found in organisation settings
orderIdOutbound Order Id
query Parameters
templatePacking slip layout mode.
Packing slip layout.
AGGREGATED, no consignment item: one PDF for the whole order.AGGREGATED, with a consignment item: one PDF, one page for that item.PER_ITEM, no consignment item: one merged PDF, one page per consignment item, in pack-list order. Pages are built in chunks of up to 20 and then merged.PER_ITEM, with a consignment item: one PDF, one page for that item.
consignmentItemIdOptional consignment item UUID. Narrows the PDF to one page for that item. Omit it for the whole order. An empty string is treated as omitted. Returns 400 when the UUID is invalid or does not belong to this outbound order.
Headers
Accept-VersionAll API end points require Accept-Version in the request header.
Failure to provide the header will return a status code of 400, however, an invalid version can return a 404, 406 or 400.
Download outbound order packing slip › Responses
Success; response body is the packing slip PDF.
Print outbound order packing slip
Submits one packing slip PDF to the tenant remote printing workflow (e.g. PrintNode) from persisted server data.
Request body uses OutboundOrderPackingSlipPrintRequest — same template and consignmentItemId rules as GET …/packing-slip/download. One print job per request.
Synchronous 200 returns the remote print job identifier in the response body.
path Parameters
tenantIdTenant ID. Can be found in organisation settings
orderIdOutbound Order Id
Headers
Accept-VersionAll API end points require Accept-Version in the request header.
Failure to provide the header will return a status code of 400, however, an invalid version can return a 404, 406 or 400.
Print outbound order packing slip › Request Body
templatePacking slip layout.
AGGREGATED, no consignment item: one PDF for the whole order.AGGREGATED, with a consignment item: one PDF, one page for that item.PER_ITEM, no consignment item: one merged PDF, one page per consignment item, in pack-list order. Pages are built in chunks of up to 20 and then merged.PER_ITEM, with a consignment item: one PDF, one page for that item.
consignmentItemIdOptional consignment item UUID. Narrows the PDF to one page for that item. Omit it for the whole order. An empty string is treated as omitted.
Supply exactly one UUID. Line-number placeholders use that item's position in the full order. Items without packed products still receive a page. When the order has no consignment items, sale order and consignment headers still render when consignments exist on the order.
Applies to AGGREGATED and PER_ITEM. Returns 400 when the UUID is invalid or does not belong to this outbound order.
Print outbound order packing slip › Responses
Success; print job submitted to the remote printing provider.
printJobIdRemote print job identifier returned by the printing provider (for example PrintNode). May be null when the provider does not return an identifier.
Download outbound order packing slip from a snapshot payload
Returns a packing slip PDF from a client-supplied snapshot, not persisted SOP quantities.
POST carries the snapshot in the body; use GET …/packing-slip/download for server data only.
Request body: OutboundOrderPackingSlipSnapshotRequest ( template / consignmentItemId same as download; snapshot-specific rules on snapshot in the schema).
path Parameters
tenantIdTenant ID. Can be found in organisation settings
orderIdOutbound Order Id
Headers
Accept-VersionAll API end points require Accept-Version in the request header.
Failure to provide the header will return a status code of 400, however, an invalid version can return a 404, 406 or 400.
Download outbound order packing slip from a snapshot payload › Request Body
templatePacking slip layout.
AGGREGATED, no consignment item: one PDF for the whole order.AGGREGATED, with a consignment item: one PDF, one page for that item.PER_ITEM, no consignment item: one merged PDF, one page per consignment item, in pack-list order. Pages are built in chunks of up to 20 and then merged.PER_ITEM, with a consignment item: one PDF, one page for that item.
Packed quantities per consignment item. packedProducts[].id is the sale order product UUID (same as OutboundOrderItem.id on GET …/items).
May be [] (empty product context for all items on the order; no error). Consignment items not listed in snapshot use empty product context, not persisted SOP quantities.
Whole order, no consignmentItemId: AGGREGATED → one PDF; PER_ITEM → one merged PDF (one page per item; chunked internally). With consignmentItemId: one page for that item; missing snapshot row → empty product context.
consignmentItemIdOptional consignment item UUID. Narrows the PDF to one page for that item. Omit it for the whole order. An empty string is treated as omitted.
Supply exactly one UUID. Line-number placeholders use that item's position in the full order. Items without packed products still receive a page. When the order has no consignment items, sale order and consignment headers still render when consignments exist on the order.
Applies to AGGREGATED and PER_ITEM. Returns 400 when the UUID is invalid or does not belong to this outbound order.
Download outbound order packing slip from a snapshot payload › Responses
Success; response body is the packing slip PDF.
Print outbound order packing slip from a snapshot payload
Submits one packing slip print job from a client snapshot.
Request body: OutboundOrderPackingSlipSnapshotRequest — same rules as POST …/packing-slip/snapshot-download. One print job per request; synchronous 200 returns printJobId.
path Parameters
tenantIdTenant ID. Can be found in organisation settings
orderIdOutbound Order Id
Headers
Accept-VersionAll API end points require Accept-Version in the request header.
Failure to provide the header will return a status code of 400, however, an invalid version can return a 404, 406 or 400.
Print outbound order packing slip from a snapshot payload › Request Body
templatePacking slip layout.
AGGREGATED, no consignment item: one PDF for the whole order.AGGREGATED, with a consignment item: one PDF, one page for that item.PER_ITEM, no consignment item: one merged PDF, one page per consignment item, in pack-list order. Pages are built in chunks of up to 20 and then merged.PER_ITEM, with a consignment item: one PDF, one page for that item.
Packed quantities per consignment item. packedProducts[].id is the sale order product UUID (same as OutboundOrderItem.id on GET …/items).
May be [] (empty product context for all items on the order; no error). Consignment items not listed in snapshot use empty product context, not persisted SOP quantities.
Whole order, no consignmentItemId: AGGREGATED → one PDF; PER_ITEM → one merged PDF (one page per item; chunked internally). With consignmentItemId: one page for that item; missing snapshot row → empty product context.
consignmentItemIdOptional consignment item UUID. Narrows the PDF to one page for that item. Omit it for the whole order. An empty string is treated as omitted.
Supply exactly one UUID. Line-number placeholders use that item's position in the full order. Items without packed products still receive a page. When the order has no consignment items, sale order and consignment headers still render when consignments exist on the order.
Applies to AGGREGATED and PER_ITEM. Returns 400 when the UUID is invalid or does not belong to this outbound order.
Print outbound order packing slip from a snapshot payload › Responses
Success; print job submitted to the remote printing provider.
printJobIdRemote print job identifier returned by the printing provider (for example PrintNode). May be null when the provider does not return an identifier.