v1
latestOpenAPI 3.0.42026-07-2685196386.6 KBSearch affiliates.
Searches affiliates by the query parameter and applies filtering/sorting/pagination. The query is matched against affiliate email, affiliate link/code, affiliate ID, and customer ID. Requires the stores.affiliates.view permission.
Path parameters
The unique identifier of the store.
Query parameters
Free-text query used by the search endpoint.
Filter by affiliate enabled status.
Filter by affiliate email address (contains).
Filter by affiliate link/code (contains).
Minimum affiliate balance (inclusive).
Maximum affiliate balance (inclusive).
Minimum return percentage (inclusive).
Maximum return percentage (inclusive).
Minimum discount percentage (inclusive).
Maximum discount percentage (inclusive).
Minimum referred delivered orders (inclusive).
Maximum referred delivered orders (inclusive).
Minimum all-time earned amount (inclusive).
Maximum all-time earned amount (inclusive).
Minimum payout count (inclusive).
Maximum payout count (inclusive).
Filter affiliates created from this date/time (inclusive).
Filter affiliates created before this date/time (inclusive).
Response
The object was successfully returned.