PickupApi

Request Pickup At Address

Schedules a pickup request for shipments at a specified address. Returns a generated PDF pickup document. Only committed shipments can be picked up; shipments must be committed before a pickup can be requested. If ShipmentIDs in the body is empty or omitted, the pickup is created for all committed shipments that have not been picked up yet.

post/requestpickupataddress

Query parameters

prefferedpickuptimestring

Preferred pickup time as a Unix timestamp in milliseconds. The system assigns the nearest available slot if the requested time is unavailable.

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.

Request body

shipmentIDsinteger[] nullable

List of shipment IDs to include in this pickup request. If empty or omitted, all available shipments are included.

pickupNamestring nullable

Name of the contact person at the pickup address.

pickupCitystring nullable

City of the pickup address.

pickupZipcodestring nullable

Postal/zip code of the pickup address.

pickupStreetAndNumberstring nullable

Street name and number of the pickup address.

Response

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

0 = OK, 1 = Error, 2 = ValidationFailed

shipmentidsinteger[] nullable

List of shipment IDs included in the created pickup.

pickupdocumentsstring[] nullable

Base64-encoded PDF pickup documents generated for this request. One document per pickup list number.

pickupIdsinteger[] nullable

List of pickup IDs created by this request.

traceIDstring nullable

Unique trace identifier for debugging and support purposes.

Changes

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