Method: GET
Filters are specified at the end of the URL like so: ?{{key}}={{value}}&{{key}}={{value}}
Filter | Description |
---|
client_id | ID of the client. Will show all clients if not specified. |
status | Status ID of the shipment. Will show all statuses if not specified. |
date | Date of the cancelled fulfilments, formatted YYYY-MM-DD. Will show all dates if not specified. |
page | Page number of your query. Will default to 1 if not specified. |
limit | How many results per page. Will default to 100 if not specified. |
Example Response:[
{
"id": 1,
"client_id": "0001",
"order_id": "0001-1565964885-38",
"service": "Courier Next Day",
"pieces": 1,
"service_price": "3.50",
"packaging_price": "1.23",
"date": 1565964885,
"despatch_date": 565965996,
"status": 5,
"invoice_id": "INV-1566814057"
}
]