Skip to main content
POST
Create an allocation
Allocate a declaration cleared elsewhere. This endpoint creates EXTERNAL allocations only.

Path Parameters

string
required
Shipment Public ID (shp_…).

Headers

string
Unique key that makes retrying this request safe for 24 hours. A UUID is recommended.

Body

string
required
Procedure type of the clearance, for example H1.
string
required
Customs declaration type, for example IM.
string
required
Customs declaration number / MRN.
integer
required
Packages allocated from remaining stock.
number
required
Gross weight allocated in kilograms.
string
default:"X"
Customs document type. Defaults to X.
string
HAWB Public ID (hawb_…). Omit to allocate to the shipment master AWB.
JSON Payload