API Reference

Create a shipment

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

When creating a shipment, the country of import of the merchant and customer associated with the shipment must match the country of import of the shipment. Currently we only support country of imports from Canada.

Body Params
string
required

The unique identifier for the merchant associated with this shipment

string
required

The unique identifier for the customer associated with this shipment

string
required

The shipment number

string
required

The cargo control number

line_items
array of objects
required

An array of line item objects

line_items*
string
required

The tracking number for the shipment

string
enum
required

The currency code the shipment was paid in

Allowed:
float
required

The total price of just the line items

float
required

The total price of the entire shipment including all fees

float
required

The total weight of the shipment

string
enum
required

The unit of weight

Allowed:
float
required
Defaults to 0

The total duties fees charged for the shipment

float
required
Defaults to 0

The total tax fees charge for the shipment

int32
required

The total number of packages

date
required

The date the shipment was created

string
required

The invoice number

string
enum
required

The transport mode

Allowed:
string
enum
required

The transaction type. B2B (business to business) or B2C (business to consumer)

Allowed:
string
Defaults to 13

The treatment code

string
Defaults to 02

The value for duty code

date
required

Estimated date of arrival

string
required

The goods description

string
required

The 4 character carrier code identifying the carrier

string
required

The name of the carrier

string

The base64 encoded string of the commercial invoice PDF for the shipment

Responses

Updated over 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 over 2 years ago