Handle the real-world details
These are integration design guidelines. They do not add endpoints or guarantees to the API.
Missing contact details and validation
The request schema marks recipient email as required and phone number as optional. Transport services can impose additional requirements. Confirm them for your enabled services; do not substitute an invented telephone number or assume a noreply address is accepted.
Validate recipient and packing data before booking. If a required value is unavailable, hold the delivery for correction and show which field needs attention.
Transport methods and account configuration
Keep an explicit mapping from your order system's delivery method to your agreed PacSort Online settings. Supported service levels are economy and priority; distribution channels are package and parcel. The parcel channel requires pickupSettings.
A label such as “Standard delivery” does not identify a carrier by itself. Confirm routing and service availability with your PacSort Online contact.
Polling an external system and preventing duplicates
Use the source system's documented pagination and change filter, such as modifiedAfter if it provides one. Process every page before advancing your checkpoint. Treat changed records as updates, not automatically as new bookings.
Track each source delivery, booking attempt and returned assignment ID in your integration. The reference does not define an idempotency key. If a POST times out, reconcile the result before sending another POST; a retry may create a second assignment. invoiceReference is a business reference, not a documented duplicate-prevention mechanism.
Multiple deliveries in one physical package
Agree which system owns consolidation before booking labels. Order lines and delivery records do not necessarily represent physical packages.
Use the actual packed weight and dimensions. Keep all contributing external references mapped to the assignment that represents the package. Do not assume unused bookings are free or automatically cancelled.
Separate access for your source system
Your PacSort Online API key authenticates requests to PacSort Online. Access to an order or warehouse system is configured separately with that provider. Agree test and production access, required permissions and the party responsible for each connection.