v2.payment.get_income_report

GET /api/v2/payment/get_income_report

To query income report status and provide file link if the income report is ready to be downloaded.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/payment/get_income_report

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

Name	Type	Required	Sample	Description
income_report_id	int64	True	123456	The identifier for income report file request.

Name	Type	Sample	Description
response	object
id	int64	123456	The identifier for income statement file request.
file_name	string	weekly_report_20241111.pdf	Income report file name.
status	int32	1	STATUS_INVALID = 0; STATUS_PROCESSING = 1; STATUS_DOWNLOADABLE = 2; STATUS_DOWNLOADED = 3; STATUS_FAILED = 4;
generated_time	int64	12345678987654	File generation time.
file_link	string	https://seller.uat.shopee.sg/api/v4/accounting/pc/seller\_income/income\_report/get\_income\_document\_file?path=0/ODljOWY0MjYtOTExMS00MmIxLTkzOGEtNzQ1MmEyZThiZGJi/weekly\_report\_20241111.pdf	Link to download income report file.
error	string		Error Code
msg	string		Error Message
request_id	string		Request ID

No Request Example Set.

No Response Example Set.