Get Affiliates

Retrieves affiliates for the specified store using query-based filter options. Supports filtering, sorting, and pagination via query parameters. Requires the stores.affiliates.view permission.

GET /stores/{storeId}/affiliates

List store affiliates.

cURL

curl --request GET \
  --url https://api.komerza.com/stores/{storeId}/affiliates \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "pages": 123,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "isEnabled": true,
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "emailAddress": "<string>",
      "link": "<string>",
      "balance": 123,
      "allTimeEarned": 123,
      "referredOrders": 123,
      "conversionRate": 123,
      "returnPercentage": 123,
      "percentageOff": 123
    }
  ]
}

Filterable Fields

This endpoint supports filtering and sorting. See the Filtering & Sorting Guide for syntax details.

Field	Type	Description
isEnabled	boolean	Filter by affiliate enabled status
email	string	Filter by email address (contains)
link	string	Filter by affiliate link/code (contains)
balanceFrom	number	Minimum affiliate balance (inclusive)
balanceTo	number	Maximum affiliate balance (inclusive)
returnPercentageFrom	integer	Minimum return percentage (inclusive)
returnPercentageTo	integer	Maximum return percentage (inclusive)
percentageOffFrom	integer	Minimum discount percentage (inclusive)
percentageOffTo	integer	Maximum discount percentage (inclusive)
referredOrdersFrom	integer	Minimum referred delivered orders (inclusive)
referredOrdersTo	integer	Maximum referred delivered orders (inclusive)
allTimeEarnedFrom	number	Minimum all-time earned amount (inclusive)
allTimeEarnedTo	number	Maximum all-time earned amount (inclusive)
payoutCountFrom	integer	Minimum payout count (inclusive)
payoutCountTo	integer	Maximum payout count (inclusive)
dateFrom	string	Filter affiliates created from this date/time (inclusive)
dateTo	string	Filter affiliates created before this date/time (inclusive)

Authorizations

Authorization · string · header · required

Your API key goes here

Path Parameters

storeId · string<uuid> · required

The unique identifier of the store.

Query Parameters

query · string

Free-text query used by the search endpoint.

isEnabled · boolean

Filter by affiliate enabled status.

email · string

Filter by affiliate email address (contains).

link · string

Filter by affiliate link/code (contains).

balanceFrom · number<double>

Minimum affiliate balance (inclusive).

balanceTo · number<double>

Maximum affiliate balance (inclusive).

returnPercentageFrom · integer<int32>

Minimum return percentage (inclusive).

returnPercentageTo · integer<int32>

Maximum return percentage (inclusive).

percentageOffFrom · integer<int32>

Minimum discount percentage (inclusive).

percentageOffTo · integer<int32>

Maximum discount percentage (inclusive).

referredOrdersFrom · integer<int32>

Minimum referred delivered orders (inclusive).

referredOrdersTo · integer<int32>

Maximum referred delivered orders (inclusive).

allTimeEarnedFrom · number<double>

Minimum all-time earned amount (inclusive).

allTimeEarnedTo · number<double>

Maximum all-time earned amount (inclusive).

payoutCountFrom · integer<int32>

Minimum payout count (inclusive).

payoutCountTo · integer<int32>

Maximum payout count (inclusive).

dateFrom · string<date-time>

Filter affiliates created from this date/time (inclusive).

dateTo · string<date-time>

Filter affiliates created before this date/time (inclusive).

Filters · string

Sorts · string

Page · integer<int32>

Required range: 1 <= x <= 2147483647

PageSize · integer<int32>

Required range: 1 <= x <= 2147483647

Response

200 - application/json

The object was successfully returned.

Represents a paginated response returned from API endpoints, which contains the paginated data and metadata about the pagination.

success · boolean · required · read-only

Indicates whether the operation was successful

pages · integer<int32> · required

The total number of pages available in the paginated response.

data · object[] · required

Represents the collection of items within a paginated response

Show child attributes