Accplanet Supplier API 快速入门:产品、订单和配送更新
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.
如果你在 Accplanet 上销售并希望实现自动化,Accplanet Supplier API 是一个用于产品、订单和配送更新的 REST 接口。本快速入门将引导卖家从 API 密钥设置到创建 / 更新 / 删除产品、列出订单以及标记配送——同时不会取代完整的Supplier API 文档。
Accplanet 是市场平台;你的供应商账户拥有商品列表和履约。脚本通过 X-API-Key 请求头中的 API 密钥进行身份验证。
简而言之
- 在你的 Accplanet 个人资料中生成 API 密钥;在每次 Supplier 调用时将其作为
X-API-Key发送。 - 产品循环:创建 → 列出/更新库存字段 → 在停用 SKU 时删除。
- 订单循环:列出供应商订单 → 更新配送信息 → 在你的流程需要时更改状态。
- POST 请求优先使用无前缀路径,如
/products/api/supplier/…(避免语言重定向将 POST 变为 GET)。 - 缓存读取;遵守 HTTP 429 和
Retry-After。
获取你的 API 密钥
以具备供应商权限的账户登录,打开个人资料 → API 密钥,并生成一个 API 密钥。对于 Accplanet 卖家集成,每个请求应如下所示:
X-API-Key: YOUR_API_KEY
Content-Type: application/json
将密钥存储在密钥管理系统中。如果笔记本电脑或 CI 日志曾打印过它,请轮换密钥。
面向卖家同步的 API 设计原则
Supplier 端点遵循通用的 API 设计原则,使 ERP 或仓库同步保持可预测:
- 资源 URL:产品和订单是独立的 REST 资源,而不是一个超级操作端点。
- 请求头认证:
X-API-Key可避免凭据出现在访问日志的查询字符串中。 - JSON 输入 / JSON 输出:创建和更新请求体是结构化的;上传使用
multipart/form-data。 - 幂等习惯:按产品 id 更新;谨慎使用配送合并标志,以免清除先前的配送行。
产品:创建、更新、删除
1 · 创建
创建产品 API
向供应商创建产品 API 发送 POST 请求。字段名称和必需的分类 id 以在线文档为准——在你能够通过身份验证后,从文档测试器开始。
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\"}"
将 JSON 替换为Supplier API 文档中的完整负载。将上面的示例视为结构提醒,而非完整架构。
2 · 列出 / 更新
列出产品并按 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\"}"
使用更新来修改价格、库存相关字段以及你的店铺已支持的描述更改。优先更新现有产品 id,而不是创建重复项。
3 · 删除
停用商品列表
curl -X POST https://accplanet.com/products/api/supplier/products/PRODUCT_ID/delete/ \
-H "X-API-Key: YOUR_API_KEY"
在管理后台或后续列表调用中确认该产品已按你的账户规则被删除或停用。
订单和配送更新
列出订单
使用 GET /orders/api/supplier/orders/ 访问供应商订单 API。在同步任务中按状态筛选;每个密钥的轮询频率不要超过每分钟一次。
更新配送
使用 POST /orders/api/supplier/orders/{order_id}/delivered/ 推送已配送的账户行。合并时,请遵循文档中关于 append_delivered_info 的说明,以免误替换先前的行。
状态 / 退款
专用的状态和退款端点位于同一供应商订单树下。仅在配送更新稳定后再接入它们。
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}"
请根据在线文档验证确切的配送负载——配送格式因产品类型而异。
上传产品图片
使用上传产品图片 API,并采用 multipart 表单数据:
curl -X POST https://accplanet.com/products/api/supplier/upload-image/ \
-H "X-API-Key: YOUR_API_KEY" \
-F "image=@./cover.webp"
当你的架构需要图片路径时,在创建/更新负载中复用返回的 URL。
速率限制
Supplier REST 的读取、写入和上传各自有独立的每分钟预算(对于简单轮询器来说,读取通常是最紧张的)。对于 Accplanet 卖家集成:
- 缓存 GET 产品和订单列表。
- 批量刷新 UI,而不是每次点击都调用列表。
- 遇到 429 时,在重试上传或写入之前遵守
Retry-After。
供应商检查清单
- API 密钥放在
X-API-Key中;密钥未被提交到代码库。 - 在沙盒 SKU 上测试了创建 → 更新 → 删除产品路径。
- 使用真实或预发布订单 id 验证了订单列表 + 配送更新。
- 在批量导入任务之前,图片上传可正常工作。
- 已实现 429 退避。
常见问题
为什么我的 POST 变成了 GET / 405?
带语言前缀的 URL 可能会重定向。写入调用优先使用无前缀的 /products/api/supplier/… 和 /orders/api/supplier/…。
Customer API 与 Supplier API 有什么区别?
买家/经销商使用 Customer API(POST /api/v2)。卖家使用此 Supplier REST API。
完整的字段列表在哪里?
始终以交互式文档为准:https://accplanet.com/en/api-docs/supplier/。