Booking API
Booking Multi-Parcel Shipments With Skrym
Last updated 28 Jun 2024
The booking.BookShipment API books the delivery of parcels with the specified transport method.
It works with the transporters' APIs as depicted in the diagram below:
Booking API Process
sequenceDiagram
autonumber
participant Retailer as Retailer
participant Skrym as Skrym
Retailer ->>+Skrym: BookShipment
Note over Skrym: Validate request
create participant Transporter as Transporter
Skrym ->>+Transporter: Availability check
Transporter -->>-Skrym: Confirm availability
Skrym ->>+Transporter: Make booking
Transporter -->>-Skrym: Confirm booking
Skrym->>-Retailer: OK (200)
This illustrates how Skrym handles the logical flow of a booking.
The endpoint responds with 200 only if the booking has been successfully made with the transporter and we have acquired the labels.
If we cannot acquire the labels from the transporter, Skrym labels are generated instead.
JSON Request Example
Endpoint Schema:
postapi.skrym.com/booking.BookShipment
Once successfuly booked, you can trigger printing of the labels via Printing API.
In case of unsuccessful booking, you can call the endpoint again to re-try the booking.
Retry