Get Delivery Order Logs

GET /tms/delivery-orders/logs

Description

This endpoint retrieves all delivery order logs based on the provided filters. You can filter logs by various parameters such as tenant ID, country code, status, dates, and more. It supports pagination and filtering by multiple criteria to help you find specific delivery orders.

Parameters

• tenantId (string, header, required): The ID of the tenant.

• countryCode (string, header, required): The country code for the delivery orders.

• pageNumber (integer, query, optional): The page number for pagination.

• pageSize (integer, query, optional): The number of items per page.

• isActive (boolean, query, optional): Filter by active status of the delivery orders.

• status (array[string], query, optional): Filter by the status of the delivery orders.

• isAssigned (boolean, query, optional): Filter by assignment status.

• orderRef (array[string], query, optional): Filter by order references.

• trackingCode (array[string], query, optional): Filter by tracking codes.

• startDate (string, query, optional): Filter by start date (in ISO 8601 format).

• endDate (string, query, optional): Filter by end date (in ISO 8601 format).

• clientId (array[string], query, optional): Filter by client IDs.

• vehicleId (array[string], query, optional): Filter by vehicle IDs.

• driverUserId (array[string], query, optional): Filter by driver user IDs.

• serviceType (array[string], query, optional): Filter by service types.

• paymentMode (array[string], query, optional): Filter by payment modes.

• paymentStatus (array[string], query, optional): Filter by payment status.

• shipmentId (array[string], query, optional): Filter by shipment IDs.

• asset (array[string], query, optional): Filter by assets.

• deliveryAssistant (array[string], query, optional): Filter by delivery assistants.

• tenantIds (array[string], query, optional): Filter by multiple tenant IDs.

• cargoType (array[string], query, optional): Filter by cargo types.

• invoiceNumber (array[string], query, optional): Filter by invoice numbers.

• searchValue (string, query, optional): Filter by search value.

• source (array[string], query, optional): Filter by source.

• businessId (array[string], query, optional): Filter by business IDs.

Responses

• 200 OK
  • 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.