Order Properties

🔒
Requires order access scope.

Order

Order Properties

Object	Fields	Type	Desc
Order	id	string	Unique identifier for the order.
	number	string	Order number, intended to simplify merchant references.
	note	string	A custom note input by the merchant regarding the order.
	status	string	The current Order status
	financial_status	string	Indicates the payment status of the order
	fulfillment_status	string	Represents the shipping or fulfillment progress of the order
	email_status	string	The status of recall emails for the order. `waiting` means “pending to send” `send` means “sent”
	cancel_reason	string	Reason for order cancellation, if applicable.
	recovery_status	string	The recovery_status field tracks the progress of an order recall process `waiting` means “Waiting to be recalled” `sending` means “Recall notification in progress” `recalling` means “Recall in progress)” `failed` means “Recall failed)” `success` means “Recall successful)”
	payment_method	string	The payment method used for the order (e.g., apple_pay, credit_card, online).
	~~discount_code~~	string	@Deprecated.
	discount_applications	string	Details of discounts
	customer_note	string	A note provided by the customer during checkout.
	~~landing_site~~	string	@Deprecated.
	buyer_accepts_marketing	bool	Indicates whether the customer has agreed to receive marketing promotions.
	currency	string	Currency code for the order
	total_price	string	The final price paid by the customer, including taxes, discounts, tips, additional fee and shipping fees.
	sub_total	string	The sum of the prices for all line items in the order. - If order.config.product_tax_included is true, the amount includes total_tax (excluding shipping_tax_total); otherwise, it excludes tax. - Formula: sub_total = sum(line_item.price * line_item.quantity).
	total_discount	string	Total amount of discounts applied to the order, including product, shipping, and payment discounts.
	total_tax	string	Total tax amount applied to the products in the order， excluding shipping tax.
	total_shipping	string	Total shipping fee for the order.
	code_discount_total	string	Total discount from discount codes applied to the order.
	~~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	This field is typically used for shipping insurance.
	addtional_prices.name	string	Name of the shipping Insurance, e.g. "sp".
	addtional_prices.price	string	Amount of the additional charge.
	~~total_refund_tax~~	string	@Deprecated.
	shipping_tax_total	string	Total shipping tax amount of the order.
	customer_deleted_at	string	Timestamp indicating when the customer associated with the order was deleted.
	created_at	string	Timestamp indicating when the order was created.
	updated_at	string	Timestamp indicating when the order was updated.
	deleted_at	string	Timestamp indicating when the order was deleted.
	canceled_at	string	Timestamp indicating when the order was canceled.
	placed_at	string	Timestamp indicating when the order was paid.
	total_tip_received	string	Total amount of tips received for the order.
	tags	string	Custom tags added to the order by merchants or the system.
	~~browser_ip~~	string	@Deprecated. IP address of the customer who placed the order.
	~~last_landing_url~~	string	@Deprecated. URL of the last page visited by the customer before checkout.
	total_paid	string	Total amount paid by the customer for the order.
	~~source~~	string	@Deprecated.Product source url
	~~source_name~~	object	@Deprecated. Product source
	~~source_name.data~~	string	@Deprecated. Product source
	~~source_name.created_at~~	string	@Deprecated. Timestamp of the creation
	~~last_referrer_show~~	object	@Deprecated. Last interaction source
	~~last_referrer_show.data~~	string	@Deprecated. Interaction source data.
	~~last_referrer_show.created_at~~	string	@Deprecated. Timestamp of the last interaction.
	shipping_line	object	Information about the shipping plan selected for the order.
	shipping_line.name	string	Name of the shipping plan.
	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	@Deprecated. Platform where the order was placed
	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( product)

Field	Type	Description
id	`string`	Unique identifier for the line item.
product_id	`string`	Unique identifier for the product associated with this line item.
variant_id	`string`	Unique identifier for the specific variant of the product.
product_title	`string`	The name of the product purchased.
~~product_handle~~	`string`	@Deprecated. The SEO-friendly link (handle) for the product, used in URLs.
variant_title	`string`	The title of the product variant (e.g., "Blue, Size M").
quantity	`integer`	The number of units of this product purchased.
note	`string`	A note related to the product in this line item, added by the merchant or customer.
fulfillment_status	`string`	The fulfillment status of this line item (e.g., `fulfilled`, `unfulfilled`). See Fulfillment Status.
sku	`string`	Stock Keeping Unit (SKU) for the product variant, used for inventory tracking.
weight	`string`	Weight of the product.
weight_unit	`string`	Unit of measurement for the product weight (e.g., `kg`, `lbs`).
vendor	`string`	The vendor or supplier of the product.
product_url	`string`	The URL of the product page for customers.
compare_at_price	`string`	The original price of the product before discounts (if applicable).
image	`string`	The URL of the image associated with the product variant.
price	`string`	Price per unit of the product, as a numeric string (e.g., `"9.99"`).
total	`string`	Total cost for this line item, calculated as `price × quantity`.
properties	`array of objects`	Additional properties or options associated with the product variant.
properties.name	`string`	Name of the property or option (e.g., `Size`).
properties.value	`string`	Value of the property or option (e.g., `Medium`).
custom_properties	`map[string]string`	Custom attributes or metadata added to this line item by the merchant.
~~refund_quantity~~	`integer`	@Deprecated. Previously used to indicate refunded quantity for this line item.
~~refund_total~~	`string`	@Deprecated. Previously used to indicate the total refund amount for this line item.
requires_shipping	`boolean`	Indicates whether this line item requires shipping (`true` or `false`).
discount_applications	`integer`	Number of discounts applied to the shipping for this line item.

PaymentLine

Field	Type	Description
payment_channel	`string`	The payment channel used for the transaction (e.g., `PayPal`, `Stripe`, `Bank Transfer`).
payment_method	`string`	The specific method of payment used within the channel (e.g., `Visa`, `MasterCard`,`online`(e.g. paypal)).
transaction_no	`string`	The unique transaction number associated with this payment.
merchant_id	`string`	The unique identifier for the merchant handling the transaction. For new payment lines, these fields are no longer included in the API response. Only the PayPal channel previously returned these fields.
merchant_email	`string`	The email address of the merchant. For new payment lines, these fields are no longer included in the API response. Only the PayPal channel previously returned these fields.
paid_total	`string`	The total amount paid via this payment channel, formatted as a numeric string (e.g., `"49.99"`).
payment_name	`string`	The name of the payment channel for display purposes (e.g., `PayPal`, `Credit Card`).

OrderConfig

Field	Type	Description
pay_type	`string`	Specifies the type of payment used for the order (e.g., `Credit Card`, `PayPal`).
product_tax_included	`boolean`	Indicates whether product prices include taxes (`true` or `false`).
requires_shipping	`boolean`	Specifies whether the order requires shipping (`true` or `false`).
~~checkout_business_type~~	`integer`	@Deprecated. Defines the business logic applied during checkout. - `0`: Standard checkout (default). - 1: virtual goods
~~checkout_template_type~~	`integer`	@Deprecated. Determines the type of template used during checkout based on product or fulfillment type. - `0`: Physical Goods Template: Includes modules for `shipping_address`, `shipping_line`, `payment_line`, and `billing_address`. - `1`: Virtual Goods Template: Used for virtual products like gift cards; includes `billing_address` and `payment_line`. - `2`: In-Store Pickup Template: For orders where products are eligible for pickup; includes `billing_address` and `payment_line`.
market_setting	MarketSetting	Specifies market-specific configurations for the order (e.g., regional taxes, currency 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

LocationLine

Field	Type	Description
`Id`	`string`	Unique identifier for the location line.
`LocationId`	`string`	Identifier for the associated location.
`LocationName`	`string`	Name of the location, such as a store or warehouse.

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	Description
id	`string`	Unique identifier for the refund.
order_id	`string`	The ID of the order associated with the refund.
note	`string`	A note regarding the refund, provided by the merchant or system.
refund_price	`string`	The total refund amount as specified by the buyer, represented as a numeric string (e.g., `"50.00"`).
currency	`string`	The currency code for the refund amount (e.g., `USD`, `EUR`).
created_at	`string`	The timestamp when the refund was created.
updated_at	`string`	The timestamp of the last update to the refund.
refund_line_items	array of RefundLineItem	A list of line items included in the refund, detailing specific products and quantities.
payment_details	array of PaymentDetail	Details about the payment channels used for the refund.
refund_shipping	`string`	The shipping cost included in the total refund amount.
refund_shipping_tax	`string`	The tax amount applied to the refunded shipping cost.
refund_method	`string`	The method of the refund:
		- `none`: Unknown
		- `general`: Standard refund
		- `customize`: Custom refund method
~~refund_status~~	`string`	@Deprecated.~~The current status of the refund:~~
		- `pending`: Refund is in progress
		- `failed`: Refund failed
		- `finished`: Refund successfully completed

RefundLineItem

Field	Type	Description
line_item_id	`string`	Unique identifier for the refund line item.
refund_quantity	`integer`	The number of units being refunded for this line item.
line_item	array of LineItem	Details of the original order line item associated with this refund.
tax	`string`	The tax amount applicable to the refunded goods.
discount	`string`	The refunded amount of any discounts applied to the goods.
sub_total	`string`	The total price of the product from the associated `line_item`.
total	`string`	The total refund amount for the goods, including discounts and taxes.
delete_quantity	`string`	The quantity of the product being refunded before it was shipped.

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( product)

PaymentLine

OrderConfig

MarketSetting

MarketCurrencySymbol

MarketPriceSetting

LocationLine

Order Status

Financial Status

Fulfillment Status

Refund

Refund properties

RefundLineItem

PaymentDetail

🔒
Requires `order` access scope.