Skip to main content

Update Delivery Order Payment Status

PATCH /tms/delivery-orders/{deliveryOrderUuid}/update-payment-status

Description​

This endpoint is used to update the payment status of a delivery order.

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​

{
  "paymentStatus": "string"
}

Responses​

Success Response (200)​

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

Response Fields​

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

Example​

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

Invalid Request (400)​

The Invalid Request (400) is returned when the request is invalid. This response indicates an issue with the request format or missing/incorrect parameters.

Delivery Order Not Found (404)​

The Delivery Order Not Found (404) is returned when the specified delivery order cannot be found. This response indicates that the provided deliveryOrderUuid does not correspond to any existing delivery order.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request PATCH \ 
 --url  /tms/delivery-orders/{deliveryOrderUuid}/update-payment-status \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

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