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"
      ]
    }
  ]
}'

Authorizations

ā€‹
x-client-id
string
headerrequired

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

ā€‹
x-client-secret
string
headerrequired

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

Headers

ā€‹
x-api-version
string
default: 2023-08-01required

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

ā€‹
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

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

ā€‹
shipment_details
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
object

Order delivery Status associated with order.

Response

200 - application/json

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
object[]
ā€‹
order_delivery_status
object

Order delivery Status associated with order.

Was this page helpful?

Get Order ExtendedSubmit or Resend OTP