商品使用说明书接口

提供查询产品使用说明书的能力，支持根据指定时间范围筛选结果，返回说明书链接及最新更新时间。

适用场景

获取通用或特定产品的使用说明书，如多语言版本的产品使用指南等

接口类型

GET

请求频率限制

默认频率：以平台配额为准

请求说明

请求URL

正式环境：https://www.westmonth.com/openapi/sku_instruction/query
测试环境：https://testing.westmonth.com/openapi/sku_instruction/query

请求参数

Header参数

参数名	类型	必填	示例值	说明
Authorization	string	是	authorization	身份验证Token
Content-Type	string	是	application/json	建议固定传此值

Query参数

参数名	类型	必填	格式示例	说明
start_time	string	否	`2024-12-17 18:24:47`	更新开始时间，格式为YYYY-MM-DD HH:MM:SS，不填则默认查询所有历史数据
end_time	string	否	`2026-12-17 18:24:47`	更新结束时间，格式同上，不填则默认查询到当前时间

响应字段说明

成功响应（HTTP 200）

根字段

字段	类型	说明
code	integer	业务状态码（0=成功，1=服务错误，2=参数错误，3=授权无效，4=请求上限）
msg	string	错误描述（成功时为空）
data	array	业务数据数组，包含符合条件的产品使用说明书信息

data数组字段

字段	类型	说明
url	string	产品使用说明书链接，指向说明书文件（如PDF格式）
latest_time	string	说明书的最新更新时间，格式为YYYY-MM-DD HH:MM:SS

调用示例

URL请求

请求示例

成功返回示例

{
    "code": 0,
    "msg": "",
    "data": [
        {
            "url": "https://oss.westmonth.com/westmonth/SKUDatum/sku_instruction/通用产品使用说明书（英德法意西日韩捷瑞波荷葡）.pdf",
            "latest_time": "2025-05-09 17:03:35"
        }
    ]
}

失败返回示例

{
    "code": 3,
    "msg": "授权无效 authorization timestamp error",
    "data": []
}

错误处理

公共错误码

HTTP status code	错误码	错误信息	描述

常见问题

Q1：接口返回的是通用说明书还是特定SKU的说明书？

A：通用产品使用说明书认。

Q2：说明书支持哪些语言版本？

A：具体语言版本以返回的说明书内容为准，可通过链接下载查看详细信息。

Q3：若未指定时间范围，会返回什么结果？

A：未指定start_time和end_time时，默认返回所有历史的产品使用说明书数据。

版本历史

版本	日期	修改说明
v1.0	2025-01-01	初始版本

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
    "code": 0,
    "msg": "",
    "data": [
        {
            "url": "https://westmonth/SKUDatum/sku_instruction/通用产品使用说明书（英德法意西日）10X10.pdf",
            "latest_time": "2024-10-23 17:19:58"
        }
    ]
}

商品使用说明书

商品使用说明书接口#

适用场景#

接口类型#

请求频率限制#

请求说明#

请求参数#

Header参数#

Query参数#

响应字段说明#

调用示例#

URL请求#

请求示例#

成功返回示例#

失败返回示例#

错误处理#

常见问题#

Q1：接口返回的是通用说明书还是特定SKU的说明书？#

Q2：说明书支持哪些语言版本？#

Q3：若未指定时间范围，会返回什么结果？#

版本历史#

请求参数

请求示例代码

返回响应

商品使用说明书接口

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Query参数

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

常见问题

Q1：接口返回的是通用说明书还是特定SKU的说明书？

Q2：说明书支持哪些语言版本？

Q3：若未指定时间范围，会返回什么结果？

版本历史