Skip to navigation
API ReferenceBroker

Generate rebate details link

Submit an asynchronous task that generates a downloadable file of per-order rebate details for the requested date range. The generated file is then retrieved with the corresponding GET endpoint.

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.

Request

This endpoint expects an object.
beginstringRequired

Start date of the rebate query range, format YYYYMMDD (e.g. 20220601). The interval between begin and end cannot exceed one natural month.

endstringRequired

End date of the rebate query range, format YYYYMMDD (e.g. 20220630). Data is available only for the most recent months.

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