PickupApi

Get Pickups List

Retrieves a scheduled pickup entry by shipment ID or pickup list number, and returns a generated PDF pickup document.

get/pickupslist

Query parameters

shipmentidinteger

ID of the shipment to retrieve the pickup list for.

pickupslistnumberinteger

Pickup list number to retrieve. When provided, returns the document for that specific pickup list.

copiesinteger

Number of pickup document PDF copies to generate. Defaults to 1.

miniboolean

When true, generates a mini-format pickup document PDF instead of the full-size version.

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

0 = OK, 1 = Error, 2 = ValidationFailed

shipmentidsinteger[] nullable

List of shipment IDs associated with this pickup.

pickupdocumentstring nullable

Base64-encoded PDF pickup document for this pickup entry.

traceIDstring nullable

Unique trace identifier for debugging and support purposes.