Order Details
This API will provide the Order details by using Entity ID.
GET
{{Base_url}}/rest/V1/orders/238332
This API endpoint (/rest/V1/orders/{entity_id}
) provides comprehensive information about a specific order, including customer details, order totals, item details, payment methods, and shipping information.
curl --location '{{Base_url}}/rest/V1/orders/238332' \
--header 'Authorization: Bearer eyJraWQiOiIxIiwiYWxnIjoiSFMyNTYifQ.eyJ1aWQiOjU1LCJ1dHlwaWQiOjIsImlhdCI6MTczNTgyODExNywiZXhwIjoxNzM1ODMxNzE3fQ.R56VpqDlvupF1uThmJSM1t7R4z5cLnH3QqsMl1q-hsk' \
--header 'Cookie: PHPSESSID=fub7nl27col74oap3tmu5b268q; private_content_version=5ab80b7def0c212f723edead3c971a19'
Response
{
"base_currency_code": "INR",
"base_discount_amount": 0,
"base_grand_total": 1018,
"base_shipping_amount": 0,
"base_subtotal": 1018,
"base_tax_amount": 0,
"base_total_due": 1018,
"billing_address_id": 462794,
"created_at": "2025-01-02 04:14:17",
"customer_email": "qa@zrpl.co.in",
"customer_firstname": "Surya",
"customer_group_id": 1,
"customer_id": 980,
"customer_is_guest": 0,
"customer_lastname": "U",
"customer_note_notify": 0,
"discount_amount": 0,
"email_sent": 0,
"entity_id": 238332,
"grand_total": 1018,
"increment_id": "14000007501",
"is_virtual": 0,
"order_currency_code": "INR",
"protect_code": "a5046f3075f34f5b59c074f9e32662de",
"shipping_amount": 0,
"shipping_description": "Flat Rate - Fixed",
"state": "new",
"status": "processing",
"store_currency_code": "INR",
"store_id": 14,
"store_name": "ZEPP SPP\nZEPP-SPP\nZEPP Store view",
"subtotal": 1018,
"subtotal_incl_tax": 1018,
"tax_amount": 0,
"total_due": 1018,
"total_item_count": 1,
"total_qty_ordered": 1,
"updated_at": "2025-01-02 14:30:53",
"weight": 1,
"items": [
{
"amount_refunded": 0,
"base_amount_refunded": 0,
"base_cost": 0,
"base_discount_amount": 0,
"base_discount_invoiced": 0,
"base_original_price": 1015,
"base_price": 1018,
"base_price_incl_tax": 1018,
"base_row_invoiced": 0,
"base_row_total": 1018,
"base_tax_amount": 0,
"base_tax_invoiced": 0,
"created_at": "2025-01-02 14:30:53",
"discount_amount": 1018,
"discount_invoiced": 0,
"discount_percent": 1018,
"free_shipping": 0,
"is_virtual": 0,
"item_id": 239851,
"name": "iFrogz Audio- Ear Pollution Plugz with Mic - Blue",
"no_discount": 0,
"order_id": 238332,
"original_price": 1018,
"price": 1018,
"price_incl_tax": 1018,
"product_id": 1,
"product_type": "simple",
"qty_backordered": 0,
"qty_canceled": 0,
"qty_invoiced": 0,
"qty_ordered": 1,
"qty_refunded": 0,
"qty_shipped": 0,
"row_invoiced": 0,
"row_total": 0,
"row_total_incl_tax": 0,
"row_weight": 0,
"sku": "IFPZMB-BL0",
"store_id": 28,
"tax_amount": 0,
"tax_invoiced": 0,
"tax_percent": 0,
"updated_at": "2025-01-02 14:30:53",
"weight": 0,
"extension_attributes": {
"itemized_taxes": []
},
"base_row_total_incl_tax": 1018
}
],
"billing_address": {
"address_type": "billing",
"city": "Bengaluru",
"company": "ZRPL",
"country_id": "IN",
"email": "qa@zrpl.co.in",
"entity_id": 462794,
"firstname": "Surya",
"lastname": "U",
"parent_id": 238332,
"postcode": "560032",
"region": "Karnataka",
"region_code": "Karnataka",
"region_id": 19,
"street": [
"Street 1",
"Street 2"
],
"telephone": "1234567890"
},
"payment": {
"account_status": null,
"additional_information": [],
"cc_last4": null,
"entity_id": 238172,
"method": "razorpay",
"parent_id": 238332
},
"status_histories": [
{
"comment": "This is a test comment",
"created_at": "2025-01-02 14:30:53",
"entity_id": 557226,
"is_customer_notified": 0,
"is_visible_on_front": 0,
"parent_id": 238332,
"status": "processing"
}
],
"extension_attributes": {
"shipping_assignments": [
{
"shipping": {
"address": {
"address_type": "shipping",
"city": "Bengaluru",
"company": "ZRPL",
"country_id": "IN",
"customer_address_id": 2,
"email": "qa@zrpl.co.in",
"entity_id": 462795,
"firstname": "Surya",
"lastname": "U",
"parent_id": 238332,
"postcode": "560032",
"region": "Karnataka",
"region_code": "Karnataka",
"region_id": 19,
"street": [
"HSR Layout",
"Street 2"
],
"telephone": "1234567890"
},
"method": "flatrate_flatrate",
"total": {
"base_shipping_amount": 0,
"shipping_amount": 0
}
},
"items": [
{
"amount_refunded": 0,
"base_amount_refunded": 0,
"base_cost": 0,
"base_discount_amount": 0,
"base_discount_invoiced": 0,
"base_original_price": 1015,
"base_price": 1018,
"base_price_incl_tax": 1018,
"base_row_invoiced": 0,
"base_row_total": 1018,
"base_tax_amount": 0,
"base_tax_invoiced": 0,
"created_at": "2025-01-02 14:30:53",
"discount_amount": 1018,
"discount_invoiced": 0,
"discount_percent": 1018,
"free_shipping": 0,
"is_virtual": 0,
"item_id": 239851,
"name": "iFrogz Audio- Ear Pollution Plugz with Mic - Blue",
"no_discount": 0,
"order_id": 238332,
"original_price": 1018,
"price": 1018,
"price_incl_tax": 1018,
"product_id": 1,
"product_type": "simple",
"qty_backordered": 0,
"qty_canceled": 0,
"qty_invoiced": 0,
"qty_ordered": 1,
"qty_refunded": 0,
"qty_shipped": 0,
"row_invoiced": 0,
"row_total": 0,
"row_total_incl_tax": 0,
"row_weight": 0,
"sku": "IFPZMB-BL0",
"store_id": 28,
"tax_amount": 0,
"tax_invoiced": 0,
"tax_percent": 0,
"updated_at": "2025-01-02 14:30:53",
"weight": 0,
"extension_attributes": {
"itemized_taxes": []
},
"base_row_total_incl_tax": 1018
}
]
}
],
"payment_additional_info": [],
"applied_taxes": [],
"item_applied_taxes": [],
"converting_from_quote": false,
"taxes": [],
"additional_itemized_taxes": [],
"prdsurcharge_amount": "0.0000",
"base_prdsurcharge_amount": "0.0000",
"prdsurcharge_tax_amount": "0.0000",
"base_prdsurcharge_tax_amount": "0.0000"
}
}
Basic Order Details
base_currency_code
:INR
The currency used for base calculations in the system (Indian Rupee).
base_discount_amount
:0
The discount amount applied to the order in base currency (₹0).
base_grand_total
:1018
The total payable amount in base currency, including all charges (₹1018).
base_shipping_amount
:0
The shipping cost in base currency (₹0).
base_subtotal
:1018
The total cost of items before discounts and tax in base currency (₹1018).
base_tax_amount
:0
The total tax applied to the order in base currency (₹0).
base_total_due
:1018
The remaining amount to be paid in base currency (₹1018).
billing_address_id
:462794
Unique ID for the billing address record.
created_at
:"2025-01-02 04:14:17"
The timestamp indicating when the order was created.
customer_email
:"qa@zrpl.co.in"
The email address associated with the customer who placed the order.
customer_firstname
:"Surya"
The first name of the customer.
customer_group_id
:1
ID indicating the group the customer belongs to (e.g., retail, wholesale).
customer_id
:980
Unique identifier for the customer in the system.
customer_is_guest
:0
Indicates if the customer is a guest (0 = No, 1 = Yes).
customer_lastname
:"U"
The last name of the customer.
customer_note_notify
:0
Whether the customer should be notified about notes added to the order (0 = No).
discount_amount
:0
Discount applied to the order in display currency (₹0).
email_sent
:0
Indicates if an email notification has been sent for the order (0 = No).
entity_id
:238332
Unique identifier for the order.
grand_total
:1018
Final amount to be paid in display currency (₹1018).
increment_id
:"14000007501"
Human-readable order ID visible to the customer.
is_virtual
:0
Indicates if the order contains virtual products only (0 = No).
order_currency_code
:"INR"
The currency displayed to the customer (₹).
protect_code
:"a5046f3075f34f5b59c074f9e32662de"
Security code for accessing the order details.
shipping_amount
:0
The shipping cost in display currency (₹0).
shipping_description
:"Flat Rate - Fixed"
Description of the applied shipping method.
state
:"new"
Internal state of the order (e.g., new, pending, processing).
status
:"processing"
Current status of the order (e.g., pending, processing, complete).
store_currency_code
:"INR"
Currency used in the store.
store_id
:14
Identifier for the store where the order was placed.
store_name
:"ZEPP SPP\nZEPP-SPP\nZEPP Store view"
Name of the store as displayed to customers.
subtotal
:1018
Total item cost in display currency before discounts and taxes (₹1018).
subtotal_incl_tax
:1018
Total item cost in display currency, including tax (₹1018).
tax_amount
:0
Total tax amount applied to the order (₹0).
total_due
:1018
Total amount left to pay in display currency (₹1018).
total_item_count
:1
Number of distinct items in the order.
total_qty_ordered
:1
Total quantity of items ordered.
updated_at
:"2025-01-02 14:30:53"
The timestamp indicating when the order was last updated.
weight
:1
Total weight of the items in the order.
Items
amount_refunded
: 0 The total amount refunded for this item. For this order, no refund has been issued.base_amount_refunded
: 0 The refunded amount in the base currency (INR
). For this item, it is0
.base_cost
: 0 The cost price of the product in base currency. For this item, it is not defined (0
).base_discount_amount
: 0 The discount amount applied to this item in the base currency. Here, no discount is applied.base_discount_invoiced
: 0 The discount amount invoiced in the base currency. No discount is invoiced for this item.base_original_price
: 1015 The original price of the product in the base currency before any adjustments.base_price
: 1018 The price of the item in the base currency, excluding tax. It is slightly higher than the original price.base_price_incl_tax
: 1018 The price of the item including tax in the base currency. Here, tax is0
, so it matchesbase_price
.base_row_invoiced
: 0 The total invoiced amount for this item in the base currency. No invoice has been generated yet.base_row_total
: 1018 The total cost of this item in the base currency (price × quantity), excluding tax.base_tax_amount
: 0 The tax amount for this item in the base currency. No tax is applied.base_tax_invoiced
: 0 The tax amount invoiced for this item in the base currency.created_at
: "2025-01-02 14:30:53" The timestamp when this item was added to the order.discount_amount
: 1018 The discount applied to this item. Here, the discount matches the item’s price, making it effectively free.discount_invoiced
: 0 The discount amount invoiced for this item.discount_percent
: 1018 The percentage of discount applied to the item. Here, it is 100% (fully discounted).free_shipping
: 0 Indicates if the item qualifies for free shipping. Here,0
means it does not qualify specifically.is_virtual
: 0 Indicates whether this is a virtual product.0
means it is a physical product.item_id
: 239851 A unique identifier for this item in the order.name
: "iFrogz Audio- Ear Pollution Plugz with Mic - Blue" The name of the product as displayed to the customer.no_discount
: 0 Indicates if discounts are disabled for this product.0
means discounts are allowed.order_id
: 238332 The unique identifier of the order to which this item belongs.original_price
: 1018 The product's original price as displayed to the customer before any adjustments.price
: 1018 The selling price of the item excluding tax.price_incl_tax
: 1018 The selling price of the item including tax.product_id
: 1 A unique identifier for the product in the catalog.product_type
: "simple" The type of product (e.g., simple, configurable). Here, it is a simple product.qty_backordered
: 0 The quantity of this item that is backordered. Here, none are backordered.qty_canceled
: 0 The quantity of this item that has been canceled.qty_invoiced
: 0 The quantity of this item that has been invoiced.qty_ordered
: 1 The total quantity of this item ordered.qty_refunded
: 0 The quantity of this item that has been refunded.qty_shipped
: 0 The quantity of this item that has been shipped.row_invoiced
: 0 The total row amount invoiced for this item.row_total
: 0 The total cost for this item, excluding tax and including adjustments. Since it is discounted, it is0
.row_total_incl_tax
: 0 The total cost for this item, including tax and adjustments. Again, it is0
due to the discount.row_weight
: 0 The total weight of this item row in the order.sku
: "IFPZMB-BL0" The SKU (Stock Keeping Unit) of the product, used for inventory management.store_id
: 28 The unique identifier of the store where this item was purchased.tax_amount
: 0 The tax amount applied to this item. Here, it is0
.tax_invoiced
: 0 The tax amount invoiced for this item.tax_percent
: 0 The tax percentage applied to this item.updated_at
: "2025-01-02 14:30:53" The timestamp of the last update made to this item.weight
: 0 The weight of the item. For this product, it is not defined (0
).extension_attributes
: {...} Additional metadata for this item.itemized_taxes
: [] A detailed breakdown of applied taxes. Here, it is empty because no taxes were applied.
base_row_total_incl_tax
: 1018 The total amount for this item, including tax, in the base currency.
Billing Address
Contains details about the billing address for the order.
address_type
: "billing" Specifies the type of address. Here, it is a billing address.city
: "Bengaluru" The city where the billing address is located.company
: "ZRPL" The name of the company associated with the billing address.country_id
: "IN" The two-letter ISO code of the country. "IN" stands for India.email
: "qa@zrpl.co.in" The email address associated with the billing contact.entity_id
: 462794 A unique identifier for this billing address record.firstname
: "Surya" The first name of the billing contact person.lastname
: "U" The last name of the billing contact person.parent_id
: 238332 The unique identifier of the order associated with this billing address.postcode
: "560032" The postal code or ZIP code of the billing address.region
: "Karnataka" The region or state where the billing address is located.region_code
: "Karnataka" A short code for the region. It matches the region name here.region_id
: 19 A unique identifier for the region.street
: ["Street 1", "Street 2"] An array containing lines of the street address. Here, there are two lines.telephone
: "1234567890" The phone number of the billing contact.
Payment
Contains details about the payment method and related information.
account_status
: null The account status related to the payment. It is not set (null
).additional_information
: [] An array to store additional information related to the payment. It is empty.cc_last4
: null The last four digits of the credit card used for payment. Not applicable here.entity_id
: 238172 A unique identifier for this payment record.method
: "razorpay" The payment method used for the order. Here, it is Razorpay.parent_id
: 238332 The unique identifier of the order associated with this payment record.
Status Histories
An array containing the status history of the order.
comment
: "This is a test comment" A comment associated with the status update.created_at
: "2025-01-02 14:30:53" The timestamp when this status was recorded.entity_id
: 557226 A unique identifier for this status history record.is_customer_notified
: 0 Indicates whether the customer was notified about this status update.0
means they were not.is_visible_on_front
: 0 Indicates whether this status is visible on the customer’s frontend.0
means it is not visible.parent_id
: 238332 The unique identifier of the order associated with this status update.status
: "processing" The current status of the order.
Extension Attributes
Additional metadata and attributes associated with the order.
shipping_assignments
: [...] An array containing shipping assignments for the order.shipping
: {...} Contains shipping details.address
: {...} Similar tobilling_address
, this object contains shipping address details.method
: "flatrate_flatrate" The shipping method used for the order.total
: {...} Contains the shipping totals.base_shipping_amount
: 0 The shipping amount in the base currency.shipping_amount
: 0 The shipping amount in the display currency.
items
: [...] An array of items included in the shipping assignment, as detailed earlier.
payment_additional_info
: [] Additional information about payment. Here, it is empty.applied_taxes
: [] A list of taxes applied to the order. It is empty.item_applied_taxes
: [] Taxes applied to specific items. It is empty.converting_from_quote
: false Indicates if the order was converted from a quote.false
means it was not.taxes
: [] A detailed breakdown of all taxes applied. It is empty.additional_itemized_taxes
: [] Additional taxes itemized by product. It is empty.prdsurcharge_amount
: "0.0000" The surcharge amount applied to the order.base_prdsurcharge_amount
: "0.0000" The surcharge amount in the base currency.prdsurcharge_tax_amount
: "0.0000" The tax amount on the surcharge.base_prdsurcharge_tax_amount
: "0.0000" The tax amount on the surcharge in the base currency.
Extension Attributes
shipping_assignments
:Includes detailed shipping information such as address, method, and costs.
Itemized Taxes: No taxes applied for this order.
Additional Info: Includes surcharge details with values set to "0.0000" for any extra charges.
{
"message": "The entity that was requested doesn't exist. Verify the entity and try again."
}
Last updated