Query Order

View order related information

Order List Properties

Parameter name	Type	Remark
shippingAddress	object	address information
id	number	order id
customOrderId	String	custom order id
remark	String	user comments
status	String	order status
purchaseDate	String	order time "2016-01-18T23:41:00Z"
payAt	String	payment time "2016-01-18T23:41:00Z"
completedAt	String	complete time "2016-01-18T23:41:00Z"
cancelDate	String	cancel time "2016-01-18T23:41:00Z"
refundDate	String	refund time "2016-01-18T23:41:00Z"
warehouseId	int[16]	order delivery warehouse, used for inventory replenishment
finalAmount	BigDecimal	payment amount
freightAmount	BigDecimal	Order shipping amount
skusAmount	BigDecimal	total order item
orderItems	array of OrderItems objects	order sku information
fulfillments	array of OrderItems objects	order logistics information
createDate	String	createAt time "2016-01-18T23:41:00Z"
updateDate	String	updateAt time "2016-01-18T23:41:00Z"

Fulfillments Properties

Parameter name	Type	Remark
id	String	package id
deliveryTime	String	delivery time "2016-01-18T23:41:00Z"
trackingCode	String	order tracking number
orderItems	array of OrderItems objects	order logistics information
logisticsSearchUrl	String	https://t.17track.net/en?v=2#nums=WNBAA0202970436YQ
carrier	String	order carrier
carrierType	String	latest or last
trackingInfos	array of TrackingInfo objects	tracking Info list. contains all the tracking information, the latest one being the first in the array

TrackingInfo

Parameter name	Type	Remark
carrier	String	order carrier
trackingCode	String	order tracking number

Order Items Properties

Parameter name	Type	Remark
id	number	item id
imageUrl	String	product picture
productName	String	product name
skuCode	String	sku
subtotal	BigDecimal	purchasePrices *productNum
purchasePrices	BigDecimal	sku sales unit price
option1	String	sku attribute 1, contains size information, variable attribute
option2	String	sku attribute 2, contains size information, variable attribute
option3	String	sku attribute 3, contains size information, variable attribute
promotionAmount	String	sku sales unit promotionAmount
stockStatus	String	normal,sold_out
productNum	int[16]	sales volume

Shipping Address Properties

Parameter name	Type	Remark
country	String	place an order country
city	String	place an order city
phone	String	place an order phone
recipient	String	place an order recipient
street1	String	place an order street1
street2	String	place an order street2
province	String	place an order province
zip	String	place an order zip
vat	String	place an order vat
ioss	String	place an order ioss

Order Status

Value	Remark
waiting_payment	order pending payment
cancel	order cancelled
waiting_to_ship	order to be shipped
refunding	order refund
refunded	order has been refunded
partial_shipped	order Partially Shipped
shipped	order shipped
delivered	order completed

GET /openapi/v1/order/orders

Query Parameters

Name	Type	Description
status	String	order status, please use comma as separator, for example waiting_payment,cancel
createStartTime	String	filter orders created at or before date, for example: 2016-01-18T23:41:00Z
createEndTime	String	filter orders created at or before date, for example: 2016-01-18T23:41:00Z
updateStartTime	String	filter orders last updated at or after date, for example: "2016-01-18T23:41:00Z"
updateEndTime	String	filter orders last updated at or before date, for example: 2016-01-18T23:41:00Z
ids	String	Order's IDs, please use comma as separator, for example 1000000065617,1000000065618
pageNumber	number	page numberlimit per page, default: 10 , maximum: 250
pageSize	number	Default is 1

200: OK Returns an array of Order objects

{
    "code": 10000,
    "data": {
        "total": 1,
        "pageNumber": 1,
        "pageSize": 10,
        "list": [
            {
                "purchaseDate": "2022-11-01T06:21:20Z",
                "completedAt": "2022-11-01T06:21:21Z",
                "payAt": "2022-11-01T06:21:21Z",
                "skusAmount": 9.3200,
                "freightAmount": 10.8000,
                "modifyDate": "2022-11-01T06:21:12Z",
                "customOrderId": "sdasddfsdfdsf",
                "orderItems": [
                    {
                        "subtotal": 9.3200,
                        "imageUrl": "https://img.kakaclo.com/image%2FFSZW08517%2FFSZW08517_PEB_S_NUB%2Fd87cb7ffcb2c692367ef1c4a521a1c93.jpg",
                        "option3": "{\"name\":\"print\", \"value\":\"\"}",
                        "purchasePrices": 4.6600,
                        "stockStatus": "normal",
                        "option1": "{\"name\":\"color\", \"value\":\"Peacock blue\"}",
                        "id": "1108502",
                        "productNum": 2,
                        "option2": "{\"name\":\"size\", \"value\":\"XXL\"}",
                        "promotionAmount": 0.5000,
                        "skuCode": "FSZW08517_PEB_XXL_NUB"
                    }
                ],
                "totalAmount": 20.1200,
                "warehouseId": 13,
                "shippingAddress": {
                    "zip": "vsvs00v30",
                    "country": "US",
                    "province": " de Lofasfasire",
                    "city": "Orlafasns",
                    "phone": "07 82 24 67 93",
                    "recipient": "Lffsollia Odfsdlena",
                    "street1": " 7 rue  Rabelais"
                },
                "id": "1000000515397",
                "status": "waiting_to_ship",
                "createDate": "2022-11-01T06:21:12Z"
            }
        ]
    },
    "message": "success"
}

401: Unauthorized

{
    // Response
}