[lightMode]

List Affiliates

GET/affiliates

[updatedIn] 2 months ago

This endpoint allows you to fetch a list of marketing affiliates.

`marketing.read`- Marketing Read Only

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Request samples

[api.label.responses]

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

status

number

required

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

required

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array[object (Affiliate) {11}]

required

number

required

Affiliate ID. Affiliate list can be found here.

Example:

611208326

code

string

required

Affiliate Code

Example:

frm11

marketer_name

string

required

Affiliate Marketing Name

Example:

User Name

marketer_city

string

required

Affiliate Marketing City

Example:

Medina

commission_type

enum<string>

required

If comission_type is fixed, then use a numeric value such as 100. If comission_type is percentage, then use a percentage value such as 15%.

Allowed values:

fixedpercentage

Example:

fixed

amount

object

required

profit

object

required

links

object

required

apply_to

string

required

Where the affiliate link should be applied. Available values are all_orders or first_order

Example:

first_order

visits_count

number

required

Link Visit Counts

Example:

notes

string

required

Additional Notes

Example:

Notes Here

pagination

object (Pagination)

required

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 611208326,
      "code": "frm11",
      "marketer_name": "User Name",
      "marketer_city": "Medina",
      "commission_type": "fixed",
      "amount": {
        "amount": 300,
        "currency": "SAR"
      },
      "profit": {
        "amount": 150,
        "currency": "SAR"
      },
      "links": {
        "affiliate": "https://salla.sa/dev-wofftr4xsra5xtlv?utm_source=aff&utm_campaign=CXNAZ",
        "statistics": "https://salla.sa/dev-wofftr4xsra5xtlv/marketing/statistics/1604086218"
      },
      "apply_to": "first_order",
      "visits_count": 17,
      "notes": "Notes Here"
    }
  ],
  "pagenation": {
    "count": 10,
    "total": 10,
    "perPage": 65,
    "currentPage": 10,
    "totalPages": 10,
    "links": []
  }
}

[updatedIn] 2 months ago