Query Order List

Last Updated on : 2023-06-15 05:56:43

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 name	Type	IN	Required	Description
mall_code	String	query	true	The code of a specified mall.
shop_code	String	query	true	The code of a specified store.
user_id	String	query	true	The buyer’s user ID (UID).
page_no	Integer	query	false	The page number.
page_size	Integer	query	false	The number of entries returned per page.

Return parameter

Parameter name	Type	Description
result	OrderListPageOpenApiVO	The returned result.

Description of result

Parameter name	Type	Description
total	Integer	The total number of entries.
data_list	List	The list of orders.

Description of data_list

Parameter name	Type	Description
mall_code	String	The code of a specified mall.
shop_code	String	The code of a specified store.
order_id	String	The order number.
pay_status	String	The status of payment.
delivery_status	String	The status of delivery.
created_time	String	The time when it is created.
current_total_price	BigDecimal	The current total price.
total_shipping_price	BigDecimal	The total postage fee.
total_tax_price	BigDecimal	The total tax fee.
total_price	BigDecimal	The total price.
currency	String	The type of currency.
delivery_list	List	The logistics information.
cancel_reason	String	The reason for canceling a specified order.
canceled_time	Long	The time when a specified order is canceled.

Description of delivery_list

Parameter name	Type	Description
logistics_company	String	The express company.
logistics_no	String	The tracking number.
logistics_url	String	The 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.

Prev DocQuery Order Details

Next DocSmart Access Control System