Skip to main content
GET
/
stores
/
{storeId}
/
affiliates
/
{customerId}
/
payouts
/
{page}
List payout records for a given affiliate (by customerId), paginated.
curl --request GET \
  --url https://api.komerza.com/stores/{storeId}/affiliates/{customerId}/payouts/{page} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "pages": 123,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "affiliateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "convertedToStoreCredit": true,
      "initiatedByIp": "<string>",
      "isVoided": true,
      "comment": "<string>",
      "initiatedByUserId": "<string>",
      "voidDate": "2023-11-07T05:31:56Z",
      "voidedByUserId": "<string>",
      "voidReason": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Your API key goes here

Path Parameters

​
storeId
string<uuid>
required
​
customerId
string<uuid>
required
​
page
integer<int32>
default:1
required

Query Parameters

​
limit
integer<int32>
default:50

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

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