Documentation Index
Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
Use this file to discover all available pages before exploring further.
Retrieve the list of commissions for a account.
GET https://services.leadconnectorhq.com/affiliate-manager/{locationId}/commissions
Autorizacion
Bearer token generado desde el portal Leadway. Ver Autenticacion. Version
string
default:"2021-07-28"
required
Version de la API.
Path parameters
locationId
string
default:"ve9EPM428h8vShlRW1KT"
required
Account Id
Query parameters
campaignId
string
default:"6385d230f6d19db03eef6fb2"
Campaign Id
affiliateId
string
default:"6385d230f6d19db03eef6fb2"
Affiliate Id
query
string
default:"affiliate@gmail.com"
Query
Maximum number of records to return. Maximum allowed value is 100.
fromDate
string
default:"2023-10-01"
toDate
string
default:"2023-10-01"
Respuestas
200 - Successful response
Commission list
_id
string
default:"6385d230f6d19db03eef6fb2"
required
Commission id
productId
string
default:"6385d230f6d19db03eef6fb2"
Product id
productName
string
default:"Basic Plan"
Product name
Product commission amount
campaignName
string
default:"Summer Promo"
Campaign name
Commission percentage or value
commissionType
string
default:"percentage"
Commission type
transactionAt
string
default:"2024-06-16T00:00:00.000Z"
Transaction time
affiliateId
string
default:"6385d230f6d19db03eef6fb2"
Affiliate id
payoutId
string
default:"6385d230f6d19db03eef6fb2"
Payout id
Whether the item is a trial commission
createdAt
string
default:"2024-06-16T00:00:00.000Z"
Created at
dueAt
string
default:"2024-06-30T00:00:00.000Z"
Due date
Whether the commission is in live mode
{
"commissions": [
{
"_id": "6385d230f6d19db03eef6fb2",
"productId": "6385d230f6d19db03eef6fb2",
"productName": "Basic Plan",
"qty": 1,
"productCommission": 25,
"commissionAmount": 25,
"amount": 100,
"unitDiscount": 5,
"campaignName": "Summer Promo",
"commission": 25,
"commissionType": "percentage",
"transactionAt": "2024-06-16T00:00:00.000Z",
"transactionId": "txn_123",
"affiliateId": "6385d230f6d19db03eef6fb2",
"payoutId": "6385d230f6d19db03eef6fb2",
"status": "pending",
"currency": "USD",
"isTrial": false,
"createdAt": "2024-06-16T00:00:00.000Z",
"eventId": "evt_123",
"dueAt": "2024-06-30T00:00:00.000Z",
"liveMode": true,
"tier": 1
}
]
}
422 - Unprocessable Entity
Ejemplo
curl -X GET 'https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/commissions' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
