BookingAmendment

Endpoints relating to BookingAmendment objects

Create and return a booking amendment - a request to change an existing booking.

Request
Request Body schema: application/json
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 (ContainerCounts)
_object
string

String representing the object’s type. Always /container_counts for this object.

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_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_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
_object
string

String representing the object’s type. Always /bookings/update/product_description for this object.

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 (Cargo)

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
string

String representing the object’s type. Always /cargo for this object.

object (Volume)
object (Weight)
marks_and_numbers
string

Optional. Identifying markings and numbers that are visible on the cargo.

Array of objects (ShippingUnit)
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.

Items Enum: "packed_loose" "packed_with_equipment" "contained_in_equipment" "contained_in_battery_powered_vehicles"
object or Array of objects (MetadataCreate)
One of:

Object format.

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_pickup_service
boolean

The requested new wants-pickup 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

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.

new_metadata
object

Set of custom key-values specific to the object. The keys are strings and values are arrays of strings. The set of valid keys is always the consignee's list of keys, even if call was made by a different party.

post/booking_amendments
Request samples
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.",
  • "new_container_counts": {
    • "twenty_ft": 2,
    • "forty_ft": 3,
    • "forty_ft_hc": 4,
    • "forty_five_ft_hc": 5
    },
  • "new_wants_pickup_service": false,
  • "new_origin_address_ref": "warehouse_cn",
  • "new_origin_port_loc_code": "CNSZP",
  • "new_cargo_ready_date": "2019-06-30",
  • "new_cargo": {
    • "volume": {
      • "value": 472.62,
      • "unit": "cbm"
      },
    • "weight": {
      • "value": 2300.4,
      • "unit": "kg"
      },
    • "marks_and_numbers": "Fragile",
    • "shipping_units": [
      • {
        }
      ],
    • "contains_hazmat": true,
    • "contains_magnets": true,
    • "contains_other_dangerous_goods": true,
    • "contains_li_ion": true,
    • "contains_non_li_ion_battery": true,
    • "lithium_batteries_packing_types": [
      • "packed_loose"
      ]
    },
  • "new_metadata": {
    • "PO": [
      • "12345"
      ],
    • "SKU": [
      • "abc123"
      ]
    }
}
Response samples
application/json
{
  • "_object": "/api/response",
  • "version": 2,
  • "data": {
    • "_object": "/booking_amendment",
    • "id": 2983,
    • "booking_id": 12345,
    • "is_pending": false,
    • "new_name": "Valentine's Day - 2020",
    • "new_container_counts": {
      • "twenty_ft": 2,
      • "forty_ft": 3,
      • "forty_ft_hc": 4,
      • "forty_five_ft_hc": 5
      },
    • "new_wants_pickup_service": false,
    • "new_origin_address": {
      • "_object": "/address",
      • "street_address": "123 Queen St",
      • "street_address2": null,
      • "city": "Shanghai",
      • "state": null,
      • "country": "China",
      • "country_code": "CN",
      • "zip": null,
      • "unlocode": "CNSHA",
      • "timezone": "China/Shanghai",
      • "ref": "my-shanghai-address-ref"
      },
    • "new_port_of_loading": {
      • "_object": "/address",
      • "street_address": "123 Queen St",
      • "street_address2": null,
      • "city": "Shanghai",
      • "state": null,
      • "country": "China",
      • "country_code": "CN",
      • "zip": null,
      • "unlocode": "CNSHA",
      • "timezone": "China/Shanghai",
      • "ref": "my-shanghai-address-ref"
      },
    • "new_port_of_unloading": {
      • "_object": "/address",
      • "street_address": "10000 West O'Hare Ave",
      • "street_address2": "PO Box 66142",
      • "city": "Chicago",
      • "state": "IL",
      • "country": "United States of America",
      • "country_code": "US",
      • "zip": "60666",
      • "unlocode": "US AL2",
      • "timezone": "America/Chicago",
      • "ref": "my-chicago-ref"
      },
    • "new_cargo_ready_date": "2019-06-30",
    • "new_cargo": {
      • "volume": {
        },
      • "weight": {
        },
      • "marks_and_numbers": "Fragile",
      • "shipping_units": [
        ],
      • "contains_hazmat": true,
      • "contains_magnets": true,
      • "contains_other_dangerous_goods": true,
      • "contains_li_ion": true,
      • "contains_non_li_ion_battery": true,
      • "lithium_batteries_packing_types": [
        ]
      },
    • "new_metadata": {
      • "PO": [
        ],
      • "SKU": [
        ]
      }
    }
}