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.

Body Params

product

string

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

Incoterm - should always be STANDARD and if you ship to Switzerland, or UK it should be DAP

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

Response body

object

data

object

required

string

required

The id of product.

product

string

required

The product. Possible values: DIRECT, EXPRESS, EXPRESS_8, EXPRESS_10, EXPRESS_12, EXPRESS_16, FIX, FIX_8, FIX_10, FIX_12, FIX_16, STANDARD.

DIRECT EXPRESS EXPRESS_8 EXPRESS_10 EXPRESS_12 EXPRESS_16 FIX FIX_8 FIX_10 FIX_12 FIX_16 STANDARD

truckType

string

Truck type of order. Possible values DIRECT_BUS_PLANE, DIRECT_BUS_PLANE_XXL, DIRECT_TRUCK_7_5, DIRECT_TRUCK_12, DIRECT_TRUCK_40

DIRECT_BUS_PLANE DIRECT_BUS_PLANE_XXL DIRECT_TRUCK_7_5 DIRECT_TRUCK_12 DIRECT_TRUCK_40

price

object

required

priceStandard

object

required

pickupOn

date-time

required

pickupAtFrom

date-time

required

pickupAtUntil

date-time

required

runtime

object

required

delivery

object

required

costItems

array of objects

required

costItems*

object

description

string

required

Description for cost item.

type

string

required

Cost item type. Possible values: DANGEROUS_GOODS, PRIVATE_CUSTOMER, IMPORT_DUTIES, CONTACT_BEFORE_PICKUP, TAIL_LIFT_TRUCK, PREMIUM_DELIVERY, CONTACT_BEFORE_DELIVERY, PHONE_CALL_FROM_DRIVER_BEFORE_DELIVERY, PHONE_CALL_FROM_DRIVER_BEFORE_PICKUP, DELIVERY_WITHOUT_CONSIGNEE_PRESENCE, TRANSPORT_INSURANCE, EXPORT_DECLARATION, ADDITIONAL_PRODUCTS, PALLET_EXCHANGE, CLIMATE_NEUTRAL_SURCHARGE, SHIPMENT, GENERAL_MARGIN, CUSTOMIZED_MARGIN, ACTUAL_COST_CORRECTION, FUEL_SURCHARGE, CUSTOMER_DISCOUNT, COUPON.

DANGEROUS_GOODS PRIVATE_CUSTOMER IMPORT_DUTIES CONTACT_BEFORE_PICKUP TAIL_LIFT_TRUCK PREMIUM_DELIVERY CONTACT_BEFORE_DELIVERY PHONE_CALL_FROM_DRIVER_BEFORE_DELIVERY PHONE_CALL_FROM_DRIVER_BEFORE_PICKUP DELIVERY_WITHOUT_CONSIGNEE_PRESENCE TRANSPORT_INSURANCE EXPORT_DECLARATION ADDITIONAL_PRODUCTS PALLET_EXCHANGE CLIMATE_NEUTRAL_SURCHARGE SHIPMENT GENERAL_MARGIN CUSTOMIZED_MARGIN ACTUAL_COST_CORRECTION FUEL_SURCHARGE CUSTOMER_DISCOUNT COUPON

subtype

string

required

Cost item subtype. Possible values: PICKUP_ADVISE, DELIVERY_ADVISE, PHONE_CALL_FROM_DRIVER_BEFORE_PICKUP, PHONE_CALL_FROM_DRIVER_BEFORE_DELIVERY, TAIL_LIFT, TAIL_LIFT_PICKUP, TAIL_LIFT_DELIVERY, DELIVERY_WHITOUT_CONSIGNEE_PRESENCE, PREMIUM_DELIVERY, PRIVATE_CONSIGNEE, EXPRESS_16, EXPRESS_12, EXPRESS_10, EXPRESS_8, FIX_16, FIX_12, FIX_10, FIX_8, PICKUP_BEFORE_12, PICKUP_AFTER_12, DELIVERY_BEFORE_12, DELIVERY_AFTER_12, EXPORT_DECLARATION, IMPORT_DECLARATION.

PICKUP_ADVISE DELIVERY_ADVISE PHONE_CALL_FROM_DRIVER_BEFORE_PICKUP PHONE_CALL_FROM_DRIVER_BEFORE_DELIVERY TAIL_LIFT TAIL_LIFT_PICKUP TAIL_LIFT_DELIVERY DELIVERY_WHITOUT_CONSIGNEE_PRESENCE PREMIUM_DELIVERY PRIVATE_CONSIGNEE EXPRESS_16 EXPRESS_12 EXPRESS_10 EXPRESS_8 FIX_16 FIX_12 FIX_10 FIX_8 PICKUP_BEFORE_12 PICKUP_AFTER_12 DELIVERY_BEFORE_12 DELIVERY_AFTER_12 EXPORT_DECLARATION IMPORT_DECLARATION

price

object

required

co2Emission

object

required

CO2Emission details.

reference

string

required

Reference of order.

links

object

rel

string

Relation name

method

string

Http method like: GET, POST, PUT, DELETE.

description

string

Description for link.

href

string

Href for relation.

403

Forbidden

409

Authorized user is not a customer

422

Unprocessable Entity

502

Bad Gateway

Language

Credentials

Header

URL


xxxxxxxxxx
32
1
curl --request POST \
2
     --url https://api-sandbox.cargoboard.com/v1/orders \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "product": "DIRECT",
8
  "shipper": {
9
    "address": {
10
      "countryCode": "AL"
11
    },
12
    "neutralData": {
13
      "countryCode": "AL"
14
    }
15
  },
16
  "consignee": {
17
    "address": {
18
      "countryCode": "AL"
19
    },
20
    "neutralData": {
21
      "countryCode": "AL"
22
    },
23
    "isPrivateCustomer": false,
24
    "wantsContactBeforeDelivery": false,
25
    "wantsPhoneCallFromDriverBeforeDelivery": false,
26
    "wantsDeliveryWithoutConsigneePresence": false
27
  },
28
  "wantsExportDeclaration": false,
29
  "wantsClimateNeutralShipment": true,

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

application/json

201Order has been successfully placed.