Deal

Các API Liên quan đến deals

1. Tạo mới deal

POST /{domain}/api/v1/deal

Tạo mới deal

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

JSON body payload

STT
Param
Kiểu dữ liệu
Độ dài
Ghi chú

1*

deal

object

Đối tượng chứa thông tin lead

..

Các trường trong object deal

1

username

Text

250

Họ tên khách hàng (Trong trường hợp số điện thoại hoặc email của khách đã tồn tại sẽ không sử dụng tham số này)

2

subject (*)

text

250

Tiêu đề

3

phone (*)

tel

50

Số điện thoại của khách hàng

4

email (*)

email

50

Email của khách hàng

5

service_id (**)

Int

10

Dịch vụ tiếp nhận Lead

6

group_id (**)

Int

10

ID bộ phận tiếp nhận

7

assignee_id (**)

Int

10

ID chuyên viên tiếp nhận

8

pipeline_id

Int

10

ID tiến trình (Mặc định theo cấu hình)

9

estimated_closed_date

DateTime

Dự kiến hoàn thành (Định dạng YYYY-MM-DD HH:mm:ss)

10

deal_label

Array

Mảng ID label của deal dạng [1,2,3]

11

pipeline_stage_id

Int

ID giai đoạn của tiến trình (mặc định là đầu giai đoạn)

12

custom_fields

Array

Mảng custom_fields tương tự tạo ticket

13

probability

Int

10

Tỉ lệ thành công (từ 0-100)

14

value

Int

10

Giá trị đơn hàng (Số)

15

comment

Text

5000

Nội dung ghi chú

9

comment.body

Text

5000

Nội dung comment

10

comment.is_public

Int

1

Trạng thái comment 0: Ghi chú 1: Public (VD: Gửi email cho người yêu cầu …)

11

comment.author_id

Int

10

ID của người bình luận

12

order_address_detail

String

255

Địa chỉ chi tiết

13

order_buyer_note

String

500

Ghi chú của người mua

14

order_city_id

String

10

ID của tỉnh (Theo danh sách Tỉnh thành)

15

order_district_id

String

10

ID của huyện/quận (Theo danh sách quận huyện)

16

order_ward_id

String

10

ID của Xã/phường (Theo danh sách xã phường)

17

order_receiver_name

String

200

Người nhận

18

order_receiver_phone

String

20

Số ĐT người nhận

19

order_shipping_fee

Float

Cước vận chuyển

20

order_status

String

50

Là một trong danh sách sau - Danh sách trạng thái

21

order_tracking_code

String

50

Mã vận chuyển

22

order_tracking_url

500

Đường dẫn kiểm tra trạng thái vận chuyển

23

order_products

Array

Mảng sản phẩm (Xem chi tiết trong mẫu)

Mẫu Payload

Mẫu phản hồi

2. Cập nhật deal

PUT /{domain}/api/v1/deal/{dealId}

Cập nhật deal cần ID được lấy từ giá trị deal.id ở tiến trình tạo deal hoặc từ các nguồn khai thác đã tạo deal từ trước.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

JSON body payload

STT
Param
Kiểu dữ liệu
Độ dài
Ghi chú

1*

deal

object

Đối tượng chứa thông tin lead

….

2

subject

text

250

Tiêu đề

7

assignee_id

Int

10

ID chuyên viên tiếp nhận

8

pipeline_id

Int

10

ID tiến trình (Mặc định theo cấu hình)

9

estimated_closed_date

DateTime

Dự kiến hoàn thành (Định dạng YYYY-MM-DD HH:mm:ss)

10

deal_label

Array

Mảng ID label của deal dạng [1,2,3]

11

pipeline_stage_id

Int

ID giai đoạn của tiến trình (mặc định là đầu giai đoạn)

12

custom_fields

Array

Mảng custom_fields tương tự tạo ticket

13

probability

Int

10

Tỉ lệ thành công (từ 0-100)

14

value

INt

10

Giá trị đơn hàng (Số)

15

comment (*)

Object

Nội dung ghi chú

16

order_address_detail

String

255

Địa chỉ chi tiết

17

order_buyer_note

String

20

Ghi chú của người mua

18

order_city_id

String

10

ID tỉnh thành trên CareSoft

19

order_district_id

String

10

ID huyện trên CareSoft

20

order_ward_id

String

10

ID xã trên CareSoft

21

order_receiver_name

String

299

Người nhận

22

order_receiver_phone

String

29

SDT người nhận

23

order_shipping_fee

Float

Giá cước

24

order_status

String

50

Trạng thái đơn hàng, Là một trong (Danh sách )

25

order_tracking_code

String

59

Mã vận chuyển

26

order_tracking_url

String

500

Đường dẫn kiểm tra trạng thái vận chuyển

27

order_products

Array

Mảng sản phẩm (Xem chi tiết trong mẫu)

Mẫu JSON BODY

Response

3. Chi tiết deal

GET /{domain}/api/v1/deal/{dealId}

Lấy chi tiết 1 deal theo tham số dealID được tạo từ bước 1 hoặc được khai thác từ quá trình đồng bộ

Các tham số của Deal gồm

  • converted_at: Ngày chuyển đổi

  • converted_by: ID chuyên viên chuyển đổi

  • converted_type: Kiểu chuyển đổi ( 1: Chuyển thành deal, 2: Chuyển thành không đạt

  • lead_status_id: Id của trạng thái lead ( mục I.2)

  • last_lead_status_id: ID trạng thái trước khi chuyển đổi

  • unqualified_reasons: Id Lý do không đạt (Xem mục I.4)

  • labels : nhãn của Lead (Xem mục I.3)

  • estimated_closed_date: thời gian dự kiến hoàn thành

  • closed_at: Thời gian đóng deal

  • closed_by: Người đóng deal

  • closed_type: Kiểu đóng deal( kiểu Won/ Lost/ Unqualified)

  • pipeline_id: ID tiến trình của deal

  • pipeline_stage_id: ID giai đoạn của deal

  • value: Giá trị của deal

  • probability: Tỷ lệ thành công của deal

  • last_deal_stage_id: ID giai đoạn cuối trước khi đóng của deal

  • lost_reasons: Lý do mất của deal

  • order_address_detail: Chi tiết địa chỉ giao hàng

  • order_buyer_note: Ghi chú của người mua

  • order_city_id: ID City (Theo danh sách thành phố)

  • order_district_id: ID quận huyện (Theo danh sách quận huyện)

  • order_ward_id: ID phường xã (Theo danh sách phường xã )

  • order_receiver_name: Tên người nhận

  • order_receiver_phone: Số điện thoại người nhận đơn

  • order_shipping_fee: Giá cước vận chuyển

  • order_payment: Phương thức thanh toán

  • order_status: Trạng thái đặt hàng, ORDER_STARTED

  • order_tracking_code: Mã vận chuyển

  • order_tracking_url: Đường dẫn tra cứu vận chuyển của nhà cung cấp dịch vụ

  • order_products: [...]. Mảng sản phẩm đặt mua

    • name:Tên sản phẩm

    • sku: SKU sản phẩm,

    • is_free: Là sản phẩm tặng kèm (1) hoặc bình thường (0)

    • unit_price: Đơn giá

    • quantity: Số lượng

    • discount_markup:Giảm giá bằng %

    • discount_value: Giảm giá bằng tiền

    • total_amount: Tổng tiền của sản phẩm

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Response

4. Danh sách deals

GET /{domain}/api/v1/deals

Danh sách deal đang có trên hệ thống

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

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

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 <token>

Response

5.2 Lý do không đạt

GET/{domain}/api/v1/deal/unqualified-reasons

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Response

5.3 Lý do mất đơn

POST /{domain}/api/v1/deal/lost-reasons

<Description of the endpoint>

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

name

string

Name of the user

age

number

Age of the user

Response

5.4 Deal labels

GET /{domain}/api/v1/deal/labels

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

name

string

Name of the user

age

number

Age of the user

Response

PreviousLeadNextKhách hàng

Last updated