Render Partial Packing Slip

Renders a partial packing slip for a fulfillment as an HTML document (which can be
printed or converted to PDF).

Unlike the full packing slip, a partial packing slip includes only the specified subset
of sale line items and the exact quantities being packed. This is useful when a
fulfillment is shipped across multiple parcels or in multiple stages.

Each entry in packed_line_items must reference a valid sale line item and specify a
positive quantity that does not exceed the quantity already packed on the pick lists.

Use the optional lang field to control the language of the static template strings.
When omitted or invalid, the packing slip defaults to en-US.

🔒 Requires: sales:read scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

The unique identifier of the fulfillment to render a partial packing slip for. Must be a positive integer.

Body Params

Request body describing the subset of line items and quantities to render on a partial packing slip

string

BCP 47 language tag used to localize the static template strings on the packing slip. Defaults to en-US when omitted or unrecognized.

packed_line_items
array of objects
required
length ≥ 1

The sale line items and quantities to include on the partial packing slip. Must contain at least one item.

packed_line_items*

A single sale line item and the quantity to include on the partial packing slip

string
required

The quantity of this line item to pack. Must be a positive finite number and must not exceed the quantity already packed on the pick lists.

uuid
required

The ID of the sale line item to include on the packing slip

Responses

400

Bad Request — one of the following:

  • the fulfillment ID is missing, non-numeric, or not a positive integer
  • the request body is missing or empty
  • packed_line_items is empty or contains an item without a sale_line_item_id
  • a packed line item quantity is not a positive finite number
  • a packed line item quantity exceeds the quantity packed on the pick lists
401

Unauthorized

403

Forbidden

404

Not Found — the fulfillment does not exist

406

Not Acceptable — the fulfillment has no items to render

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/html