v2.order.get_order_list

GET /api/v2/order/get_order_list

Use this api to search orders. You may also filter them by status, if needed.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/order/get_order_list

Common Request Parameters

Name	Type	Sample	Description
partner_id	int	1	Partner ID is assigned upon registration is successful. Required for all requests.
timestamp	timestamp	1610000000	This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_id	int	600000	Shopee's unique identifier for a shop. Required param for most APIs.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

Request Parameters

Name	Type	Required	Sample	Description
time_range_field	string	True	create_time	The kind of time_from and time_to. Available value: create_time, update_time.
time_from	timestamp	True	1607235072	The time_from and time_to fields specify a date range for retrieving orders (based on the time_range_field). The time_from field is the starting date range. The maximum date range that may be specified with the time_from and time_to fields is 15 days.
time_to	timestamp	True	1608271872	The time_from and time_to fields specify a date range for retrieving orders (based on the time_range_field). The time_from field is the starting date range. The maximum date range that may be specified with the time_from and time_to fields is 15 days.
page_size	int32	True	20	Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data.The limit of page_size if between 1 and 100.
cursor	string	False		Specifies the starting entry of data to return in the current call. The default is empty. If the data is more than one page, the offset can be some entry to start the next call.
order_status	string	False	READY_TO_SHIP	The order_status filter for retriveing orders and each one only every request. Available value: UNPAID/READY_TO_SHIP/PROCESSED/SHIPPED/COMPLETED/IN_CANCEL/CANCELLED/INVOICE_PENDING
response_optional_fields	string	False	order_status	Optional fields in response. Available value: order_status.
request_order_status_pending	boolean	False	true	Compatible parameter during migration period, send True will let API support PENDING status, send False or don’t send will fallback to old logic.
logistics_channel_id	int32	False	91007	The identity of logistic channel. Valid only for BR.

Response Parameters

Name	Type	Sample	Description
request_id	string	b937c04e554847789cbf3fe33a0ad5f1	The identifier for an API request for error tracking.
error	string	common.error_auth	Indicate error type if hit error. Empty if no error happened.
message	string	Invalid access_token.	Indicate error details if hit error. Empty if no error happened.
response	object		Detail informations you are querying.
more	boolean	false	This is to indicate whether the order list is more than one page. If this value is true, you may want to continue to check next page to retrieve orders.
order_list	object[]
order_sn	string	201218V2Y6E59M	Shopee's unique identifier for an order.
order_status	string	READY_TO_SHIP	The order_status filter for retriveing orders and each one only every request. Available value: UNPAID/READY_TO_SHIP/PROCESSED/SHIPPED/COMPLETED/IN_CANCEL/CANCELLED
booking_sn	string	2404098R48U37H	Return by default. Shopee's unique identifier for a booking. Only returned for advance fulfilment matched order only.
next_cursor	string	20	If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false.