Skip to main content

v2.ams.get_validation_report

GET /api/v2/ams/get_validation_report

Retrieve detailed information for a specific validation bill

Endpoint URL

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

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

Request Parameters

NameTypeRequiredSampleDescription
page_noint32True1Specifies 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_sizeint32True20Number of records returned per page, the maximum limit is 500, and page_no * page_size must be <= 10000.
validation_idstringTrue602516439202502Unique identifier of the billing entry.
validation_monthint32True202502Billing month in the format YYYYMM (e.g., 202405).
campaign_sourcestringTrueShopeeManagedSource of campaign setup. Applicable values: ShopeeManaged Seller
order_snstringFalseCWTUQ80EF9Unique identifier of the order.
l1_category_idint64False104136Hierarchical product category classification. (L1 Category)
l2_category_idint64False241360Hierarchical product category classification. (L2 Category)
l3_category_idint64False404136Hierarchical product category classification. (L3 Category)
item_idint64False3702824955Unique identifier of the product.
item_namestringFalseitem1The product's name.
verified_statusstringFalseValidVerified Status. Applicable values: Valid Invalid
attr_campaign_idint64False18071ID referencing the campaign rule applied. (Ties to the campaign seller created).
place_order_time_starttimestampTrue1753459200Start time (inclusive) of order placement, in timestamp format.
place_order_time_endtimestampTrue1756051199End time (inclusive) of order placement, in timestamp format.

Response Parameters

NameTypeSampleDescription
errorstringerror_paramIndicate error type if hit error. Empty if no error happened.
messagestringInvalid page_sizeIndicate error details if hit error. Empty if no error happened.
request_idstringb937c04e554847789cbf3fe33a0ad5f1The identifier for an API request for error tracking.
responseobjectResponse payload containing result data.
listobject[]Array of order records. Each object contains order and commission details.
order_snstringYSWVY8D7OUUnique identifier of the order.
order_statusstringPendingCurrent status of the order (e.g., Pending, Completed, Cancelled).
verified_statusstringUnverifiedVerification status of the order (Unverified, Verified).
place_order_timestring2025/8/10 15:36:22Time when the order was placed.
order_completed_timestring2025/8/10 13:10:00Time when the order was marked as completed.
conversion_completed_timestring2025/8/9 17:38:54Time when the conversion (affiliate action) was completed.
affiliate_namestringYoyi popupDisplay name of the affiliate who promoted the item.
affiliate_usernamestringyiyi.test.0206.19Login username of the affiliate.
linked_mcnstringauto.id.108MCN (Multi-Channel Network) linked with the affiliate, if any.
campaign_partnerstringtestid.mcn.0Partner identifier for the campaign.
order_typestringDirect OrderType of order: Direct Order or Indirect Order.
order_brand_commissionstring2999.7Commission (amount) for the whole order, paid by the seller.
channelstringShopeevideoTraffic channel or platform where the promotion took place.
affiliate_idint6411393990003Unique identifier of the affiliate.
buyer_statusstringExistingBuyer Status. Applicable values: New Existing
itemsobject[]
item_idint643903624400Unique identifier of the item in the order.
item_namestringitem1Name of the item in the order.
model_idint641232348722SKU/model identifier for the item.
l1_category_idint64104136Level-1 global category id classification of the item.
l2_category_idint64204136Level-2 global category id classification of the item.
l3_category_idint64404136Level-3 global category id classification of the item.
promotion_idstring36262963_0_0Identifier of the promotion campaign linked to the order.
priceint6490Item price in cents (or smallest currency unit).
qtyint641Quantity of the item purchased.
seller_campaign_typestringSeller Open CampaignType of seller campaign: 1. Seller Open Campaign – Open to all affiliates. 2. Seller Target Campaign – Restricted to designated affiliates.
attr_campaign_idint641130273167000412ID referencing the campaign rule applied.
purchase_valueint649099Total purchase value of the order in cents (or smallest currency unit).
refund_amountstring50Amount refunded for the item.
item_brand_commissionstring899.91Commission (amount) for the item, paid by the seller.
item_brand_commission_rate_to_affiliatestring10%Commission rate allocated to the affiliate for the item.
item_brand_commission_to_affiliatestring899.98Commission (amount) allocated to the affiliate for the item.
item_brand_commission_rate_to_mcnstring33%Commission rate allocated to the MCN for the item.
item_brand_commission_to_mcnstring233.8Commission (amount) allocated to the MCN for the item.
total_countint64345Total number of entities that match the condition.
has_morebooleantrueThis 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.