Chuyển đến nội dung chính

Documentation Index

Fetch the complete documentation index at: https://docs.sellfern.com/llms.txt

Use this file to discover all available pages before exploring further.

API Sellfern cho phép bạn tự động hóa quy trình, xây dựng tích hợp và truy vấn dữ liệu kinh doanh theo chương trình bằng các yêu cầu HTTP và JSON tiêu chuẩn. Bạn có thể liệt kê và cập nhật đơn hàng, lấy tóm tắt doanh thu và lợi nhuận, quản lý hàng đợi hoàn tất đơn và đăng ký các điểm cuối webhook — tất cả từ các script, agent hoặc nền tảng bên thứ ba.

​
URL cơ sở

Tất cả các yêu cầu API được thực hiện đến URL cơ sở sau: 
https://api.sellfern.com

​
Bắt đầu nhanh

Tạo một token API trong Settings → API Tokens, sau đó thực hiện yêu cầu đầu tiên của bạn: 
curl -X GET "https://api.sellfern.com/api/v2/analytics/summary?period=last_7_days" \
  -H "Authorization: Bearer sk_live_YOUR_TOKEN_HERE"
Phản hồi mong đợi: 
{
  "success": true,
  "data": {
    "period": "last_7_days",
    "start_date": "2026-04-19",
    "end_date": "2026-04-26",
    "revenue": 12450.00,
    "order_count": 87,
    "cogs": 6225.00,
    "gross_profit": 6225.00,
    "margin_pct": 50.0
  },
  "meta": { "request_id": "req_abc123" }
}

​
Phiên bản API

Tất cả các điểm cuối được tài liệu hóa ở đây được phiên bản hóa dưới /api/v2/. Tiền tố phiên bản xuất hiện trong mọi đường dẫn: 
https://api.sellfern.com/api/v2/orders
https://api.sellfern.com/api/v2/analytics/summary
https://api.sellfern.com/api/v2/fulfillment/queue
https://api.sellfern.com/api/v2/webhooks

​
Định dạng yêu cầu

  • GET requests — truyền bộ lọc và tùy chọn dưới dạng tham số chuỗi truy vấn.
  • POST and PATCH requests — gửi body JSON và bao gồm tiêu đề Content-Type: application/json.
  • Idempotency — các điểm cuối ghi (POST, PATCH) chấp nhận tiêu đề Idempotency-Key tùy chọn. Gửi cùng khóa khi thử lại để ngăn các thao tác trùng lặp.

​
Định dạng phản hồi

Mọi phản hồi đều bao gồm boolean success. Phản hồi thành công gói kết quả trong trường data. Phản hồi lỗi bao gồm đối tượng error với code và message. 
{
  "success": true,
  "data": { ... },
  "meta": { "request_id": "req_abc123" }
}
Hình dạng lỗi: 
{
  "success": false,
  "error": {
    "code": "missing_scope",
    "message": "Token lacks the required scope for this endpoint."
  }
}

​
Giới hạn tốc độ

Tất cả các yêu cầu API đều tuân theo giới hạn tốc độ được thực thi theo từng token. Khi bạn vượt quá giới hạn, API trả về 429 Too Many Requests. Hãy chậm lại và thử lại sau một khoảng tạm dừng ngắn. Bạn cũng có thể đặt dailyQuota khi tạo token để giới hạn khối lượng cuộc gọi hàng ngày của nó.

​
Đặc tả OpenAPI

Đặc tả OpenAPI có thể đọc được bằng máy có sẵn tại: 
GET https://api.sellfern.com/api/openapi.json
Bạn cũng có thể duyệt nó tương tác tại /api-docs.

​
Tài nguyên

Đơn hàng

Liệt kê, lọc và cập nhật đơn hàng. Thực hiện cập nhật trạng thái hàng loạt và thêm ghi chú.

Phân tích

Truy vấn tóm tắt doanh thu, COGS, lợi nhuận gộp và biên theo kỳ hoặc cửa hàng.

Hoàn tất đơn

Lấy hàng đợi hoàn tất đơn và gán nhà cung cấp cho đơn hàng.

Webhook

Đăng ký và quản lý các điểm cuối webhook để nhận thông báo sự kiện theo thời gian thực.
Mỗi token API được giới hạn vào các khả năng cụ thể. Một token không có phạm vi yêu cầu trả về 403 missing_scope. Xem trang Xác thực và Phạm vi để biết chi tiết về tạo token và chọn đúng phạm vi.