Skip to main content
Create a shipment

Body

application/json
freight_mode
enum<string>
required
Available options:
air,
ocean,
rail
load_type
enum<string>
required

fcl cargo is described by cargo.containers, lcl cargo by cargo.loads.

Available options:
fcl,
lcl
needs_ad_valorem_insurance
boolean
required
route
object
required

Needs an origin, the pickup location or the departure port, and a destination, the arrival port or the delivery location.

cargo
object
cargo_ready_date
string<date>
Example:

"2027-03-01"

desired_delivery_date
string<date>
Example:

"2027-04-15"

incoterm
enum<string>
Available options:
exw,
fca,
fas,
fob,
cpt,
cfr,
cif,
cip,
dap,
ddp,
dpu,
dat
Example:

"fob"

name
string
Example:

"June Air Export USA"

specific_instructions
string
Example:

"Call the warehouse before delivery"

transported_goods
object

Response

The created shipment.

name
string
Example:

"June Air Export USA"

ovrsea_shipment_id
string
Example:

"CDEF"

status
enum<string>
Available options:
booking_request,
awaiting_booking,
booked,
draft,
in_progress,
finished,
cancelled
created_at
string
Example:

"2021-09-20T10:02:09+01:00"

incoterm
enum<string>
Available options:
exw,
fca,
fas,
fob,
cpt,
cfr,
cif,
cip,
dap,
ddp,
dpu,
dat
Example:

"fob"

freight_mode
enum<string>
Available options:
air,
ocean,
rail,
truck
load_type
enum<string>
Available options:
fcl,
lcl,
both
freight_type
enum<string>
Available options:
port_to_door,
door_to_port,
door_to_door,
port_to_port
route
object
cargo_ready_date
string
Example:

"2021-10-11"

desired_delivery_date
string
Example:

"2021-10-11"

specific_instructions
string

Optional field containing specific instruction given by the client

cargo
object
transported_goods
object
commercial_value
object
needs_ad_valorem_insurance
boolean
default:false
purchase_order_references
string[]
main_tracking_dates
object
booking_information
object
invoice_status
enum<string>
Available options:
available,
awaiting_invoice,
due,
paid,
partially_paid
invoice_references
string[]
accepted_quote
object