Query Order Details

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

Query the details of a specified order based on mall code, store code, buyer’s user ID (UID), and order ID.

API address

GET: /v1.0/mall/plugin/order/{order_id}

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).
order_id	String	uri	true	The order number.

Return parameter

Parameter name	Type	Description
result	OrderDetailOpenApiVO	The returned result.

Description of result

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	Long	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.
commodity_list	List	The list of commodities in the order.
billing_address	AddressModelOpenApiVO	The billing address of a specified payer.
shipping_address	AddressModelOpenApiVO	The shipping address of a specified payer.

Description of commodity_list

Parameter name	Type	Description
title	String	The name of a specified commodity.
sku	String	The unique code of a specified SKU.
available	Boolean	Indicates whether the commodity is available for sale.
price	PriceModelOpenApiVO	The price.
weight	BigDecimal	The weight.
quantity	Integer	The purchase quantity.
image	String	The image URL of a specified commodity.
selected_options	List	The list of commodity attributes.

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.

Description of billing_address

Parameter name	Type	Description
country_code	String	The code of a specified country or region.
province_code	String	The code of a specified province.
country	String	The name of a specified country or region.
province	String	The name of a specified province.
city	String	The name of a specified city.
address	String	The detailed address.
zip	String	The postal code.
latitude	String	The latitude.
longitude	String	The longitude.
name	String	The name.
first_name	String	The first name.
last_name	String	The last name.
phone	String	The mobile phone number.

Description of shipping_address

Parameter name	Type	Description
country_code	String	The code of a specified country or region.
province_code	String	The code of a specified province.
country	String	The name of a specified country or region.
province	String	The name of a specified province.
city	String	The name of a specified city.
address	String	The detailed address.
zip	String	The postal code.
latitude	String	The latitude.
longitude	String	The longitude.
name	String	The name.
first_name	String	The first name.
last_name	String	The last name.
phone	String	The mobile phone number.

Description of selected_options

Parameter name	Type	Description
name	String	The name of a specified attribute.
value	String	The value of a specified attribute.

Description of price

Parameter name	Type	Description
amount	BigDecimal	The amount.
currency	String	The type of currency.

Request example

GET: /v1.0/mall/plugin/order/1234567?mall_code=MALL_CODE&shop_code=SHOP_CODE&user_id=USER_ID&order_id=ORDER_ID

{
  "mall_code": "testMallCode",
  "shop_code": "testShopCode",
  "user_id": "testUserId",
  "order_id": "testOrderId"
}

Return example

{
    "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,
    "billing_address": {
        "zip": "40202",
        "country": "United States",
        "address": "Chestnut Street ***",
        "city": "Louisville",
        "latitude": "45.41634",
        "last_name": "Norman",
        "province_code": "KY",
        "country_code": "US",
        "province": "Kentucky",
        "phone": "555-625-11**",
        "name": "Bob Norman",
        "first_name": "Bob",
        "longitude": "-75.6868"
    },
    "total_shipping_price": 1,
    "commodity_list": [
        {
            "image": "xxx",
            "quantity": 1,
            "selected_options": [
                {
                    "name": "Color",
                    "value": "Blue"
                }
            ],
            "available": true,
            "weight": 10,
            "title": "IPod Nano - 8gb",
            "price": {
                "amount": 2,
                "currency": "USD"
            },
            "id": 466157049,
            "sku": "IPOD2008*****"
        }
    ],
    "pay_status": "paid",
    "cancel_reason": "The reason for calceling a specified order",
    "mall_code": "testMallCode",
    "current_total_price": 10,
    "currency": "USD",
    "shipping_address": {
        "zip": "40202",
        "country": "United States",
        "address": "Chestnut Street **",
        "city": "Louisville",
        "latitude": "45.41634",
        "last_name": "Norman",
        "province_code": "KY",
        "country_code": "US",
        "province": "Kentucky",
        "phone": "555-625-11**",
        "name": "Bob Norman",
        "first_name": "Bob",
        "longitude": "-75.6868"
    },
    "order_id": "testOrderId",
    "delivery_status": "shipped"
}

Error code

For more information, see error code.

Prev DocReview COD Order

Next DocQuery Order List