Retrieve affiliates
POST/affiliate/affiliates/query
Retrieves a group of affiliates from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the affiliates returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
Request
Responses
- 200
- 400
- 401
- 410
- 429
- 500
Successful response
Status Code 400: bad request input such as invalid json
Response Headers
Contains human readable error message
Status Code 401: invalid credentials supplied
Response Headers
Contains human readable error message
Status Code 410: Your authorized application has been disabled by UltraCart
Response Headers
Contains human readable error message
Status Code 429: you have exceeded the allowed API call rate limit for your application.
Response Headers
Contains human readable error message
Status Code 500: any server side error. the body will contain a generic server error message
Response Headers
Contains human readable error message