SellApp
ApiResourcesAffiliates

Retrieve or review a referral

Retrieve an affiliate referral or move it through a valid review decision.

Once a referral is assigned to a payout, change it through the payout status endpoint so the payout and referral ledger remain consistent.

GET
/v2/affiliate-referrals/{referral}

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

referral*integer

The referral path parameter.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://sell.app/api/v2/affiliate-referrals/0"
{
  "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"
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
PATCH
/v2/affiliate-referrals/{referral}/status

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

referral*integer

The referral path parameter.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://sell.app/api/v2/affiliate-referrals/0/status" \  -H "Content-Type: application/json" \  -d '{    "status": "accepted"  }'
{
  "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"
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}