Order Properties

🔒
Requires order access scope.

Order

Order Properties

Object	Fields	Type	Desc
Order	id	string	order id
	number	string	Order's number(more convenient for merchants)
	note	string	merchant input for taking a note
	status	string	Order status
	financial_status	string	Financial status
	fulfillment_status	string	Fulfillment status
	email_status	string	Recovery email status: `waiting` means “pending to send” `send` means “sent”
	cancel_reason	string
	recovery_status	string	Recovery status: `waiting` means “to be recalled” `sending` means “sent” `recalling` means “recall in progress” `failed` means “recall failed” `success` means “recall successful”
	payment_method	string	Payment method,such as apple_pay,cod,credit_card,online etc.
	~~discount_code~~	string	@Deprecated.
	discount_applications	string	Details of discounts
	customer_note	string	Customer's order note.
	landing_site	string	First visited page
	buyer_accepts_marketing	bool	Whether the customer accepts the marketing promotion
	currency	string	Currency code
	total_price	string	Total price of the order (final price paid by the customer), numeric string, for example: `"9.99",`
	sub_total	string	Total price of order's products , numeric string, for example: `"9.99"` .If `order.config.product_tax_included` is `true`, the amount includes total_tax (not includes shipping_tax_total), otherwise it does not。order.sub_total = sum(line_item.total_price) = sum(line_item.price*line_item.quantity)
	total_discount	string	Total discount price of order, numeric string, for example: `"9.99"`, include product discount,shipping discount and payment discount.
	total_tax	string	Sales tax on the order or Tax on the order product items., numeric string, for example: `"9.99"`
	total_shipping	string	Order logistics total fee, numeric string, for example: `"9.99"`
	code_discount_total	string	Order discount code discount price, numeric string, for example: `"9.99"`
	line_item_discount_total	string	@Deprecated.total Product discount, numeric string, for example: `"9.99"`,includes code_discount_total
	gift_card_total	string	Gift card discount amount, numeric string, for example: `"9.99"`
	total_refund_price	string	Total refund amount has been successfully processed, numeric string, for example: `"9.99"`
	~~total_refund_discount~~	string	@Deprecated.Total discount refunded, numeric string, for example: `"9.99"`
	additional_total	string	Total amount of additional charges, numeric string, for example: `"9.99"`
	addtional_prices	array of object	the detail list of additional charges
	addtional_prices.name	string
	addtional_prices.price	string
	~~total_refund_tax~~	string	@Deprecated.
	shipping_tax_total	string	Total shipping tax amount for the order.
	customer_deleted_at	string	Time of user deletion
	created_at	string
	updated_at	string
	deleted_at	string	Deletion time
	canceled_at	string
	placed_at	string	Payment time
	total_tip_received	string
	tags	string	Merchant or system tags the order
	browser_ip	string	Visitor IP address
	last_landing_url	string	Customer last visited page
	total_paid	string	Total payment amount
	source	string	Product link
	source_name	object	Referrer
	source_name.data	string
	source_name.created_at	string
	last_referrer_show	object	Last interaction source
	last_referrer_show.data	string
	last_referrer_show.created_at	string
	shipping_line	object	Shipping plan
	shipping_line.name	string
	customer	Customer	Customer details
	shipping_address	Address	Delivery address
	billing_address	Address	Billing address
	payment_line	PaymentLine	Payment details
	line_items	array of LineItem	List of purchased products
	fulfillments	array of Fulfillment	List of fulfillments
	logistics_code	string	Logistics code
	refer_info	string	Visit information
	config	OrderConfig	Order configuration information
	sales_platform	string	Sales platform
	checkout_url	string	The checkout page url for the order with storeDomain
	location_line	LocationLine	Merchant's warehouse address.
	invoice_url	string	The checkout page url for the order without storeDomain

LineItem(means product)

Field	Type	Desc
id	string
product_id	string	Product's ID
variant_id	string	Varaint's ID
product_title	string	Product title
product_handle	string	Product SEO link
variant_title	string	Variant title
quantity	integer	Quantity purchased
note	string
fulfillment_status	string	Fulfillment status
sku	string	The SKU of the variant
weight	string	Product weight
weight_unit	string	Weight unit
vendor	string	Vendor
product_url	string	Product URL for customers
compare_at_price	string	Compare at price
image	string	Variant image link
price	string	Price
total	string	Total amount
properties	array of objects	Properties, corresponding to options of the variant
properties.name	string	Property name, corresponds to option name
properties.value	string	Property value, corresponds to option value
custom_properties	map[string]string	Custom properties
~~refund_quantity~~	integer	@Deprecated.Refund quantity
~~refund_total~~	string	@Deprecated.Refund total amount
requires_shipping	boolean	Requires shipping or not
discount_applications	integer	Shipping quantity

PaymentLine

Field	Type	Desc
payment_channel	string	Payment channel
payment_method	string	Payment method
transaction_no	string	Transaction number
merchant_id	string	Merchant ID
merchant_email	string	Merchant email
paid_total	string	Total amount paid via this channel
payment_name	string	Payment channel name

OrderConfig

Field	Type	Desc
pay_type	string	Payment type
product_tax_included	boolean	Whether the product includes tax
requires_shipping	boolean	Whether shipping is required
checkout_business_type	integer	Checkout business type
checkout_template_type	integer	Checkout template type
market_setting	MarketSetting	Market settings

MarketSetting

Field	Type	Desc
primary_market_lang	string	Primary market language
market_lang	string	Market language, for example: `en-US`
market_id	string	Market configuration ID
market_currency	string	Market currency code, for example: `USD`
market_country	string	Market country, for example: `US`
market_currency_symbol	MarketCurrencySymbol	Market currency symbol
market_base_id	string	Market base ID
market_base_currency	string	Market base currency, for example: `USD`
market_base_currency_symbol	MarketCurrencySymbol	Market base currency symbol
primary_market_id	string	Primary market ID
primary_market_currency	string	Primary market currency code, for example: `USD`
primary_market_currency_symbol	MarketCurrencySymbol	Primary market currency symbol
market_price_setting	MarketPriceSetting	Market price settings

MarketCurrencySymbol

Field Name	Field Type	Description
code	string	Currency code, for example: `USD`
val	string	Currency symbol, for example: `$`
left	string	Content displayed to the left of the number, for example: `$`
right	string	Content displayed to the right of the numbe

MarketPriceSetting

Field	Field	Desc
local_currency_enabled	boolean	Local currency enable status
custom_rate_enabled	boolean	Custom rate enable status
custom_rate	number	Custom rate, primary market currency -> market base currency
rate	number	primary market currency -> market base currency / local currency
back_rate	number	market base currency / local currency -> primary market currency
actual_rate	number	Actual exchange rate, primary market currency -> market base currency / local currency
base_to_local	integer	market base currency -> local currency
adjust	integer	Price adjustment
price_round_enabled	boolean	Enable price rounding

Order Status

Status	desc
opened	Order successfully created
canceled	Cancellation of unpaid order
placed	Completed paid orders
finished	The scenarios where the order is in the `finished` state: 1. All items in the order have been received 2. Order cancelled after payment 3. Full refund of order amount with all items deleted 4. Full refund of order amount with all items returned

Financial Status

Status	Desc
waiting	Pending payment
paying	Payment Processing
authorized	Authorized
partially_paid	Partial Payment (Gift Card Used)
paid	Payment Received
cancelled	Payment Cancelled
failed	Payment Failed
refunding	Refund Processing
refund_fail	Refund Failed
refunded	Fully Refunded
partially_refunded	Partial Refund

Fulfillment Status

Status	Desc
initialled	Initial status, order unpaid
waiting	Awaiting shipment
cancelled	Cancel shipment
partially_shipped	Partial shipment
shipped	Full shipment
partially_finished	Partial receipt
finished	Full receipt
returning	Return in progress
partially_returned	Partial return
returned	Full return

Refund

Refund properties

Field	Type	Desc
id	string
order_id	string	Order ID
note	string
refund_price	string	total refund amount by buyer input
currency	string
created_at	string
updated_at	string
refund_line_items	array of RefundLineItem
payment_details	array of PaymentDetail
refund_shipping	string	Shipping included in the refund amount
refund_shipping_tax	string	Shipping tax is included in the refund amount
refund_method	string	Refund method: `none` - Unknown， `general` - `customize` -
refund_status	string	Refund status: `pending` - `failed` - `finished` -

RefundLineItem

Field	Type	Desc
line_item_id	string	refund line item id
refund_quantity	integer	Quantity to be refunded
line_item	array of LineItem	Order line items
tax	string	Contributory tax on goods to be returned
discount	string	Actual refund of discount charges on goods
sub_total	string	Total price of product of line_item
total	string	The actual refund of the amount paid for the goods
delete_quantity	string	Quantity for refund before shipping.

PaymentDetail

Field	Type	Desc
payment_channel	string	Refund payment channel
payment_method	string	Refund payment method
refund_price	string	Channel refund amount
finished_at	string	Refund Completion time RFC3339 Time does not exist is an empty string

🔒Requires order access scope.

Order

Order Properties

LineItem(means product)

PaymentLine

OrderConfig

MarketSetting

MarketCurrencySymbol

MarketPriceSetting

Order Status

Financial Status

Fulfillment Status

Refund

Refund properties

RefundLineItem

PaymentDetail

🔒
Requires `order` access scope.