English
English
简体中文
Contact Us
Register
Log In

Get Order Details

Last Updated on : 2023-01-31 08:36:37

Get the order details based on the order ID.

API address

GET: /v1.0/sellercenter/order/{order_id}

Request parameter

Parameter nameTypeINRequiredDescription
order_idStringuritrueThe order ID.
mall_codeStringquerytrueThe code of a specified mall.
site_codeStringquerytrueThe code of a specified site.
langStringqueryfalseThe language.

Return parameter

Parameter nameTypeDescription
resultOrderDetailOpenVOThe returned result.

Description of result

Parameter nameTypeDescription
order_idStringThe unique identifier of a specified order.
order_type_codeStringThe code of a specified order type.
order_statusStringThe status of a specified order.
amount_originBigDecimalThe original price of a specified order.
amount_tradeBigDecimalThe transaction price of a specified order.
amount_paidBigDecimalThe paid amount of a specified order.
amount_restBigDecimalThe remaining amount to be paid.
price_trade_listListThe total price details of a specified order.
gmt_order_createLongThe time when the order is created.
gmt_order_payLongThe time when the order is paid.
commodity_listListThe list of commodities in the order.
currencyStringThe currency.
payment_listListThe list of payment for the order.
refund_statusIntegerThe status of refund.
amount_refundBigDecimalThe refund amount.
addressAddressVOThe delivery address.
delivery_listListThe information about the delivery list.
order_flow_listListThe list of order status.
customerCustomerVOThe information about a specified buyer.
remarkStringThe remarks by the seller.
buyer_remarkStringThe remarks by the buyer.

Description of commodity_list

Parameter nameTypeDescription
commodity_codeStringThe code of a specified commodity.
specification_codeStringThe stock keeping unit (SKU) of a specified commodity.
commodity_nameStringThe name of a specified commodity.
icon_urlStringThe icon URL of a specified commodity.
currencyStringThe currency.
unit_price_originBigDecimalThe original unit price.
unit_price_tradeBigDecimalThe transaction unit price.
unit_nameStringThe unit, such as pieces and times.
quantityIntegerThe quantity of a specified commodity.
attach_jsonJSONObjectThe additional information about a specified commodity.

Description of address

Parameter nameTypeDescription
address_idStringThe ID of a specified address.
nameStringThe recipient.
phoneStringThe mobile phone number.
countryStringThe country/region.
country_codeStringThe country code.
provinceStringThe name of a province.
cityStringThe name of a city.
districtStringThe name of a district or county.
address_detailStringThe detailed address.
addressStringThe entire address.
is_defaultByteIndicates whether the value is default or not.
post_codeStringThe postal code.
siteStringThe site.
address_typeIntegerThe address type.

Description of delivery_list

Parameter nameTypeDescription
delivery_idStringThe ID of a specified package.
delivery_statusIntegerThe status of a specified package.
gmt_out_stockLongThe time when the package is dispatched.
logistics_companyStringThe code of a specified logistics company.
logistics_company_nameStringThe name of a specified logistics company.
logistics_noStringThe logistical tracking number.
delivery_quantityIntegerThe total number of SKUs.
delivery_detail_listListThe details of package delivery.

Description of order_flow_list

Parameter nameTypeDescription
order_flow_idStringThe primary key of the order business flow chart.
order_idStringThe order ID.
creator_idStringThe creator ID.
order_status_bossStringThe status of main standard order.
order_statusStringThe status of a specified order.
gmt_createLongThe time when it is created.
gmt_modifiedLongThe time when it is modified.

Description of price_trade_list

Parameter nameTypeDescription
keyStringThe detailed code of a price.
price_detail_nameStringThe detailed name of a price.
amountBigDecimalThe sales price.
amount_originBigDecimalThe original price.
amount_couponBigDecimalThe discounted price.
attachJSONObjectThe additional information.

Description of payment_list

Parameter nameTypeDescription
trade_amountBigDecimalThe amount of payment.
currencyStringThe currency.
paid_providerStringThe method of payment.
paid_typeStringThe payment type.
transaction_noStringPayment number
gmt_createLongThe time when it is created.
trade_statusStringThe status of payment.

Description of customer

Parameter nameTypeDescription
uidStringThe ID of a specified buyer.
nameStringThe nickname.
mobileStringThe mobile phone number.
emailStringThe email address.

Description of delivery_detail_list

Parameter nameTypeDescription
commodity_codeStringThe code of a specified commodity in the order.
sku_codeStringThe stock keeping unit (SKU) of a specified commodity.
delivery_quantityIntegerThe 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,
            "address_id": "7a33441805a4934a8",
            "is_default": 1,
            "address_detail": "gdichakjcn",
            "country_code": "86",
            "city_name": "Beijing Municipality",
            "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": "Angel 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.