GET
/
orders
/
{order_id}
/
extended
curl --request GET \
  --url https://sandbox.cashfree.com/pg/orders/{order_id}/extended \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
  "cf_order_id": "2149460581",
  "order_id": "order_3242Tq4Edj9CC5RDcMeobmJOWOBJij",
  "order_amount": 22,
  "order_currency": "INR",
  "created_at": "2023-08-11T18:02:46+05:30",
  "charges": {
    "shipping_charges": 5,
    "cod_handling_charges": 10
  },
  "customer_details": {
    "customer_id": "409128494",
    "customer_name": "Aditya Keshri",
    "customer_email": "pmlpayme@ntsas.com",
    "customer_phone": "9876543210",
    "customer_uid": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10"
  },
  "shipping_address": {
    "name": "Saurav Singh",
    "address_line_one": "MK Building",
    "address_line_two": "Test Address",
    "country": "India",
    "country_code": "IN",
    "state": "Karnataka",
    "state_code": "KA",
    "city": "Bangalore",
    "pin_code": "560034",
    "phone": "+91 1118911189",
    "email": "test@cashfree.com"
  },
  "billing_address": {
    "name": "Saurav Singh",
    "address_line_one": "MK Building",
    "address_line_two": "Test Address",
    "country": "India",
    "country_code": "IN",
    "state": "Karnataka",
    "state_code": "KA",
    "city": "Bangalore",
    "pin_code": "560034",
    "phone": "+91 1118911189",
    "email": "test@cashfree.com"
  },
  "cart": {
    "name": "test",
    "items": [
      {
        "item_id": "26",
        "item_name": "Sample Product",
        "item_description": "item-description",
        "item_tags": [
          "1",
          "2"
        ],
        "item_details_url": "http://cashfree.com",
        "item_image_url": "http://cashfree.com",
        "item_original_unit_price": "1",
        "item_discounted_unit_price": "1",
        "item_quantity": 1,
        "item_currency": "INR"
      },
      {
        "item_id": "35",
        "item_name": "Sample Product",
        "item_description": "item-description",
        "item_tags": [
          "1",
          "2"
        ],
        "item_details_url": "http://cashfree.com",
        "item_image_url": "http://cashfree.com",
        "item_original_unit_price": "1",
        "item_discounted_unit_price": "1",
        "item_quantity": 1,
        "item_currency": "INR"
      }
    ]
  },
  "offer": {
    "offer_id": "d2b430fb-1afe-455a-af31-66d00377b29a",
    "offer_status": "active",
    "offer_meta": {
      "offer_title": "some title",
      "offer_description": "some offer description",
      "offer_code": "CFTESTOFFER",
      "offer_start_time": "2023-03-21T08:09:51Z",
      "offer_end_time": "2023-03-29T08:09:51Z"
    },
    "offer_tnc": {
      "offer_tnc_type": "text",
      "offer_tnc_value": "TnC for the Offer."
    },
    "offer_details": {
      "offer_type": "DISCOUNT_AND_CASHBACK",
      "discount_details": {
        "discount_type": "flat",
        "discount_value": "10",
        "max_discount_amount": "10"
      },
      "cashback_details": {
        "cashback_type": "percentage",
        "cashback_value": "20",
        "max_cashback_amount": "150"
      }
    },
    "offer_validations": {
      "min_amount": 10,
      "payment_method": {
        "wallet": {
          "issuer": "paytm"
        }
      },
      "max_allowed": 2
    }
  }
}

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 in the merchant dashboard.

Headers

​
x-api-version
string
default:2025-01-01
required

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

​
x-request-id
string

Request ID for the API call. It can be used to resolve technical issues. Include this in your tech-related queries to Cashfree.

​
x-idempotency-key
string

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

Path Parameters

​
order_id
string
required

The id which uniquely identifies your order

Response

200
application/json
OK

The complete 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

​
order_amount
number
​
order_currency
string

Currency of the order. Example INR

​
created_at
string

When the order was created at cashfree's server

Example:

"2022-08-16T14:45:38+05:30"

​
charges
object

Charges accociated with the order

Example:
{
  "shipping_charges": 5,
  "cod_handling_charges": 10
}
​
customer_details
object

Recent Customer details associated with the order.

Example:
{
  "customer_id": "7112AAA812234",
  "customer_email": "john@cashfree.com",
  "customer_phone": "9908734801",
  "customer_name": "John Doe",
  "customer_uid": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10"
}
​
shipping_address
object

Address associated with the customer.

Example:
{
  "name": "Aditya Keshri",
  "address_line_one": "MK Building",
  "address_line_two": "Test Address",
  "country": "India",
  "country_code": "IN",
  "state": "Karnataka",
  "state_code": "KA",
  "city": "Bangalore",
  "pin_code": "560034",
  "phone": "+91 1118911189",
  "email": "test@cashfree.com"
}
​
billing_address
object

Address associated with the customer.

Example:
{
  "name": "Aditya Keshri",
  "address_line_one": "MK Building",
  "address_line_two": "Test Address",
  "country": "India",
  "country_code": "IN",
  "state": "Karnataka",
  "state_code": "KA",
  "city": "Bangalore",
  "pin_code": "560034",
  "phone": "+91 1118911189",
  "email": "test@cashfree.com"
}
​
cart
object

The cart details that are necessary like shipping address, billing address and more.

​
offer
object

Details of the offer which got applied to the paid order.

Was this page helpful?