Bắt đầu nhanh với Accplanet Supplier API: Sản phẩm, Đơn hàng và Cập nhật Giao hàng
Accplanet Supplier API quick start
Authenticate with X-API-Key, manage products, list orders, and update delivery through the Supplier REST API.
-
Create an API key
Generate a supplier API key in Profile → API key and send it as the X-API-Key header.
-
Create or update products
Use /products/api/supplier/create/ and /products/api/supplier/products/{id}/update/ with JSON bodies from the live docs.
-
Fulfill orders
List /orders/api/supplier/orders/ and POST delivered updates for each order id. Cache GETs and back off on 429.
Nếu bạn bán hàng trên Accplanet và muốn tự động hóa, Accplanet Supplier API là một bề mặt REST cho sản phẩm, đơn hàng và cập nhật giao hàng. Hướng dẫn nhanh này dẫn dắt người bán từ thiết lập API key đến tạo / cập nhật / xóa sản phẩm, liệt kê đơn hàng và đánh dấu giao hàng — mà không thay thế toàn bộ tài liệu Supplier API.
Accplanet là sàn thương mại điện tử; tài khoản nhà cung cấp của bạn sở hữu các listing và việc thực hiện đơn hàng. Các script xác thực bằng API key trong header X-API-Key.
Tóm tắt nhanh
- Tạo API key trong hồ sơ Accplanet của bạn; gửi nó dưới dạng
X-API-Keytrong mọi lệnh gọi Supplier. - Vòng lặp sản phẩm: tạo → liệt kê/cập nhật các trường tồn kho → xóa khi ngừng một SKU.
- Vòng lặp đơn hàng: liệt kê đơn hàng nhà cung cấp → cập nhật thông tin đã giao → thay đổi trạng thái khi quy trình của bạn yêu cầu.
- Ưu tiên các đường dẫn không có tiền tố như
/products/api/supplier/…cho POST (tránh việc chuyển hướng ngôn ngữ biến POST thành GET). - Cache các lệnh đọc; tôn trọng HTTP 429 và
Retry-After.
Lấy API key của bạn
Đăng nhập bằng tài khoản có quyền nhà cung cấp, mở Hồ sơ → API key và tạo một API key. Đối với tích hợp người bán Accplanet, mọi yêu cầu nên trông như sau:
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Lưu trữ key trong một kho bí mật. Xoay vòng nó nếu một laptop hoặc log CI từng in nó ra.
Nguyên tắc thiết kế API cho đồng bộ người bán
Các endpoint Supplier tuân theo các nguyên tắc thiết kế API phổ biến giúp việc đồng bộ ERP hoặc kho hàng có thể dự đoán được:
- URL tài nguyên: sản phẩm và đơn hàng là các tài nguyên REST riêng biệt thay vì một endpoint hành động khổng lồ.
- Xác thực qua header:
X-API-Keygiữ thông tin xác thực ngoài chuỗi truy vấn trong log truy cập. - JSON vào / JSON ra: nội dung tạo và cập nhật có cấu trúc; tải lên dùng
multipart/form-data. - Thói quen idempotent: cập nhật theo id sản phẩm; sử dụng cờ hợp nhất giao hàng cẩn thận để không xóa các dòng giao hàng trước đó.
Sản phẩm: tạo, cập nhật, xóa
1 · Tạo
API tạo sản phẩm
POST đến API tạo sản phẩm của nhà cung cấp. Tên trường và id danh mục bắt buộc được ghi trong tài liệu trực tiếp — hãy bắt đầu từ trình thử nghiệm tài liệu sau khi bạn có thể xác thực.
curl -X POST https://accplanet.com/products/api/supplier/create/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d "{\"title\":\"Example listing\",\"price\":\"9.99\",\"category_id\":\"CATEGORY_ID\"}"
Thay thế JSON bằng payload đầy đủ từ tài liệu Supplier API. Coi mẫu trên như một gợi ý về hình dạng, không phải một schema hoàn chỉnh.
2 · Liệt kê / cập nhật
Liệt kê sản phẩm và cập nhật theo id
curl -X GET https://accplanet.com/products/api/supplier/products/ \
-H "X-API-Key: YOUR_API_KEY"
curl -X POST https://accplanet.com/products/api/supplier/products/PRODUCT_ID/update/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d "{\"price\":\"8.50\"}"
Sử dụng cập nhật cho giá, các trường liên quan đến tồn kho và thay đổi mô tả mà cửa hàng của bạn đã hỗ trợ. Ưu tiên cập nhật id sản phẩm hiện có hơn là tạo bản trùng lặp.
3 · Xóa
Ngừng một listing
curl -X POST https://accplanet.com/products/api/supplier/products/PRODUCT_ID/delete/ \
-H "X-API-Key: YOUR_API_KEY"
Xác nhận trong trang quản trị hoặc một lệnh gọi liệt kê tiếp theo rằng sản phẩm đã biến mất hoặc không hoạt động theo định nghĩa quy tắc tài khoản của bạn.
Đơn hàng và cập nhật giao hàng
Liệt kê đơn hàng
GET /orders/api/supplier/orders/ cho API đơn hàng nhà cung cấp. Lọc theo trạng thái trong công việc đồng bộ của bạn; không thăm dò nhanh hơn một lần mỗi phút cho mỗi key.
Cập nhật giao hàng
POST /orders/api/supplier/orders/{order_id}/delivered/ để đẩy các dòng tài khoản đã giao. Khi hợp nhất, hãy làm theo tài liệu cho append_delivered_info để bạn không vô tình thay thế các hàng trước đó.
Trạng thái / hoàn tiền
Các endpoint trạng thái và hoàn tiền chuyên dụng tồn tại trong cùng cây đơn hàng nhà cung cấp. Chỉ kết nối chúng sau khi cập nhật giao hàng đã ổn định.
curl -X GET "https://accplanet.com/orders/api/supplier/orders/" \
-H "X-API-Key: YOUR_API_KEY"
curl -X POST https://accplanet.com/orders/api/supplier/orders/ORDER_ID/delivered/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d "{\"delivered_info\":\"[\\\"line1\\\",\\\"line2\\\"]\",\"append_delivered_info\":true}"
Xác thực payload đã giao chính xác dựa trên tài liệu trực tiếp — định dạng giao hàng khác nhau tùy theo loại sản phẩm.