| Name | Type | Description |
|---|---|---|
| number | string | order number |
| note | string | order notes |
| total_price | string | actual price of the order (final price paid by the customer), numeric string, for example: "9.99" |
| sub_total | string | total price of products, numeric string, for example: "9.99" |
| currency | string | currency type |
| financial_status | string | order payment status: waiting, paying, paid, cancelled, failed, refunding, refund_failed, refunded, partially_refunded |
| status | string | Order status: opened, placed, finished, cancelled |
| canceled_at | date | order cancellation time, ISO-8601 format |
| cancel_reason | string | reason for order cancellation |
| payment_method | string | payment method (cod, online , none) |
| fulfillment_status | string | Logistics status: initialled, waiting, partially_shipped, shipped, partially_finished, finished, cancelled, returning, returned |
| customer_deleted_at | date | customer delete order time, ISO-8601 format |
| deleted_at | date | order delete time, ISO-8601 format |
| placed_at | date | order confirmation time, ISO-8601 format |
| tags | string | order label |
| discount_code | string | order coupon code |
| buyer_accepts_marketing | boolean | whether the customer subscribes to order notifications |
| code_discount_total | number | order discount code discount price |
| line_item_discount_total | string | merchandise discount, numeric string, for example: "9.99" |
| customer_note | string | customer note |
| total_discount | string | discount price, numeric string, for example: "9.99" |
| total_tax | string | order tax, numeric string, for example: "9.99" |
| total_shipping | string | order logistics fee, numeric string, for example: "9.99" |
| total_refund_price | string | total refund amount, numeric string, for example: "9.99" |
| total_refund_tax | string | Total Tax Refunded, numeric string, for example: "9.99" |
| total_refund_discount | string | Total Discount Refunded, numeric string, for example: "9.99" |
| refund_status | string | Refund Status, possible values are: none: there's no refund general: there's refund in this order, and refund for some products customize: there's refund in this order, and customized by store admin |
| created_at | date | The time this order created, ISO-8601 format |
| updated_at | date | The time this order last updated, ISO-8601 format |
| landing_site | string | First page the customer landed |
| payment_line | object |
payment_line: {
payment_channel:string
payment_method:string
transaction_no:string
merchant_id:string
merchant_email:string
}
|
| customer | object |
customer:{
email:string
first_name:string
last_name:string
orders_count:string
total_spent:string
phone:string
}
|
| shipping_address | object |
shipping_address:{
first_name:string
last_name:string
address1:string
address2:string
phone:string
city:string
zip:string
province:string
country:string
company:string
latitude:string
longitude:string
name:string
country_code:string
province_code:string
phone_area_code:string
email:string
area:string
extra_info:string
}
|
| billing_address | object |
billing_address:{
first_name:string
last_name:string
address1:string
address2:string
city:string
zip:string
province:string
country:string
company:string
latitude:string
longitude:string
name:string
country_code:string
province_code:string
phone_area_code:string
email:string
area:string
}
|
| shipping_line | object |
shipping_line:{
name:string
}
name: Shipping Profile's title
|
| line_item | object |
line_item:{
product_title:string
variant_title:string
quantity:number
note:string
image:json
price:number
compare_at_price:number
total:number
sku:string
weight:number
weight_uint:string
vendor:string
properties:json
product_url:string
product_handle:string
refund_quantity:Integer
refund_total:Integer
}
|
Here is a formula: total_price = sub_total - total_discount + total_tax + total_shipping