Get Order Details
Last Updated on : 2024-03-07 02:43:32download
Get the order details based on the order ID.
API address
GET: /v1.0/sellercenter/order/{order_id}
Request parameter
| Parameter name | Type | IN | Required | Description |
|---|---|---|---|---|
| order_id | String | uri | true | The order ID. |
| mall_code | String | query | true | The code of a specified mall. |
| site_code | String | query | true | The code of a specified site. |
| lang | String | query | false | The code of a specified language. |
Return parameter
| Parameter name | Type | Description |
|---|---|---|
| result | OrderDetailOpenVO | The result of the query. |
Description of result
| Parameter name | Type | Description |
|---|---|---|
| order_id | String | The unique identifier of a specified order. |
| order_type_code | String | The code of a specified order type. |
| order_status | String | The status of a specified order. |
| amount_origin | BigDecimal | The original price of a specified order. |
| amount_trade | BigDecimal | The transaction price of a specified order. |
| amount_paid | BigDecimal | The paid amount of a specified order. |
| amount_rest | BigDecimal | The remaining amount to be paid. |
| price_trade_list | List | The total price details of a specified order. |
| gmt_order_create | Long | The time when an order is created. |
| gmt_order_pay | Long | The time when a specified order is paid. |
| commodity_list | List | The list of commodities in the order. |
| currency | String | The currency. |
| payment_list | List | The payment flow of a specified order. |
| refund_status | Integer | The status of refund. |
| amount_refund | BigDecimal | The refund amount. |
| address | AddressVO | The delivery address. |
| delivery_list | List | The information about the delivery list. |
| order_flow_list | List | The list of order status. |
| customer | CustomerVO | The information about a specified buyer. |
| remark | String | The remarks by the seller. |
| buyer_remark | String | The remarks by the buyer. |
| payment_detail | PaymentDetail | The payment information of a specified order. |
Description of commodity_list
| Parameter name | Type | Description |
|---|---|---|
| commodity_code | String | The code of a specified commodity. |
| specification_code | String | The stock keeping unit (SKU) of a specified commodity. |
| commodity_name | String | The name of a specified commodity. |
| icon_url | String | The icon URL of a specified commodity. |
| currency | String | The currency. |
| unit_price_origin | BigDecimal | The original unit price. |
| unit_price_trade | BigDecimal | The transaction unit price. |
| unit_name | String | The unit, such as pieces and times. |
| quantity | Integer | The quantity of a specified commodity. |
| attach_json | JSONObject | The additional information about a specified commodity. |
Description of payment_detail
| Parameter name | Type | Description |
|---|---|---|
| currency | String | The currency. |
| commodity_origin_amount | BigDecimal | The amount of a specified commodity. |
| shipping_fee_name | String | The name of a specified freight. |
| shipping_amount | BigDecimal | The freight. |
| install_amount | BigDecimal | The installation fee. |
| discount_type | String | The discount type. Valid values:
|
| discount_code | String | The code of a specified discount. |
| discount_amount | BigDecimal | The discount amount. |
| points_used | Integer | The loyalty points used. |
| points_deduct_amount | BigDecimal | The amount deducted by loyalty points. |
| trade_amount | BigDecimal | The transaction amount of a specified order. |
| paid_amount | BigDecimal | The paid amount of a specified order. |
| refund_amount | BigDecimal | The refund amount. |
Description of address
| Parameter name | Type | Description |
|---|---|---|
| address_id | String | The ID of a specified address. |
| name | String | The recipient. |
| phone | String | The contact phone number. |
| country | String | The country or region. |
| country_code | String | The code of a specified country or region. |
| province | String | The name of a specified province. |
| city | String | The name of a specified city. |
| district | String | The name of a specified district or county. |
| address_detail | String | The detailed address. |
| address | AddressVO | The delivery address. |
| is_default | Byte | Indicates whether the value is default or not. |
| post_code | String | The postal code. |
| site | String | The site. |
Description of delivery_list
| Parameter name | Type | Description |
|---|---|---|
| delivery_id | String | The ID of a specified package. |
| delivery_status | Integer | The status of a specified package. |
| gmt_out_stock | Long | The time when the package is dispatched. |
| logistics_company | String | The code of a specified logistics company. |
| logistics_company_name | String | The name of a specified logistics company. |
| logistics_no | String | The logistical tracking number. |
| delivery_quantity | Integer | The total number of SKUs. |
| delivery_detail_list | List | The details of package delivery. |
Description of order_flow_list
| Parameter name | Type | Description |
|---|---|---|
| order_flow_id | String | The primary key of the order business flow chart. |
| order_id | String | The order ID. |
| creator_id | String | The creator ID. |
| order_status_boss | String | The status of the main standard order. |
| order_status | String | The status of a specified order. |
| gmt_create | Long | The time when it was created. |
| gmt_modified | Long | The time when it is modified. |
Description of price_trade_list
| Parameter name | Type | Description |
|---|---|---|
| Key | String | The code of a specified price detail. |
| price_detail_name | String | The name of a specified price detail. |
| amount | BigDecimal | The sales price. |
| amount_origin | BigDecimal | The original price. |
| amount_coupon | BigDecimal | The discount amount. |
| attach | JSONObject | The additional information. |
Description of payment_list
| Parameter name | Type | Description |
|---|---|---|
| trade_amount | BigDecimal | The amount of payment. |
| currency | String | The currency. |
| paid_provider | String | The payment service provider. |
| paid_type | String | The payment type. |
| transaction_no | String | The transaction number. |
| gmt_create | Long | The time when it was created. |
| trade_status | String | The status of payment. |
Description of customer
| Parameter name | Type | Description |
|---|---|---|
| uid | String | The user ID (UID) of a specified buyer. |
| name | String | The nickname. |
| mobile | String | The phone number. |
| String | The email address. |
Description of address
| Parameter name | Type | Description |
|---|---|---|
| address_id | String | The ID of a specified address. |
| name | String | The recipient. |
| phone | String | The contact phone number. |
| country | String | The country or region. |
| country_code | String | The code of a specified country or region. |
| province | String | The name of a specified province. |
| city | String | The name of a specified city. |
| district | String | The name of a specified district or county. |
| address_detail | String | The detailed address. |
| address | String | The complete address, including province, city, district, and detailed address. |
| is_default | Byte | Indicates whether the value is default or not. |
| post_code | String | The postal code. |
| site | String | The site. |
Description of delivery_detail_list
| Parameter name | Type | Description |
|---|---|---|
| commodity_code | String | The code of a specified commodity in the order. |
| sku_code | String | The SKU code of a specified commodity. |
| delivery_quantity | Integer | The quantity of delivery. |
Request example
GET: /v1.0/sellercenter/order/test_order_id?mall_code=MALL_CODE&site_code=SITE_CODE
Return example
{
"result": {
"amount_paid": {
"Value": "1.04"
},
"address": {
"country": "China",
"address": "Gdichakjcn, Dongcheng District, Beijing Municipality",
"address_type": 0,
"city": "Municipal District",
"address_id": "7a33441805a4934a8",
"is_default": 1,
"address_detail": "gdichakjcn",
"country_code": "86",
"site": "CN",
"province": "Beijing",
"phone": "136****6837",
"scope_id": "SO2110258K167O5C",
"district": "Dongcheng District",
"name": "ewfdjfutjghsnewfdjfutjghsnewfdjfutjghr",
"scope_type": "order"
},
"refund_status": -2,
"delivery_list": [
{
"logistics_no": "1111",
"delivery_id": "142837559e57c000",
"gmt_out_stock": 0,
"logistics_company": "agopost",
"delivery_status": 2,
"logistics_company_name": "Super Courier",
"delivery_detail_list": [
{
"commodity_code": "CMar68c6bxxgs4",
"delivery_quantity": 1,
"sku_code": "SKar68c6djd4q0"
}
]
},
{
"logistics_no": "1235YT",
"delivery_id": "14283767dbb78000",
"gmt_out_stock": 0,
"logistics_company": "annto",
"delivery_status": 2,
"logistics_company_name": "Annto Logistics",
"delivery_detail_list": [
{
"commodity_code": "CMaowxikwzdohw",
"delivery_quantity": 1,
"sku_code": "SKaowxikzha0y3"
},
{
"commodity_code": "CMa1kxmeidi592",
"delivery_quantity": 1,
"sku_code": "SKa1kxmekswldn"
}
]
}
],
"order_flow_list": [
{
"gmt_create": 1635131166548,
"order_flow_id": "1452471502836826112",
"gmt_modified": 1635131166548,
"order_status": "created",
"creator_id": "sh1620790178699Ms6LM",
"order_status_boss": "created",
"order_id": "SO2110258K167O5C"
},
{
"gmt_create": 1635131169674,
"order_flow_id": "1452471515946139648",
"gmt_modified": 1635131169674,
"order_status": "paid",
"creator_id": "sh1620790178699Ms6LM",
"order_status_boss": "paid",
"order_id": "SO2110258K167O5C"
},
{
"gmt_create": 1635131169720,
"order_flow_id": "1452471516139077632",
"gmt_modified": 1635131169720,
"order_status": "pending_audit_paid",
"creator_id": "sh1620790178699Ms6LM",
"order_status_boss": "",
"order_id": "SO2110258K167O5C"
},
{
"gmt_create": 1635131193523,
"order_flow_id": "1452471615976095744",
"gmt_modified": 1635131193523,
"order_status": "paid",
"creator_id": "sh15408881429088tZ2u",
"order_status_boss": "paid",
"order_id": "SO2110258K167O5C"
},
{
"gmt_create": 1635131218863,
"order_flow_id": "1452471722259759104",
"gmt_modified": 1635131218863,
"order_status": "part_delivered",
"creator_id": "sh15408881429088tZ2u",
"order_status_boss": "",
"order_id": "SO2110258K167O5C"
},
{
"gmt_create": 1635131237380,
"order_flow_id": "1452471799927767040",
"gmt_modified": 1635131237380,
"order_status": "delivered",
"creator_id": "sh15408881429088tZ2u",
"order_status_boss": "delivered",
"order_id": "SO2110258K167O5C"
},
{
"gmt_create": 1635131538982,
"order_flow_id": "1452473064938242048",
"gmt_modified": 1635131538982,
"order_status": "finished",
"creator_id": "system",
"order_status_boss": "finished",
"order_id": "SO2110258K167O5C"
}
],
"amount_origin": {
"Value": "1.04"
},
"amount_rest": {
"Value": "0.00"
},
"price_trade_list": [
{
"amount": {
"Value": "1.00"
},
"amount_coupon": {
"Value": "0.00"
},
"amount_origin": {
"Value": "100.000000"
},
"price_detail_name": "Freight",
"key": "POSTAGE"
},
{
"amount": {
"Value": "0.03"
},
"amount_coupon": {
"Value": "0.00"
},
"amount_origin": {
"Value": "3.000000"
},
"price_detail_name": "Total price of the commodities",
"key": "COMMODITY"
},
{
"amount": {
"Value": "0.01"
},
"amount_coupon": {
"Value": "0.00"
},
"amount_origin": {
"Value": "1.000000"
},
"price_detail_name": "Installation fee",
"key": "INSTALL"
}
],
"amount_trade": {
"Value": "1.04"
},
"payment_list": [
{
"gmt_create": 1635131169624,
"paid_type": "cod",
"paid_provider": "offline_pay",
"trade_amount": {
"Value": "1.04"
},
"trade_status": "TRADE_SUCCESS",
"currency": "CNY"
}
],
"order_type_code": "INT_OEM_APP_MALL",
"buyer_remark": "",
"commodity_list": [
{
"icon_url": "ecommerce/162633217319c17fa480b.png",
"commodity_code": "CMar68c6bxxgs4",
"quantity": 1,
"unit_price_origin": {
"Value": "0.01"
},
"attach_json": {
"amount_after_coupon": {
"Value": "0.01"
},
"commodity_amount_origin": {
"Value": "0.01"
},
"install_type": "2",
"price_detail": [
{
"amount": {
"Value": "0.01"
},
"amount_coupon": 0,
"amount_origin": {
"Value": "0.01"
},
"price_detail_name": "Total price of the commodities",
"key": "COMMODITY"
},
{
"amount": {
"Value": "0.01"
},
"amount_coupon": 0,
"amount_origin": {
"Value": "0.01"
},
"price_detail_name": "Installation fee",
"key": "INSTALL"
},
{
"amount": {
"Value": "0.33"
},
"amount_coupon": 0,
"amount_origin": {
"Value": "0.33"
},
"price_detail_name": "Freight",
"key": "POSTAGE"
}
],
"sku_value_list": [
"1M",
"Dry battery"
],
"extend_sku_code": ""
},
"unit_price_trade": {
"Value": "0.35"
},
"specification_code": "SKar68c6djd4q0",
"currency": "CNY",
"commodity_name": "Installation fee + freight"
},
{
"icon_url": "ecommerce/886c9816-4785-4e92-8883-51e2da1603ee.png",
"commodity_code": "CMaowxikwzdohw",
"quantity": 1,
"unit_price_origin": {
"Value": "0.01"
},
"attach_json": {
"amount_after_coupon": {
"Value": "0.01"
},
"commodity_amount_origin": {
"Value": "0.01"
},
"install_type": "1",
"price_detail": [
{
"amount": {
"Value": "0.01"
},
"amount_coupon": 0,
"amount_origin": {
"Value": "0.01"
},
"price_detail_name": "Total price of the commodities",
"key": "COMMODITY"
},
{
"amount": {
"Value": "0.00"
},
"amount_coupon": 0,
"amount_origin": {
"Value": "0.00"
},
"price_detail_name": "Installation fee",
"key": "INSTALL"
},
{
"amount": {
"Value": "0.00"
},
"amount_coupon": 0,
"amount_origin": {
"Value": "0.00"
},
"price_detail_name": "Freight",
"key": "POSTAGE"
}
],
"sku_value_list": [
"White",
"S"
],
"extend_sku_code": ""
},
"unit_price_trade": {
"Value": "0.01"
},
"specification_code": "SKaowxikzha0y3",
"currency": "CNY",
"commodity_name": "No installation fee + freight"
},
{
"icon_url": "ecommerce/16226962402ab330a5cfd.png",
"commodity_code": "CMa1kxmeidi592",
"quantity": 1,
"unit_price_origin": {
"Value": "0.01"
},
"attach_json": {
"amount_after_coupon": {
"Value": "0.01"
},
"commodity_amount_origin": {
"Value": "0.01"
},
"install_type": "1",
"price_detail": [
{
"amount": {
"Value": "0.01"
},
"amount_coupon": 0,
"amount_origin": {
"Value": "0.01"
},
"price_detail_name": "Total price of the commodities",
"key": "COMMODITY"
},
{
"amount": {
"Value": "0.00"
},
"amount_coupon": 0,
"amount_origin": {
"Value": "0.00"
},
"price_detail_name": "Installation fee",
"key": "INSTALL"
},
{
"amount": {
"Value": "0.00"
},
"amount_coupon": 0,
"amount_origin": {
"Value": "0.00"
},
"price_detail_name": "Freight",
"key": "POSTAGE"
}
],
"sku_value_list": [
"Green"
],
"extend_sku_code": ""
},
"unit_price_trade": {
"Value": "0.01"
},
"specification_code": "SKa1kxmekswldn",
"currency": "CNY",
"commodity_name": "Mall commodity"
}
],
"order_status": "finished",
"amount_refund": {
"Value": "0.00"
},
"currency": "CNY",
"gmt_order_create": 1635131166093,
"order_id": "SO2110258K167O5C",
"customer": {
"mobile": "86-159****9374",
"uid": "sh1**************6LM",
"name": "",
"email": "nai********@tuya.com"
}
},
"t": 1635167709597,
"success": true
}
Error code
For more information, see error code.
Is this page helpful?
YesFeedbackIs this page helpful?
YesFeedbackMarketing Cooperation
Business Cooperation
Customer Service
Media Inquiry
© 2024 Tuya Inc.