Skip to main content

Assign Orders to Vehicle

PATCH /tms/delivery-orders/assign-vehicle

Description​

Assign delivery orders to a specific vehicle and driver.

Parameters​

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

Request Body​

  • Media Type: application/json

Example Value​

{
  "orderUuId": [
    "string"
  ],
  "driverUserId": "string",
  "vehicleId": "string"
}

Responses​

Success Response (200)​

The Success Response (200) is returned when the orders are successfully assigned to the vehicle. This response indicates the success of the operation and provides additional details.

Response Fields​

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

Example​

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

Media Type​

application/json: The response is in JSON format.

Error Responses​

400 Invalid Reference Supplied​

This response is returned when an invalid reference is supplied.

404 Resource Not Found​

This response is returned when the specified resource is not found.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

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

RESPONSE

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