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.

addtional_prices.fee_title

string

Custom Charge Name

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

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

duty_total

string

Total Duty Amount

primary_market_price

PrimaryMarketSetting

Primary market information

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).

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).

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