COD NetworkAppearance
Leads
On this page, you can see all endpoints related to the Seller's leads
Dataset
| Field | Description |
|---|---|
id | The unique identifier of the lead. |
phone | The customer's phone number |
calls | The number of calls. |
status | The current status of the lead, it can be: new, confirmed, call_later,call_later_scheduled, no_reply, cancelled, wrong, expired, processing, delayed, cancelled_price |
fees | The lead call center fees. |
created_at | The lead creation datetime. |
pay_mode | The lead pay mode, it can be : Cod, Pre paid. |
lead_inputs | The lead inputs data |
items[].quantity | The quantity of lead's product. |
items[].product_sku | The unique code of lead's product. |
items[].sku | The sku of lead's product. |
items[].product_name | The name of lead's product. |
history | The history of lead status. |
Get All leads
Retrieve a list of all leads.
Endpoint
/seller/leads
1
Method GET
Query Parameters
- sku : Filter leads by their sku items.
- phone : Filter leads by phone.
Request Example
/seller/leads?sku=ABC123&...
1
Response
json
{
"status": "success",
"data": [
{
"id": "...",
"items": [
{
"product_sku": "...",
"sku": "...",
"product_name": "...",
"quantity": "..."
},
...
],
"phone": "...",
"status": "...",
"calls": "...",
"fees": {
"entered" : ...,
"confirmed" : ...,
"delivered" : ...,
"up_down_cross_sell" : ...
},
"created_at": "...",
"lead_inputs": [
{...}
],
"pay_mode":"...",
"history" : [
{
"id": ...,
"status": "...",
"comment": "...",
"created_at": ...
},
...
]
},
...
],
"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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
Show lead
Retrieve a lead.
Endpoint
/seller/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": "...",
"items": [
{
"product_sku": "...",
"sku": "...",
"product_name": "...",
"quantity": "..."
},
...
],
"phone": "...",
"status": "...",
"calls": "...",
"fees": {
"entered" : ...,
"confirmed" : ...,
"delivered" : ...,
"up_down_cross_sell" : ...
},
"created_at": "...",
"lead_inputs": [
{...}
],
"pay_mode":"...",
"history" : [
{
"id": ...,
"status": "...",
"comment": "...",
"created_at": ...
},
...
]
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
Create lead
Create one lead.
Endpoint
/seller/leads
1
Method POST
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| phone | string | The customer's phone number | Yes |
| items[].sku | string | The unique code of lead's product. | Yes |
| items[].price | float | The product price | No |
| items[].quantity | integer | The quantity of product | Yes |
| name | string | The customer's name | No |
| country | string | The country ISO code 2 of customer | No |
| address | string | The customer's address | No |
Response
201 Created
json
{
"status": "success",
"data": {
"id": "...",
"items": [
{
"product_sku": "...",
"sku": "...",
"product_name": "...",
"quantity": "..."
},
...
],
"phone": "...",
"status": "...",
"calls": "...",
"fees": {
"entered" : ...,
"confirmed" : ...,
"delivered" : ...,
"up_down_cross_sell" : ...
},
"created_at": "...",
"lead_inputs": [
{...}
],
"pay_mode":"...",
"history" : [
{
"id": ...,
"status": "...",
"comment": "...",
"created_at": ...
},
...
]
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
Get notified on a lead status update
To obtain the latest lead status update, kindly navigate to your account settings, access the API developer section, and input your designated webhook callback URL. Ensure that the action is executed using the POST method. Should you encounter any issues or require further assistance, please don't hesitate to reach out to us at [email protected].
Json format
json
{
"id": "...",
"items": [
{
"product_sku": "...",
"quantity": "..."
},
...
],
"phone": "...",
"status": "...",
"calls": "...",
"created_at": "...",
"lead_inputs": [
{...}
],
"pay_mode":"..." ,
"history" : [
{
"id": ...,
"status": "...",
"comment": "...",
"created_at": ...
},
...
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27