Sau khi thêm tài khoản affiliate (cookie) vào hệ thống tại
Tài khoản Shopee và bật đồng bộ, dữ liệu
đơn hàng / chuyển đổi và click được lưu sẵn và truy xuất qua một REST API duy nhất.
Lấy API Key tại trang Chuyển đổi.
Giới hạn 60 request / phút / key.
Xác thực
| Cách |
Mô tả |
Ví dụ |
| Header |
Gửi key qua header X-API-Key (khuyến nghị) |
X-API-Key: <48 ký tự hex> |
| api_key |
Hoặc truyền qua query/POST api_key |
?api_key=<48 ký tự hex> |
Tham số truy vấn
| Trường |
Bắt buộc |
Mô tả |
Ví dụ |
| type |
Không |
orders (mặc định) · items (chi tiết từng sản phẩm) · clicks |
items |
| source |
Không |
shopee (mặc định) hoặc food (đơn ShopeeFood) |
food |
| account_id |
Không |
Giới hạn theo 1 tài khoản; bỏ trống = tất cả tài khoản của bạn |
3 |
| from / to |
Không |
Khoảng thời gian; định dạng YYYY-MM-DD hoặc unix timestamp |
2026-05-01 |
| status |
Không |
Lọc theo trạng thái chuyển đổi (tuỳ chọn) |
1 |
| page / page_size |
Không |
Phân trang (page_size mặc định 50) |
1 / 50 |
| format |
Không |
json (mặc định) hoặc csv (tải file) |
csv |
Cấu trúc phản hồi (JSON)
| Trường |
Kiểu |
Mô tả |
| ok | boolean | Thành công hay không |
| meta | object | type, page, page_size, total |
| summary | object | orders, clicks, gmv, gross_commission, estimated_total_commission, conversion_rate |
| data | array | Danh sách bản ghi theo type (xem dưới) |
Báo cáo chuyển đổi — type=orders / type=items
orders trả mỗi checkout 1 dòng; items tách chi tiết từng sản phẩm trong đơn (kèm ảnh, tên, giá, hoa hồng, phí MCN).
| Trường (items) | Kiểu | Mô tả |
|---|
| purchase_time / click_time | unix | Thời điểm mua / click |
| item_name / image / item_url | string | Tên, ảnh, link sản phẩm |
| price / qty / order_value | number | Giá, số lượng, giá trị đơn (VNĐ) |
| commission | number | Hoa hồng (VNĐ) |
| mcn_fee | number | Phí MCN của dòng (VNĐ) |
| utm / sub_id1 | string | UTM / Sub ID |
Báo cáo click — type=clicks
| Trường | Kiểu | Mô tả |
|---|
| click_id | string | ID click |
| click_time | unix | Thời điểm click |
| click_region | string | Vùng |
| sub_id | string | Sub ID |
| direct_source / last_external_source | string | Nguồn click |
Ví dụ
# Báo cáo chuyển đổi (chi tiết sản phẩm) tháng này
curl 'https://addlivetag.com/api/v1/conversions.php?type=items&from=2026-05-01&to=2026-05-31' \
-H 'X-API-Key: <API_KEY>'
# Đơn ShopeeFood của 1 tài khoản
curl 'https://addlivetag.com/api/v1/conversions.php?type=orders&source=food&account_id=3' \
-H 'X-API-Key: <API_KEY>'
# Báo cáo click, xuất CSV
curl 'https://addlivetag.com/api/v1/conversions.php?type=clicks&format=csv' \
-H 'X-API-Key: <API_KEY>' -o clicks.csv