` |
**Parameters**
| Param | Ghi chú |
| -------------- | ---------------------------------------------------------------------------------------------------------- |
| requester\_id | ID Người yêu cầu |
| assignee\_id | ID Chuyên viên |
| service\_id | ID dịch vụ |
| page | Trang số (mặc định 1) |
| count | Số bản ghi /trang (mặc định 50, max 500) |
| created\_since | Ngày tạo từ (Kiểu Time TZ)
Vd: 2024-06-01T00:00:00Z
|
| created\_to | Ngày tạo tới (Kiểu Time TZ)
Vd: 2024-06-01T00:00:00Z
|
| updated\_since | Ngày cập nhật từ (Kiểu Time TZ)
Vd: 2024-06-01T00:00:00Z
|
| updated\_to | Ngày cập nhật tới (Kiểu Time TZ)
Vd: 2024-06-01T00:00:00Z
|
| convert\_since | Ngày chuyển đổi thành deal (từ lead) (Kiểu Time TZ)
Vd: 2024-06-01T00:00:00Z
|
| convert\_to | Ngày chuyển đổi thành deal tới (Kiểu Time TZ)
Vd: 2024-06-01T00:00:00Z
|
| closed\_since | Ngày đóng Deal từ (Kiểu Time TZ)
Vd: 2024-06-01T00:00:00Z
|
| closed\_to | Ngày đóng Deal tới (Kiểu Time TZ)
Vd: 2024-06-01T00:00:00Z
|
| pipeline\_ids | ID Tiến trình chọn nhiều cách nhau bởi dấu phẩy
VD: 12 hoặc 12,34,56
|
| stage\_ids | ID chọn nhiều cách nhau bởi dấu phẩy
VD: 12 hoặc 12,34,56
|
| closed\_type | Trạng thái đóng:
1: Thành công, 2: Mất Deal , 3: Không đạt
|
| convert\_type | Trạng thái chuyển đổi từ lead sang deal
1:Chuyển thành Deal , 2: Chuyển thành unqualified.
|
**Response**
{% tabs %}
{% tab title="200" %}
```json
{
"code": "ok",
"numFound": 2,
"deals": [
{
"id": 414858584,
"deal_no": 275062,
"requester_id": 63203703,
"ticket_source_end_status": null,
"assignee_id": 63203703,
"ticket_priority": "Normal",
"ticket_source": "Web",
"is_overdue": null,
"subject": "csxcsxdv",
"created_at": "2024-05-24T17:22:21Z",
"updated_at": "2024-05-27T11:32:17Z",
"duedate": null,
"service_id": null,
"incident_id": -1,
"satisfaction": null,
"satisfaction_at": null,
"satisfaction_content": null,
"campaign_id": null,
"automessage_id": null,
"ticket_source_detail_id": null,
"convert_by": null,
"convert_at": null,
"convert_type": null,
"unqualified_reasons": null,
"last_lead_status_id": null,
"lead_status_id": null,
"estimated_closed_date": "2024-05-24 23:59:59",
"closed_at": "2024-05-27 11:06:02",
"closed_by": 63203703,
"closed_type": 2,
"pipeline_id": 56,
"pipeline_stage_id": 382,
"value": 0,
"probability": 20,
"last_deal_stage_id": 377,
"lost_reasons": 79
},
{
"id": 414857144,
"deal_no": 273806,
"requester_id": 1,
"ticket_source_end_status": null,
"assignee_id": 1,
"ticket_priority": "Normal",
"ticket_source": "Web",
"is_overdue": null,
"subject": "xxxx",
"created_at": "2024-05-07T13:46:14Z",
"updated_at": "2024-05-07T17:48:36Z",
"duedate": null,
"service_id": null,
"incident_id": -1,
"satisfaction": null,
"satisfaction_at": null,
"satisfaction_content": null,
"campaign_id": null,
"automessage_id": null,
"ticket_source_detail_id": null,
"convert_by": null,
"convert_at": null,
"convert_type": null,
"unqualified_reasons": null,
"last_lead_status_id": null,
"lead_status_id": null,
"estimated_closed_date": null,
"closed_at": "2024-05-07 17:48:36",
"closed_by": 29370874,
"closed_type": 2,
"pipeline_id": 56,
"pipeline_stage_id": 382,
"value": 0,
"probability": 5,
"last_deal_stage_id": 376,
"lost_reasons": 85
}
]
}
```
{% endtab %}
{% tab title="400" %}
```json
{
"error": "Invalid request"
}
```
{% endtab %}
{% endtabs %}
## 5. Các API liên quan khác
## 5.1 Danh sách Các tiến trình và giai đoạn
`GET` `/{domain}/api/v1/deal/pipelines`
**Headers**
| Name | Value |
| ------------- | ------------------ |
| Content-Type | `application/json` |
| Authorization | `Bearer ` |
**Response**
{% tabs %}
{% tab title="200" %}
```json
{
"code": "ok",
"data": [
{
"id": 41,
"label": "Sale pipeline",
"created_at": "2024-03-01 09:43:10",
"updated_at": "2024-03-30 00:40:06",
"default": 0,
"stages": [
{
"id": 296,
"pipeline_id": 41,
"stage_name": "Tư vấn triển khai ",
"stage_type": 1,
"probability": 50
},
{
"id": 298,
"pipeline_id": 41,
"stage_name": "Hợp đồng báo giá",
"stage_type": 0,
"probability": 20
},
{
"id": 299,
"pipeline_id": 41,
"stage_name": "Vận đơn Logistic",
"stage_type": 0,
"probability": 70
},
{
"id": 300,
"pipeline_id": 41,
"stage_name": "Thanh toán thành công",
"stage_type": 2,
"probability": 0
},
{
"id": 301,
"pipeline_id": 41,
"stage_name": "Hoàn hàng ",
"stage_type": 3,
"probability": 0
},
{
"id": 302,
"pipeline_id": 41,
"stage_name": "Đổi trả ",
"stage_type": 4,
"probability": 0
}
]
}
]
}
```
{% endtab %}
{% tab title="400" %}
```json
{
"error": "Invalid request"
}
```
{% endtab %}
{% endtabs %}
## 5.2 Lý do không đạt
`GET``/{domain}/api/v1/deal/unqualified-reasons`
**Headers**
| Name | Value |
| ------------- | ------------------ |
| Content-Type | `application/json` |
| Authorization | `Bearer ` |
**Response**
{% tabs %}
{% tab title="200" %}
```json
{
"code": "ok",
"data": [
{
"id": 193,
"label": "No need"
},
{
"id": 194,
"label": "Not the decision maker"
},
{
"id": 195,
"label": "No budget"
},
{
"id": 196,
"label": "Not the right timing"
},
{
"id": 197,
"label": "Other"
}
]
}
```
{% endtab %}
{% tab title="400" %}
```json
{
"error": "Invalid request"
}
```
{% endtab %}
{% endtabs %}
## 5.3 Lý do mất đơn
`POST` `/{domain}/api/v1/deal/lost-reasons`
\
**Headers**
| Name | Value |
| ------------- | ------------------ |
| Content-Type | `application/json` |
| Authorization | `Bearer ` |
**Body**
| Name | Type | Description |
| ------ | ------ | ---------------- |
| `name` | string | Name of the user |
| `age` | number | Age of the user |
**Response**
{% tabs %}
{% tab title="200" %}
```json
{
"code": "ok",
"data": [
{
"id": 20,
"label": "Lost to competiton"
},
{
"id": 21,
"label": "Poor follow up"
},
{
"id": 22,
"label": "We are too expensive"
},
{
"id": 23,
"label": "Timing Gap"
}
]
}
```
{% endtab %}
{% tab title="400" %}
```json
{
"error": "Invalid request"
}
```
{% endtab %}
{% endtabs %}
## 5.4 Deal labels
`GET` `/{domain}/api/v1/deal/labels`
**Headers**
| Name | Value |
| ------------- | ------------------ |
| Content-Type | `application/json` |
| Authorization | `Bearer ` |
**Body**
| Name | Type | Description |
| ------ | ------ | ---------------- |
| `name` | string | Name of the user |
| `age` | number | Age of the user |
**Response**
{% tabs %}
{% tab title="200" %}
```json
{
"code": "ok",
"data": [
{
"id": 37,
"label": "Automation",
"created_at": "2023-10-27 23:18:55",
"updated_at": "2023-10-27 23:18:55"
},
{
"id": 29,
"label": "Cold Deal",
"created_at": "2023-10-27 23:16:34",
"updated_at": "2023-10-27 23:16:34"
},
{
"id": 30,
"label": "Web Form",
"created_at": "2023-10-27 23:16:45",
"updated_at": "2023-10-27 23:16:45"
}
]
}
```
{% endtab %}
{% tab title="400" %}
```json
{
"error": "Invalid request"
}
```
{% endtab %}
{% endtabs %}
[^1]: "ORDER\_STARTED": Khởi tạo đơn hàng
"BUYER\_CONFIRMED": Người mua xác nhận
"SELLER\_CONFIRMED: Nhà bán xác nhận
"SHIPPING": Đang vận chuyển
"RETURNED": Hoàn
"CANCELED": Hủy
"RECEIVED"": Đã nhận
[^2]: "sku": Mã sản phẩm
"is\_free": Hàng tặng "1", Mặc định 0
"unit\_price": Giá tiền
"quantity": Số lượng
"discount\_markup": Tỉ lệ giảm giá, "discount\_value": Giảm giá bằng tiền
[^3]: "ORDER\_STARTED": Khởi tạo đơn hàng
"BUYER\_CONFIRMED": Người mua xác nhận
"SELLER\_CONFIRMED: Nhà bán xác nhận
"SHIPPING": Đang vận chuyển
"RETURNED": Hoàn
"CANCELED": Hủy
"RECEIVED"": Đã nhận
[^4]: "sku": Mã sản phẩm
"is\_free": Hàng tặng "1", Mặc định 0
"unit\_price": Giá tiền
"quantity": Số lượng
"discount\_markup": Tỉ lệ giảm giá, "discount\_value": Giảm giá bằng tiền