Skip to main content
POST
/
api
/
offloads
Report offloads
curl --request POST \
  --url https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/offloads \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "awbNumber": "15712345678",
  "flightId": "QR001-20240101",
  "reason": "capacity",
  "pieces": 2,
  "weight": 100,
  "notes": "Insufficient capacity on flight"
}'
{
  "offloadId": "offload-123",
  "awbNumber": "15712345678",
  "status": "reported"
}
Report offloaded or short-shipped pieces.

​
Reference Documentation

For more information on offload procedures, please refer to:

Authorizations

​
Authorization
string
header
required

Body

application/json
​
awbNumber
string
required
Example:

"15712345678"

​
flightId
string
required
Example:

"QR001-20240101"

​
reason
enum<string>
required
Available options:
capacity,
documentation,
security,
other
Example:

"capacity"

​
pieces
integer
Example:

2

​
weight
number
Example:

100

​
notes
string
Example:

"Insufficient capacity on flight"

Response

201 - application/json

Offload reported

​
offloadId
string
Example:

"offload-123"

​
awbNumber
string
Example:

"15712345678"

​
status
string
Example:

"reported"

⌘I