COD NetworkAppearance
Leads
On this page, you can see all endpoints related to the Affiliate's leads
Dataset
| Field | Description |
|---|---|
id | The unique identifier of the lead. |
offer_id | The identifier of the associated offer. |
referral_id | The referral code. |
tracking_number | The shipping tracking number. |
status | The current status of the lead, it can be: lead, confirmed, delivered,return, call_later, call_later_scheduled, no_reply, cancelled, wrong, expired, out_of_stock, shipped, duplicated |
country_iso_code | The ISO country code 2. |
note | The lead's comment. |
commission | The commission (payout). |
currency | The commission's currency. |
created_at | The lead creation datetime. |
updated_at | The lead modification datetime. |
subid | The ID used for tracking. |
subid2 | The second ID used for tracking. |
Get All leads
Retrieve a list of all leads.
Endpoint
/affiliate/leads
1
Method GET
Parameters
None.
Response
json
{
"status": "success",
"data": [
{
"id": "...",
"offer_id": "...",
"referral_id": "...",
"tracking_number": "...",
"status": "...",
"country_iso_code": "...",
"note": "...",
"created_at": "...",
"updated_at": "...",
"subid": "...",
"subid2": "...",
"commission": "",
"currency": ""
},
...
],
"meta": {
"pagination": {...}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Show lead
Retrieve a lead.
Endpoint
/affiliate/leads/{id}
1
Method GET
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
id | string | The unique identifier of the lead to retrieve. | Yes |
Response
json
{
"status": "success",
"data": {
"id": "...",
"offer_id": "...",
"referral_id": "...",
"tracking_number": "...",
"status": "...",
"country_iso_code": "...",
"note": "...",
"created_at": "...",
"updated_at": "...",
"subid": "...",
"subid2": "...",
"commission": "",
"currency": ""
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Create lead
Create one lead.
Endpoint
/affiliate/leads
1
Method POST
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| referral_id | string | The referral id | Yes |
| name | string | The customer's name | Yes |
| phone | string | The customer's phone number | Yes |
| address | string | The customer's address | Yes |
| subid | string | The ID used for tracking | No |
| subid2 | string | The second ID used for tracking | No |
| city | string | The customer's city | No |
| country | string | The offer country ISO code 2 | No |
| zip Code | string | The customer's zip code | No |
| quantity | int | The quantity ordered | No |
| note | string | The lead's comment. | No |
Response
201 Created
json
{
"status": "success",
"data": {
"id": "...",
"offer_id": "...",
"referral_id": "...",
"tracking_number": "...",
"status": "...",
"country_iso_code": "...",
"note": "...",
"created_at": "...",
"updated_at": "...",
"subid": "...",
"subid2": "...",
"commission": "",
"currency": ""
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Get notified on a lead status update
To retrieve the lead status update go to your account settings and put your webhook callback URL, if something went wrong, do not hesitate to contact us at [email protected]
Json format
json
{
"lead_id": "...",
"status": "...",
"subid": "...",
"subid2": "..."
}
1
2
3
4
5
6
2
3
4
5
6