Place an Order

post

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

Authorization with customer token (XApiKey) or user token (Bearer). Orders placed on this endpoint need confirmation for authorization different than wih XApiKey that is customers tokenApi.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

product

string

enum

required

The product for which a quotation should be received. Possible values: DIRECT, EXPRESS, EXPRESS_8, EXPRESS_10, EXPRESS_12, EXPRESS_16, FIX, FIX_8, FIX_10, FIX_12, FIX_16, STANDARD.

shipper

object

required

consignee

object

required

lines

array of objects

required

Line for a product.

lines*

customerOrderCode

string

A code applied by customer that will appear on documents as CustomerOrderNo

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.

wantsClimateNeutralShipment

boolean

Defaults to true

Negative environmental impact will be reduced for this service.

wantsInsurance

boolean

Defaults to false

Cargoboard will organize an insurance for this shipment. goodsValueAmount is necessary if you set wantsInsurance

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 - should always be STANDARD and if you ship to Switzerland, or UK it should be DAP

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.

Responses

403

Forbidden

409

Authorized user is not a customer

422

Unprocessable Entity

502

Bad Gateway

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Order has been successfully placed.