v2.ams.get_conversion_report

GET /api/v2/ams/get_conversion_report

Retrieve the shop's conversion report with details about each order, item, affiliate, campaign.You can filter results using one or multiple time ranges, and the final result will be the intersection of these ranges. Due to data volume limitations, the maximum queryable time span is three months, etc.Maximum data can be viewed is 500 pages, please export data for more details.

Endpoint URL

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

Common Request 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

Request Parameters

Name	Type	Required	Sample	Description
page_no	int32	True	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	True	20	Number of records returned per page, the maximum limit is 500, and page_no * page_size must be <= 10000.
order_sn	string	False	YSWVY8D7OU	Unique identifier of the order.
affiliate_id	int64	False	11346460002	ID of the affiliate who promoted the item.
item_id	int64	False	3903624400	ID of the product purchased.
item_name	string	False	item1	Product's name.
l1_category_id	int64	False	104136	Hierarchical product category classification. (L1 Category)
l2_category_id	int64	False	241360	Hierarchical product category classification. (L2 category)
l3_category_id	int64	False	404136	Hierarchical product category classification. (L3 Category)
order_status	string	False	Unpaid	Order Status. Applicable values: Unpaid Pending Completed Cancelled
verified_status	string	False	Unverified	Verified Status. Applicable values: Unverified Valid Invalid
buyer_status	string	False	New	Buyer Status. Applicable values: New Existing
attr_campaign_id	int64	False	18017	ID referencing the campaign rule applied.
campaign_partner	string	False	auto.1	Name/ID of campaign partner.
seller_campaign_type	string	False	TargetCampaign	Seller Campaign Type. Applicable values: TargetCampaign OpenCampaign MCNCampaign
deduction_status	string	False	PendingDeduction	Deduction Status. Applicable values: PendingDeduction Deducted
deduction_method	string	False	OrderEscrow	Deduction Method. Applicable values: OrderEscrow SellerWallet AutoAdjustment SVSPaymentLink OfflineSettlement AMSCredit
place_order_time_start	timestamp	False	1753459200	Start time (inclusive) of order placement, in timestamp format.
place_order_time_end	timestamp	False	1756051199	End time (inclusive) of order placement, in timestamp format.
order_completed_time_start	timestamp	False	1753459200	Start time (inclusive) of order completion, in timestamp format.
order_completed_time_end	timestamp	False	1756051199	End time (inclusive) of order completion, in timestamp format.
conversion_completed_time_start	timestamp	False	1753459200	Start time (inclusive) of final completion, in timestamp format.
conversion_completed_time_end	timestamp	False	1756051199	End time (inclusive) of final completion, in timestamp format.
ams_deduction_time_start	timestamp	False	1753459200	Start time (inclusive) of fee deduction, in timestamp format.
ams_deduction_time_end	timestamp	False	1756051199	End time (inclusive) of fee deduction, in timestamp format.

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.
list	object[]		Array of order records. Each object contains order and commission details.
order_sn	string	YSWVY8D7OU	Unique identifier of the order.
order_status	string	Pending	Current status of the order (e.g., Pending, Completed, Cancelled).
verified_status	string	Unverified	Verification status of the order (Unverified, Verified).
place_order_time	string	2025/8/10 15:36:22	Time when the order was placed.
order_completed_time	string	2025/8/10 13:10:00	Time when the order was marked as completed.
conversion_completed_time	string	2025/8/9 17:38:54	Time when the conversion (affiliate action) was completed.
affiliate_id	int64	11393990003	Unique identifier of the affiliate.
affiliate_name	string	Yoyi popup	Shopee display name of the affiliate who promoted the item.
affiliate_username	string	yiyi.test.0206.19	Affiliate's Shopee login username.
linked_mcn	string	auto.id.108	MCN (Multi-Channel Network) linked with the affiliate, if any.
order_brand_commission	string	2999.7	Commission (amount) for the whole order, paid by the seller.
channel	string	Telegram	Traffic channel or platform where the promotion took place.
order_type	string	Direct Order	Type of order: Direct Order or Indirect Order.
buyer_status	string	Existing	Buyer Status. Applicable values: New Existing
items	object[]
item_id	int64	3903624400	Unique identifier of the item in the order.
item_name	string	item1	Name of the item in the order.
model_id	int64	1232348722	SKU/model identifier for the item.
l1_category_id	int64	104136	Level-1 global category id classification of the item.
l2_category_id	int64	204136	Level-2 global category id classification of the item.
l3_category_id	int64	404136	Level-3 global category id classification of the item.
promotion_id	string	36262963_0_0	Identifier of the promotion campaign linked to the order.
price	int64	9090	Item price in cents (or smallest currency unit).
qty	int64	1	Quantity of the item purchased.
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.
attr_campaign_id	int64	1130273167000412	Campaign attribute ID associated with the order.
purchase_value	int64	9099	Total purchase value of the order in cents (or smallest currency unit).
refund_amount	string	50	Amount refunded for the order.
item_brand_commission	string	899.91	Commission (amount) for the item, paid by the seller.
item_brand_commission_rate_to_affiliate	string	10%	Commission rate allocated to the affiliate for the item.
item_brand_commission_to_affiliate	string	899.91	Commission (amount) allocated to the affiliate for the item.
item_brand_commission_rate_to_mcn	string	33%	Commission rate allocated to the MCN for the item.
item_brand_commission_to_mcn	string	2999.7	Commission (amount) allocated to the MCN for the item.
campaign_partner	string	testid.mcn.0	Partner identifier for the campaign.
total_count	int64	345	Total number of entities that match the condition.
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.