Skip to main content

Get Total Shipping Fee

GET /tms/delivery-orders/{driverUserId}/get-total-shipping-fee

Description​

This endpoint retrieves the total shipping fee for a specific delivery order associated with a driver.

Parameters​

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

Responses​

Success Response (200)​

The Success Response (200) is returned when the total shipping fee is successfully retrieved. This response indicates the success of the operation and provides additional details.

Response Fields​

FieldTypeDescription
statusbooleanIndicates the success of the request.
statusCodeintegerNumeric code representing the status of the response (e.g., 0 for success).
messagestringA message indicating the outcome of the operation.
dataobjectContains the retrieved shipping fee details.
errorsarrayAn array of objects providing details about any errors encountered during the request.

Example Value​

JSON:

{
  "status": true,
  "statusCode": 0,
  "message": "Total shipping fee retrieved successfully",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

Media Type​

application/json: The response is in JSON format.

Error Responses​

Invalid Driver ID Reference (400)​

The Invalid Driver ID Reference (400) response is returned when an invalid driver ID is supplied.

Resource Not Found (404)​

The Resource Not Found (404) response is returned when the specified resource cannot be found.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /tms/delivery-orders/{driverUserId}/get-total-shipping-fee \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

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