Place an Order

post

https://api-sandbox.cargoboard.com/v1/orders

Books a transport order. The response contains the order ID (data.id), the Cargoboard shipment reference (data.reference), the price and links for follow-up actions such as labels, confirmation, tracking and cancellation.

Production: every order is executed and billed — test in the sandbox first.

Guides: Shipper and Consignee Information, Package types, Shipment Products, Dangerous Goods.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

product

string

enum

required

Shipment product — see Shipment Products. FIX products require consignee.deliveryOn.

shipper

object

required

consignee

object

required

lines

array of objects

required

length between 1 and 100

Goods to ship — one entry per group of identical handling units. See Package types.

lines*

content

string

required

Description of the goods.

unitQuantity

integer

required

1 to 100

Number of identical units in this line.

unitPackageType

string

enum

required

Package type of one unit. Common values: EP one-way pallet, FP euro pallet, GP euro box pallet (Gitterbox), KI wooden crate, KT carton (also used for parcel shipments), PA package, CC collico, PARTIE part load by loading meter. DIRECT_* values book a complete vehicle and require the product DIRECT (DIRECT_TRUCK_40 also works with EXPRESS) — see Van/Truck Product.

unitLength

integer

required

0 to 1360

Length of one unit in centimeters.

unitWidth

integer

required

0 to 240

Width of one unit in centimeters.

unitHeight

integer

required

0 to 300

Height of one unit in centimeters.

unitWeight

number

required

≥ 0

Weight of one unit in kilograms.

isStackable

boolean

Defaults to false

Set to true if the units can be stacked.

wantsPalletExchange

boolean

Defaults to false

Set to true if you want a pallet exchange. Only for FP, GP, PARTIE and DIRECT_*.

additionalEuroPallets

number

Additional euro Pallets for the line (e.g. as top or side protection).

combinedNomenclatureCode

string

Combined Nomenclature (customs tariff) code for the line's content.

additionalGitterBoxes

number

Additional wire mesh boxes (Gitterboxen), e.g. as top or side protection. Only with GP.

dangerousGoods

array of objects

length ≤ 100

Dangerous goods (ADR) contained in this line — see Dangerous Goods.

dangerousGoods

customerOrderCode

string

Your own reference, e.g. a delivery note number. Appears on documents as customer order number.

couponCode

string

A code applied by customer that will allow for special actions like discount etc.

wantsExportDeclaration

boolean

Defaults to false

A service where shipment will be declared for customs. Some customers do this by themselves and others book this option. This service should be only possible if shipment goes to, or comes from a country outside of the EU, like Great Britain, Norway, Switzerland.

wantsClimateContribution

boolean

Defaults to true

Climate contribution to reduce the negative environmental impact of this shipment.

wantsInsurance

boolean

Defaults to false

Cargoboard arranges transport insurance for this shipment. Requires valueOfGoodsAmount.

wantsSignatureRequiredParcel

boolean

Defaults to false

Parcel service: signature required upon delivery.

wantsDirectDeliveryParcel

boolean

Defaults to false

Parcel service: direct delivery without hub sorting.

customsTariffQuantity

number

Customs tariff quantity.

wantsNonTransshipment

boolean

Defaults to false

Shipment must not be transshipped en route.

valueOfGoodsAmountEur

number

Value of goods converted to EUR.

valueOfGoodsAmount

number

Amount of money - value of goods for insurance or customs

valueOfGoodsCurrency

string

Currency of value of goods. Possible values EUR

incoterm

string

enum

Incoterm. Use STANDARD in general. For shipments to Switzerland or the UK use DAP_CLEARED or DAP_UNCLEARED.

Allowed:

isSupplyingCompanyOrReceivingCustomer

boolean

Has to be set if shipment is going to Switzerland or other non-EU countries for tax reasons. If true customer is supplying company or receiving customer.

201Order has been successfully placed.