List Shipments
List Shipments
Introduction
This API document is a draft
You can list your shipments based on the following filters and pagination.
GET /shipmentsFilters
DateFrom “string” example: “2023-01-06T11:46:18.031Z”
DateTo “string” example: “2023-01-06T11:46:18.031Z”
Status “string” One of or many from this list*:
Not Printed, Printed, Manifested, Awaiting Collection, Enroute to Depot, At the Depot, On Vehicle For Delivery, Unknown, On Hold, Lost, Destroyed, Not Scanned, Delivered to Receiver, Returned to Sender, Failed, Cancelled
Pagination
Page “int32” - defaults to 1 if not present
ItemsPerPage “int32” - defaults to 100 if not present
Display order
OrderByDate “string” one of: “NewestFirst, OldestFirst” - defaults to NewestFirst if not present.
Example Requests
GET /shipments?DateFrom=2023-01-01&DateTo=2023-01-06&Page=1& ItemsPerPage=20&OrderByDate=NewestFirstExample Responses
HTTP 200
{
"totalItems": 0,
"totalPieces": 0,
"items": [
{
"id": 0,
"shipmentNo": "string",
"createdOn": "2023-01-06T14:49:52.397Z",
"shipping": "2023-01-06T14:49:52.397Z",
"shipper": "string",
"reference": "string",
"deliveryAddress": "string",
"carrier": "string",
"carrierService": "string",
"pieces": 0,
"weight": 0,
"weightMeasurement": "string",
"status": "string",
"trackingDescription": "string",
"statusDateTime": "2023-01-06T14:49:52.397Z",
"statusLocation": "string",
"statusSignatory": "string"
}
]
} HTTP 400, 404
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
} Last updated on