Void Shipment
Use this endpoint to void a previously booked shipment.
REST Endpoint
POST /restapi/v1/customers/:customerId/shipments/:bookNumber
Request Content Type
application/json
Request JSON Example
{
"voided": true
}
Explanation of Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
| voided | boolean | true | Must be true (shipments cannot be "un-voided") |
Response Status Code
201 Created
Response Content Type
application/json
Response JSON Example
{
"ok": true
}