Order List

get https://{subdomain}.myshoplaza.com/openapi/2022-01/orders

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

Fields	Type	Desc
count	int	Total number of records in this query.
next_token	string	The next positioning of the cursor (requires submission of the previous query conditions).
orders	arrays of order object
order.id	string	order id
order.number	string	Order's number(more convenient for merchants)
order.note	string	merchant input for taking a note
order.status	string	Order status
order.financial_status	string	Financial status
order.fulfillment_status	string	Fulfillment status
order.cancel_reason	string
order.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”
order.payment_method	string	Payment method,such as apple_pay,cod,credit_card,online etc.
~~order.discount_code~~	string	@Deprecated.
order.discount_applications	string	Details of discounts
order.customer_note	string	Customer's order note.
~~order.landing_site~~	string	@Do not focus too much.
~~order.sales_platform~~		@Do not focus too much.
order.buyer_accepts_marketing	bool	Whether the customer accepts the marketing promotion
order.currency	string	Currency code
order.total_price	string	Total price of the order (final price paid by the customer), numeric string, for example: `"9.99",`
order.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)
order.product_tax_included	bool	refer to "sub_total"
order.total_discount	string	Total discount price of order, numeric string, for example: `"9.99"`, include product discount,shipping discount and payment discount.
order.total_tax	string	Sales tax on the order or Tax on the order product items., numeric string, for example: `"9.99"`
order.total_shipping	string	Order logistics total fee, numeric string, for example: `"9.99"`
order.code_discount_total	string	Order discount code discount price, numeric string, for example: `"9.99"`
order.line_item_discount_total	string	@Deprecated.total Product discount, numeric string, for example: `"9.99"`,includes code_discount_total
order.gift_card_total	string	Gift card discount amount, numeric string, for example: `"9.99"`
order.total_refund_price	string	Total refund amount has been successfully processed, numeric string, for example: `"9.99"`
order.refund_status	string	Refund status: `pending` - `failed` - `finished` -
~~order.total_refund_discount~~	string	@Deprecated.Total discount refunded, numeric string, for example: `"9.99"`
order.additional_total	string	Total amount of additional charges, numeric string, for example: `"9.99"`
order.additional_prices	array of AdditionalPrice	Additional fees, such as: shipping insurance, etc.
order.additional_prices.name		fee type
order.additional_prices.price	string	the total of this fee type
~~order.additional_prices.biz_id~~	string	@Do not focus too much.
~~order.total_refund_tax~~	string	@Deprecated.
order.shipping_tax_total	string	Total shipping tax amount for the order.
order.customer_deleted_at	string	Time of user deletion
order.created_at	string
order.updated_at	string
order.deleted_at	string	Deletion time
order.canceled_at	string
order.placed_at	string	Payment time
order.total_tip_received	string
order.tags	string	Merchant tags the order
~~order.browser_ip~~	string	@Do not focus too much.
order.email_status	string	Recovery email status: `waiting` means “pending to send” `send` means “sent”
~~order.last_landing_url~~	string	@Do not focus too much.
order.total_paid	string	Total payment amount
~~order.source~~	string	@Do not focus too much.
~~order.source_name~~	object	@Do not focus too much.
~~order.source_name.data~~	string	@Do not focus too much.
~~order.source_name.created_at~~	string	@Do not focus too much.
~~order.last_referrer_show~~	object	@Do not focus too much.
~~order.last_referrer_show.data~~	string	@Do not focus too much.
~~order.last_referrer_show.created_at~~	string	@Do not focus too much.
order.shipping_line	object	Shipping plan
order.shipping_line.name	string
order.customer	Object	Customer details
order.customer.id	string
order.customer.email	string
order.customer.first_name	string
order.customer.last_name	string
order.customer.phone	string
order.customer.created_at	string
order.customer.updated_at	string
order.customer.orders_count	int	the created order of this customer
order.customer.total_spent	string	Customer's total expenditure.
order.shipping_address	Object	Delivery address
order.shipping_address.first_name	string
order.shipping_address.last_name	string
order.shipping_address.address1	string
order.shipping_address.address2	string
order.shipping_address.phone	string
order.shipping_address.city	string
order.shipping_address.zip	string
order.shipping_address.province	string
order.shipping_address.country	string
order.shipping_address.company	string
order.shipping_address.name	string
order.shipping_address.Latitude	string
order.shipping_address.Longitude	string
order.shipping_address.country_code	string
order.shipping_address.province_code	string
order.shipping_address.phone_area_code	string
order.shipping_address.email	string
order.shipping_address.area	string
order.shipping_address.extra_info	json	"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_address	Object	Billing address
order.billing_address.first_name	string
order.billing_address.last_name	string
order.billing_address.email	string
order.billing_address.country_code	string
order.billing_address.country	string
order.billing_address.province_code	string
order.billing_address.province	string
order.billing_address.area	string
order.billing_address.city	string
order.billing_address.address	string
order.billing_address.address1	string
order.billing_address.zip	string
order.billing_address.company	string
order.billing_address.phone	string
order.payment_line	Object	one of payment_lines
order.payment_line.payment_name	string
order.payment_line.payment_channel	string	such as : cod,dlocal, ,ebanxlocal, oceanapple etc.
order.payment_line.payment_method	string	such as: thirdpay/online/apple_pay/cod etc.
order.payment_line.transaction_no	string
order.payment_line.merchant_id	string
order.payment_line.merchant_email	string
order.payment_line.paid_total	string	total payment amount
order.payment_lines	array of Payment_line object	If there are multiple payment methods, then return all the payment methods.
order.payment_lines.payment_name	string
order.payment_lines.payment_channel	string
order.payment_lines.payment_method	string
order.payment_lines.transaction_no	string
order.payment_lines.merchant_id	string
order.payment_lines.merchant_email	string
order.payment_lines.paid_total	string
order.line_items	array of orderlineItem Ojbect	List of purchased products
order.line_items.id	string
order.line_items.product_id	string
order.line_items.variant_id	string
order.line_items.variant_title	string
order.line_items.product_title	string
~~order.line_items.product_handle~~	string	@Do not focus too much.
order.line_items.quantity	string	the number of product
order.line_items.note	string
order.line_items.fulfillment_status	string	Logistics 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.sku	string
order.line_items.weight_unit	string
order.line_items.vendor	string	Product supplier
order.line_items.product_url	string
order.line_items.compare_at_price	string	Original price of the product
order.line_items.image	string
order.line_items.price	string	sales price
order.line_items.total	string	total_price = price *quantity
order.line_items.weight	string
order.line_items.properties	Object of LineItemOption
order.line_items.properties.name	string
order.line_items.properties.value	string
order.line_items.custom_properties	json
~~order.line_items.refund_quantity~~	string	@Deprecated
~~order.line_items.refund_total~~	string	@Deprecated refund_total=refund_quantity*
~~order.line_items.base_price~~	string	@Do not focus too much.
order.line_items.discount_applications	string	Detailed information on discounts.
order.line_items.requires_shipping	bool	if true means requires logistics.
order.fulfillments	array of Fulfillment Object	List of fulfillments
order.fulfillments.id	string
order.fulfillments.order_id	string
order.fulfillments.status	string	Waybill status： waiting (Pending Shipment), shipped (Shipped), finished (Completed), cancelled (Cancelled)
order.fulfillments.tracking_company	string
order.fulfillments.tracking_number	string
order.fulfillments.tracking_company_code	string
order.fulfillments.created_at	string
order.fulfillments.updated_at	string
order.fulfillments.line_items	array of FulfillmentLineItem	Logistics information for the product in transit.
order.fulfillments.line_items.id	string
order.fulfillments.line_items.product_id	string
order.fulfillments.line_items.variant_id	string
order.fulfillments.line_items.variant_title	string
order.fulfillments.line_items.product_title	string
~~order.fulfillments.line_items.product_handle~~	string	@Do not focus too much.
order.fulfillments.line_items.quantity	string
order.fulfillments.line_items.note	string
order.fulfillments.line_items.fulfillment_status	string
order.fulfillments.line_items.sku	string
order.fulfillments.line_items.weight_unit	string
order.fulfillments.line_items.vendor	string
order.fulfillments.line_items.product_url	string
order.fulfillments.line_items.compare_at_price	string
order.fulfillments.line_items.image	string
order.fulfillments.line_items.price	string
order.fulfillments.line_items.total	string
order.fulfillments.line_items.weight	string
order.fulfillments.line_items.properties	string
order.fulfillments.line_items.properties.name	string
order.fulfillments.line_items.properties.vaule	string
order.fulfillments.line_items.custom_properties	json
order.fulfillments.line_items.refund_quantity	string
order.fulfillments.line_items.refund_total	string
order.fulfillments.line_items.taxable	bool	if true means contains tax
order.fulfillments.line_items.requires_shipping	bool	if true means requires logistics.
order.fulfillments.line_items.shipping_quantity	string
order.fulfillments.phone_number	string
order.logistics_code	string	Logistics code
order.refer_info	string	the information of visited user agent
order.config	Object of orderconfig	Order configuration information
order.config.page_type	string	Payment type
order.config.requires_shipping	bool	Whether shipping is required
~~order.config.checkout_business_type~~	int	@Do not focus too much.
order.config.product_tax_included	bool	Whether the product includes tax
~~order.config.checkout_template_type~~	int	@Do not focus too much.
order.config.market_setting	Object of MarketSetting
order.config.market_setting.primary_market_lang	string	rimary market language
order.config.market_setting.market_lang	string	current market language, for example: en-US
order.config.market_setting.market_id	string	Market configuration ID
order.config.market_setting.market_currency	string	Market currency code, for example: USD
order.config.market_setting.market_currency_symbol	object of CurrencySymbol
order.config.market_setting.market_currency_symbol.code	string	Currency code, for example: USD
order.config.market_setting.market_currency_symbol.val	string	Currency symbol, for example: $
order.config.market_setting.market_currency_symbol.left	string	Content displayed to the left of the number, for example: $
order.config.market_setting.market_currency_symbol.right	string	Content displayed to the right of the numbe
order.config.market_setting.market_base_id	string
order.config.market_setting.market_base_currency	string
order.config.market_setting.market_base_currency_symbol	object of CurrencySymbol
order.config.market_setting.primary_market_id
order.config.market_setting.primary_market_currency
order.config.market_setting.primary_market_currency_symbol	object of CurrencySymbol
order.config.market_setting.market_price_setting	object of MarketPriceSetting
order.config.market_setting.market_price_setting.local_currency_enabled	bool	Local currency enable status
order.config.market_setting.market_price_setting.custom_rate_enabled	bool	Custom rate enable status
order.config.market_setting.market_price_setting.custom_rate	float	Custom rate, primary market currency -> market base currency
order.config.market_setting.market_price_setting.rate	float	primary market currency -> market base currency / local currency
order.config.market_setting.market_price_setting.back_rate	float	market base currency / local currency -> primary market currency
order.config.market_setting.market_price_setting.actual_rate	float	Actual exchange rate, primary market currency -> market base currency / local currency
order.config.market_setting.market_price_setting.base_to_local	float	market base currency -> local currency
order.config.market_setting.market_price_setting.local_to_base	float
order.config.market_setting.market_price_setting.adjust	float	Price adjustment
order.config.market_setting.market_price_setting.price_round_enabled	bool	Enable price rounding
order.config.market_setting.market_country	string	Market country, for example: US
order.config_info	json	json of config
order.location_line	object of LocationLine
order.location_line.id
order.location_line.location_id
order.location_line.location_name
order.checkout_url	string	The link used for payment of this order.
primary_market_price	object of PrimaryMarketPrice
primary_market_price.price	string	Prices converted into primary market currencies
primary_market_price.actual_rate	float	The actual exchange rate against the primary currency

Error Detail

ErrorCode	Description	Possible reasons
406		1:per_page too large 2:deep pagination not allowed
500	StatusInternalServerError	Aborted/NotFound/Unimplemented/Unauthenticated/DeadlineExceeded
400		1:invalid sort_by param 2:invalid sort_direction param

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.

Error Detail

Request Params

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

Error Detail

Request Params

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

📘
The relationships between entities.