Skip to main content

Activate or Deactivate Delivery Orders

PUT /tms/delivery-orders/{deliveryOrderUuid}/activate

Description​

This endpoint is used to activate or deactivate delivery orders by specifying the delivery order UUID and the desired active status.

Parameters​

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

Request Body​

  • Media Type: application/json

Example Value​

{
  "userId": "string",
  "isActive": true
}

Responses​

Success Response (200)​

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

Response Fields​

FieldTypeDescription
statusbooleanIndicates the success of the delivery order activation or deactivation request.
statusCodeintegerNumeric code representing the status of the response (e.g., 0 for success).
messagestringA message indicating the outcome of the operation.
dataobjectContains any additional data related to the response.
errorsarrayAn array of objects providing details about any errors encountered during the request.

Example​

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

Media Type​

application/json: The response is in JSON format.

Example Value​

Schema:

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

Error Responses​

400 Invalid reference supplied​

This response indicates that an invalid reference was provided in the request.

404 Resource not found​

This response indicates that the specified resource could not be found.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request PUT \ 
 --url  /tms/delivery-orders/{deliveryOrderUuid}/activate \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

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