Skip to main content

Get Delivery Orders

GET /tms/delivery-orders

Description​

This endpoint retrieves all delivery orders based on the specified filters. It supports various query parameters to refine the search and can return delivery orders based on different criteria, such as status, date range, and other attributes.

Parameters​

  • tenantId (string, header, required): The ID of the tenant.
  • countryCode (string, header, required): The code representing the country.

Query Parameters​

  • pageNumber (integer, query, optional): The page number of the results to retrieve.
  • pageSize (integer, query, optional): The number of results per page.
  • isActive (boolean, query, optional): Filter results by active status.
  • status (array[string], query, optional): Filter results by delivery order status.
  • isAssigned (boolean, query, optional): Filter results by assignment status.
  • orderRef (array[string], query, optional): Filter results by order references.
  • trackingCode (array[string], query, optional): Filter results by tracking codes.
  • startDate (string, query, optional): Filter results by start date (ISO 8601 format).
  • endDate (string, query, optional): Filter results by end date (ISO 8601 format).
  • clientId (array[string], query, optional): Filter results by client IDs.
  • vehicleId (array[string], query, optional): Filter results by vehicle IDs.
  • driverUserId (array[string], query, optional): Filter results by driver user IDs.
  • spaceId (array[string], query, optional): Filter results by space IDs.
  • serviceType (array[string], query, optional): Filter results by service types.
  • paymentMode (array[string], query, optional): Filter results by payment modes.
  • paymentStatus (array[string], query, optional): Filter results by payment statuses.
  • shipmentId (array[string], query, optional): Filter results by shipment IDs.
  • asset (array[string], query, optional): Filter results by assets.
  • deliveryAssistant (array[string], query, optional): Filter results by delivery assistants.
  • cargoType (array[string], query, optional): Filter results by cargo types.
  • invoiceNumber (array[string], query, optional): Filter results by invoice numbers.
  • searchValue (string, query, optional): Filter results by search value.
  • source (array[string], query, optional): Filter results by source.
  • businessId (array[string], query, optional): Filter results by business IDs.

Responses​

200 OK​

  • Description: Found the delivery orders.
  • Media Type: Controls Accept header.

Example Value​

{
  "status": true,
  "statusCode": 0,
  "message": "string",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

400 Bad Request​

Description: Invalid reference supplied.

404 Not Found​

Description: Resource not found.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /tms/delivery-orders \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!