English
English
简体中文
Contact Us
Register
Log In

Query Order List

Last Updated on : 2022-09-27 06:13:07

Query a list of orders based on data such as mall code, store code and buyer's user ID (UID).

API address

GET: /v1.0/mall/plugin/order/search

Request parameter

Parameter nameTypeINRequiredDescription
mall_codeStringquerytrueThe code of a specified mall.
shop_codeStringquerytrueThe code of a specified store.
user_idStringquerytrueThe buyer's user ID (UID).
page_noIntegerqueryfalseThe page number.
page_sizeIntegerqueryfalseThe number of entries returned per page.

Return parameter

Parameter nameTypeDescription
resultOrderListPageOpenApiVOThe returned result.

Description of result

Parameter nameTypeDescription
totalIntegerThe total number of entries.
data_listListThe list of orders.

Description of data_list

Parameter nameTypeDescription
mall_codeStringThe code of a specified mall.
shop_codeStringThe code of a specified store.
order_idStringThe order number.
pay_statusStringThe status of payment.
delivery_statusStringThe status of delivery.
created_timeStringThe time when it is created.
current_total_priceBigDecimalThe current total price.
total_shipping_priceBigDecimalThe total postage fee.
total_tax_priceBigDecimalThe total tax fee.
total_priceBigDecimalThe total price.
currencyStringThe type of currency.
delivery_listListThe logistics information.
cancel_reasonStringThe reason for canceling a specified order.
canceled_timeLongThe time when a specified order is canceled.

Description of delivery_list

Parameter nameTypeDescription
logistics_companyStringThe express company.
logistics_noStringThe tracking number.
logistics_urlStringThe logistics URL.

Request example

GET: /v1.0/mall/plugin/order/search?mall_code=MALL_CODE&shop_code=SHOP_CODE&user_id=USER_ID&page_no=1&page_size=10
{
  "mall_code": "testMallCode",
  "shop_code": "testShopCode",
  "user_id": "testUserId",
  "page_no": 1,
  "page_size": 10
}

Return example

{
    "data_list": [
        {
            "created_time": "20220901",
            "subtotal_price": 2,
            "canceled_time": "20220902",
            "total_price": 2,
            "shop_code": "testShopCode",
            "delivery_list": [
                {
                    "logistics_no": "1Z2345",
                    "logistics_url": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2***",
                    "logistics_company": "USPS"
                }
            ],
            "total_tax_price": 1,
            "total_shipping_price": 1,
            "pay_status": "paid",
            "cancel_reason": "The reason for calceling a specified order",
            "mall_code": "testMallCode",
            "current_total_price": 10,
            "currency": "USD",
            "order_id": "testOrderId",
            "delivery_status": "shipped"
        }
    ],
    "total": 100
}

Error code

For more information, see error code.