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

Path Parameters

​
reference
string
required

Response

Order preparation found

Order preparation found

​
client_role_on_order
enum<string>

Role of the client on this order (buyer or seller)

Available options:
buyer,
seller
​
commercial_invoice_ids
string[]

List of commercial invoice IDs to include in the request

​
customer_names_for_whom_order_is_prepared
string[]

Names of customers for whom the order is being prepared

​
external_user_ids
string[]

IDs of external users who should have access

​
freight_method
enum<string>

Mode of transportation for the shipment

Available options:
air,
ocean,
rail,
truck
​
hazardous_details
string

Details about the hazardous nature of the goods in the OP

Example:

"UN1845 - Dry ice"

​
incoterm
enum<string>

International commercial terms for the shipment

Available options:
cfr,
cif,
cip,
cpt,
dap,
dat,
ddp,
dpu,
exw,
fas,
fca,
fob
​
instructions
object

Packaging and documentation instructions

​
locations
object

Warehouse and delivery locations

​
name
string

Name of the order preparation request

​
on_behalf_of_client_id
string

Client ID if creating on behalf of another client

​
on_behalf_of_user_id
string

User ID if creating on behalf of another user

​
owner_in_charge_of_moving_goods_in_fca_export
boolean

Whether the owner is responsible for moving goods in FCA export

​
picking_references
string[]

Picking references for the goods to prepare

​
refrigerated_details
string

Temperature instruction details for the OP

Example:

"+2°C/+8°C"

​
total_commercial_invoice_amount
number

Total amount from all commercial invoices

​
total_commercial_invoice_amount_currency
enum<string>

Currency of the total commercial invoice amount

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