Get all delivery orders

GET {{base_url}}/delivery-orders

Description

This API endpoint retrieves delivery orders based on various criteria.

API Request:

Headers:

Name	Description
tenantId	A string identifying the tenant.
countryCode	A string representing the country code.

Query Parameters:

Name	Type	Description
pageNumber	integer	The page number for pagination.
pageSize	integer	The size of each page for pagination.
isActive	boolean	Indicates whether the order is active.
status	string	The status of the delivery order.
isAssigned	boolean	Indicates whether the order is assigned.
orderRef	array	An array of order reference strings.
trackingCode	array	An array of tracking code strings.
startDate	string	The start date for filtering orders.
endDate	string	The end date for filtering orders.

Responses:

• 200 OK:

{
  "status": true,
  "statusCode": 0,
  "message": "Delivery orders found.",
  "data": {},
  "errors": []
}

• 400 Bad Request:

{
  "status": false,
  "statusCode": 400,
  "message": "Invalid reference supplied.",
  "errors": [
    {
      "message": "Invalid reference supplied.",
      "descriptiveMessage": "The provided reference is not valid. Please ensure correct values are supplied."
    }
  ]
}

• 404 Not Found:

{
  "status": false,
  "statusCode": 404,
  "message": "Delivery Orders not found.",
  "errors": [
    {
      "message": "Delivery Orders not found.",
      "descriptiveMessage": "No delivery orders were found matching the specified criteria."
    }
  ]
}