Order Properties
Name | Type | Description |
---|---|---|
id | string | Order ID |
note | string | Order notes |
number | string | Order number |
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 |
cancel_reason | string | Reason for order cancellation |
payment_method | string | Payment method (cod, online , none) |
fulfillment_status | string | Logistics status of order: initialled, waiting, partially_shipped, shipped, partially_finished, finished, cancelled, returning, returned |
discount_code | string | Order coupon code |
discount_applications | string | Order discount information of applications |
customer_note | string | Customer note |
landing_site | string | First page the customer landed |
buyer_accepts_marketing | boolean | Whether the customer subscribes to order notifications |
currency | string | Currency type |
total_price | string | Actual price of the order (final price paid by the customer), numeric string, for example: "9.99" |
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" |
sub_total | string | Total price of products, numeric string, for example: "9.99" |
code_discount_total | number | Order discount code discount price |
line_item_discount_total | string | Merchandise discount, numeric string, for example: "9.99" |
tags | string | Order label |
created_at | date | The time this order created, ISO-8601 format |
updated_at | date | The time this order last updated, ISO-8601 format |
canceled_at | date | Order cancellation time, ISO-8601 format |
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 |
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 |
total_tip_received | string | Total tips received, numeric string, for example: "9.99" |
browser_ip | string | Browser IP |
source | string | First visit landing page URL |
last_landing_url | string | Last visit landing page URL |
email_status | string | Email send status: send, waiting |
recovery_status | string | Recovery status: waiting, sending, recalling, failed, success |
source_name | object | First interaction source (refer to Source name) |
last_referrer_show | object | Last interaction source (refer to Source name) |
shipping_line | object | Shipping line (refer to Shipping line) |
customer | object | Customer information (refer to Customer) |
shipping_address | object | Shipping address (refer to Shipping address) |
billing_address | object | Billing address (refer to Billing address) |
payment_line | object | Payment line (refer to Payment line) |
line_items | array of object | Line items (refer to Line item) |
fulfillments | array of object | Fulfillments (refer to Fulfillment) |
Source Name
name | type | description |
---|---|---|
data | string | Source name, eg. `Direct`, `Others` |
created_at | date | Created time, ISO-8601 format |
Shipping line
name | type | description |
---|---|---|
name | string | Shipping profile's title |
Customer
name | type | description |
---|---|---|
string | Customer's email | |
first_name | string | Customer's first name |
last_name | string | Customer's last name |
phone | string | Customer's phone number |
created_at | date | Created time, ISO-8601 format |
updated_at | date | Last updated time, ISO-8601 format |
orders_count | integer | Count of orders |
total_spent | string | Total spent |
Shipping address
name | type | description |
---|---|---|
first_name | string | Customer's first name |
last_name | string | Customer's last name |
address1 | string | Address Line #1 |
address2 | string | Address Line #2 |
phone | string | Customer's phone number |
city | string | City |
zip | string | ZIP code |
province | string | Province |
country | string | Country |
company | string | Company Name |
latitude | number | Latitude |
longitude | number | Longitude |
name | string | Customer's name |
country_code | string | Country code |
province_code | string | Province code |
phone_area_code | string | Area code of phone number |
string | Customer's email | |
area | string | Area |
extra_info | string | Extra information, eg. tax data |
Billing address
name | type | description |
---|---|---|
first_name | string | Customer's first name |
last_name | string | Customer's last name |
address1 | string | Address Line #1 |
address2 | string | Address Line #2 |
city | string | City |
zip | string | ZIP code |
province | string | Province |
country | string | Country |
company | string | Company Name |
latitude | number | Latitude |
longitude | number | Longitude |
name | string | Customer's name |
country_code | string | Country code |
province_code | string | Province code |
string | Customer's email | |
area | string | Area |
Payment line
name | type | description |
---|---|---|
payment_channel | string | Payment channel |
payment_method | string | Payment method |
transaction_no | string | Transaction number |
merchant_id | string | Merchant's ID |
merchant_email | string | Merchant's email |
Payment lines
name | type | description |
---|---|---|
payment_channel | string | Payment channel |
payment_method | string | Payment method |
transaction_no | string | Transaction number |
merchant_id | string | Merchant's ID |
merchant_email | string | Merchant's email |
paid_total | string | Payment Channel Paid Total |
Line item
name | type | description |
---|---|---|
id | string | Variant's ID |
product_id | string | Product's ID |
variant_id | string | Variant's ID |
variant_title | string | Variant's title |
product_title | string | Product's title |
product_handle | string | Product's handle |
quantity | integer | Quantity of line items |
note | string | Product's note |
fulfillment_status | string | Logistics status of line item, waiting, shipped, finished, partially_shipped, partially_finished, returning, returned |
sku | string | SKU |
weight_unit | string | Weight unit, eg. kg |
vendor | string | Vendor |
product_url | string | Product URL |
compare_at_price | string(number) | Line item's compare at price (original price) |
image | string | Line item's image |
price | string(number) | Line item's price |
total | string(number) | Line items' total price |
weight | string(number) | Line item's weight |
properties | array of object | Options of the line item, eg. [{"name":"color","value":"red"},{"name":"size","value":"M"}] |
custom_properties | object | Custom properties |
refund_quantity | integer | Refund quantity |
refund_total | string(number) | Refund total price |
Fulfillment
name | type | description |
---|---|---|
id | string | Fulfillment's ID |
order_id | string | Order's ID |
status | string | Fulfillment status, eg. waiting, shipped, finished, cancelled |
tracking_company | string | Tracking company |
tracking_number | string | Tracking code |
tracking_company_code | string | Tracking company's code |
created_at | date | Created time of fulfillment, ISO-8601 format |
updated_at | date | Last updated time of fulfillment, ISO-8601 format |
line_items | array of object | Line items, (refer to Line item) |
Here is a formula: total_price = sub_total - total_discount + total_tax + total_shipping + total_tip_received