Skip to main content

v2.ams.get_validation_list

GET /api/v2/ams/get_validation_list

Retrieve the seller's AMS validation bill

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/ams/get_validation_list

Common Request Parameters

NameTypeSampleDescription
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

No Request Parameters Set.

Response Parameters

NameTypeSampleDescription
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
validation_listobject[]
validation_idstring363636002508Unique identifier of the billing entry.
payment_methodint321Payment method. Applicable values: 1 = Online 2 = Offline
validation_monthint32202508Billing month in the format YYYYMM (e.g., 202405).
campaign_sourcestringShopeeManagedSource of campaign setup. Applicable values: ShopeeManaged Seller
online_billobjectBilling details when payment method is Online.
total_amountfloat300.0Total commission amount for the billing month.
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
deducted_amountfloat300.0Commission amount already deducted.
ams_credit_deducted_amountfloat200.0Commission amount paid using AMS Credits
pending_amountint640Commission amount pending deduction.
offline_billsobject[]List of billing details when payment method is Offline, grouped by order placement month.
order_place_monthint32202507Order placement month in the format YYYYMM.
total_amountfloat420.5Total commission amount = commission_amount_after_tax + ams_credit_deducted_amount.
commission_amountfloat200.0Offline commission amount before tax.
commission_amount_after_taxfloat220.0Offline commission amount including tax.
ams_credit_deducted_amountfloat200.5Commission amount already paid using AMS Credits.