Error
A valid request URL is required to generate request examples{
"insertShipmentsOne": {
"carrier": {
"id": 123,
"name": "<string>"
},
"customer": {
"id": 123,
"name": "<string>"
},
"dueDate": "<unknown>",
"id": 123,
"plannedDepartureDate": null,
"reference": "<string>",
"site": {
"id": 123,
"name": "<string>"
}
}
}Shipments
Create a shipment
Creates a shipment.
POST
/
shipments
Error
A valid request URL is required to generate request examples{
"insertShipmentsOne": {
"carrier": {
"id": 123,
"name": "<string>"
},
"customer": {
"id": 123,
"name": "<string>"
},
"dueDate": "<unknown>",
"id": 123,
"plannedDepartureDate": null,
"reference": "<string>",
"site": {
"id": 123,
"name": "<string>"
}
}
}Creates a shipment.
Request body
{
"reference": "EXP-0042",
"clientOrganizationId": 3,
"siteId": 1,
"dueDate": "2026-08-28",
"plannedDepartureDate": "2026-08-27T08:00:00+02:00",
"carrierOrganizationId": 9
}
Headers
API token from your Bonx space.
Query Parameters
"reference" is required (enter it either in parameters or request body)
Body
application/json
Query parameters can also be provided in the request body as a JSON object
Response
200 - application/json
Response
Show child attributes
Show child attributes
Was this page helpful?