v2.order.get_order_list

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 · 2026-09-06 12:13:49

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.order.get_order_list

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

§2 Overview

Overview

Field	Value
Module	Order
API type	Shop
HTTP method	GET
Path	/api/v2/order/get_order_list
Production URL	https://partner.shopeemobile.com/api/v2/order/get_order_list
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/order/get_order_list
Rate limit	[0, 0, 0]
Permission	ERP System; Seller In House System; Order Management; Customer Service; Brand Membership; Ads Service; Swam ERP; Livestream Management; Affiliate Marketing Solution Management

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
time_range_field	string	Yes	create_time	The kind of time_from and time_to. Available value: create_time, update_time.
time_from	timestamp	Yes	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	Yes	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	Yes	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	No		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	No	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	No	order_status	Optional fields in response. Available value: order_status.
request_order_status_pending	boolean	No	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	No	91007	The identity of logistic channel. Valid only for BR.

§4 Response parameters

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.
response.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.
response.order_list	object[]
response.order_list.order_sn	string	201218V2Y6E59M	Shopee's unique identifier for an order.
response.order_list.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
response.order_list.booking_sn	string	2404098R48U37H	Return by default. Shopee's unique identifier for a booking.; Only returned for advance fulfilment matched order only.
response.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.

§5 Common parameters

Common 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

§6 Request samples

Request samples

§7 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/order/get_order_list?page_size=20&response_optional_fields=order_status&timestamp=timestamp&shop_id=shop_id&order_status=READY_TO_SHIP&partner_id=partner_id&access_token=access_token&cursor=""&time_range_field=create_time&time_from=1607235072&time_to=1608271872&sign=sign")
.asString();

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/order/get_order_list?access_token=access_token&cursor=%22%22&order_status=READY_TO_SHIP&page_size=20&partner_id=partner_id&response_optional_fields=order_status&shop_id=shop_id&sign=sign&time_from=1607235072&time_range_field=create_time&time_to=1608271872&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

§9 cURL

cURL

curl --location --request GET 'https://partner.shopeemobile.com/api/v2/order/get_order_list?timestamp=timestamp&shop_id=shop_id&order_status=READY_TO_SHIP&partner_id=partner_id&access_token=access_token&page_size=20&response_optional_fields=order_status&time_range_field=create_time&time_from=1607235072&time_to=1608271872&sign=sign&cursor=""'

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/order/get_order_list?access_token=access_token&cursor=%22%22&order_status=READY_TO_SHIP&page_size=20&partner_id=partner_id&response_optional_fields=order_status&shop_id=shop_id&sign=sign&time_from=1607235072&time_range_field=create_time&time_to=1608271872&timestamp=timestamp"

payload={}
headers = {

}
response = requests.request("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

§11 Response sample

Response sample

§12 JSON

JSON

{
    "error": "",
    "message": "",
    "response": {
        "more": true,
        "next_cursor":"20",
        "order_list": [
            {
                "order_sn": "201218V2Y6E59M"
            },
            {
                "order_sn": "201218V2W2SG1E"
            },
            {
                "order_sn": "201218V2VJJC70"
            },
            {
                "order_sn": "201218V2TEURPF"
            },
            {
                "order_sn": "201218UXWNTUNP"
            },
            {
                "order_sn": "201218UWFYSCF1"
            },
            {
                "order_sn": "201215MPRFUUNN"
            },
            {
                "order_sn": "201215MCR3V9N8"
            },
            {
                "order_sn": "201214JASXYXY6"
            },
            {
                "order_sn": "201214JAJXU6G7"
            }
        ]
    },
    "request_id": "b937c04e554847789cbf3fe33a0ad5f1"
}

§13 Error example

Error example

§14 JSON

JSON

{
    "error": "order.order_list_invalid_time",
    "message": "Start time must be earlier than end time and diff in 15days.",
    "request_id": "2ca3ed1fe1fab0d1e12e5e1efa90e4ac"
}

§15 Errors

Errors

Error	Description	Solution
error_not_found	Wrong parameters, detail: {msg}.
error_param	Wrong parameters, detail: {msg}.
error_permission	Sorry you don't have the permission, detail: {msg}.
error_server	System error. Please try again later.
order.order_list_invalid_time	Start time must be earlier than end time and diff in 15days.
error_network	Inner http call failed
error_data	parse data failed
error_data	data not exist
error_param	parameter invalid
error_param	The information you queried is not found.
error_param	Wrong parameters, detail: {msg}.
error_server	Something wrong. Please try later.
error_shop	shopid is invalid
error_param	request not from gateway

§16 Common errors

Common errors

Error	Description	Solution
error_auth	partner_id is invalid
error_auth	The App is deleted, and you'll be unable to make any API call.
error_auth	App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_param	There is no partner_id in query.
error_param	Invalid partner_id.
error_param	no timestamp
error_param	Invalid timestamp
error_param	There is no sign in query.
error_sign	Wrong sign.
invalid_partner_id	Invalid partner_id, please have a check.
error_auth	No permission to current api.
error_api_call_restricted	The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspended	The API is offline. Please call v2 API instead.
error_limit	The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limit	Too many requests. You have reached the rate limit. Please try again later.
source_ip_undeclared	Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_param	Permission denied. This API is currently offline or the request path is incorrect.
error_param	Partner_id is invalid, should be an integer between 0 and 4294967295.
error_param	no timestamp.
error_param	Timestamp is invalid, should be an integer between 0 and 4294967295.
error_param	Timestamp is expired.
error_partner_key_expired	Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permission	This app type has no permission to this API.
error_param	There is no access_token in query.
error_auth	Invalid access_token.
error_auth	Invalid partner_id or shopid.
shop_no_linked	Partner and shop has no linked.
shop_banned	The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_token	Invalid access_token, please have a check.
partner_shop_no_link	Invalid partner_id or shop_id, please have a check.
error_ashop_api_permission	The shop is Affiliate shop has no permission to call this API.
error_kyc_auth	No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_auth	System error, please try again later.
error_param	There is no shop_id in query.
error_param	shop_id is invalid, should be an integer between 0 and 4294967295.

§17 Update log

Update log

Date	Change
2025-04-23	Change the cursor input parameter.
2024-07-03	add a new response field "booking_sn" for advance fulfilment order.
2023-06-16	add a new field "request_order_status_pending" to control if wanna response "PENDING" status order
2023-05-15	update the API description.
2021-06-11	Update INVOICE_PENDING order status.

这条内容对你有帮助吗？