Skip to navigation
API ReferenceBroker

Get rebate details link

Retrieve the download link for a previously generated per-order rebate details file. The link is only available once the generation task has completed.

Authentication

OK-ACCESS-KEYstring
Your API key.
OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring
The passphrase you set when creating the API key.

Query parameters

typestringRequired
File type of the rebate report to retrieve.
beginstringRequired

Start date of the rebate query range, format YYYYMMDD (must match the range used to generate the file).

endstringRequired

End date of the rebate query range, format YYYYMMDD (must match the range used to generate the file).

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional