The Booking System API allows you to generate, confirm, handle, cancel, modify, and receive booking information directly.
Start designing your API in minutes. The OpenAPI specification file enables you to learn and interact with API elements, including all available endpoints, input and output representations.
Booking System API is organized around REST.
Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses,
and uses standard HTTP response codes, authentication, and verbs.
1https://rates.searates.com/api/v1/bookings
All endpoints are only accessible via HTTPS and are located at rates.searates.com
To access Booking System API, you first need to obtain a bearer token.
1GET https://www.searates.com/auth/platform-token
| Parameter | Description |
|---|---|
id | Your platform ID, provided by your SeaRates manager |
api_key | Your API key, provided by your SeaRates manager |
login | Your SeaRates website login |
password | Your SeaRates website password |
1GET https://www.searates.com/auth/platform-token?id=PLATFORM_ID&api_key=API_KEY&login=YOUR_LOGIN&password=YOUR_PASSWORD
Include the token in the Authorization header for subsequent API requests:
1Authorization: Bearer 123
post/createExample: Authorization: Bearer 123
Content-Typeapplication/json
Allowed values:fcllclbulkland_fclftlltlfwllwlrail_fclrail_ftlair
List of parties involved in the booking. The object may include up to three party objects: shipper, consignee, and notify (used for Shipping Instructions). Each party object contains the contact and company details required for the booking documentation.
First name of the contact person.
Last name of the contact person.
Contact email address.
Contact phone number.
Company name.
ISO 2-letter country code.
City name.
Street address.
Postal/ZIP code.
VAT or tax number.
Reference from the freight forwarder.
First name of the contact person.
Last name of the contact person.
Contact email address.
Contact phone number.
Company name.
ISO 2-letter country code.
City name.
Street address.
Postal/ZIP code.
VAT or tax number.
Reference from the freight forwarder.
First name of the contact person.
Last name of the contact person.
Contact email address.
Contact phone number.
Company name.
ISO 2-letter country code.
City name.
Street address.
Postal/ZIP code.
VAT or tax number.
Reference from the freight forwarder.
Product and cargo details used for creating the booking.
HS code of the cargo. May also represent 'personal' or 'all_freight' cases.
>= 1
>= 1
>= 1
Default:false
Default:false
Cargo weight value.
Weight measurement unit.
Allowed values:KGMT
Cargo volume value.
Volume measurement unit.
Allowed values:CBMM3
Additional information about the cargo.
Default:false
>= 0
Default:false
Default:false
Default:false
Default:false
1{
2 "success": true,
3 "data": {
4 "id": 1000999
5 }
6}