API Reference

Create a consolidated shipment

post
https://dev.borderbuddy.com/api/consolidated-shipments
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Cargo control number

importer
object
required

Importer details

supplier
object
required

Supplier details

shipper
object

Shipper details

string
required

Three-letter ISO currency code, in uppercase

commercial_invoices
array of objects
required

An array of commercial invoice objects

commercial_invoices*
string
required

A brief description of the goods

date
required

The estimated date of arrival

date

Date the airway bill was created

string

base64 encoded string of the PDF file

string

A note to add to the declaration

string
Defaults to CAVAN

The UN/LOCODE port for the final shipment destination

int32

The sublocation code. Must be 4 digits long.

int32

The port of clearance. Must be 4 digits long.

string
enum
required
Defaults to air

The transportation mode for the shipment

Allowed:
Responses

Updated about 2 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 years ago