Booking

Create or update a booking

Creates a new booking, or updates an existing booking with the listed parameters.

Security

Request

header Parameters

x-api-key

required

string

The API Key.

Request Body schema: application/json

requestId	string
source	string
carrierId	string <uuid>
bookingNumber	string
validFrom	object (Instant)
notes	string
status	string Enum: "PENDING" "CONFIRMED" "CANCELED"
contractNumber	string
size	string
gateIn	object (Instant)
shippedOnBoard	object (Instant)
teu	object (BigDecimal)
	Array of objects (BookingEquipmentDto)
placeOfReceipt	string
portOfLoad	string
portOfDischarge	string
placeOfDelivery	string
service	string
voyage	string
vessel	string
confirmedAt	object (Instant)
confirmedAtIfEarlier	object (Instant)
confirmedAtOnCreate	object (Instant)
weight	integer <int32>
portCut	object (Instant)
proformaDeparture	object (Instant)
reasonCode	string
nvoBookingReferences	Array of strings
namedAccount	string
customerReference	string
adhocData	string

Responses

200

Booking was saved

post/v1/bookings/save

Request samples

Payload
curl
Node.js
Python

application/json

{"requestId": "string",
"source": "string",
"carrierId": "81a9910c-2657-4f54-9feb-7f6d85d613bc",
"bookingNumber": "string",
"validFrom": { },
"notes": "string",
"status": "PENDING",
"contractNumber": "string",
"size": "string",
"gateIn": { },
"shippedOnBoard": { },
"teu": { },
"equipment": [{"containerType": "string",
"quantity": 0
}
],
"placeOfReceipt": "string",
"portOfLoad": "string",
"portOfDischarge": "string",
"placeOfDelivery": "string",
"service": "string",
"voyage": "string",
"vessel": "string",
"confirmedAt": { },
"confirmedAtIfEarlier": { },
"confirmedAtOnCreate": { },
"weight": 0,
"portCut": { },
"proformaDeparture": { },
"reasonCode": "string",
"nvoBookingReferences": ["string"
],
"namedAccount": "string",
"customerReference": "string",
"adhocData": "string"
}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"action": "CREATE"
}