Query Order

View order related information

Request Query Parameter

Parameter name	Type	Remark
createStartTime	String	filter orders created at or before the date, for example: 2016-01-18T23:41:00Z
createEndTime	String	filter orders created at or before the date, for example: 2016-01-18T23:41:00Z
updateStartTime	String	filter orders last updated at or after the date, for example: "2016-01-18T23:41:00Z"
updateEndTime	String	filter orders last updated at or before the date, for example: 2016-01-18T23:41:00Z
ids	String	Order's IDs, please use commas as separators, for example, 1000000065617,1000000065618
pageNumber	number	page number limit per page, default: 10 , maximum: 250
pageSize	number	Default is 1

GET /openapi/v2/order/orders

Query Parameters

Name	Type	Description
createStartTime	String	filter orders created at or before the date, for example: 2016-01-18T23:41:00Z
createEndTime	String	filter orders created at or before the date, for example: 2016-01-18T23:41:00Z
updateStartTime	String	filter orders last updated at or after the date, for example: "2016-01-18T23:41:00Z"
updateEndTime	String	filter orders last updated at or before the date, for example: 2016-01-18T23:41:00Z
ids	String	Order's IDs, please use commas as separators, for example, 1000000065617,1000000065618
pageNumber	number	page number limit 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

Order List Properties

Parameter name	Type	Remark
id	number	order id
customOrderId	String	custom order id
status	String	order status: abnormal_order,waiting_payment,processing,completed,cancel
financialStatus	String	payment status：NULL,waiting,paid
fulfillmentStatus	String	logistics status: NULL,waiting_to_ship,fully_shipped,partially_shipped
refundStatus	String	refund status：NULL,refunding,partial_refund,refunded
purchaseDate	String	order time "2016-01-18T23:41:00Z"
payDate	String	payment time "2016-01-18T23:41:00Z"
completedDate	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
currencyCode	String	The default currency is USD
finalAmount	BigDecimal	payment amount, finalAmount = subTotalAmount + freightAmount - couponAmount
freightAmount	BigDecimal	order shipping amount
subTotalAmount	BigDecimal	total order item subTotalAmount = sum(item.total)
couponAmount	BigDecimal	discount amount for order using promo code
promotionAmount	BigDecimal	product discount amount
refundableAmount	BigDecimal	order allowable refund amount, refundableAmount = finalAmount - refundedAmount
refundedAmount	BigDecimal	the amount of the refunded portion of the item in the order, refundedAmount= finalAmount - refundableAmount
fulfillments	array of Fulfillments objects	order logistics information
shippingAddress	object	address information
orderItems	array of OrderItems objects	order sku information
remark	String	user comments
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
packId	String	package id
status	String	preparing,shipped,completed
carrier	String	order carrier
carrierType	String	latest or last
trackingCode	String	order tracking number
logisticsSearchUrl	String	https://t.17track.net/en?v=2#nums=WNBAA0202970436YQ
deliveryTime	String	delivery time "2016-01-18T23:41:00Z"
items	array of OrderItems objects	order logistics information
trackingInfos	array of TrackingInfo objects	tracking Info list. contains all the tracking information, the latest one being the first in the array

Tracking Info

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

Order Items Properties

Parameter name	Type	Remark
id	number	item id
itemId	String	item id
imageUrl	String	product picture
productName	String	product name
skuCode	String	sku
amount	BigDecimal	unit sku payment amount,the selling price displayed on the product page
productNum	int[16]	sales volume
total	BigDecimal	total = amount*productNum
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
stockStatus	String	normal,sold_out
fulfillmentStatus	String	logistics status: NULL,waiting_to_ship,fully_shipped,partially_shipped
refundStatus	String	NULL,refunding,refunded
countryCode	String	Country code,The country code of the actual delivery warehouse of the sku, the Chinese warehouse is 'CN', and the overseas warehouse is 'US'.

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
abnormal_order	an exception occurred in the order
waiting_payment	order pending payment
processing	the order is in processing
completed	order has been completed
cancel	order cancelled

Financial Status

Value	Remark
NULL	initial empty state
waiting	waiting to pay
paid	paid

Fulfillment Status

Value	Remark
NULL	initial empty state
waiting_to_ship	waiting to be shipped
partially_shipped	part of the order has been shipped （the package does not have this status）
fully_shipped	all packages of the order have been shipped
completed	the order confirms that the package has been received

Refund Status

Value	Remark
NULL	initial empty state
refunding	the refund has been submitted and is waiting for the agency's response
partial_refund	some items in the order have been refunded
refund	the entire order has been refunded successfully

Fulfillments Properties#Status

Value	Remark
preparing	the package has been sub-packaged and is waiting for delivery by the logistics provider
shipped	the package has been shipped
completed	the package has been confirmed to have been delivered and the user has signed for it