Version: v202201

OpenAPI

Shoplazza 2022-01 OpenAPI 允许应用读写 Shoplazza 店铺数据。本页介绍该版本的请求模型、身份验证、速率限制和 HTTP 状态响应。

身份验证每个请求都需要携带有效的应用访问令牌。速率限制按平台限制设计调用频率和重试策略。状态和错误代码处理 2022-01 中更完整的 HTTP 状态码集合。

身份验证

所有 OpenAPI 请求都需要身份验证。请在 access-token 请求头中传入应用访问令牌。

字段	值
Security scheme type	apiKey
Header parameter name	access-token

速率限制

Shoplazza API 会进行限流，以保护平台稳定性。如果请求过于频繁，请降低调用频率、将任务放入队列、缓存重复读取结果，并在短暂延迟后重试。

状态和错误代码

下表概述了调用 2022-01 Shoplazza API 时常见的 HTTP 状态码及其含义。

状态码	说明
200 OK	请求已由 Shoplazza 成功处理。
400 Bad Request	服务器无法理解请求，通常是语法错误，或 Content-Type 请求头未设置为 application/json。当认证凭据缺失或无效，或请求入参格式、结构不正确时，也可能返回该状态码。
401 Unauthorized	请求中缺少必要的认证凭据，或认证凭据不正确。
403 Forbidden	服务器拒绝响应该请求。通常表示应用未申请执行该操作所需的 scope。
404 Not Found	请求的资源不存在。
405 Method Not Allowed	服务器识别该请求，但拒绝当前 HTTP 方法。
406 Not Acceptable	服务器无法生成符合客户端请求的响应，例如对非售后状态的订单执行退款。
422 Unprocessable Entity	请求参数格式不正确。常见原因包括参数类型错误、时间格式错误、参数值无效，或少数情况下服务端内部问题。
429 Too Many Requests	应用超过 API 速率限制，请求未被接受。请降低请求频率并查看速率限制说明。
500 Internal Server Error	Shoplazza 内部发生错误。请简化或重试请求；如果问题持续存在，请记录错误码和时间戳并联系 Partner Support。