快工助手跨境电商知识与商机助手

v2.ams.get_validation_list

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

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

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.ams.get_validation_list

Retrieve the seller's AMS validation bill

#

§2 Overview

Overview

FieldValue
ModuleAMS
API typeShop
HTTP methodGET
Path/api/v2/ams/get_validation_list
Production URLhttps://partner.shopeemobile.com/api/v2/ams/get_validation_list
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/ams/get_validation_list
PermissionAffiliate Marketing Solution Management
#

§3 Response parameters

Response parameters

NameTypeRequiredSampleDescription
errorstringerror_authIndicate error type if hit error. Empty if no error happened.
messagestringInvalid access_tokenIndicate error details if hit error. Empty if no error happened.
request_idstringb937c04e554847789cbf3fe33a0ad5f1The identifier for an API request for error tracking.
responseobject
response.validation_listobject[]
response.validation_list.validation_idstring363636002508Unique identifier of the billing entry.
response.validation_list.payment_methodint321Payment method. Applicable values: 1 = Online; 2 = Offline
response.validation_list.validation_monthint32202508Billing month in the format YYYYMM (e.g., 202405).
response.validation_list.campaign_sourcestringShopeeManagedSource of campaign setup. Applicable values: ShopeeManaged; Seller
response.validation_list.online_billobjectBilling details when payment method is Online.
response.validation_list.online_bill.total_amountfloat300.0Total commission amount for the billing month.
response.validation_list.online_bill.bill_statusint322Billing Status. Applicable values: 1 = Pending 2 = Completed; 3 = In process; 4 = To pay via payment link; 5 = Manual completed; 6 = To Be Settled Offline
response.validation_list.online_bill.deducted_amountfloat300.0Commission amount already deducted.
response.validation_list.online_bill.ams_credit_deducted_amountfloat200.0Commission amount paid using AMS Credits
response.validation_list.online_bill.pending_amountint640Commission amount pending deduction.
response.validation_list.offline_billsobject[]List of billing details when payment method is Offline, grouped by order placement month.
response.validation_list.offline_bills.order_place_monthint32202507Order placement month in the format YYYYMM.
response.validation_list.offline_bills.total_amountfloat420.5Total commission amount = commission_amount_after_tax + ams_credit_deducted_amount.
response.validation_list.offline_bills.commission_amountfloat200.0Offline commission amount before tax.
response.validation_list.offline_bills.commission_amount_after_taxfloat220.0Offline commission amount including tax.
response.validation_list.offline_bills.ams_credit_deducted_amountfloat200.5Commission amount already paid using AMS Credits.
#

§4 Common parameters

Common parameters

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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
#

§5 Request samples

Request samples

#

§6 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/ams/get_validation_list?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.asString();
#

§7 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/ams/get_validation_list?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&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;
#

§8 cURL

cURL

curl --location --request GET 'https://partner.shopeemobile.com/api/v2/ams/get_validation_list?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' 
#

§9 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/ams/get_validation_list?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload={}
headers = {

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

print(response.text)
#

§10 Response sample

Response sample

#

§11 JSON

JSON

{
	"error": "",
	"message": "",
	"request_id": "b937c04e554847789cbf3fe33a0ad5f1",
	"response": {
		"validation_list": [
			{
				"validation_id": "363636002508",
				"payment_method": 1,
				"validation_month": 202508,
				"campaign_source": "ShopeeManaged",
				"online_bill": {
					"total_amount": 300,
					"bill_status": 2,
					"deducted_amount": 300,
					"ams_credit_deducted_amount": 200,
					"pending_amount": 0
				},
				"offline_bills": [
					{
						"order_place_month": 202507,
						"total_amount": 420.5,
						"commission_amount": 200,
						"commission_amount_after_tax": 220,
						"ams_credit_deducted_amount": 200.5
					}
				]
			}
		]
	}
}
#

§12 Error example

Error example

#

§13 JSON

JSON

{
	"error": "error_auth",
	"message": "Invalid access_token",
	"request_id": "b937c04e554847789cbf3fe33a0ad5f1"
}
#

§14 Errors

Errors

ErrorDescriptionSolution
error_paraminvalid param
error_serverSomething wrong. Please try later.
#

§15 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp 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_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe 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_suspendedThe API is offline. Please call v2 API instead.
error_limitThe 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_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour 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_permissionThis app type has no permission to this API.
error_paramThere is no access_token in query.
error_authInvalid access_token.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#

§16 Update log

Update log

DateChange
2025-10-15New API
#