Endpoints relating to BookingAmendment objects. An existing booking is required to create booking amendments for.
Create a new booking amendment.
Request
Request Body schema: application/json
required
booking_id
required
integer
Identifier of the existing booking to be modified
new_name
string
Name of the booking.
amendment_note
string
Additional message to Flexport regarding the booking amendment.
object (CreateContainerCounts)
twenty_ft
integer
Quantity of 20 ft containers requested.
forty_ft
integer
Quantity of 40 ft containers requested.
forty_ft_hc
integer
Quantity of 40 ft HC containers requested.
forty_five_ft_hc
integer
Quantity of 45 ft HC containers requested.
new_wants_pickup_service
boolean
new_wants_import_customs_service
boolean
new_wants_flexport_freight
boolean
new_wants_bco
boolean
new_wants_214_filing
boolean
Set 214 filing as an additional service
new_wants_ftz_entry
boolean
Set FTZ entry as an additional service
new_origin_address_ref
string
Customizable reference ID of network location that is the pickup location.
new_origin_port_us_cbp_port_code
string
At most one of origin_port_us_cbp_port_code or origin_port_loc_code may be specified. Unique port reference code used by US Customs and Border Protection.
new_origin_port_loc_code
string
At most one of origin_port_us_cbp_port_code or origin_port_loc_code may be specified. UN code for the origin port.
new_destination_address_ref
string
Customizable reference ID of network location that is the delivery location.
new_destination_port_us_cbp_port_code
string
At most one of new_destination_port_us_cbp_port_code or new_destination_port_loc_code may be specified. Unique port reference code used by US Customs and Border Protection.
new_destination_port_loc_code
string
At most one of new_destination_port_us_cbp_port_code or new_destination_port_loc_code may be specified. UN code for the destination port.
new_cargo_ready_date
string <date>
Date when cargo is ready for pickup at the origin location.
Array of objects (CreateBookingAmendmentHsCode)
New product (HS code) information
Array
description
required
string
Always required. English description of product in booking.
description_for_export_customs
string
Required if booking if origin address or origin port is in Mainland China. Chinese description of product in booking.
hs_code
required
string
The six digit code under which the product should be classified for export customs.
object (CreateCargo)
With cargo you have two options, detailed or simple. These are both expressed directly on the cargo object. For detailed cargo, shipping_units is required, and weight and volume is required in the cargo object or the shipping_units object. For simple cargo, shipping_units is required, but only one should be specified, and weight and volume are required in the cargo object.
object (VolumeCreate)
object (WeightCreate)
marks_and_numbers
string
Optional. Identifying markings and numbers that are visible on the cargo.
Array of objects (ShippingUnitCreate)
contains_hazmat
boolean
Required. Whether the cargo contains hazardous materials.
contains_magnets
boolean
Required. Whether the cargo contains magnets.
contains_other_dangerous_goods
boolean
Required. Whether the cargo contains other non-hazmat, non-magnet, non-battery dangerous goods.
contains_li_ion
boolean
Required. Whether the cargo contains lithium-ion batteries.
contains_non_li_ion_battery
boolean
Required. Whether the cargo contains non-lithium-ion batteries, e.g. lithium batteries.
lithium_batteries_packing_types
Array of any
Required if contains_li_ion is true. List of ways in which lithium-ion batteries will be packed for this booking. This can be a subset of packed_loose, packed_with_equipment, contained_in_equipment, and contained_in_battery_powered_vehicle.
Metadata has two allowed formats. Either array format or object format. Refer to the metadata section in this documentation for more information.
example_key
Array of strings
Responses
200
The created booking amendment
Response Schema: application/json
_object
string
self
string
version
integer
object (BookingAmendment)
_object
string
Type of the object
id
integer
Unique identifier for the booking amendment
booking_id
integer
Unique identifier for the booking that this amendment is for
is_pending
boolean
Depending on various conditions, the requested booking amendment may either be accepted and applied instantly, or it may require Flexport approval. 'is_pending' is set to true if approval is required.
new_name
string
The requested new name of the booking
object
The requested new container count values
new_wants_import_customs_service
boolean
The requested new wants-import-customs-service value
new_wants_pickup_service
boolean
The requested new wants-pickup value
new_wants_flexport_freight
boolean
The requested new wants-flexport-freight value
new_wants_bco
boolean
The requested new wants-bco value
object
The requested new origin address
object
The requested new origin port (port of loading)
object
The requested new destination port (port of unloading)
new_cargo_ready_date
string <date>
The requested new cargo ready date
Array of objects (BookingAmendmentHsCode)
New product (HS code) information
object
The requested new cargo, possibly including package details
new_metadata
object
The requested new metadata
400
error
post/booking_amendments
Request samples
Payload
application/json
{
"booking_id": 12345,
"new_name": "Valentine's Day - 2020",
"amendment_note": "This is an amendment note with useful context to changes made to the booking.",
