Booking Management

Core API CRUD Operations

Comprehensive endpoints for managing shipment bookings throughout their lifecycle—from creation to fulfillment. Handle single bookings, multipiece shipments, and track booking states.

9 Endpoints

Full booking lifecycle

Auth

Bearer token required

Base URL

/partner/booking/

---

Available endpoints

Single bookings

Endpoint	Method	Description
Create Booking	POST	Create a new shipment booking with sender/receiver details
Update Booking	PUT	Modify an existing booking's details
List Bookings	GET	Retrieve paginated list of all bookings
Get Booking By ID	GET	Retrieve complete details for a specific booking
Fetch Recent Bookings	GET	Get recently created bookings with cursor pagination
Delete Booking	DELETE	Remove a booking from the system

Multipiece bookings

Endpoint	Method	Description
Create Multipiece	POST	Combine multiple bookings into a single shipment
Update Multipiece	PATCH	Add or remove bookings from a multipiece
Get Multipiece By ID	GET	Retrieve multipiece booking details

---

Booking lifecycle

┌─────────────┐    ┌─────────────┐    ┌─────────────┐    ┌─────────────┐
│   Created   │ ─► │    Paid     │ ─► │  Processed  │ ─► │  Shipped    │
│  (State 1)  │    │  (State 2)  │    │  (State 3)  │    │  (State 8)  │
└─────────────┘    └─────────────┘    └─────────────┘    └─────────────┘

See Booking Enums for complete state definitions.

---

Common use cases

Creating a booking

1. Authenticate to get a bearer token
2. Call Create Booking with sender, receiver, and package details
3. Receive booking ID and calculated quote
4. Process payment using Transaction endpoints

Tracking bookings

• Use List Bookings for dashboard views
• Use Fetch Recent Bookings for incremental syncing
• Use Get Booking By ID for detailed single-booking views

Multipiece shipments

For shipments with multiple packages going to the same destination:

1. Create individual bookings for each package
2. Use Create Multipiece to combine them
3. Add/remove packages with Update Multipiece

---

Related resources

• Invoices — View and manage booking invoices
• Transactions — Process payments for bookings
• Shipments — Track shipped bookings
• Booking Enums — State codes and type definitions

---

API authorization

All Booking Management endpoints require authorization via API tokens. Ensure each request includes a valid Authorization header:

Authorization: Bearer {{ your_token }}

See Authentication for token generation.