SellApp
ApiResourcesAffiliates

List affiliate payouts

List or retrieve affiliate payouts with masked destinations.

These records settle affiliate referral commissions. They are not seller platform balance payouts.

Responses can include cancelled historical payouts. The payout status update endpoint only supports settling a due payout or reopening a paid payout.

GET
/v2/affiliate-payouts

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Query Parameters

affiliate_id?integer

Filter by affiliate ID.

Range1 <= value
status?string

Filter by payout status.

Value in"due" | "paid"
limit?integer

Number of items to return per page.

Default15
Range1 <= value <= 100
page?integer

Page number to return.

Default1
Range1 <= value

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://sell.app/api/v2/affiliate-payouts"
{
  "data": [
    {
      "id": 0,
      "affiliate_id": 0,
      "affiliate_email": "user@example.com",
      "amount_usd_cents": 0,
      "status": "due",
      "payout_method": "string",
      "payout_account": "string",
      "referrals_count": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "links": {
    "first": "https://sell.app/api/v1/blacklists?page=1",
    "last": "https://sell.app/api/v1/blacklists?page=4",
    "prev": null,
    "next": "https://sell.app/api/v1/blacklists?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 4,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "https://sell.app/api/v1/blacklists",
    "per_page": 15,
    "to": 15,
    "total": 57
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
GET
/v2/affiliate-payouts/{payout}

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Path Parameters

payout*integer

The payout path parameter.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://sell.app/api/v2/affiliate-payouts/0"
{
  "data": {
    "id": 0,
    "affiliate_id": 0,
    "affiliate_email": "user@example.com",
    "amount_usd_cents": 0,
    "status": "due",
    "payout_method": "string",
    "payout_account": "string",
    "referrals_count": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}