Skip to main content
PUT
/
orders
/
{order_id}
/
extended
curl --request PUT \
  --url https://sandbox.cashfree.com/pg/orders/{order_id}/extended \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "shipment_details": [
    {
      "tracking_company": "DHL",
      "tracking_urls": [
        "https://dhl.com/track/123456"
      ],
      "tracking_numbers": [
        "TRACK123456"
      ]
    }
  ]
}
'
{
  "$ref": "#/components/examples/update_order_extended_data_entity_list_example/value/0"
}

Authorizations

​
x-client-id
string
header
required

Client app ID. You can find your app id in the Merchant Dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

​
x-api-version
string
default:2023-08-01
required

API version to be used. Format is in YYYY-MM-DD API version to be used

​
x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

​
x-idempotency-key
string<UUID>

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Path Parameters

​
order_id
string
required

The id which uniquely identifies your order

Body

application/json

Request Body to Update extended data related to order

Request Body to Update extended data related to order

​
shipment_details
ShipmentDetails · object[]
required

Shipment details, such as the tracking company, tracking number, and tracking URLs, associated with the shipping of an order. Either shipment_details or order_delivery_status is required.

​
order_delivery_status
OrderDeliveryStatus · object

Order delivery Status associated with order.

Example:
{ "status": "SHIPPED", "reason": "shipped" }

Response

OK

The complete update order extended data entity

​
cf_order_id
string

unique id generated by cashfree for your order

​
order_id
string

order_id sent during the api request

​
shipment_details
ShipmentDetails · object[]
​
order_delivery_status
OrderDeliveryStatus · object

Order delivery Status associated with order.