v2.ams.get_validation_report

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

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

打开官方原文 ↗

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

查看技术与溯源信息

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

资料正文

§1 v2.ams.get_validation_report

Retrieve detailed information for a specific validation bill

§2 Overview

Overview

Field	Value
Module	AMS
API type	Shop
HTTP method	GET
Path	/api/v2/ams/get_validation_report
Production URL	https://partner.shopeemobile.com/api/v2/ams/get_validation_report
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/ams/get_validation_report
Permission	Affiliate Marketing Solution Management

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
page_no	int32	Yes	1	Specifies the page number of data to return in the current call. Starting from 1. If data is more than one page, the page_no can be some entry to start next call.
page_size	int32	Yes	20	Number of records returned per page, the maximum limit is 500, and page_no * page_size must be <= 10000.
validation_id	string	Yes	602516439202502	Unique identifier of the billing entry.
validation_month	int32	Yes	202502	Billing month in the format YYYYMM (e.g., 202405).
campaign_source	string	Yes	ShopeeManaged	Source of campaign setup. Applicable values: ShopeeManaged; Seller
order_sn	string	No	CWTUQ80EF9	Unique identifier of the order.
l1_category_id	int64	No	104136	Hierarchical product category classification. (L1 Category)
l2_category_id	int64	No	241360	Hierarchical product category classification. (L2 Category)
l3_category_id	int64	No	404136	Hierarchical product category classification. (L3 Category)
item_id	int64	No	3702824955	Unique identifier of the product.
item_name	string	No	item1	The product's name.
verified_status	string	No	Valid	Verified Status. Applicable values: Valid; Invalid
attr_campaign_id	int64	No	18071	ID referencing the campaign rule applied. (Ties to the campaign seller created).
place_order_time_start	timestamp	Yes	1753459200	Start time (inclusive) of order placement, in timestamp format.
place_order_time_end	timestamp	Yes	1756051199	End time (inclusive) of order placement, in timestamp format.

§4 Response parameters

Response parameters

Name	Type	Sample	Description
error	string	error_param	Indicate error type if hit error. Empty if no error happened.
message	string	Invalid page_size	Indicate error details if hit error. Empty if no error happened.
request_id	string	b937c04e554847789cbf3fe33a0ad5f1	The identifier for an API request for error tracking.
response	object		Response payload containing result data.
response.list	object[]		Array of order records. Each object contains order and commission details.
response.list.order_sn	string	YSWVY8D7OU	Unique identifier of the order.
response.list.order_status	string	Pending	Current status of the order (e.g., Pending, Completed, Cancelled).
response.list.verified_status	string	Unverified	Verification status of the order (Unverified, Verified).
response.list.place_order_time	string	2025/8/10 15:36:22	Time when the order was placed.
response.list.order_completed_time	string	2025/8/10 13:10:00	Time when the order was marked as completed.
response.list.conversion_completed_time	string	2025/8/9 17:38:54	Time when the conversion (affiliate action) was completed.
response.list.affiliate_name	string	Yoyi popup	Display name of the affiliate who promoted the item.
response.list.affiliate_username	string	yiyi.test.0206.19	Login username of the affiliate.
response.list.linked_mcn	string	auto.id.108	MCN (Multi-Channel Network) linked with the affiliate, if any.
response.list.campaign_partner	string	testid.mcn.0	Partner identifier for the campaign.
response.list.order_type	string	Direct Order	Type of order: Direct Order or Indirect Order.
response.list.order_brand_commission	string	2999.7	Commission (amount) for the whole order, paid by the seller.
response.list.channel	string	Shopeevideo	Traffic channel or platform where the promotion took place.
response.list.affiliate_id	int64	11393990003	Unique identifier of the affiliate.
response.list.buyer_status	string	Existing	Buyer Status. Applicable values: New; Existing
response.list.items	object[]
response.list.items.item_id	int64	3903624400	Unique identifier of the item in the order.
response.list.items.item_name	string	item1	Name of the item in the order.
response.list.items.model_id	int64	1232348722	SKU/model identifier for the item.
response.list.items.l1_category_id	int64	104136	Level-1 global category id classification of the item.
response.list.items.l2_category_id	int64	204136	Level-2 global category id classification of the item.
response.list.items.l3_category_id	int64	404136	Level-3 global category id classification of the item.
response.list.items.promotion_id	string	36262963_0_0	Identifier of the promotion campaign linked to the order.
response.list.items.price	int64	90	Item price in cents (or smallest currency unit).
response.list.items.qty	int64	1	Quantity of the item purchased.
response.list.items.seller_campaign_type	string	Seller Open Campaign	Type of seller campaign: 1. Seller Open Campaign – Open to all affiliates. 2. Seller Target Campaign – Restricted to designated affiliates.
response.list.items.attr_campaign_id	int64	1130273167000412	ID referencing the campaign rule applied.
response.list.items.purchase_value	int64	9099	Total purchase value of the order in cents (or smallest currency unit).
response.list.items.refund_amount	string	50	Amount refunded for the item.
response.list.items.item_brand_commission	string	899.91	Commission (amount) for the item, paid by the seller.
response.list.items.item_brand_commission_rate_to_affiliate	string	10%	Commission rate allocated to the affiliate for the item.
response.list.items.item_brand_commission_to_affiliate	string	899.98	Commission (amount) allocated to the affiliate for the item.
response.list.items.item_brand_commission_rate_to_mcn	string	33%	Commission rate allocated to the MCN for the item.
response.list.items.item_brand_commission_to_mcn	string	233.8	Commission (amount) allocated to the MCN for the item.
response.list.items.seller_service_fee_rate	string	14%	Seller service fee rate applied to the item.
response.list.items.seller_service_fee	string	125.98	Seller service fee amount charged for the item. seller_service_fee = item_brand_commission * seller_service_fee_rate
response.total_count	int64	345	Total number of entities that match the condition.
response.has_more	boolean	true	This is to indicate whether the list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of datas.

§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/ams/get_validation_report?access_token=access_token&attr_campaign_id=18071&campaign_source=ShopeeManaged&item_id=3702824955&item_name=item1&l1_category_id=104136&l2_category_id=241360&l3_category_id=404136&order_sn=CWTUQ80EF9&page_no=1&page_size=20&partner_id=partner_id&place_order_time_end=1756051199&place_order_time_start=1753459200&shop_id=shop_id&sign=sign&timestamp=timestamp&validation_id=602516439202502&validation_month=202502&verified_status=Valid")
.asString();

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/ams/get_validation_report?access_token=access_token&attr_campaign_id=18071&campaign_source=ShopeeManaged&item_id=3702824955&item_name=item1&l1_category_id=104136&l2_category_id=241360&l3_category_id=404136&order_sn=CWTUQ80EF9&page_no=1&page_size=20&partner_id=partner_id&place_order_time_end=1756051199&place_order_time_start=1753459200&shop_id=shop_id&sign=sign&timestamp=timestamp&validation_id=602516439202502&validation_month=202502&verified_status=Valid',
  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/ams/get_validation_report?access_token=access_token&attr_campaign_id=18071&campaign_source=ShopeeManaged&item_id=3702824955&item_name=item1&l1_category_id=104136&l2_category_id=241360&l3_category_id=404136&order_sn=CWTUQ80EF9&page_no=1&page_size=20&partner_id=partner_id&place_order_time_end=1756051199&place_order_time_start=1753459200&shop_id=shop_id&sign=sign&timestamp=timestamp&validation_id=602516439202502&validation_month=202502&verified_status=Valid'

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/ams/get_validation_report?access_token=access_token&attr_campaign_id=18071&campaign_source=ShopeeManaged&item_id=3702824955&item_name=item1&l1_category_id=104136&l2_category_id=241360&l3_category_id=404136&order_sn=CWTUQ80EF9&page_no=1&page_size=20&partner_id=partner_id&place_order_time_end=1756051199&place_order_time_start=1753459200&shop_id=shop_id&sign=sign&timestamp=timestamp&validation_id=602516439202502&validation_month=202502&verified_status=Valid"

payload={}
headers = {

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

print(response.text)

§11 Response sample

Response sample

§12 JSON

JSON

{
    "error": "",
    "message": "",
    "request_id": "b937c04e554847789cbf3fe33a0ad5f1",
    "response": {
        "list": [
            {
                "order_sn": "YSWVY8D7OU",
                "order_status": "Pending",
                "verified_status": "Unverified",
                "place_order_time": "2025/8/10 15:36:22",
                "order_completed_time": "2025/8/10 13:10:00",
                "conversion_completed_time": "2025/8/9 17:38:54",
                "affiliate_name": "Yoyi popup",
                "affiliate_username": "yiyi.test.0206.19",
                "linked_mcn": "auto.id.108",
                "campaign_partner": "testid.mcn.0",
                "order_type": "Direct Order",
                "order_brand_commission": "2999.7",
                "channel": "Shopeevideo",
                "affiliate_id": 11393990003,
                "buyer_status": "Existing",
                "items": [
                    {
                        "item_id": 3903624400,
                        "item_name": "item1",
                        "model_id": 1232348722,
                        "l1_category_id": 104136,
                        "l2_category_id": 204136,
                        "l3_category_id": 404136,
                        "promotion_id": "36262963_0_0",
                        "price": 90,
                        "qty": 1,
                        "seller_campaign_type": "Seller Open Campaign",
                        "attr_campaign_id": 1130273167000412,
                        "purchase_value": 9099,
                        "refund_amount": "50",
                        "item_brand_commission": "899.91",
                        "item_brand_commission_rate_to_affiliate": "10%",
                        "item_brand_commission_to_affiliate": "899.98",
                        "item_brand_commission_rate_to_mcn": "33%",
                        "item_brand_commission_to_mcn": "233.8",
                        "seller_service_fee_rate": "14%",
                        "seller_service_fee": "125.98"
                    }
                ]
            }
        ],
        "total_count": 345,
        "has_more": true
    }
}

§13 Error example

Error example

§14 JSON

JSON

{
	"error": "error_param",
	"message": "Invalid page_size",
	"request_id": "b937c04e554847789cbf3fe33a0ad5f1"
}

§15 Errors

Errors

Error	Description	Solution
error_param	invalid campaign source
error_param	invalid page_no
error_param	invalid page_size
error_param	invalid param
error_param	invalid time range, detail:{detail}
error_param	invalid validation month,detail:{detail}

§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
2026-07-02	Add seller_service_fee_rate and seller_service_fee response parameters under response.list[].items[].
-	New API

这条内容对你有帮助吗？