Update Delivery Order

PUT /tms/delivery-orders/{deliveryOrderUuid}

Description

This endpoint is used to update the details of an existing delivery order. The update process involves submitting various details such as the updated contact information, pickup and drop-off locations, and order status.

Parameters

• tenantId (string, header, required): The ID of the tenant.
• countryCode (string, header, required): The country code.
• deliveryOrderUuid (string, path, required): The UUID of the delivery order.

Request Body

• Media Type: application/json

Example Value

{
  "updatedByEmail": "string",
  "pickupLocation": {
    "latitude": 0,
    "longitude": 0,
    "address": "string",
    "userId": "string",
    "city": "string"
  },
  "dropOffLocation": {
    "latitude": 0,
    "longitude": 0,
    "address": "string",
    "userId": "string",
    "city": "string"
  },
  "dropOffContact": "string",
  "pickupContact": "string",
  "pickupEmail": "string",
  "dropOffEmail": "string",
  "shippingFee": 0,
  "items": [
    {
      "name": "string",
      "paid": true,
      "price": 1,
      "quantity": 1,
      "weight": 0,
      "imageUrl": "string"
    }
  ],
  "orderStatus": "string",
  "serviceType": "string",
  "paymentMode": "string",
  "issue": "string",
  "comments": "string",
  "numberOfAssets": 0,
  "serviceCharge": 0,
  "shipmentId": "string",
  "asset": "string",
  "orderCapacity": 0,
  "clientInvoiceImageUrl": "string",
  "cargoType": "string",
  "invoiceNumber": "string",
  "businessId": "string",
  "amountPaid": 0,
  "deliveryAssistants": [
    {
      "name": "string",
      "fee": 0
    }
  ]
}

Responses

Success Response (200)

The Success Response (200) is returned when the delivery order is successfully updated. This response indicates the success of the operation and provides additional details.

Response Fields

Field	Type	Description
status	boolean	Indicates the success of the delivery order update request.
statusCode	integer	Numeric code representing the status of the response.
message	string	A message indicating the outcome of the operation.
data	object	Contains the updated address details.
errors	array	An array of objects providing details about any errors encountered during the request.

Example

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

Invalid Request Response (400)

The Invalid Request Response (400) is returned when the request is invalid. This response indicates that there was an issue with the request parameters or body.

Resource Not Found Response (404)

The Resource Not Found Response (404) is returned when the specified delivery order could not be found. This response indicates that the delivery order UUID does not exist.