SellApp
ApiResourcesAffiliates

List affiliate referrals

List referral commissions and their attributed Order and InvoiceV2 product line.

Percentage commissions expose commission.percentage as a decimal string. Fixed commissions expose commission.amount_usd_cents as integer USD cents; the unused value is null.

GET
/v2/affiliate-referrals

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 store affiliate ID.

Range1 <= value
order_id?integer

Filter by attributed Order ID.

Range1 <= value
status?string

Filter by referral status.

Value in"created" | "accepted" | "in_review" | "pending" | "paid" | "rejected" | "void" | "expired"
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-referrals"
{
  "data": [
    {
      "id": 0,
      "affiliate_id": 0,
      "affiliate_email": "user@example.com",
      "order_id": 0,
      "invoice_v2_id": 0,
      "product_variant_id": 0,
      "product_title": "string",
      "variant_title": "string",
      "customer_id": 0,
      "amount_usd_cents": 0,
      "commission": {
        "type": "percentage",
        "percentage": "string",
        "amount_usd_cents": 0
      },
      "status": "created",
      "eligible_for_payout_at": "2019-08-24T14:15:22Z",
      "payout_id": 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."
    ]
  }
}