Order List

📘

The data returned by the list interface may not necessarily be consistent with the order data displayed by the store admin. The store admin will filter out orders with a status of canceled and those without a shipping address and more filters.

Response Description

📘

The relationships between entities.


FieldsTypeDesc
countintTotal number of records in this query.
next_tokenstringThe next positioning of the cursor (requires submission of the previous query conditions).
ordersarrays of order object
order.idstringorder id
order.numberstringOrder's number(more convenient for merchants)
order.notestringmerchant input for taking a note
order.statusstringOrder status
order.financial_statusstringFinancial status
order.fulfillment_statusstringFulfillment status
order.cancel_reasonstring
order.recovery_statusstringRecovery status:
waiting means “to be recalled”
sending means “sent”
recalling means “recall in progress”
failed means “recall failed”
success means “recall successful”
order.payment_methodstringPayment method,such as apple_pay,cod,credit_card,online etc.
order.discount_codestring@Deprecated.
order.discount_applicationsstringDetails of discounts
order.customer_notestringCustomer's order note.
order.landing_sitestring@Do not focus too much.
order.sales_platform@Do not focus too much.
order.buyer_accepts_marketingboolWhether the customer accepts the marketing promotion
order.currencystringCurrency code
order.total_pricestringTotal price of the order (final price paid by the customer), numeric string, for example: "9.99",
order.sub_totalstringTotal 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)
order.product_tax_includedboolrefer to "sub_total"
order.total_discountstringTotal discount price of order, numeric string, for example: "9.99", include product discount,shipping discount and payment discount.
order.total_taxstringSales tax on the order or Tax on the order product items., numeric string, for example: "9.99"
order.total_shippingstringOrder logistics total fee, numeric string, for example: "9.99"
order.code_discount_totalstringOrder discount code discount price, numeric string, for example: "9.99"
order.line_item_discount_totalstring@Deprecated.total Product discount, numeric string, for example: "9.99",includes code_discount_total
order.gift_card_totalstringGift card discount amount, numeric string, for example: "9.99"
order.total_refund_pricestringTotal refund amount has been successfully processed, numeric string, for example: "9.99"
order.refund_statusstringRefund status:
pending -
failed -
finished -
order.total_refund_discountstring@Deprecated.Total discount refunded, numeric string, for example: "9.99"
order.additional_totalstringTotal amount of additional charges, numeric string, for example: "9.99"
order.additional_pricesarray of AdditionalPriceAdditional fees, such as: shipping insurance, etc.
order.additional_prices.namefee type
order.additional_prices.pricestringthe total of this fee type
order.additional_prices.biz_idstring@Do not focus too much.
order.total_refund_taxstring@Deprecated.
order.shipping_tax_totalstringTotal shipping tax amount for the order.
order.customer_deleted_atstringTime of user deletion
order.created_atstring
order.updated_atstring
order.deleted_atstringDeletion time
order.canceled_atstring
order.placed_atstringPayment time
order.total_tip_receivedstring
order.tagsstringMerchant tags the order
order.browser_ipstring@Do not focus too much.
order.email_statusstringRecovery email status:
waiting means “pending to send”
send means “sent”
order.last_landing_urlstring@Do not focus too much.
order.total_paidstringTotal payment amount
order.sourcestring@Do not focus too much.
order.source_nameobject@Do not focus too much.
order.source_name.datastring@Do not focus too much.
order.source_name.created_atstring@Do not focus too much.
order.last_referrer_showobject@Do not focus too much.
order.last_referrer_show.datastring@Do not focus too much.
order.last_referrer_show.created_atstring@Do not focus too much.
order.shipping_lineobjectShipping plan
order.shipping_line.namestring
order.customerObjectCustomer details
order.customer.idstring
order.customer.emailstring
order.customer.first_namestring
order.customer.last_namestring
order.customer.phonestring
order.customer.created_atstring
order.customer.updated_atstring
order.customer.orders_countintthe created order of this customer
order.customer.total_spentstringCustomer's total expenditure.
order.shipping_addressObjectDelivery address
order.shipping_address.first_namestring
order.shipping_address.last_namestring
order.shipping_address.address1string
order.shipping_address.address2string
order.shipping_address.phonestring
order.shipping_address.citystring
order.shipping_address.zipstring
order.shipping_address.provincestring
order.shipping_address.countrystring
order.shipping_address.companystring
order.shipping_address.namestring
order.shipping_address.Latitudestring
order.shipping_address.Longitudestring
order.shipping_address.country_codestring
order.shipping_address.province_codestring
order.shipping_address.phone_area_codestring
order.shipping_address.emailstring
order.shipping_address.areastring
order.shipping_address.extra_infojson"extra_info": {
"cpf":"123.123.123-12", // Tax ID
"id_number":"32010219800101001X", // Identity Card Number
"id_number_text":"Resident Identity Card", // Identity Card Description
"tax_text":"Tax ID" // Tax ID Description
}
order.billing_addressObjectBilling address
order.billing_address.first_namestring
order.billing_address.last_namestring
order.billing_address.emailstring
order.billing_address.country_codestring
order.billing_address.countrystring
order.billing_address.province_codestring
order.billing_address.provincestring
order.billing_address.areastring
order.billing_address.citystring
order.billing_address.addressstring
order.billing_address.address1string
order.billing_address.zipstring
order.billing_address.companystring
order.billing_address.phonestring
order.payment_lineObjectone of payment_lines
order.payment_line.payment_namestring
order.payment_line.payment_channelstringsuch as : cod,dlocal,
,ebanxlocal, oceanapple etc.
order.payment_line.payment_methodstringsuch as: thirdpay/online/apple_pay/cod etc.
order.payment_line.transaction_nostring
order.payment_line.merchant_idstring
order.payment_line.merchant_emailstring
order.payment_line.paid_totalstringtotal payment amount
order.payment_linesarray of Payment_line objectIf there are multiple payment methods, then return all the payment methods.
order.payment_lines.payment_namestring
order.payment_lines.payment_channelstring
order.payment_lines.payment_methodstring
order.payment_lines.transaction_nostring
order.payment_lines.merchant_idstring
order.payment_lines.merchant_emailstring
order.payment_lines.paid_totalstring
order.line_itemsarray of orderlineItem OjbectList of purchased products
order.line_items.idstring
order.line_items.product_idstring
order.line_items.variant_idstring
order.line_items.variant_titlestring
order.line_items.product_titlestring
order.line_items.product_handlestring@Do not focus too much.
order.line_items.quantitystringthe number of product
order.line_items.notestring
order.line_items.fulfillment_statusstringLogistics status:
initialled (empty),
waiting (pending shipment),
partially_shipped (partially shipped),
shipped (shipped),
partially_finished (partially completed),
finished (completed),
cancelled (cancelled),
returning (returning),
returned (returned).
order.line_items.skustring
order.line_items.weight_unitstring
order.line_items.vendorstringProduct supplier
order.line_items.product_urlstring
order.line_items.compare_at_pricestringOriginal price of the product
order.line_items.imagestring
order.line_items.pricestringsales price
order.line_items.totalstringtotal_price = price *quantity
order.line_items.weightstring
order.line_items.propertiesObject of LineItemOption
order.line_items.properties.namestring
order.line_items.properties.valuestring
order.line_items.custom_propertiesjson
order.line_items.refund_quantitystring@Deprecated
order.line_items.refund_totalstring@Deprecated refund_total=refund_quantity*
order.line_items.base_pricestring@Do not focus too much.
order.line_items.discount_applicationsstringDetailed information on discounts.
order.line_items.requires_shippingboolif true means requires logistics.
order.fulfillmentsarray of Fulfillment ObjectList of fulfillments
order.fulfillments.idstring
order.fulfillments.order_idstring
order.fulfillments.statusstringWaybill status:
waiting (Pending Shipment),
shipped (Shipped),
finished (Completed),
cancelled (Cancelled)
order.fulfillments.tracking_companystring
order.fulfillments.tracking_numberstring
order.fulfillments.tracking_company_codestring
order.fulfillments.created_atstring
order.fulfillments.updated_atstring
order.fulfillments.line_itemsarray of FulfillmentLineItemLogistics information for the product in transit.
order.fulfillments.line_items.idstring
order.fulfillments.line_items.product_idstring
order.fulfillments.line_items.variant_idstring
order.fulfillments.line_items.variant_titlestring
order.fulfillments.line_items.product_titlestring
order.fulfillments.line_items.product_handlestring@Do not focus too much.
order.fulfillments.line_items.quantitystring
order.fulfillments.line_items.notestring
order.fulfillments.line_items.fulfillment_statusstring
order.fulfillments.line_items.skustring
order.fulfillments.line_items.weight_unitstring
order.fulfillments.line_items.vendorstring
order.fulfillments.line_items.product_urlstring
order.fulfillments.line_items.compare_at_pricestring
order.fulfillments.line_items.imagestring
order.fulfillments.line_items.pricestring
order.fulfillments.line_items.totalstring
order.fulfillments.line_items.weightstring
order.fulfillments.line_items.propertiesstring
order.fulfillments.line_items.properties.namestring
order.fulfillments.line_items.properties.vaulestring
order.fulfillments.line_items.custom_propertiesjson
order.fulfillments.line_items.refund_quantitystring
order.fulfillments.line_items.refund_totalstring
order.fulfillments.line_items.taxableboolif true means contains tax
order.fulfillments.line_items.requires_shippingboolif true means requires logistics.
order.fulfillments.line_items.shipping_quantitystring
order.fulfillments.phone_numberstring
order.logistics_codestringLogistics code
order.refer_infostringthe information of visited user agent
order.configObject of orderconfigOrder configuration information
order.config.page_typestringPayment type
order.config.requires_shippingboolWhether shipping is required
order.config.checkout_business_typeint@Do not focus too much.
order.config.product_tax_includedboolWhether the product includes tax
order.config.checkout_template_typeint@Do not focus too much.
order.config.market_settingObject of MarketSetting
order.config.market_setting.primary_market_langstringrimary market language
order.config.market_setting.market_langstringcurrent market language, for example: en-US
order.config.market_setting.market_idstringMarket configuration ID
order.config.market_setting.market_currencystringMarket currency code, for example: USD
order.config.market_setting.market_currency_symbolobject of CurrencySymbol
order.config.market_setting.market_currency_symbol.codestringCurrency code, for example: USD
order.config.market_setting.market_currency_symbol.valstringCurrency symbol, for example: $
order.config.market_setting.market_currency_symbol.leftstringContent displayed to the left of the number, for example: $
order.config.market_setting.market_currency_symbol.rightstringContent displayed to the right of the numbe
order.config.market_setting.market_base_idstring
order.config.market_setting.market_base_currencystring
order.config.market_setting.market_base_currency_symbolobject of CurrencySymbol
order.config.market_setting.primary_market_id
order.config.market_setting.primary_market_currency
order.config.market_setting.primary_market_currency_symbolobject of CurrencySymbol
order.config.market_setting.market_price_settingobject of MarketPriceSetting
order.config.market_setting.market_price_setting.local_currency_enabledboolLocal currency enable status
order.config.market_setting.market_price_setting.custom_rate_enabledboolCustom rate enable status
order.config.market_setting.market_price_setting.custom_ratefloatCustom rate, primary market currency -> market base currency
order.config.market_setting.market_price_setting.ratefloatprimary market currency -> market base currency / local currency
order.config.market_setting.market_price_setting.back_ratefloatmarket base currency / local currency -> primary market currency
order.config.market_setting.market_price_setting.actual_ratefloatActual exchange rate, primary market currency -> market base currency / local currency
order.config.market_setting.market_price_setting.base_to_localfloatmarket base currency -> local currency
order.config.market_setting.market_price_setting.local_to_basefloat
order.config.market_setting.market_price_setting.adjustfloatPrice adjustment
order.config.market_setting.market_price_setting.price_round_enabledboolEnable price rounding
order.config.market_setting.market_countrystringMarket country, for example: US
order.config_infojsonjson of config
order.location_lineobject of LocationLine
order.location_line.id
order.location_line.location_id
order.location_line.location_name
order.checkout_urlstringThe link used for payment of this order.
primary_market_priceobject of PrimaryMarketPrice
primary_market_price.pricestringPrices converted into primary market currencies
primary_market_price.actual_ratefloatThe actual exchange rate against the primary currency

Error Detail

ErrorCodeDescriptionPossible reasons
4061:per_page too large
2:deep pagination not allowed
500StatusInternalServerErrorAborted/NotFound/Unimplemented/Unauthenticated/DeadlineExceeded
4001:invalid sort_by param
2:invalid sort_direction param

Request Params

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!