Void Freight

• Endpoint
• Request
• Request Example
• Response
• Response Example

This request is used to void previously created freight orders

Endpoint

Request

Field | Required | Type | Description

- | : | :- | shipment_order_id | Yes | Integer | This field is used to identify the shipment (can be obtained from ship method).

Request Example

{
    "shipment_order_id": 12345678
}

Response

Field | Type | Description

- | : | success | Boolean | true or false message | String | Message data | Object | Shipment order id container +shipment_order_id | Integer | This is the id of your shipment +void_fee | Integer | If a void fee is charged it will be shown here

Response Examples

Successful

{
    "success": true,
    "data": {
        "shipment_order_id": 123123123,
        "void_fee": 0
    },
    "message": "Shipment Order successfully voided"
}

Failed

{
    "success": false,
    "message": "Shipment Order does not exist"
}