curl --request POST \
--url https://panel.sendcloud.sc/api/v3/carriers/dp/finalize-order \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"copy_count": 1
}
'{
"data": {
"copy_count": 1,
"awb_document_url": "/api/v3/parcels/12345/documents/air-waybill",
"next_order_id": "2"
}
}Carrier-specific: Deutsche Post
Finalize a Deutsche Post order
Closes the current open order/box and generates AWB (Air Waybill) documents for all parcels in that box.
How it works:
- As you create Deutsche Post International parcels, they are automatically added to the current box (identified by the current box_number).
- When the box is full or you’re ready to ship, call this endpoint to finalize the box.
- The finalization process:
- Generates a single AWB label that is shared by all parcels in the finalized box
- Attaches the AWB label to all parcels in the box
- Increments the box_number, automatically starting a new box for subsequent parcels
- You can create and finalize multiple boxes throughout the day as needed.
Important notes:
- Each box has its own unique AWB label
- All parcels within a single box share the same AWB label
- The AWB document can be retrieved from any parcel that was in the finalized box
- New parcels created after finalization will be added to the new box
POST
/
carriers
/
dp
/
finalize-order
curl --request POST \
--url https://panel.sendcloud.sc/api/v3/carriers/dp/finalize-order \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"copy_count": 1
}
'{
"data": {
"copy_count": 1,
"awb_document_url": "/api/v3/parcels/12345/documents/air-waybill",
"next_order_id": "2"
}
}Authorizations
HTTPBasicAuthOAuth2ClientCreds
Basic Authentication using API key and secrets is currently the main authentication mechanism.
Body
application/json
Request schema for finalizing a Deutsche Post order.
Number of AWB label copies to generate (1-99)
Required range:
1 <= x <= 99Response
Order finalized successfully
Response schema for finalize order endpoint.
Data schema for finalize order response.
Show child attributes
Show child attributes