Get order details by number

GET 
/openapi/2026-07/orders/number/:number

Retrieves detailed information about a specific order using its unique order number.

Request

Path Parameters

number stringrequired

Order number, intended to simplify merchant references

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

order object

Order

idstring

Order ID

created_atstring

Time when the order was created (e.g., 2018-11-02T12:30:10Z)

updated_atstring

Time when the order was last updated (e.g., 2018-11-02T12:30:10Z)

notestring

A custom note input by the merchant regarding the order

numberstring

Order number

total_pricestring

The final price paid by the customer, including taxes, discounts, tips, additional fee and shipping fees

sub_totalstring

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)

currencystring

Currency code for the order

financial_statusstring

Payment status of the order:

• waiting: pending payment
• paying: payment under review
• authorized: authorized
• partially_paid: partially paid
• paid: paid
• cancelled: cancelled
• failed: payment failed
• refunding: refund in progress
• refund_failed: refund failed
• refunded: fully refunded
• partially_refunded: partially refunded

statusstring

Order status:

• opened: pending payment
• cancelled: cancelled
• placed: in progress
• finished: completed

cancelled_atstring

Time when the order was canceled

cancel_reasonstring

Reason for order cancellation

payment_methodstring

The payment method used for the order (e.g., apple_pay, credit_card, online)

fulfillment_statusstring

Order fulfillment status:

• initialled: initial
• waiting: waiting to ship
• partially_shipped: partially shipped
• shipped: fully shipped
• partially_finished: partially received
• finished: fully received
• cancelled: cancelled
• returning: return in progress
• partially_returned: partially returned
• returned: fully returned

customer_deleted_atstring

Time when the customer associated with the order was deleted

deleted_atstring

Time when the order was deleted

placed_atstring

Time when the order was paid

tagsstring

Custom tags added to the order by merchants or the system

buyer_accepts_marketingboolean

Indicates whether the customer has agreed to receive marketing promotions

code_discount_totalstring

Total discount from discount codes applied to the order

customer_notestring

A note provided by the customer during checkout

total_discountstring

Total amount of discounts applied to the order, including product, shipping, and payment discounts

total_taxstring

Total tax amount applied to the products in the order, excluding shipping tax

total_shippingstring

Total shipping fee for the order

line_items object[]

List of purchased products

Array [

idstring

Line item ID

product_idstring

Product associated with this line item ID

product_titlestring

The name of the product purchased

variant_idstring

Specific variant of the product ID

variant_titlestring

The title of the product variant, for example, "Blue, Size M"

quantityuint32

The number of units of this product purchased

notestring

A note related to the product in this line item, added by the merchant or customer

image object

Image

srcstring

The source URL of the image

widthint32

The width of the image in pixels

heightint32

The height of the image in pixels

altstring

Alt text for the image

pricestring

Price

compare_at_pricestring

Compare-at price

total_pricestring

Total price

fulfillment_statusstring

The fulfillment status of this line item. For example, "fulfilled", "unfulfilled". See Fulfillment Status

skustring

Stock Keeping Unit (SKU) for the product variant, used for inventory tracking

weightstring

Weight of the product

weight_unitstring

Unit of measurement for the product weight. For example, "kg", "lbs"

vendorstring

The vendor or supplier of the product

product_urlstring

The URL of the product page for customers

created_atstring

Creation time, in ISO-8601 format

updated_atstring

Last update time, in ISO-8601 format

options object[]

Product option values (a.k.a. variant option values) associated with this line item

Array [

namestring

Option name

valuestring

Option value

]

product_slugstring

URL-friendly identifier of the product

taxableboolean

Whether the line item is taxable

requires_shippingboolean

Whether this line item requires shipping

spustring

Standard Product Unit (SPU)

product_tagsstring

Product tags

refund_quantity_totaluint32

Refunded quantity for this line item

customboolean

Whether the line item is a custom item

trunk_pricestring

Trunk price

discount_applicationsstring

Number of discounts applied to the shipping for this line item

tax_pricestring

Tax of the line item

duty_pricestring

Duty cost

payment_discount_pricestring

Price of payment discounts applied to the line item

custom_propertiesobject

Custom properties of the line item, such as size, color, etc. JSON format

]

payment_line object

Payment details

idstring

Payment line ID

payment_namestring

The name of the payment channel for display purposes (e.g., PayPal, Credit Card)

payment_channelstring

The payment channel used for the transaction (e.g., PayPal, Stripe, Bank Transfer)

payment_methodstring

The specific method of payment used within the channel (e.g., Visa, MasterCard,online(e.g. paypal))

credit_card_numberstring

The last few digits of the credit card used

trans_channelstring

Transaction channel

trans_methodstring

Transaction method

transaction_nostring

The unique transaction number associated with this payment

merchant_emailstring

Merchant email address

shipping_line object

Information about the shipping plan selected for the order

idstring

Shipping ID

namestring

Name

descstring

Description

delivery_methodint32

Delivery method

billing_address object

Billing address

first_namestring

First name of consignee

last_namestring

Last name of consignee

addressstring

The main street address for delivery (e.g., 1 Rue des Carrieres)

address1string

Additional address information (e.g., Suite 1234)

phonestring

Phone number (e.g., +86 1231231234)

citystring

City (e.g., SAN JOSE)

zipstring

ZIP code (e.g., 87036)

provincestring

Province (e.g., New Mexico)

countrystring

Country (e.g., United States)

companystring

Company (e.g., ABC Limited)

latitudestring

Latitude of the delivery address (e.g., 22.54)

longitudestring

Longitude of the delivery address (e.g., 114.06)

namestring

Name of consignee

country_codestring

Country code (e.g., US)

province_codestring

Province code (e.g., NM)

phone_area_codestring

Area code (e.g., +86)

emailstring

Email address

areastring

Area (e.g., Bay area)

extra_info object

Special shipping information fields, including tax ID, etc

addition object

Additional key-value items for special shipping information, such as tax ID fields

property name* AdditionItem

namestring

Name

valstring

Value

cpfstring

Personal tax ID

tax_textstring

Tax text

shipping_address object

Delivery address

first_namestring

First name of consignee

last_namestring

Last name of consignee

addressstring

The main street address for delivery (e.g., 1 Rue des Carrieres)

address1string

Additional address information (e.g., Suite 1234)

phonestring

Phone number (e.g., +86 1231231234)

citystring

City (e.g., SAN JOSE)

zipstring

ZIP code (e.g., 87036)

provincestring

Province (e.g., New Mexico)

countrystring

Country (e.g., United States)

companystring

Company (e.g., ABC Limited)

latitudestring

Latitude of the delivery address (e.g., 22.54)

longitudestring

Longitude of the delivery address (e.g., 114.06)

namestring

Name of consignee

country_codestring

Country code (e.g., US)

province_codestring

Province code (e.g., NM)

phone_area_codestring

Area code (e.g., +86)

emailstring

Email address

areastring

Area (e.g., Bay area)

extra_info object

Special shipping information fields, including tax ID, etc

addition object

Additional key-value items for special shipping information, such as tax ID fields

property name* AdditionItem

namestring

Name

valstring

Value

cpfstring

Personal tax ID

tax_textstring

Tax text

fulfillments object[]

List of fulfillments

Array [

idstring

Fulfillment ID

order_idstring

Order's ID

statusstring

Fulfillment status:

• pending: pending shipment
• shipped: shipped
• finished: finished
• cancelled: cancelled

created_atstring

Creation time, in ISO-8601 format

updated_atstring

Last update time, in ISO-8601 format

tracking_companystring

Logistics company

tracking_numberstring

Tracking number

tracking_company_codestring

Logistics company code

line_items object[]

Line items included in this fulfillment

Array [

idstring

Line item ID

product_idstring

Product associated with this line item ID

product_titlestring

The name of the product purchased

variant_idstring

Specific variant of the product ID

variant_titlestring

The title of the product variant, for example, "Blue, Size M"

quantityuint32

The number of units of this product purchased

notestring

A note related to the product in this line item, added by the merchant or customer

image object

Image

srcstring

The source URL of the image

widthint32

The width of the image in pixels

heightint32

The height of the image in pixels

altstring

Alt text for the image

pricestring

Price

compare_at_pricestring

Compare-at price

total_pricestring

Total price

fulfillment_statusstring

The fulfillment status of this line item. For example, "fulfilled", "unfulfilled". See Fulfillment Status

skustring

Stock Keeping Unit (SKU) for the product variant, used for inventory tracking

weightstring

Weight of the product

weight_unitstring

Unit of measurement for the product weight. For example, "kg", "lbs"

vendorstring

The vendor or supplier of the product

product_urlstring

The URL of the product page for customers

created_atstring

Creation time, in ISO-8601 format

updated_atstring

Last update time, in ISO-8601 format

options object[]

Product option values (a.k.a. variant option values) associated with this line item

Array [

namestring

Option name

valuestring

Option value

]

product_slugstring

URL-friendly identifier of the product

taxableboolean

Whether the line item is taxable

requires_shippingboolean

Whether this line item requires shipping

spustring

Standard Product Unit (SPU)

product_tagsstring

Product tags

refund_quantity_totaluint32

Refunded quantity for this line item

ship_quantityuint32

Shipped quantity for this line item

customboolean

Whether the line item is a custom item

trunk_pricestring

Trunk price

discount_applicationsstring

Number of discounts applied to the shipping for this line item

tax_pricestring

Tax of the line item

duty_pricestring

Duty cost

payment_discount_pricestring

Price of payment discounts applied to the line item

custom_propertiesobject

Custom properties of the line item, such as size, color, etc. JSON format

]

tracking_urlstring

Tracking URL

phone_numberstring

Phone number

tracking_items object[]

List of tracking items included in this fulfillment

Array [

tracking_numberstring

Tracking number

tracking_companystring

Logistics company

tracking_company_codestring

Logistics company code

tracking_urlstring

Tracking URL

]

]

customer object

Customer details

idstring

Order ID

emailstring

Email address

first_namestring

First name

last_namestring

Last name

phonestring

Phone number

created_atstring

Time when the customer record was created (e.g., 2018-11-02T12:30:10Z)

updated_atstring

Time when the customer record was last updated (e.g., 2018-11-02T12:30:10Z)

order_countint32

Number of orders

total_spentstring

Total amount spent by the customer

refer_infostring

Visit information

sales_platformstring

Sales channel

total_refund_pricestring

Total refund amount has been successfully processed, numeric string (e.g., "9.99")

primary_market_price object

Primary market price

compare_at_pricestring

The compare-at price in the main/store currency

pricestring

The unit price in the main currency

total_pricestring

The total price (main_currency_prices.price * quantity)

actual_ratestring

The actual exchange rate used for conversion

total_tip_receivedstring

Total amount of tips received for the order

discount_applicationsstring

Details of discounts

refund_statusstring

Refund status:

• pending: refund in progress
• finished: refund completed
• failed: refund failed

email_statusstring

The status of recall emails for the order:

• waiting: pending to send
• send: sent

recovery_statusstring

The progress of an order recall process:

• waiting: waiting to be recalled
• sending: recall notification in progress
• recalling: recall in progress
• failed: recall failed
• success: recall successful

total_paidstring

Total amount paid by the customer for the order

payment_lines object[]

List of payment lines

Array [

idstring

Payment line ID

payment_namestring

The name of the payment channel for display purposes (e.g., PayPal, Credit Card)

payment_channelstring

The payment channel used for the transaction (e.g., PayPal, Stripe, Bank Transfer)

payment_methodstring

The specific method of payment used within the channel (e.g., Visa, MasterCard,online(e.g. paypal))

credit_card_numberstring

The last few digits of the credit card used

trans_channelstring

Transaction channel

trans_methodstring

Transaction method

transaction_nostring

The unique transaction number associated with this payment

merchant_emailstring

Merchant email address

]

gift_card_totalstring

Gift card discount amount, numeric string (e.g., "9.99")

logistics_codestring

Logistics code

shipping_tax_totalstring

Total shipping tax amount of the order

location_line object

Merchant's warehouse address

idstring

Warehouse location ID

location_idstring

Identifier for the associated location

location_namestring

Name of the location, such as a store or warehouse

additional_totalstring

Total amount of additional charges, numeric string (e.g., "9.99")

additional_prices object[]

The detail list of additional charges

Array [

namestring

Name of the additional charge

pricestring

Amount of the additional charge

biz_idstring

Business ID

fee_titlestring

Custom Charge Name

]

config object

Order configuration information

page_typestring

Checkout page type (e.g., three_step)

requires_shippingboolean

Specifies whether the order requires shipping

product_tax_includedboolean

Indicates whether product prices include taxes

market_setting object

Specifies market-specific configurations for the order (e.g., regional taxes, currency settings)

primary_market_langstring

Primary market language

market_langstring

Market language (e.g., en-US)

market_idstring

Market configuration ID

market_currencystring

Market currency code (e.g., USD)

market_currency_symbol object

Market currency symbol

codestring

Currency code (e.g., USD)

valstring

Currency symbol (e.g., $)

leftstring

Content displayed to the left of the number (e.g., $)

rightstring

Content displayed to the right of the number

market_base_idstring

Market base ID

market_base_currencystring

Market base currency (e.g., USD)

market_base_currency_symbol object

Market base currency symbol

codestring

Currency code (e.g., USD)

valstring

Currency symbol (e.g., $)

leftstring

Content displayed to the left of the number (e.g., $)

rightstring

Content displayed to the right of the number

primary_market_idstring

Primary market ID

primary_market_currencystring

Primary market currency code (e.g., USD)

primary_market_currency_symbol object

Primary market currency symbol

codestring

Currency code (e.g., USD)

valstring

Currency symbol (e.g., $)

leftstring

Content displayed to the left of the number (e.g., $)

rightstring

Content displayed to the right of the number

market_price_setting object

Market price settings

local_currency_enabledboolean

Local currency enable status

custom_rate_enabledboolean

Custom rate enable status

custom_ratefloat

Custom rate: primary market currency to market base currency

ratefloat

Rate: primary market currency to market base currency or local currency

back_ratefloat

Back rate: market base currency or local currency to primary market currency

actual_ratefloat

Actual exchange rate: primary market currency to market base currency or local currency

base_to_ratefloat

Rate: market base currency to local currency

local_to_ratefloat

Local to rate

adjustint32

Price adjustment

price_round_enabledboolean

Enable price rounding

market_countrystring

Market country (e.g., US)

checkout_urlstring

The checkout page URL for the order (including store domain)

duty_totalstring

Total customs duty and tax amount

order_confirm_notifyint32

Whether to send order confirmation notification

fulfillment_notifyint32

Whether to send the order fulfillment notification to the customer:

• 0: follow system config
• 1: send email
• 2: do not send email

partial_fulfillment_notifyint32

Whether to send the partial fulfillment notification to the customer:

• 0: follow system config
• 1: send email
• 2: do not send email

order_delivered_notifyint32

Whether to send delivery notification

finished_atstring

Time when the order was completed

devicestring

Device

order_typestring

Order type:

• 0: regular order
• 1: gift card order

sourcestring

First visited page

source_namestring

First touchpoint

last_landing_urlstring

Last visited page

last_referrer_showstring

Last touchpoint

browser_ipstring

Browser IP address

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "order": {
      "id": "string",
      "created_at": "string",
      "updated_at": "string",
      "note": "string",
      "number": "string",
      "total_price": "string",
      "sub_total": "string",
      "currency": "string",
      "financial_status": "string",
      "status": "string",
      "cancelled_at": "string",
      "cancel_reason": "string",
      "payment_method": "string",
      "fulfillment_status": "string",
      "customer_deleted_at": "string",
      "deleted_at": "string",
      "placed_at": "string",
      "tags": "string",
      "buyer_accepts_marketing": true,
      "code_discount_total": "string",
      "customer_note": "string",
      "total_discount": "string",
      "total_tax": "string",
      "total_shipping": "string",
      "line_items": [
        {
          "id": "string",
          "product_id": "string",
          "product_title": "string",
          "variant_id": "string",
          "variant_title": "string",
          "quantity": 0,
          "note": "string",
          "image": {
            "src": "string",
            "width": 0,
            "height": 0,
            "alt": "string"
          },
          "price": "string",
          "compare_at_price": "string",
          "total_price": "string",
          "fulfillment_status": "string",
          "sku": "string",
          "weight": "string",
          "weight_unit": "string",
          "vendor": "string",
          "product_url": "string",
          "created_at": "string",
          "updated_at": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "product_slug": "string",
          "taxable": true,
          "requires_shipping": true,
          "spu": "string",
          "product_tags": "string",
          "refund_quantity_total": 0,
          "custom": true,
          "trunk_price": "string",
          "discount_applications": "string",
          "tax_price": "string",
          "duty_price": "string",
          "payment_discount_price": "string",
          "custom_properties": {}
        }
      ],
      "payment_line": {
        "id": "string",
        "payment_name": "string",
        "payment_channel": "string",
        "payment_method": "string",
        "credit_card_number": "string",
        "trans_channel": "string",
        "trans_method": "string",
        "transaction_no": "string",
        "merchant_email": "string"
      },
      "shipping_line": {
        "id": "string",
        "name": "string",
        "desc": "string",
        "delivery_method": 0
      },
      "billing_address": {
        "first_name": "string",
        "last_name": "string",
        "address": "string",
        "address1": "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": {
          "addition": {},
          "cpf": "string",
          "tax_text": "string"
        }
      },
      "shipping_address": {
        "first_name": "string",
        "last_name": "string",
        "address": "string",
        "address1": "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": {
          "addition": {},
          "cpf": "string",
          "tax_text": "string"
        }
      },
      "fulfillments": [
        {
          "id": "string",
          "order_id": "string",
          "status": "string",
          "created_at": "string",
          "updated_at": "string",
          "tracking_company": "string",
          "tracking_number": "string",
          "tracking_company_code": "string",
          "line_items": [
            {
              "id": "string",
              "product_id": "string",
              "product_title": "string",
              "variant_id": "string",
              "variant_title": "string",
              "quantity": 0,
              "note": "string",
              "image": {
                "src": "string",
                "width": 0,
                "height": 0,
                "alt": "string"
              },
              "price": "string",
              "compare_at_price": "string",
              "total_price": "string",
              "fulfillment_status": "string",
              "sku": "string",
              "weight": "string",
              "weight_unit": "string",
              "vendor": "string",
              "product_url": "string",
              "created_at": "string",
              "updated_at": "string",
              "options": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "product_slug": "string",
              "taxable": true,
              "requires_shipping": true,
              "spu": "string",
              "product_tags": "string",
              "refund_quantity_total": 0,
              "ship_quantity": 0,
              "custom": true,
              "trunk_price": "string",
              "discount_applications": "string",
              "tax_price": "string",
              "duty_price": "string",
              "payment_discount_price": "string",
              "custom_properties": {}
            }
          ],
          "tracking_url": "string",
          "phone_number": "string",
          "tracking_items": [
            {
              "tracking_number": "string",
              "tracking_company": "string",
              "tracking_company_code": "string",
              "tracking_url": "string"
            }
          ]
        }
      ],
      "customer": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "created_at": "string",
        "updated_at": "string",
        "order_count": 0,
        "total_spent": "string"
      },
      "refer_info": "string",
      "sales_platform": "string",
      "total_refund_price": "string",
      "primary_market_price": {
        "compare_at_price": "string",
        "price": "string",
        "total_price": "string",
        "actual_rate": "string"
      },
      "total_tip_received": "string",
      "discount_applications": "string",
      "refund_status": "string",
      "email_status": "string",
      "recovery_status": "string",
      "total_paid": "string",
      "payment_lines": [
        {
          "id": "string",
          "payment_name": "string",
          "payment_channel": "string",
          "payment_method": "string",
          "credit_card_number": "string",
          "trans_channel": "string",
          "trans_method": "string",
          "transaction_no": "string",
          "merchant_email": "string"
        }
      ],
      "gift_card_total": "string",
      "logistics_code": "string",
      "shipping_tax_total": "string",
      "location_line": {
        "id": "string",
        "location_id": "string",
        "location_name": "string"
      },
      "additional_total": "string",
      "additional_prices": [
        {
          "name": "string",
          "price": "string",
          "biz_id": "string",
          "fee_title": "string"
        }
      ],
      "config": {
        "page_type": "string",
        "requires_shipping": true,
        "product_tax_included": true,
        "market_setting": {
          "primary_market_lang": "string",
          "market_lang": "string",
          "market_id": "string",
          "market_currency": "string",
          "market_currency_symbol": {
            "code": "string",
            "val": "string",
            "left": "string",
            "right": "string"
          },
          "market_base_id": "string",
          "market_base_currency": "string",
          "market_base_currency_symbol": {
            "code": "string",
            "val": "string",
            "left": "string",
            "right": "string"
          },
          "primary_market_id": "string",
          "primary_market_currency": "string",
          "primary_market_currency_symbol": {
            "code": "string",
            "val": "string",
            "left": "string",
            "right": "string"
          },
          "market_price_setting": {
            "local_currency_enabled": true,
            "custom_rate_enabled": true,
            "custom_rate": 0,
            "rate": 0,
            "back_rate": 0,
            "actual_rate": 0,
            "base_to_rate": 0,
            "local_to_rate": 0,
            "adjust": 0,
            "price_round_enabled": true
          },
          "market_country": "string"
        }
      },
      "checkout_url": "string",
      "duty_total": "string",
      "order_confirm_notify": 0,
      "fulfillment_notify": 0,
      "partial_fulfillment_notify": 0,
      "order_delivered_notify": 0,
      "finished_at": "string",
      "device": "string",
      "order_type": "string",
      "source": "string",
      "source_name": "string",
      "last_landing_url": "string",
      "last_referrer_show": "string",
      "browser_ip": "string"
    }
  }
}