Get My Deals List.

# 1. Tổng quan

  • Action URL: /api/v1/deals/my-deals
  • Đặc tả chi tiết: Swagger Link (opens new window)
  • Tính năng này cho phép lấy danh sách Opportunity (Deal) thuộc portal/tài khoản hiện tại của Agency.
  • Chỉ áp dụng cho tài khoản Agency có quyền truy cập hợp lệ

# 2. Hướng dẫn

  • Bước 1: Xây dựng request với đầy đủ header và body
  • Bước 2: Gửi request POST tới Action URL.
  • Bước 3: Nhận về response chứa danh sách Opportunity.

# 3. Request

# 3.1 Ví dụ

{
  "maxSize": 20,
  "offset": 0,
  "orderBy": "createdAt",
  "order": "desc"
}

# 3.2 Cấu trúc dữ liệu Resquest

Thuộc tính Bắt buộc Kiểu dữ liệu Mô tả Ví dụ
maxSize Có Number Giới hạn số bản ghi trả về 5
offset Có Number Vị trí bắt đầu lấy dữ liệu( phân trang) 0
orderBy Có Number Trường để sắp xếp kết quả createdAt
order Không String Thứ tự sắp xếp desc

# 4. Response

# 4.1 Ví dụ

{
  "StatusCode": 200,
  "Timestamp": "9:05:04 AM",
  "Path": "/api/v1/deals/my-deals",
  "Message": "Lấy danh sách deal thành công",
  "Data": {
    "total": 1,
    "list": [
      {
        "id": "68f1e27c4d3741aef",
        "name": "Assign Sub - Test 02",
        "amount": 10,
        "stage": "Presented",
        "createdAt": "2025-10-17 06:30:20",
        "serviceBooking": "OTHER",
        "bookingCode": null,
        "amountCurrency": "VND",
        "accountId": "68f1e125b22108c62",
        "accountName": "#AG.56997.Test_17",
        "contactsIds": [],
        "contactsNames": {},
        "contactsColumns": {},
        "contactId": null,
        "createdById": "67b0376d4e804731f",
        "assignedUserId": null,
        "assignedUserName": null
      }
    ]
  },
  "Errors": null,
  "RequestId": "req_1761296703437_s96vi104d",
  "TotalDuration": 678
}

# 4.2 Bảng mô tả trường (Response)

Thuộc tính Bắt buộc Kiểu dữ liệu Mô tả Ví dụ
StatusCode Có String Tình trạng tạo sub
Timestamp Có String Thời gian xử lý request
Path Có String
Message Có String Thông báo kết quả
Errors Không String Thông tin lỗi nếu có
RequestId Có String Mã định danh request
TotalDuration Không string Thời gian xử lý (ms)
Data Có object Đối tượng chứa dữ liệu chính của phản hồi.
total Có integer Tổng số deal được tìm thấy.
list Có array Danh sách các deal. Mỗi phần tử trong mảng là một đối tượng deal.
id Có string Mã định danh (ID) duy nhất của deal.
name Có string Tên của deal
amount Có number Giá trị tiền của deal.
stage Có string Trạng thái hoặc giai đoạn hiện tại của deal
createdAt string (datetime) Thời gian tạo deal, định dạng "YYYY-MM-DD HH:mm:ss".
serviceBooking Có string Loại dịch vụ gắn với deal (ví dụ: "OTHER", "FLIGHT", "HOTEL"...).
bookingCode Không String Mã đặt chỗ liên kết với deal (nếu có).
amountCurrency Có string Loại tiền tệ của giá trị deal (ví dụ: "VND", "USD"...).
accountId Có string ID của tài khoản (account) liên quan đến deal.
accountName Có string Tên tài khoản liên quan
contactsIds Không array Danh sách ID của các liên hệ liên quan đến deal.
contactsNames Không object Danh sách tên các liên hệ (nếu có).
contactsColumns Không object Các cột dữ liệu liên hệ tương ứng (nếu có).
contactId Không string ID của liên hệ chính (nếu có).
createdById Có string ID của người tạo deal.
assignedUserId Không string ID của người được giao phụ trách deal (nếu có).
assignedUserName Không string Tên người được giao phụ trách deal (nếu có).

# Bảng mô tả mã tình trạng tạo sub

Mã Ý nghĩa
200 Thành công
400 Dữ liệu không hợp lệ
401 Không có quyền tạo sub
404 DealId không tồn tại trong hệ thống
500 Lỗi từ phía server

This site uses cookies to learn which topics interest our readers.