put https://{shopdomain}.myshoplaza.com/openapi/2022-01/orders/
Response Description
Fields | Type | Desc |
---|---|---|
id | string | order id |
number | string | Order's number(more convenient for merchants) |
note | string | merchant input for taking a note |
status | string | Order status |
financial_status | string | Financial status |
fulfillment_status | string | Fulfillment status |
cancel_reason | string | |
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” |
payment_method | string | Payment method,such as apple_pay,cod,credit_card,online etc. |
string | @Deprecated. | |
discount_applications | string | Details of discounts |
customer_note | string | Customer's order note. |
string | @Do not focus too much. | |
@Do not focus too much. | ||
buyer_accepts_marketing | bool | Whether the customer accepts the marketing promotion |
currency | string | Currency code |
total_price | string | Total price of the order (final price paid by the customer), numeric string, for example: "9.99", |
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) |
product_tax_included | bool | refer to "sub_total" |
total_discount | string | Total discount price of order, numeric string, for example: "9.99" , include product discount,shipping discount and payment discount. |
total_tax | string | Sales tax on the order or Tax on the order product items., numeric string, for example: "9.99" |
total_shipping | string | Order logistics total fee, numeric string, for example: "9.99" |
code_discount_total | string | Order discount code discount price, numeric string, for example: "9.99" |
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" |
refund_status | string | Refund status:pending -failed -finished - |
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" |
additional_prices | array of AdditionalPrice | Additional fees, such as: shipping insurance, etc. |
additional_prices.name | fee type | |
additional_prices.price | string | the total of this fee type |
string | @Do not focus too much. | |
string | @Deprecated. | |
shipping_tax_total | string | Total shipping tax amount for the order. |
customer_deleted_at | string | Time of user deletion |
created_at | string | |
updated_at | string | |
deleted_at | string | Deletion time |
canceled_at | string | |
placed_at | string | Payment time |
total_tip_received | string | |
tags | string | Merchant tags the order |
string | @Do not focus too much. | |
email_status | string | Recovery email status:waiting means “pending to send”send means “sent” |
string | @Do not focus too much. | |
total_paid | string | Total payment amount |
string | @Do not focus too much. | |
object | @Do not focus too much. | |
string | @Do not focus too much. | |
string | @Do not focus too much. | |
object | @Do not focus too much. | |
string | @Do not focus too much. | |
string | @Do not focus too much. | |
shipping_line | object | Shipping plan |
shipping_line.name | string | |
customer | Object | Customer details |
customer.id | string | |
customer.email | string | |
customer.first_name | string | |
customer.last_name | string | |
customer.phone | string | |
customer.created_at | string | |
customer.updated_at | string | |
customer.orders_count | int | the created order of this customer |
customer.total_spent | string | Customer's total expenditure. |
shipping_address | Object | Delivery address |
shipping_address.first_name | string | |
shipping_address.last_name | string | |
shipping_address.address1 | string | |
shipping_address.address2 | string | |
shipping_address.phone | string | |
shipping_address.city | string | |
shipping_address.zip | string | |
shipping_address.province | string | |
shipping_address.country | string | |
shipping_address.company | string | |
shipping_address.name | string | |
shipping_address.Latitude | string | |
shipping_address.Longitude | string | |
shipping_address.country_code | string | |
shipping_address.province_code | string | |
shipping_address.phone_area_code | string | |
shipping_address.email | string | |
shipping_address.area | string | |
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 } |
billing_address | Object | Billing address |
billing_address.first_name | string | |
billing_address.last_name | string | |
billing_address.email | string | |
billing_address.country_code | string | |
billing_address.country | string | |
billing_address.province_code | string | |
billing_address.province | string | |
billing_address.area | string | |
billing_address.city | string | |
billing_address.address | string | |
billing_address.address1 | string | |
billing_address.zip | string | |
billing_address.company | string | |
billing_address.phone | string | |
payment_line | Object | one of payment_lines |
payment_line.payment_name | string | |
payment_line.payment_channel | string | such as : cod,dlocal, ,ebanxlocal, oceanapple etc. |
payment_line.payment_method | string | such as: thirdpay/online/apple_pay/cod etc. |
payment_line.transaction_no | string | |
payment_line.merchant_id | string | |
payment_line.merchant_email | string | |
payment_line.paid_total | string | total payment amount |
payment_lines | array of Payment_line object | If there are multiple payment methods, then return all the payment methods. |
payment_lines.payment_name | string | |
payment_lines.payment_channel | string | |
payment_lines.payment_method | string | |
payment_lines.transaction_no | string | |
payment_lines.merchant_id | string | |
payment_lines.merchant_email | string | |
payment_lines.paid_total | string | |
line_items | array of orderlineItem Ojbect | List of purchased products |
line_items.id | string | |
line_items.product_id | string | |
line_items.variant_id | string | |
line_items.variant_title | string | |
line_items.product_title | string | |
string | @Do not focus too much. | |
line_items.quantity | string | the number of product |
line_items.note | string | |
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). |
line_items.sku | string | |
line_items.weight_unit | string | |
line_items.vendor | string | Product supplier |
line_items.product_url | string | |
line_items.compare_at_price | string | Original price of the product |
line_items.image | string | |
line_items.price | string | sales price |
line_items.total | string | total_price = price *quantity |
line_items.weight | string | |
line_items.properties | Object of LineItemOption | |
line_items.properties.name | string | |
line_items.properties.value | string | |
line_items.custom_properties | json | |
string | @Deprecated | |
string | @Deprecated refund_total=refund_quantity* | |
string | @Do not focus too much. | |
line_items.discount_applications | string | Detailed information on discounts. |
line_items.requires_shipping | bool | if true means requires logistics. |
fulfillments | array of Fulfillment Object | List of fulfillments |
fulfillments.id | string | |
fulfillments.order_id | string | |
fulfillments.status | string | Waybill status: waiting (Pending Shipment), shipped (Shipped), finished (Completed), cancelled (Cancelled) |
fulfillments.tracking_company | string | |
fulfillments.tracking_number | string | |
fulfillments.tracking_company_code | string | |
fulfillments.created_at | string | |
fulfillments.updated_at | string | |
fulfillments.line_items | array of FulfillmentLineItem | Logistics information for the product in transit. |
fulfillments.line_items.id | string | |
fulfillments.line_items.product_id | string | |
fulfillments.line_items.variant_id | string | |
fulfillments.line_items.variant_title | string | |
fulfillments.line_items.product_title | string | |
string | @Do not focus too much. | |
fulfillments.line_items.quantity | string | |
fulfillments.line_items.note | string | |
fulfillments.line_items.fulfillment_status | string | |
fulfillments.line_items.sku | string | |
fulfillments.line_items.weight_unit | string | |
fulfillments.line_items.vendor | string | |
fulfillments.line_items.product_url | string | |
fulfillments.line_items.compare_at_price | string | |
fulfillments.line_items.image | string | |
fulfillments.line_items.price | string | |
fulfillments.line_items.total | string | |
fulfillments.line_items.weight | string | |
fulfillments.line_items.properties | string | |
fulfillments.line_items.properties.name | string | |
fulfillments.line_items.properties.vaule | string | |
fulfillments.line_items.custom_properties | json | |
fulfillments.line_items.refund_quantity | string | |
fulfillments.line_items.refund_total | string | |
fulfillments.line_items.taxable | bool | if true means contains tax |
fulfillments.line_items.requires_shipping | bool | if true means requires logistics. |
fulfillments.line_items.shipping_quantity | string | |
fulfillments.phone_number | string | |
logistics_code | string | Logistics code |
refer_info | string | the information of visited user agent |
config | Object of orderconfig | Order configuration information |
config.page_type | string | Payment type |
config.requires_shipping | bool | Whether shipping is required |
int | @Do not focus too much. | |
config.product_tax_included | bool | Whether the product includes tax |
int | @Do not focus too much. | |
config.market_setting | Object of MarketSetting | |
config.market_setting.primary_market_lang | string | Primary market language |
config.market_setting.market_lang | string | Current market language, for example: en-US |
config.market_setting.market_id | string | Market configuration ID |
config.market_setting.market_currency | string | Market currency code, for example: USD |
config.market_setting.market_currency_symbol | object of CurrencySymbol | |
config.market_setting.market_currency_symbol.code | string | Currency code, for example: USD |
config.market_setting.market_currency_symbol.val | string | Currency symbol, for example: $ |
config.market_setting.market_currency_symbol.left | string | Content displayed to the left of the number, for example: $ |
config.market_setting.market_currency_symbol.right | string | Content displayed to the right of the numbe |
config.market_setting.market_base_id | string | |
config.market_setting.market_base_currency | string | |
config.market_setting.market_base_currency_symbol | object of CurrencySymbol | |
config.market_setting.primary_market_id | ||
config.market_setting.primary_market_currency | ||
config.market_setting.primary_market_currency_symbol | object of CurrencySymbol | |
config.market_setting.market_price_setting | object of MarketPriceSetting | |
config.market_setting.market_price_setting.local_currency_enabled | bool | Local currency enable status |
config.market_setting.market_price_setting.custom_rate_enabled | bool | Custom rate enable status |
config.market_setting.market_price_setting.custom_rate | float | Custom rate, primary market currency -> market base currency |
config.market_setting.market_price_setting.rate | float | primary market currency -> market base currency / local currency |
config.market_setting.market_price_setting.back_rate | float | market base currency / local currency -> primary market currency |
config.market_setting.market_price_setting.actual_rate | float | Actual exchange rate, primary market currency -> market base currency / local currency |
config.market_setting.market_price_setting.base_to_local | float | market base currency -> local currency |
config.market_setting.market_price_setting.local_to_base | float | |
config.market_setting.market_price_setting.adjust | float | Price adjustment |
config.market_setting.market_price_setting.price_round_enabled | bool | Enable price rounding |
config.market_setting.market_country | string | Market country, for example: US |
config_info | json | json of config |
location_line | object of LocationLine | |
location_line.id | ||
location_line.location_id | ||
location_line.location_name | ||
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 |
---|---|---|
Record not found | ||
422 | StatusUnprocessableEntity | 1.InvalidArgument 2.FailedPrecondition 3.AlreadyExists |
500 | StatusInternalServerError | Aborted |
499 | deadline is exceeded | |
authentication metadata is invalid or a Credentials callback fails |