COD NetworkAppearance
Orders
On this page, you can see all endpoints related to the Seller's orders
Dataset
| Field | Description |
|---|---|
id | The unique identifier of the order. |
reference | The order reference. |
lead_id | The lead id of the order. |
customer_name | The customer name. |
customer_phone | The customer phone. |
customer_city | The customer city. |
customer_area | The customer area. |
customer_country.name | The customer country name. |
customer_country.iso_code | The customer country iso code. |
customer_address | The customer address. |
shipped_at | The shipping datetime. |
delivered_at | The delivery datetime. |
returned_at | The return datetime. |
status | The current status of order, it can be: new, assigned(order sent to shipping company), shipped, delivered, return, cancel, out_of_stock, pending(shipped), return_on_process. |
action | The order action. |
products[].name | The order's product name. |
products[].sku | The order's product sku. |
products[].price | The order's product price. |
products[].quantity | The order's product quantity. |
from_to | The from/to countries. |
tracking_status | The tracking status. |
tracking_number | The tracking number. |
currency | The price currency. |
total | The total amount. |
total_usd | The total USD amount. |
total_weight | The total weight. |
shipping_fees | The shipping fees. |
delivery_fees | The delivery fees. |
created_at | The creation datetime. |
last_update | The last update datetime. |
pay_mode | The Order pay mode, it can be : Cod, Pre paid. |
history | The history of order status. |
Get All orders
Retrieve a list of all orders.
Endpoint
/seller/orders
1
Method GET
Query Parameters
- sku : Filter orders by their sku items.
- customer_phone : Filter orders by customer phone.
- customer_name : Filter orders by customer name.
Request Example
/seller/orders?sku=ABC123&...
1
Response
json
{
"status": "success",
"data": [
{
"id": "...",
"reference": "...",
"lead_id": "...",
"customer_name": "...",
"customer_phone": "...",
"customer_city": "...",
"customer_area": "... ",
"customer_country": {
"name": "...",
"iso_code": "..."
},
"customer_address": "...",
"shipped_at": "...",
"delivered_at": "...",
"returned_at": "...",
"status": "...",
"action": "...",
"products": [
{
"name": "...",
"sku": "...",
"price": "...",
"quantity": "..."
},
...
],
"from_to": "...",
"tracking_status": "...",
"tracking_number": "...",
"currency": "...",
"total": "...",
"total_usd": "...",
"total_weight": "...",
"shipping_fees": "...",
"delivery_fees": "...",
"created_at": "...",
"last_update": "...",
"pay_mode":"...",
"history" : [
{
"id": ...,
"status": "...",
"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
45
46
47
48
49
50
51
52
53
54
55
56
57
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
45
46
47
48
49
50
51
52
53
54
55
56
57
Show order
Retrieve a order.
Endpoint
/seller/orders/{id}
1
Method GET
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
id | string | The unique identifier of the order to retrieve. | Yes |
Response
json
{
"status": "success",
"data": {
"id": "...",
"reference": "...",
"lead_id": "...",
"customer_name": "...",
"customer_phone": "...",
"customer_city": "...",
"customer_area": "... ",
"customer_country": {
"name": "...",
"iso_code": "..."
},
"customer_address": "...",
"shipped_at": "...",
"delivered_at": "...",
"returned_at": "...",
"status": "...",
"action": "...",
"products": [
{
"name": "...",
"sku": "...",
"price": "...",
"quantity": "..."
},
...
],
"from_to": "...",
"tracking_status": "...",
"tracking_number": "...",
"currency": "...",
"total": "...",
"total_usd": "...",
"total_weight": "...",
"shipping_fees": "...",
"delivery_fees": "...",
"created_at": "...",
"last_update": "...",
"pay_mode":"...",
"history" : [
{
"id": ...,
"status": "...",
"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
39
40
41
42
43
44
45
46
47
48
49
50
51
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
45
46
47
48
49
50
51
Create order
Create one order.
Endpoint
/seller/orders
1
Method POST
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| full_name | string | The customer full name | Yes |
| phone | string | The customer phone number | Yes |
| country | string | The country ISO code 2 of customer | Yes |
| address | string | The customer address | Yes |
| city | string | The customer city | Yes |
| area | string | The customer area | Yes |
| items[].sku | string | The unique code of order's product. | Yes |
| items[].price | float | The product price | Yes |
| items[].quantity | integer | The quantity of product | Yes |
Response
201 Created
json
{
"status": "success",
"data": {
"id": "...",
"reference": "...",
"lead_id": "...",
"customer_name": "...",
"customer_phone": "...",
"customer_city": "...",
"customer_area": "... ",
"customer_country": {
"name": "...",
"iso_code": "..."
},
"customer_address": "...",
"shipped_at": "...",
"delivered_at": "...",
"returned_at": "...",
"status": "...",
"action": "...",
"products": [
{
"name": "...",
"sku": "...",
"price": "...",
"quantity": "..."
},
...
],
"from_to": "...",
"tracking_status": "...",
"tracking_number": "...",
"currency": "...",
"total": "...",
"total_usd": "...",
"total_weight": "...",
"shipping_fees": "...",
"delivery_fees": "...",
"created_at": "...",
"last_update": "...",
"pay_mode":"...",
"history" : [
{
"id": ...,
"status": "...",
"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
39
40
41
42
43
44
45
46
47
48
49
50
51
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
45
46
47
48
49
50
51
Get notified on a order status update
To obtain the latest order 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": "...",
"reference": "...",
"lead_id": "...",
"customer_name": "...",
"customer_phone": "...",
"customer_city": "...",
"customer_area": "... ",
"customer_country": {
"name": "...",
"iso_code": "..."
},
"customer_address": "...",
"shipped_at": "...",
"delivered_at": "...",
"returned_at": "...",
"status": "...",
"action": "...",
"products": [
{
"name": "...",
"sku": "...",
"price": "...",
"quantity": "..."
},
...
],
"from_to": "...",
"tracking_status": "...",
"tracking_number": "...",
"currency": "...",
"total": "...",
"total_usd": "...",
"total_weight": "...",
"shipping_fees": "...",
"delivery_fees": "...",
"created_at": "...",
"last_update": "...",
"pay_mode":"...",
"history": [
{
"id": ...,
"status": "...",
"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
39
40
41
42
43
44
45
46
47
48
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
45
46
47
48