Skip to main content
Create an order preparation
curl --request POST \
  --url localhost:///8080/v1/orderPreparations \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_role_on_order": "buyer",
  "instructions": {
    "should_label_packages": true,
    "should_palletise": true,
    "origin_certification_type": "atr",
    "should_certify_commercial_invoices": true,
    "target_pickup_date": 123
  },
  "locations": {
    "preparing_warehouse_id": "<string>",
    "delivery_location_id": "<string>"
  },
  "name": "<string>",
  "owner_in_charge_of_moving_goods_in_fca_export": true,
  "picking_references": [
    "<string>"
  ],
  "commercial_invoice_ids": [
    "<string>"
  ],
  "customer_names_for_whom_order_is_prepared": [
    "<string>"
  ],
  "external_user_ids": [
    "<string>"
  ],
  "freight_method": "air",
  "incoterm": "cfr",
  "hazardous_details": "UN1845 - Dry ice",
  "on_behalf_of_client_id": "<string>",
  "on_behalf_of_user_id": "<string>",
  "refrigerated_details": "+2°C/+8°C",
  "total_commercial_invoice_amount": 123,
  "total_commercial_invoice_amount_currency": "AED",
  "target_pickup_date": "2021-10-11",
  "packaging_done_at": "2021-10-11"
}
'
{
  "reference": "BIO-0008"
}

Body

application/json
​
client_role_on_order
enum<string>
required
Available options:
buyer,
seller
​
instructions
object
required
​
locations
object
required
​
name
string
required
​
owner_in_charge_of_moving_goods_in_fca_export
boolean
required
​
picking_references
string[]
required
​
commercial_invoice_ids
string[]
​
customer_names_for_whom_order_is_prepared
string[]
​
external_user_ids
string[]
​
freight_method
enum<string>
Available options:
air,
ocean,
rail,
truck
​
incoterm
enum<string>
Available options:
cfr,
cif,
cip,
cpt,
dap,
dat,
ddp,
dpu,
exw,
fas,
fca,
fob
​
hazardous_details
string
Example:

"UN1845 - Dry ice"

​
on_behalf_of_client_id
string
​
on_behalf_of_user_id
string
​
refrigerated_details
string
Example:

"+2°C/+8°C"

​
total_commercial_invoice_amount
number
​
total_commercial_invoice_amount_currency
enum<string>
Available options:
AED,
AUD,
BHD,
BRL,
CAD,
CHF,
CNY,
EUR,
GBP,
HKD,
IDR,
INR,
JPY,
KRW,
KWD,
MXN,
MYR,
NZD,
PLN,
SEK,
SGD,
THB,
TWD,
USD,
XOF,
XPF,
ZAR
​
target_pickup_date
string
Example:

"2021-10-11"

​
packaging_done_at
string
Example:

"2021-10-11"

Response

Order preparation created

Order preparation created

​
reference
string