Booking (Create)
Creates a new Booking.
Authentication
Every request needs both of the following:
- An authorized UserID, passed in to the request body — this is the user's cieTrade.net email.
- A Bearer Token in the Authorization header of your tool or code call. The token is found under Settings → Integration → Api Token.
The user must have Can Access cieTrade API checked under Settings → Users & Roles, and must have an email address on their user record — the create and update endpoints record that user against every change they make.
Request Example
{
"UserID": "example@email.net",
"BookingNo": "BK10001",
"BookingDate": "2026-09-29",
"BookingContact": "Bob Stone",
"InvoiceNo": "10284",
"OrderNo": "10264",
"Status": "Completed",
"PrimaryCarrier": "3P GLOBAL RESOURCES LLC",
"InitialCarrier": "27 RECYCLING CORP XERO",
"ForwarderCarrier": "A & A CONTRACT CUSTOMS BROKERS LTD",
"Type": "CNTR",
"Quantity": 6,
"Size": "10YARD",
"UserDefined1": "Door to Pier",
"CutOffDate": "2026-09-29T15:30:00",
"DocumentCutOffDate": "2026-09-29T16:00:00",
"VGMCutOffDate": "2026-09-29T16:00:00",
"TimeZone": "ET",
"ReceivedConfirmDate": "2026-09-29",
"EarliestReturnDate": "2026-09-29",
"ShipperRef": "8021bAAAc",
"DescriptionOfGoods": "6 10 yard containers.",
"TotalWeight": 15,
"WeightUOM": "MT",
"MinWeight": 5,
"MaxWeight": 25,
"ETD": "2026-09-29",
"ETA": "2026-09-29",
"VesselName": "V1293129",
"VoyageNumber": "802b",
"Feeder": "BF Fortaleza",
"PlaceOfReceipt": "Asan, South Korea",
"POL": "Anyang, South Korea",
"POD": "Asuncion, Paraguay",
"PlaceOfDelivery": "Ashdod, Israel"
}
Body Parameters
| Parameter | Description | Required |
|---|---|---|
UserID |
cieTrade.NET User Email. Used for Authentication and Logging. | REQUIRED |
BookingNo |
Booking number. | REQUIRED |
BookingDate |
Date of the booking (e.g. "2026-09-29"). Defaults to today. See Dates section below. | OPTIONAL |
BookingContact |
Name of the contact the booking was made with. | OPTIONAL |
InvoiceNo |
Invoice number reference. | OPTIONAL |
OrderNo |
cieTrade Sales Order number | OPTIONAL |
Status |
Booking status. Defaults to (na). Accepts (na), Request, Confirm, Completed, Canceled. An empty value is treated as (na). |
OPTIONAL |
PrimaryCarrier |
Primary carrier name. Must match a Counterparty in cieTrade. | REQUIRED |
InitialCarrier |
Initial carrier (trucker) name. Must match a Counterparty in cieTrade. | OPTIONAL |
ForwarderCarrier |
Freight forwarder name. Must match a Counterparty in cieTrade. | OPTIONAL |
Type |
Booking type. Defaults to CNTR (container). Any other value marks the booking as break bulk. |
OPTIONAL |
Quantity |
Number of containers. | REQUIRED |
Size |
Container size (e.g. "10YARD"). Must match an Equipment Type (Short Name) in cieTrade. | REQUIRED |
UserDefined1 |
User-defined field 1. | OPTIONAL |
CutOffDate |
Cut-off date and time (e.g. "2026-09-29T15:30:00"). See Dates section below. | OPTIONAL |
DocumentCutOffDate |
Document cut-off date and time. | REQUIRED |
VGMCutOffDate |
VGM (Verified Gross Mass) cut-off date and time. | OPTIONAL |
TimeZone |
Time zone for the cut-off times. Accepts ET, CT, MT, PT. |
OPTIONAL |
ReceivedConfirmDate |
Date the booking confirmation was received. | OPTIONAL |
EarliestReturnDate |
Earliest date the container can be returned. | OPTIONAL |
ShipperRef |
Shipper reference number. | OPTIONAL |
DescriptionOfGoods |
Description of the goods being shipped. | OPTIONAL |
TotalWeight |
Total weight. Defaults to 0. | OPTIONAL |
WeightUOM |
Weight Unit of Measurement. Defaults to MT. Accepts EA, LBS, KG, ST, MT, ADMT, GT. |
OPTIONAL |
MinWeight |
Minimum weight. Defaults to 0. | OPTIONAL |
MaxWeight |
Maximum weight. Defaults to 0. | OPTIONAL |
ETD |
Estimated Time of Departure. | OPTIONAL |
ETA |
Estimated Time of Arrival. | OPTIONAL |
VesselName |
Vessel name. | OPTIONAL |
VoyageNumber |
Voyage number. | OPTIONAL |
Feeder |
Feeder vessel name. | OPTIONAL |
PlaceOfReceipt |
Place of receipt. See Ports section below. | OPTIONAL |
POL |
Port of Loading. See Ports section below. | OPTIONAL |
POD |
Port of Discharge. See Ports section below. | OPTIONAL |
PlaceOfDelivery |
Place of delivery. See Ports section below. | OPTIONAL |
Dates
All date fields use the ISO 8601 format: YYYY-MM-DD for dates (e.g. "2026-09-29") and YYYY-MM-DDTHH:mm:ss for dates with a time (e.g. "2026-09-29T15:30:00"), using the 24-hour clock.
Ports
PlaceOfReceipt, POL, POD and PlaceOfDelivery must match a port name in cieTrade.
Ports can be sent either as the port name alone (e.g. "Asan") or in the "Port, Country" format shown in cieTrade (e.g. "Asan, South Korea").
Response Example
On Success [HTTP 201]:
{
"Msg": "Successfully Created Booking BK10001"
}
On Error [HTTP 500/HTTP 401/HTTP 400]:
{
"ErrMsg": "Error: Counterparty 3P GLOBAL RESOURCES LLC not found in cieTrade."
}