Endpoint Information
| Category | API calls |
|---|---|
| Description | Void a shipment |
| Endpoint | https://api.rm-nl.nl/api/rm/void |
| Method | POST |
Request Headers
| Type | Parameter | Required | Default | Example | Description |
|---|---|---|---|---|---|
| string | Content-Type | Required | - | - | The type of content present in the request payload. |
| string | Authorization | Required | - | - | The bearer token used for authentication. |
Request Body Parameters
| Type | Parameter | Required | Default | Example | Description | Carrier |
|---|---|---|---|---|---|---|
| string |
shipmentNumber
shipmentNumber |
Required | - | - | The unique number assigned to the shipment being voided. |
Response: 200
OK
| Type | Parameter | Default | Example | Description |
|---|---|---|---|---|
| boolean |
success
|
true | - | Indicates whether the void operation was successful. |
Response: 400
Bad Request
| Type | Parameter | Default | Example | Description |
|---|---|---|---|---|
| boolean |
success
|
false | - | Indicates whether the void operation was successful. |
| array |
errors
|
- | - | List of errors encountered during the void operation. |
| string |
errors[].errorCode
errorCode |
- | - | Code indicating the specific error encountered during the void operation. |
| string |
errors[].errorDescription
errorDescription |
- | - | Description of the error encountered during the void operation. |
Request Example
{
"shipmentNumber": null
}