API 文档易客 / 亿乐
网站首页
公共说明

API 接入文档

易客客户端、易客供应商端与亿乐供应商接口。左侧按系统和用途查阅,接口页包含请求参数、响应字段及调用示例。

服务地址

TEXT
https://www.yikesup.com

此地址为本次验证使用的 API 服务域名。文档发布网站与 API 服务可以使用不同域名。

接口分组

系统用途接口前缀
易客 API · 客户端商品查询、下单、退款申请、账户信息/api/client/
易客 API · 供应商端商品管理、订单处理、进度更新、回调/api/supplier/
亿乐 API · 供应商亿乐格式的商品和订单管理/openapi/supplier/

开始调用

  1. 在对应账户后台取得 AppId 与 AppSecret。
  2. 按照签名认证计算请求头。
  3. 使用Python 示例调用商品列表,确认业务状态码。
  4. 从列表取得有效编号,再查询详情或处理业务。

两套协议的区别

项目易客 API亿乐 API
成功码code = 100code = 0(已验证查询接口)
提示字段msgmessage
业务数据resultdata
分页列表result.datadata.infos
分页总数result.totaldata.count
常见订单标识orderSNid
订单状态字段statestatus / old_status / new_status

本次验证范围

2026-09-17 已验证 8 个商品、订单查询接口的成功响应。客户端 5 个查询接口返回认证失败;下单、退款、状态修改、商品修改与推送回调未执行。

实测结果仅适用于当前服务与本次样本。原文与实测不一致的字段在接口页分别展示,详见差异记录

公共说明

签名认证

本次易客供应商与亿乐查询均使用以下签名方式成功。客户端应使用对应会员凭据。

必需请求头

请求头必填取值
AppId当前接口所属账户的 AppId
AppTokenSHA1 签名,见签名认证
AppTimestamp本次签名使用的 Unix 秒级时间戳

计算规则

TEXT
AppToken = SHA1(AppId + AppSecret + requestURI + AppTimestamp)
  1. 使用当前 Unix 秒级时间戳,转为字符串。
  2. 将请求路径与最终 QueryString 拼成 requestURI,不包含协议、域名和 URL 片段。
  3. 按上述顺序直接连接,不添加分隔符,使用 UTF-8 编码后计算 SHA1 小写十六进制字符串。
  4. 签名和请求头必须使用同一个 AppTimestamp;签名后不再改变查询串。
PYTHON
requestURI = "/api/supplier/goods/v2/goods/list?limit=1&page=1"
# 签名使用这一完整字符串;实际请求也发送完全相同的路径与查询串。

Header 名称不区分大小写,Appid / AppId 等效。POST 的 JSON 正文不在原文签名公式内;已验证的亿乐 POST 查询按此方式通过。

时间与查询串

情况处理方式
秒与毫秒使用 int(time.time());不要直接使用毫秒时间戳。
中文、空格、特殊符号先生成最终 URL 编码后的查询串,再使用同一查询串签名和发送。
参数顺序避免签名后重新排序参数。
网络重试每次重新生成时间戳和签名;写入接口不得因超时直接盲目重试。
服务端时钟保持系统时间准确;允许的时间偏差窗口未提供。

推送回调验签

回调使用后台配置的完整 URL,包含协议和域名。使用请求头里的时间戳与账户密钥计算期望签名。

PYTHON
import hashlib
import hmac

expected = hashlib.sha1(
    (app_id + app_secret + configured_callback_url + header_timestamp).encode("utf-8")
).hexdigest()
valid = hmac.compare_digest(expected, header_token)

回调 URL 的 QueryString 如有配置,也需按原文完整 URL 规则参与计算。回调重放时限、成功应答正文与重试间隔原文未定义,需与平台约定。

AppSecret 只在调用方服务端保存,不发送给 API,也不放入公开网页。

公共说明

Python 调用示例

Python 3 标准库实现,无第三方依赖。函数支持易客与亿乐协议,自动生成签名,并分别检查 HTTP 与业务错误。

设置凭据

以下为 PowerShell 示例。填入自己的凭据,在同一终端运行 Python 文件。

POWERSHELL
$env:API_APP_ID = "YOUR_APP_ID"
$env:API_APP_SECRET = "YOUR_APP_SECRET"
python api_client.py

本示例已验证易客 GET 与亿乐 POST 查询。保留显式 User-Agent;本次默认 Python 请求头曾收到 HTTP 403。

公共调用函数

api_client.py
"""Python 3 standard library. Set API_APP_ID and API_APP_SECRET before use."""
import hashlib
import json
import os
import time
from urllib.parse import urlencode
from urllib.request import Request, build_opener, HTTPRedirectHandler
from urllib.error import HTTPError

BASE_URL = "https://www.yikesup.com"

class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None

class APIError(RuntimeError):
    pass

def request_api(path, *, method="GET", query=None, body=None, family="yike"):
    """Returns the entire response. family is 'yike' or 'yile'."""
    if family not in ("yike", "yile"):
        raise ValueError("family must be yike or yile")
    if not path.startswith("/") or path.startswith("//") or "?" in path or "#" in path:
        raise ValueError("Use an absolute API path and pass query separately")
    app_id = os.environ["API_APP_ID"]
    app_secret = os.environ["API_APP_SECRET"]
    # Generate the query string once; sign and send exactly the same URI.
    query_string = urlencode(query or {}, doseq=True)
    uri = path + ("?" + query_string if query_string else "")
    url = BASE_URL.rstrip("/") + uri
    timestamp = str(int(time.time()))  # Unix seconds, not milliseconds
    token = hashlib.sha1(
        (app_id + app_secret + uri + timestamp).encode("utf-8")
    ).hexdigest()
    headers = {
        "AppId": app_id,
        "AppToken": token,
        "AppTimestamp": timestamp,
        "Accept": "application/json",
        "User-Agent": "API-Documentation-Verification/1.0",
    }
    payload = None
    if body is not None:
        headers["Content-Type"] = "application/json"
        payload = json.dumps(body, ensure_ascii=False).encode("utf-8")
    req = Request(url, data=payload, headers=headers, method=method)
    try:
        with build_opener(NoRedirect).open(req, timeout=20) as response:
            raw = response.read()
    except HTTPError as exc:
        raise APIError(f"HTTP {exc.code}; check the service response") from exc
    try:
        response_data = json.loads(raw)
    except (ValueError, UnicodeDecodeError) as exc:
        raise APIError("The server did not return JSON") from exc
    expected_code = 100 if family == "yike" else 0
    if not isinstance(response_data, dict):
        raise APIError("Unexpected response structure")
    if response_data.get("code") != expected_code:
        message = response_data.get("msg", response_data.get("message", ""))
        raise APIError(f"API {response_data.get('code')}: {message}")
    return response_data

if __name__ == "__main__":
    # Read-only example: Yike supplier goods, one row per page.
    response = request_api(
        "/api/supplier/goods/v2/goods/list",
        query={"limit": 1, "page": 1},
    )
    print(json.dumps(response, ensure_ascii=False, indent=2))

亿乐查询示例

PYTHON
response = request_api(
    "/openapi/supplier/Goods/Paging",
    method="POST",
    body={"page": 1, "list_rows": 1, "id": None, "status": 1, "goods_category_id": None},
    family="yile",
)
items = response["data"]["infos"]
print(items)

cURL 请求结构

先按签名规则计算 APP_TOKEN;APP_TIMESTAMP 必须与该次签名一致。

BASH
curl --request GET \
  "https://www.yikesup.com/api/supplier/goods/v2/goods/list?limit=1&page=1" \
  --header "AppId: YOUR_APP_ID" \
  --header "AppToken: CALCULATED_APP_TOKEN" \
  --header "AppTimestamp: SAME_TIMESTAMP_USED_IN_SIGNATURE"
公共说明

响应与错误处理

业务状态码

系统code含义与依据
易客100成功;供应商查询已验证。
易客403认证失败;客户端查询已验证,HTTP 仍为 200。
易客900错误;原文定义,未验证具体触发条件。
亿乐0本次查询接口成功状态。
亿乐1本次无效商品 id 查询返回“商品无效”;不能推断为全部错误的统一枚举。

建议检查顺序

  1. 检查 HTTP 状态和响应是否为 JSON。
  2. 按接口系列检查 code,读取 msg 或 message。
  3. 检查业务对象的编号和关键字段,不能把空记录当作有效订单。
  4. 按实际类型处理数组、JSON 字符串和 null。

字段类型兼容

PYTHON
import json
from decimal import Decimal

def as_list(value):
    if value is None or value == "":
        return []
    parsed = json.loads(value) if isinstance(value, str) else value
    if not isinstance(parsed, list):
        raise TypeError("expected a list or JSON-encoded list")
    return parsed

# 仅对确实是 JSON 文本的字段解析一次。
params = as_list(order.get("params"))
logs = as_list(order.get("logs"))
# 金额如需计算,用 Decimal 保留十进制精度。
price = Decimal(str(order["price"]))

常见问题

现象排查
HTTP 200 但调用失败检查业务 code。易客成功 100,亿乐成功 0。
AppId 没找到核对服务域名、AppId 所属账户及客户端 / 供应商接口范围。
认证失败检查 AppSecret、秒级时间戳、拼接顺序、最终 QueryString。
HTTP 403(非业务 code)本次 Python 默认 User-Agent 曾收到 HTTP 403;显式设置示例中的 User-Agent 后成功。检查请求头及服务端网关规则。
亿乐商品列表为空核对审核状态等过滤条件;本次 status=2 为空,status=1 有数据。
字段解析失败易客 params 与 ParamsTemplate 实测为数组;亿乐 params 与 logs 实测为字符串。
查询返回 code=0 但记录为空核对有效 ID。本次亿乐订单 id=0 也返回过空值对象。
订单提交超时先对账或查询,不根据网络错误直接重复创建。
出现 429 / 5xx原文未规定限速;只读查询可在业务允许时退避重试,写入需先确认结果。
公共说明

订单状态

以下易客枚举来自原文,状态转换约束未实测。亿乐不能复用易客枚举。

易客供应商端 state

说明
-1待付款
1已付款
2处理中
3异常
4已完成
5退单中
6已退单
7已退款
8待处理

易客客户端订单 state

说明
1待处理
2处理中
3已退单
4有异常
5退款中
6异常中
7已完成
9未使用
10退款

亿乐订单状态

响应和订单列表过滤使用 status,状态更改接口使用 old_status、new_status。以下为平台补充确认的状态定义。

状态码说明
1已付款
2待处理
3处理中
4补单中
5退单中
6已完成
7已退单
8已退款
9有异常

new_status = 8(已退款)时,refund_number 必传。状态值定义不代表任意两种状态之间均允许转换;状态转换约束未实测。

公共说明

实测差异记录

验证日期:2026-09-17。执行只读查询,包括使用 POST 的亿乐查询接口。

已验证的成功响应

接口实测结果
易客 API / 供应商端 · 商品列表实测列表返回 result.data 数组和 result.total;价格字段为 supplyPrice。原文示例是单个商品对象,不能直接作为当前列表结构使用。
易客 API / 供应商端 · 商品详情实测详情为 goodsSN / goodsName 等字段,ParamsTemplate 为数组。原文 Id / GoodsName / Gid 等字段属于旧示例,保留在原文对照中。
易客 API / 供应商端 · 订单列表实测 params 是数组,logs 仍为序列化 JSON 字符串。goodsSN、number 是字符串,orderSN 是整数。
易客 API / 供应商端 · 订单详情实测 params 是数组,logs 是字符串。不要对已经是数组的 params 再执行 JSON.parse。
亿乐 API / 供应商 · 商品列表实测 status = 1 可查到审核通过的商品;status = 2 本次返回空列表。分页记录位于 data.infos,总数位于 data.count。空列表不能说明签名失败。
亿乐 API / 供应商 · 订单列表实测 status = null 查询到已有订单。buy_params、status_changes 为数组,params、logs 为 JSON 字符串。订单状态不可套用易客的 state。
亿乐 API / 供应商 · 商品详情实测有效商品 id 返回 code = 0,id = 0 返回 code = 1、message = 商品无效。
亿乐 API / 供应商 · 订单详情有效订单 ID 的响应已验证。另一次 id = 0 查询仍返回 code = 0 和空值记录,因此不能仅以 code = 0 判断订单存在,应核对返回 id 及关键业务字段。

未确认范围

范围当前结论
易客客户端5 个查询接口认证失败,未获得成功字段结构。
写入类接口下单、退款、状态修改、商品修改未执行。请求定义来自原文。
回调未配置或触发推送,签名规则和字段来自原文。
全量枚举与可空性仅验证有限查询样本,未推断完整业务范围。
分页上限与限流未做压力或边界测试。
易客 API / 客户端

商品分类

本次凭据认证未通过

GET/api/client/goods/v2/category

本次请求返回 HTTP 200、业务 code = 403,提示 AppId 未找到。以下成功响应取自原文,需使用客户端所属会员凭据验证。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式GET
参数位置URL Query
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-TypeGET 示例不发送请求体
业务成功码100(易客)

Content-Type 原文值:未填写。当前查询示例按实际验证的传输方式编写。

原文未列出 Query 参数。本页示例不附加未定义参数。

成功响应(原文)

JSON
{
  "code": 100,
  "msg": "ok",
  "result": {
    "data": [
      {
        "categoryId": 1,
        "categoryName": "DY",
        "categoryThumb": "http://www.baidu.com/uploads/2022-06/16560595528229.png",
        "parentCategoryId": 0
      },
      {
        "categoryId": 12,
        "categoryName": "视屏号",
        "categoryThumb": "http://cms2.hengchengde.cn:5000/uploads/2022-06/16563241412957.png",
        "parentCategoryId": 0
      }
    ],
    "total": 367
  }
}
参数名示例值参数类型参数描述
categoryId-string分类id
categoryName-string分类名称
categoryThumb-string分类图片
parentCategoryId-string上级id

认证失败响应(实测)

JSON
{
  "code": 403,
  "msg": "接口认证失败,AppId 未找到(提示已简化)",
  "result": {
    "data": ""
  }
}

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/client/goods/v2/category',
    family="yike"
)
print(response)
原文地址与失败响应说明

http://接口域名/api/client/goods/v2/category

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 客户端

商品列表

本次凭据认证未通过

GET/api/client/goods/v2/goods/list

本次请求返回 HTTP 200、业务 code = 403,提示 AppId 未找到。以下成功响应取自原文,需使用客户端所属会员凭据验证。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式GET
参数位置URL Query
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-TypeGET 示例不发送请求体
业务成功码100(易客)

Content-Type 原文值:未填写。当前查询示例按实际验证的传输方式编写。

原文未列出 Query 参数。本页示例不附加未定义参数。

成功响应(原文)

JSON
{
  "code": 100,
  "msg": "ok",
  "result": {
    "data": [
      {
        "goodsSN": 1,
        "goodsName": "哈哈",
        "goodsThumb": "http://58.57sj.cn/upload/console/goods/5e942ea421b4ae146eb0ea2022095fda.png",
        "categoryId": 1,
        "categoryName": "DY"
      }
    ],
    "total": 3
  }
}
参数名示例值参数类型参数描述
goodsSN-string商品编号
goodsName-string商品名称
goodsThumb-string商品缩略图
categoryId-string分类id
categoryName-string分类名称

认证失败响应(实测)

JSON
{
  "code": 403,
  "msg": "接口认证失败,AppId 未找到(提示已简化)",
  "result": {
    "data": ""
  }
}

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/client/goods/v2/goods/list',
    family="yike"
)
print(response)
原文地址与失败响应说明

http://接口域名/api/client/goods/v2/goods/list

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 客户端

商品详情

本次凭据认证未通过

GET/api/client/goods/v2/goods

原文参数表写 paramsTemplate,响应示例写 ParamsTemplate。客户端成功响应尚未验证,不用供应商端字段替代客户端契约。

本次请求返回 HTTP 200、业务 code = 403,提示 AppId 未找到。以下成功响应取自原文,需使用客户端所属会员凭据验证。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式GET
参数位置URL Query
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-TypeGET 示例不发送请求体
业务成功码100(易客)

Content-Type 原文值:none。当前查询示例按实际验证的传输方式编写。

Query 参数

参数类型必填说明原文示例
goodsSNstring商品编号-

成功响应(原文)

JSON
{
  "code": 100,
  "msg": "ok",
  "result": {
    "goodsSN": 1,
    "goodsId": 1,
    "goodsName": "测试",
    "goodsThumb": "http://58.xxxxsj.cn/upload/console/goods/5e942ea421b4ae146eb0ea2022095fda.png",
    "goodsUnit": "个",
    "goodsDesc": "GoodsDesc",
    "minOrderNum": 2,
    "maxOrderNum": 10000,
    "goodsPrice": "1.3",
    "goodsDetail": " dddd",
    "goodsStock": 1000,
    "preUnitNum": 1,
    "ParamsTemplate": "[{\"alias\":\"作品链接\",\"assist\":\"input\",\"desc\":\"连接\",\"name\":\"连接111\",\"required\":true}]",
    "goodsType": 1,
    "canTui": "1",
    "canRepeat": 1,
    "categoryId": 1,
    "isClose": 2,
    "categoryName": "DY"
  }
}
参数名示例值参数类型参数描述
goodsSN-string商品编号
goodsName-string商品名称
goodsThumb-string商品缩略图
goodsUnit-string商品单位
goodsDesc-string商品简介
minOrderNum-string最低下单量
maxOrderNum-string最大下单量
categoryName-string分类名称
goodsPrice-string商品单价
goodsDetail-string商品详情
goodsStock-string库存数量
preUnitNum-string下单基数
paramsTemplate-string下单参数模板
name-string参数名称
alias-string参数别名
assist-string辅助填写
desc-string参数说明
goodsType-string商品类型2=卡密
canTui-string可以退单的状态
canRepeat-string是否可以重复下单,1:是,2:否
isClose-string是否关闭下单;1:关闭,2:开启

认证失败响应(实测)

JSON
{
  "code": 403,
  "msg": "接口认证失败,AppId 未找到(提示已简化)",
  "result": {
    "data": ""
  }
}

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/client/goods/v2/goods',
    query={'goodsSN': '10001'},
    family="yike"
)
print(response)
原文地址与失败响应说明

http://接口域名/api/client/goods/v2/goods?goodsSN=

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 客户端

下单

原文定义 · 未验证写入

POST/api/client/goods/v2/order

customOrderSN 按原文为必填且 40 位以内。成功示例已补齐 JSON 逗号;重试前应先确认原请求是否成功,避免重复下单。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码100(易客)

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明原文示例
goodsSNstring商品编号商品编号
customOrderSNstring自定义单号,防止重复下单,40位以内-
numberstring下单数量-
orderNotestring下单备注-
paramsstring下单参数-
namestring参数名称-
aliasstring参数别名-
valuestring参数值-

原文表中 number、params 标为 string,但正文示例分别为数字和数组。此写入未验证,接入时需确认服务端实际类型约束。

请求正文

JSON
{
  "goodsSN": "10",
  "number": 500,
  "orderNote": "下单",
  "customOrderSN": "dddddd",
  "params": [
    {
      "alias": "主页链接",
      "name": "作品连接",
      "value": "http://www.baidu.com"
    },
    {
      "alias": "时长",
      "name": "作品连接",
      "value": "2"
    }
  ]
}

成功响应(原文)

JSON
{
  "code": 100,
  "result": {
    "orderSN": "39292823123"
  },
  "msg": ""
}

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/client/goods/v2/order',
    method="POST",
    body={'goodsSN': '10',
     'number': 500,
     'orderNote': '下单',
     'customOrderSN': 'dddddd',
     'params': [{'alias': '主页链接',
                 'name': '作品连接',
                 'value': 'http://www.baidu.com'},
                {'alias': '时长', 'name': '作品连接', 'value': '2'}]},
    family="yike"
)
print(response)
原文地址与失败响应说明

http://接口域名/api/client/goods/v2/order

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 客户端

订单详情

本次凭据认证未通过

GET/api/client/goods/v2/order

客户端 state 枚举与供应商端不同,见订单状态。此处成功结构仍为原文定义。

本次请求返回 HTTP 200、业务 code = 403,提示 AppId 未找到。以下成功响应取自原文,需使用客户端所属会员凭据验证。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式GET
参数位置URL Query
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-TypeGET 示例不发送请求体
业务成功码100(易客)

Content-Type 原文值:未填写。当前查询示例按实际验证的传输方式编写。

Query 参数

参数类型必填说明原文示例
orderSNstring订单编号-

成功响应(原文)

JSON
{
  "code": 100,
  "msg": "ok",
  "result": {
    "orderSN": 84,
    "state": 7,
    "goodsSN": "3",
    "goodsName": "亿乐测试",
    "orderNum": "10",
    "orderRemark": "下单",
    "startNum": 0,
    "currentNum": 0,
    "finishTotal": 0,
    "price": "1.00300000",
    "orderAmount": "10.03000000",
    "refundAmount": "5.01500000",
    "refundNumber": 5,
    "params": "[{\"alias\":\"主页链接\",\"name\":\"作品连接\",\"value\":\"http://www.baidu.com\"},{\"alias\":\"评论内容\",\"name\":\"作品连接\",\"value\":\"dfdfdfdfdfdfdfd\"}]",
    "logs": "[{\"content\":\"状态为:创建订单\",\"createdAt\":\"2023-11-11 11:16:16\"},{\"content\":\"状态为:已退款\",\"createdAt\":\"2023-11-11 12:35:56\"}]",
    "createdAt": 1699672576,
    "cardNumber": ""
  }
}
参数名示例值参数类型参数描述
orderSN-string订单编号
state-string订单状态1:待处理 2:处理中 3:已退单 4:有异常 5:退款中 6: 异常中 7:已完成 9:未使用 10:退款
goodsSN-string商品编号
goodsName-string商品名称
orderNum-string下单数量
orderRemark-string备注
startNum-string开始数量
currentNum-string当前数量
finishTotal-string完成数量
price-string下单单价
orderAmount-string下单总金额
refundAmount-string退款金额
refundNumber-string退款数量
params-string下单参数
name-string参数名称
alias-string参数别名
value-string参数值
logs-string订单操作记录

认证失败响应(实测)

JSON
{
  "code": 403,
  "msg": "接口认证失败,AppId 未找到(提示已简化)",
  "result": {
    "data": ""
  }
}

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/client/goods/v2/order',
    query={'orderSN': '10001'},
    family="yike"
)
print(response)
原文地址与失败响应说明

http://接口域名/api/client/goods/v2/order?orderSN=

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 客户端

申请退款

原文定义 · 未验证写入

POST/api/client/goods/v2/order/state

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码100(易客)

Content-Type 原文值:未填写。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明原文示例
orderSNstring订单编号-

请求正文

JSON
{
  "orderSN": "10"
}

成功响应(原文)

JSON
{
  "code": 100,
  "result": "",
  "msg": "ok"
}

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/client/goods/v2/order/state',
    method="POST",
    body={'orderSN': '10'},
    family="yike"
)
print(response)
原文地址与失败响应说明

http://接口域名/api/client/goods/v2/order/state

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 客户端

账户信息

本次凭据认证未通过

GET/api/client/account/v2/profile

本次请求返回 HTTP 200、业务 code = 403,提示 AppId 未找到。以下成功响应取自原文,需使用客户端所属会员凭据验证。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式GET
参数位置URL Query
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-TypeGET 示例不发送请求体
业务成功码100(易客)

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

原文未列出 Query 参数。本页示例不附加未定义参数。

成功响应(原文)

JSON
{
  "code": 100,
  "msg": "ok",
  "result": {
    "balance": "1005.0150000000",
    "uid": 15737,
    "username": "huaxia12"
  }
}
参数名示例值参数类型参数描述
uid-string会员编号
username-string会员名称
balance-string账户余额

认证失败响应(实测)

JSON
{
  "code": 403,
  "msg": "接口认证失败,AppId 未找到(提示已简化)",
  "result": {
    "data": ""
  }
}

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/client/account/v2/profile',
    family="yike"
)
print(response)
原文地址与失败响应说明

http://接口域名/api/client/account/v2/profile

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 供应商端

订单退单

原文定义 · 未验证写入

POST/api/supplier/order/v2/refundTd

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码100(易客)

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明
orderSNstring原文未标注需要退单的订单编号。
remarksstring原文未标注退单备注。

请求正文

JSON
{
  "orderSN": "41",
  "remarks": "下单"
}

成功响应(原文)

原文未提供成功响应正文。

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/supplier/order/v2/refundTd',
    method="POST",
    body={'orderSN': '41', 'remarks': '下单'},
    family="yike"
)
print(response)
原文地址与失败响应说明

http://域名/api/supplier/order/v2/refundTd

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 供应商端

商品列表

实测成功 · 2026-09-17

GET/api/supplier/goods/v2/goods/list

实测列表返回 result.data 数组和 result.total;价格字段为 supplyPrice。原文示例是单个商品对象,不能直接作为当前列表结构使用。

原文接口状态:已完成。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式GET
参数位置URL Query
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-TypeGET 示例不发送请求体
业务成功码100(易客)

Content-Type 原文值:form-data。当前查询示例按实际验证的传输方式编写。

Query 参数

参数类型必填说明原文示例
goodsNamestring商品名称-
goodsSNstring商品id-
goodsStatestring商品审核状态1:通过,2:未审核,3:拒绝-
categoryIdstring一级类型id-
isClosestring是否关闭下单,2否,1:是-
limitstring每页条数100
pagestring第几页1

响应字段

以下类型来自 2026-09-17 的成功响应样本;不代表所有记录的可空范围。[] 表示数组元素。

字段路径实测类型说明
codeinteger业务状态码;易客成功为 100,亿乐成功为 0。
msgstring易客接口提示信息。
resultobject易客响应业务数据。
result.dataarray数据对象或分页记录,按所在层级区分。
result.data[].goodsSNinteger易客商品编号。
result.data[].goodsNamestring商品名称。
result.data[].goodsThumbstring商品图片地址,可能为空字符串。
result.data[].AddTimeinteger创建时间字段,integer;请按服务端约定解析。
result.data[].goodsUnitstring商品单位。
result.data[].goodsDescstring商品简介。
result.data[].goodsStateinteger商品审核状态;原文为 1 通过、2 未审核、3 拒绝。
result.data[].minOrderNuminteger最低下单量。
result.data[].maxOrderNuminteger最高下单量。
result.data[].supplyPricestring商品列表实测返回的供应价格字段;原文写作 goodsPrice。
result.data[].goodsDetailstring商品详情。
result.data[].goodsStockinteger库存数量;实测允许出现 -1,其业务含义未在原文定义。
result.data[].preUnitNuminteger下单基数。
result.data[].goodsTypeinteger商品类型;原文注明 2 为卡密。
result.data[].categoryIdinteger商品分类编号。
result.data[].isCloseinteger是否关闭下单;原文为 1 关闭、2 开启。
result.data[].categoryNamestring分类名称。
result.totalinteger易客分页记录总数。

成功响应示例

HTTP 200。结构与类型来自实测;编号、名称、金额和业务数值已替换,数组仅保留一项。

JSON
{
  "code": 100,
  "msg": "ok",
  "result": {
    "data": [
      {
        "goodsSN": 10001,
        "goodsName": "示例名称",
        "goodsThumb": "",
        "AddTime": 1760000000,
        "goodsUnit": "",
        "goodsDesc": "",
        "goodsState": 1,
        "minOrderNum": 1000,
        "maxOrderNum": 100000000,
        "supplyPrice": "1.00",
        "goodsDetail": "示例内容",
        "goodsStock": -1,
        "preUnitNum": 1,
        "goodsType": 1,
        "categoryId": 10001,
        "isClose": 2,
        "categoryName": "示例名称"
      }
    ],
    "total": 1
  }
}
原文响应定义对照
JSON
{
  "code": 100,
  "msg": "ok",
  "result": {
    "goodsSN": 1,
    "goodsName": "测试",
    "goodsThumb": "http://58.57sj.cn/upload/console/goods/5e942ea421b4ae146eb0ea2022095fda.png",
    "goodsUnit": "个",
    "goodsDesc": "GoodsDesc",
    "goodsState": 1,
    "minOrderNum": 2,
    "maxOrderNum": 10000,
    "goodsPrice": "1.00000000",
    "goodsDetail": "",
    "goodsStock": 1000,
    "preUnitNum": 1,
    "ParamsTemplate": "[{\"alias\":\"作品链接\",\"assist\":\"input\",\"desc\":\"连接\",\"name\":\"连接111\",\"required\":true}]",
    "goodsType": 1,
    "canTui": "1",
    "canRepeat": 1,
    "categoryId": 1,
    "isClose": 2,
    "categoryName": "DY"
  }
}
参数名示例值参数类型参数描述
code100integer-
msgokstring-
result-object-
result.goodsSN1integer商品编号
result.goodsName直客测试string商品名称
result.goodsThumbhttp://58.57sj.cn/upload/console/goods/5e942ea421b4ae146eb0ea2022095fda.pngstring商品缩略图
result.goodsUnitstring商品单位
result.goodsDescGoodsDescstring商品简介
result.goodsState1integer审核状态,1:通过,2:未审核,3:拒绝
result.minOrderNum2integer最低下单量
result.maxOrderNum10000integer最大下单量
result.goodsPrice1.00000000string商品单价
result.goodsDetail-string商品详情
result.goodsStock1000integer库存数量
result.preUnitNum1integer下单基数
result.ParamsTemplate[{“alias”:“作品链接”,“assist”:“input”,“desc”:“连接”,“name”:“连接111”,“required”:true}]string-
result.goodsType1integer商品类型2=卡密
result.canTui1string可以退单的状态
result.canRepeat1integer是否可以重复下单
result.categoryId1integer分类id
result.isClose2integer是否关闭下单;1:关闭,2:开启
result.categoryNameDYstring分类名称

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/supplier/goods/v2/goods/list',
    query={'limit': 10, 'page': 1},
    family="yike"
)
print(response)
原文地址与失败响应说明

http://接口域名/api/supplier/goods/v2/goods/list?goodsName=&goodsSN=&goodsState=&categoryId=&isClose=&limit=100&page=1

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 供应商端

商品详情

实测成功 · 2026-09-17

GET/api/supplier/goods/v2/goods

实测详情为 goodsSN / goodsName 等字段,ParamsTemplate 为数组。原文 Id / GoodsName / Gid 等字段属于旧示例,保留在原文对照中。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式GET
参数位置URL Query
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-TypeGET 示例不发送请求体
业务成功码100(易客)

Content-Type 原文值:none。当前查询示例按实际验证的传输方式编写。

Query 参数

参数类型必填说明原文示例
goodsSNstring商品编号-

响应字段

以下类型来自 2026-09-17 的成功响应样本;不代表所有记录的可空范围。[] 表示数组元素。

字段路径实测类型说明
codeinteger业务状态码;易客成功为 100,亿乐成功为 0。
msgstring易客接口提示信息。
resultobject易客响应业务数据。
result.goodsSNinteger易客商品编号。
result.goodsNamestring商品名称。
result.AddTimeinteger创建时间字段,integer;请按服务端约定解析。
result.goodsThumbstring商品图片地址,可能为空字符串。
result.goodsUnitstring商品单位。
result.goodsDescstring商品简介。
result.goodsStateinteger商品审核状态;原文为 1 通过、2 未审核、3 拒绝。
result.minOrderNuminteger最低下单量。
result.maxOrderNuminteger最高下单量。
result.goodsPricestring商品详情中的单价字符串。
result.goodsDetailstring商品详情。
result.goodsStockinteger库存数量;实测允许出现 -1,其业务含义未在原文定义。
result.preUnitNuminteger下单基数。
result.ParamsTemplatearray下单参数模板;本次供应商详情实测为数组。
result.ParamsTemplate[].aliasstring参数别名。
result.ParamsTemplate[].assiststring填写辅助类型,取值需依据商品模板。
result.ParamsTemplate[].descstring参数说明。
result.ParamsTemplate[].namestring名称,按商品或参数所在层级区分。
result.ParamsTemplate[].requiredboolean该模板参数是否必填。
result.goodsTypeinteger商品类型;原文注明 2 为卡密。
result.canTuistring可退单状态配置,可能为空字符串。
result.canRepeatinteger是否允许重复下单;原文为 1 是、2 否。
result.categoryIdinteger商品分类编号。
result.isCloseinteger是否关闭下单;原文为 1 关闭、2 开启。
result.categoryNamestring分类名称。

成功响应示例

HTTP 200。结构与类型来自实测;编号、名称、金额和业务数值已替换,数组仅保留一项。

JSON
{
  "code": 100,
  "msg": "ok",
  "result": {
    "goodsSN": 10001,
    "goodsName": "示例名称",
    "AddTime": 1760000000,
    "goodsThumb": "",
    "goodsUnit": "",
    "goodsDesc": "",
    "goodsState": 1,
    "minOrderNum": 1000,
    "maxOrderNum": 100000000,
    "goodsPrice": "1.00",
    "goodsDetail": "示例内容",
    "goodsStock": -1,
    "preUnitNum": 1,
    "ParamsTemplate": [
      {
        "alias": "示例内容",
        "assist": "示例内容",
        "desc": "示例内容",
        "name": "示例名称",
        "required": true
      }
    ],
    "goodsType": 1,
    "canTui": "",
    "canRepeat": 2,
    "categoryId": 10001,
    "isClose": 2,
    "categoryName": "示例名称"
  }
}
原文响应定义对照
JSON
{
  "code": 100,
  "msg": "ok",
  "result": {
    "Id": 1,
    "Gid": "758",
    "AddTime": 1698202421,
    "GoodsName": "11测试",
    "ShequId": 4,
    "IsClose": 2,
    "CategoryId3": 10,
    "CategoryId2": 3,
    "GoodsType": 1,
    "CategoryId": 1,
    "Sort": 1,
    "GoodsThumb": "http://58.57sj.cn/upload/console/goods/5e942ea421b4ae146eb0ea2022095fda.png",
    "GoodsPrice": "1.00000000",
    "ParamsTemplate": "[{\"description\":\"连接\",\"is_default\":false,\"key\":\"作品链接\",\"name\":\"连接111\",\"type\":1,\"type_config\":\"\",\"value\":{\"max\":1,\"min\":100}}]",
    "CanTui": "1",
    "CanRepeat": 1,
    "IsSecret": 1,
    "OtherName": "",
    "GoodsUnit": "个",
    "GongId": 71,
    "Bs": 1,
    "MinOrderNum": 2,
    "MaxOrderNum": 10000,
    "LimitMoney": "10.00",
    "LimitCount": -1,
    "GoodsDesc": "GoodsDesc",
    "GoodsDetail": "",
    "JiuwuType": "",
    "Lable": "Lable",
    "IsTb": 1,
    "IsIndex": 1,
    "IsTc": 1,
    "TcTitle": "TcTitle",
    "TcContent": "TcContent",
    "SfGoodsName": "SfGoodsName",
    "Bq": "Bq",
    "GoodsStock": 1000,
    "IsMx": 1,
    "MxSort": 1,
    "TbTime": 1698661781,
    "AuditStatus": 1,
    "SSupid": 0
  }
}
参数名示例值参数类型参数描述
code100integer-
msgokstring-
result-object-
result.Id1integer-
result.Gid758string-
result.AddTime1698202421integer创建时间
result.GoodsName11测试string商品名称
result.ShequId4integer-
result.IsClose2integer-
result.CategoryId310integer-
result.CategoryId23integer-
result.GoodsType1integer-
result.CategoryId1integer-
result.Sort1integer-
result.GoodsThumbhttp://58.57sj.cn/upload/console/goods/5e942ea421b4ae146eb0ea2022095fda.pngstring-
result.GoodsPrice1.00000000string-
result.ParamsTemplate[{“description”:“连接”,“is_default”:false,“key”:“作品链接”,“name”:“连接111”,“type”:1,“type_config”:““,”value”:{“max”:1,“min”:100}}]string-
result.CanTui1string-
result.CanRepeat1integer-
result.IsSecret1integer-
result.OtherName-string-
result.GoodsUnitstring-
result.GongId71integer-
result.Bs1integer-
result.MinOrderNum2integer-
result.MaxOrderNum10000integer-
result.LimitMoney10.00string-
result.LimitCount-1integer-
result.GoodsDescGoodsDescstring-
result.GoodsDetail-string-
result.JiuwuType-string-
result.LableLablestring-
result.IsTb1integer-
result.IsIndex1integer-
result.IsTc1integer-
result.TcTitleTcTitlestring-
result.TcContentTcContentstring-
result.SfGoodsNameSfGoodsNamestring-
result.BqBqstring-
result.GoodsStock1000integer-
result.IsMx1integer-
result.MxSort1integer-
result.TbTime1698661781integer-
result.AuditStatus1integer-
result.SSupid0integer-

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/supplier/goods/v2/goods',
    query={'goodsSN': '10001'},
    family="yike"
)
print(response)
原文地址与失败响应说明

http://接口域名/api/supplier/goods/v2/goods?goodsSN=

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 供应商端

订单列表

实测成功 · 2026-09-17

GET/api/supplier/order/v2/orders

实测 params 是数组,logs 仍为序列化 JSON 字符串。goodsSN、number 是字符串,orderSN 是整数。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式GET
参数位置URL Query
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-TypeGET 示例不发送请求体
业务成功码100(易客)

Content-Type 原文值:none。当前查询示例按实际验证的传输方式编写。

Query 参数

参数类型必填说明原文示例
pagestring页码,不填默认为1-
goodsSNstring商品编号-
orderSNstring订单编号-
statestring订单状态-
limitinteger每页显示的数量-

响应字段

以下类型来自 2026-09-17 的成功响应样本;不代表所有记录的可空范围。[] 表示数组元素。

字段路径实测类型说明
codeinteger业务状态码;易客成功为 100,亿乐成功为 0。
msgstring易客接口提示信息。
resultobject易客响应业务数据。
result.dataarray数据对象或分页记录,按所在层级区分。
result.data[].orderSNinteger易客订单编号。
result.data[].customOrderSNstring自定义订单号;原文要求 40 位以内,用于防止重复下单。
result.data[].stateinteger易客供应商订单状态,参见订单状态章节。
result.data[].buyUserIdinteger下单用户编号。
result.data[].goodsSNstring易客商品编号。
result.data[].goodsNamestring商品名称。
result.data[].numberstring订单数量;本次返回为字符串。
result.data[].orderRemarkstring订单备注。
result.data[].startNuminteger开始数量。
result.data[].currentNuminteger当前数量。
result.data[].finishTotalinteger完成数量。
result.data[].pricestring价格;不同接口可能是字符串或 JSON 数字,类型见本表。
result.data[].amountstring订单金额;不同接口类型不同,单位和精度需按所属接口确认。
result.data[].refundAmountstring退款金额字符串。
result.data[].refundNumberinteger退款数量。
result.data[].paramsarray订单参数;易客实测为数组,亿乐实测为 JSON 字符串。
result.data[].params[].aliasstring参数别名。
result.data[].params[].namestring名称,按商品或参数所在层级区分。
result.data[].params[].valuestring参数值。
result.data[].orderNotestring订单附加备注。
result.data[].logsstring操作记录;本次为字符串,内容可为序列化 JSON 数组。
result.data[].createdAtinteger创建时间字段,integer。
result.totalinteger易客分页记录总数。

成功响应示例

HTTP 200。结构与类型来自实测;编号、名称、金额和业务数值已替换,数组仅保留一项。

JSON
{
  "code": 100,
  "msg": "ok",
  "result": {
    "data": [
      {
        "orderSN": 10001,
        "customOrderSN": "10001",
        "state": 2,
        "buyUserId": 10001,
        "goodsSN": "10001",
        "goodsName": "示例名称",
        "number": "1000",
        "orderRemark": "",
        "startNum": 0,
        "currentNum": 100,
        "finishTotal": 100,
        "price": "1.00",
        "amount": "1000.00",
        "refundAmount": "0.00",
        "refundNumber": 0,
        "params": [
          {
            "alias": "示例内容",
            "name": "示例名称",
            "value": "https://example.com/image.png"
          }
        ],
        "orderNote": "",
        "logs": "[{\"content\":\"示例内容\",\"createdAt\":\"示例内容\"}]",
        "createdAt": 1760000000
      }
    ],
    "total": 1
  }
}
原文响应定义对照
JSON
{
  "code": 100,
  "msg": "ok",
  "result": {
    "data": [
      {
        "orderSN": 86,
        "customOrderSN": "202311113rBGhVNul",
        "state": 2,
        "buyUserId": 15737,
        "goodsSN": "3",
        "goodsName": "11测试",
        "number": "10",
        "orderRemark": "下单",
        "startNum": 0,
        "currentNum": 0,
        "finishTotal": 0,
        "price": "1.00300000",
        "amount": "10.03000000",
        "refundAmount": "0.00000000",
        "refundNumber": 0,
        "params": "[{\"alias\":\"主页链接\",\"name\":\"作品连接\",\"value\":\"http://www.baidu.com\"},{\"alias\":\"评论内容\",\"name\":\"作品连接\",\"value\":\"dfdfdfdfdfdfdfd\"}]",
        "orderNote": "",
        "logs": "[{\"content\":\"状态为:创建订单\",\"createdAt\":\"2023-11-11 11:20:25\"}]",
        "createdAt": 1699672825,
        "cardNumber": ""
      }
    ],
    "total": 3
  }
}
参数名示例值参数类型参数描述
code100integer-
msgokstring-
result-object-
result.data-array-
result.data.orderSN86integer订单编号
result.data.customOrderSN202311113rBGhVNulstring自定义单号,防止重复下单,40位以内
result.data.state2integer订单状态
result.data.buyUserId15737integer下单用户id
result.data.goodsSN3string商品编号
result.data.goodsName11测试string商品名称
result.data.number10string下单数量
result.data.orderRemark下单string备注
result.data.startNum0integer开始数量
result.data.currentNum0integer当前数量
result.data.finishTotal0integer完成数量
result.data.price1.00300000string下单单价
result.data.amount10.03000000string下单总金额
result.data.refundAmount0.00000000string退款金额
result.data.refundNumber0integer退款数量
result.data.params[{“alias”:“主页链接”,“name”:“作品连接”,“value”:“http://www.baidu.com”},{“alias”:“评论内容”,“name”:“作品连接”,“value”:“dfdfdfdfdfdfdfd”}]string下单参数
result.data.orderNote-string下单备注
result.data.logs[{“content”:“状态为:创建订单”,“createdAt”:“2023-11-11 11:20:25”}]string订单操作记录
result.data.createdAt1699672825integer-
result.data.cardNumber-string-
result.total3integer总数

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/supplier/order/v2/orders',
    query={'limit': 10, 'page': 1},
    family="yike"
)
print(response)
原文地址与失败响应说明

http://接口域名/api/supplier/order/v2/orders?page=&goodsSN=&orderSN=&state=&limit=

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 供应商端

订单详情

实测成功 · 2026-09-17

GET/api/supplier/order/v2/order

实测 params 是数组,logs 是字符串。不要对已经是数组的 params 再执行 JSON.parse。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式GET
参数位置URL Query
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-TypeGET 示例不发送请求体
业务成功码100(易客)

Content-Type 原文值:none。当前查询示例按实际验证的传输方式编写。

Query 参数

参数类型必填说明原文示例
orderSNstring订单编号-

响应字段

以下类型来自 2026-09-17 的成功响应样本;不代表所有记录的可空范围。[] 表示数组元素。

字段路径实测类型说明
codeinteger业务状态码;易客成功为 100,亿乐成功为 0。
msgstring易客接口提示信息。
resultobject易客响应业务数据。
result.orderSNinteger易客订单编号。
result.customOrderSNstring自定义订单号;原文要求 40 位以内,用于防止重复下单。
result.stateinteger易客供应商订单状态,参见订单状态章节。
result.buyUserIdinteger下单用户编号。
result.goodsSNstring易客商品编号。
result.goodsNamestring商品名称。
result.numberstring订单数量;本次返回为字符串。
result.orderRemarkstring订单备注。
result.startNuminteger开始数量。
result.currentNuminteger当前数量。
result.finishTotalinteger完成数量。
result.pricestring价格;不同接口可能是字符串或 JSON 数字,类型见本表。
result.amountstring订单金额;不同接口类型不同,单位和精度需按所属接口确认。
result.refundAmountstring退款金额字符串。
result.refundNumberinteger退款数量。
result.paramsarray订单参数;易客实测为数组,亿乐实测为 JSON 字符串。
result.params[].aliasstring参数别名。
result.params[].namestring名称,按商品或参数所在层级区分。
result.params[].valuestring参数值。
result.orderNotestring订单附加备注。
result.logsstring操作记录;本次为字符串,内容可为序列化 JSON 数组。
result.createdAtinteger创建时间字段,integer。

成功响应示例

HTTP 200。结构与类型来自实测;编号、名称、金额和业务数值已替换,数组仅保留一项。

JSON
{
  "code": 100,
  "msg": "ok",
  "result": {
    "orderSN": 10001,
    "customOrderSN": "10001",
    "state": 2,
    "buyUserId": 10001,
    "goodsSN": "10001",
    "goodsName": "示例名称",
    "number": "1000",
    "orderRemark": "",
    "startNum": 0,
    "currentNum": 100,
    "finishTotal": 100,
    "price": "1.00",
    "amount": "1000.00",
    "refundAmount": "0.00",
    "refundNumber": 0,
    "params": [
      {
        "alias": "示例内容",
        "name": "示例名称",
        "value": "https://example.com/image.png"
      }
    ],
    "orderNote": "",
    "logs": "[{\"content\":\"示例内容\",\"createdAt\":\"示例内容\"}]",
    "createdAt": 1760000000
  }
}
原文响应定义对照
JSON
{
  "code": 100,
  "msg": "ok",
  "result": {
    "orderSN": 84,
    "customOrderSN": "202311111bPES_70D",
    "state": 7,
    "buyUserId": 15737,
    "goodsSN": "3",
    "goodsName": "亿乐测试",
    "number": "10",
    "orderRemark": "下单",
    "startNum": 0,
    "currentNum": 0,
    "finishTotal": 0,
    "price": "1.00300000",
    "amount": "10.03000000",
    "refundAmount": "5.01500000",
    "refundNumber": 5,
    "params": "[{\"alias\":\"主页链接\",\"name\":\"作品连接\",\"value\":\"http://www.baidu.com\"},{\"alias\":\"评论内容\",\"name\":\"作品连接\",\"value\":\"dfdfdfdfdfdfdfd\"}]",
    "orderNote": "不要意思要退款",
    "logs": "[{\"content\":\"状态为:创建订单\",\"createdAt\":\"2023-11-11 11:16:16\"},{\"content\":\"状态为:已退款\",\"createdAt\":\"2023-11-11 12:35:56\"}]",
    "createdAt": 1699672576
  }
}
参数名示例值参数类型参数描述
code100integer-
msgokstring-
result-object-
result.orderSN84integer订单编号
result.customOrderSN202311111bPES_70Dstring自定义单号,防止重复下单,40位以内
result.state7integer订单状态
result.buyUserId15737integer-
result.goodsSN3string商品编号
result.goodsName亿乐测试string商品名称
result.number10string下单数量
result.orderRemark下单string备注
result.startNum0integer开始数量
result.currentNum0integer当前数量
result.finishTotal0integer完成数量
result.price1.00300000string下单单价
result.amount10.03000000string总价
result.refundAmount5.01500000string退款金额
result.refundNumber5integer退款数量
result.params[{“alias”:“主页链接”,“name”:“作品连接”,“value”:“http://www.baidu.com”},{“alias”:“评论内容”,“name”:“作品连接”,“value”:“dfdfdfdfdfdfdfd”}]string下单参数
result.orderNote不要意思要退款string下单备注
result.logs[{“content”:“状态为:创建订单”,“createdAt”:“2023-11-11 11:16:16”},{“content”:“状态为:已退款”,“createdAt”:“2023-11-11 12:35:56”}]string订单操作记录
result.createdAt1699672576integer创建时间

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/supplier/order/v2/order',
    query={'orderSN': '10001'},
    family="yike"
)
print(response)
原文地址与失败响应说明

http://接口域名/api/supplier/order/v2/order?orderSN=

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 供应商端

订单状态操作

原文定义 · 未验证写入

POST/api/supplier/order/v2/order

原文 state = 500 不在其状态表中,调用示例改为 2(处理中)。实际业务是否允许该状态转换未验证。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码100(易客)

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明原文示例
orderSNstring订单编号10
stateinteger-1:待付款,1:已付款,2:处理中,3:异常,4.已完成,5:退单中,6:已退单,7:已退款,8:待处理500
remarksstring备注信息下单

请求正文

JSON
{
  "orderSN": "10",
  "state": 2,
  "remarks": "下单"
}

成功响应(原文)

JSON
{
  "code": 100,
  "msg": "ok",
  "result": ""
}

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/supplier/order/v2/order',
    method="POST",
    body={'orderSN': '10', 'state': 2, 'remarks': '下单'},
    family="yike"
)
print(response)
原文地址与失败响应说明

http://接口域名/api/supplier/order/v2/order

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 供应商端

更新订单完成进度

原文定义 · 未验证写入

POST/api/supplier/order/v2/progress

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码100(易客)

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明原文示例
orderSNstring订单编号10
startNuminteger开始数量500
currentNuminteger当前数量600
remarksstring备注信息下单

请求正文

JSON
{
  "orderSN": 803583,
  "startNum": 602,
  "currentNum": 602,
  "remarks": ""
}
原文请求注释
  • orderSN、startNum、currentNum 必传。remarks 在原文参数表中也标为必填。

成功响应(原文)

JSON
{
  "code": 100,
  "msg": "ok",
  "result": ""
}

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/supplier/order/v2/progress',
    method="POST",
    body={'orderSN': 803583, 'startNum': 602, 'currentNum': 602, 'remarks': ''},
    family="yike"
)
print(response)
原文地址与失败响应说明

http://127.0.0.1:9991/api/supplier/order/v2/progress

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 供应商端

修改商品信息

原文定义 · 未验证写入

POST/api/supplier/goods/v2/goods

原文最低数量 600 大于最高数量 10,调用示例改为 minNum = 10、maxNum = 10000。修改接口未执行。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码100(易客)

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明原文示例
goodsSNstring商品编号10
pricestring下单单价500
minNuminteger最低下单量600
maxNuminteger最大下单量10
baseNuminteger下单基数10
closeboolean关闭下单 true或者falsetrue

请求正文

JSON
{
  "goodsSN": "10",
  "price": "500",
  "minNum": 10,
  "maxNum": 10000,
  "baseNum": 10,
  "close": true
}

成功响应(原文)

JSON
{
  "code": 100,
  "msg": "ok",
  "result": ""
}

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/supplier/goods/v2/goods',
    method="POST",
    body={'goodsSN': '10',
     'price': '500',
     'minNum': 10,
     'maxNum': 10000,
     'baseNum': 10,
     'close': True},
    family="yike"
)
print(response)
原文地址与失败响应说明

http://接口域名/api/supplier/goods/v2/goods

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 供应商端

订单退款

原文定义 · 未验证写入

POST/api/supplier/order/v2/refund

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码100(易客)

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明原文示例
orderSNstring订单编号10
numberinteger退单数量500
remarksstring备注信息下单

请求正文

JSON
{
  "orderSN": "10",
  "number": 500,
  "remarks": "下单"
}

成功响应(原文)

JSON
{
  "code": 100,
  "msg": "ok",
  "result": ""
}

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/api/supplier/order/v2/refund',
    method="POST",
    body={'orderSN': '10', 'number': 500, 'remarks': '下单'},
    family="yike"
)
print(response)
原文地址与失败响应说明

http://接口域名/api/supplier/order/v2/refund

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

易客 API / 供应商端

订单推送回调

原文定义

POST后台配置的推送地址

推送方向为平台 → 供应商后台配置的回调地址;不是调用服务域名上的固定路径。验签时使用完整回调 URL。原文未定义应答正文、重试策略和超时时间。

请求说明

项目说明
服务地址供应商后台设置的推送地址
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码原文未定义回调应答正文

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明原文示例
createdAtinteger创建时间1710816528
goodsNamestring商品名称供应商测试5
goodsSNinteger商品id164
goodsThumbstring商品图片-
numberinteger数量1
orderSNstring订单号202403192oujgmJuv
unitPricestring单价37.00000000

请求正文

JSON
{
  "createdAt": 1710816528,
  "goodsName": "供应商测试5",
  "goodsSN": 164,
  "goodsThumb": "",
  "number": 1,
  "orderSN": "202403192oujgmJuv",
  "unitPrice": "37.00000000"
}

成功响应(原文)

原文未提供成功响应正文。

原文地址与失败响应说明

xxxx

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

亿乐 API / 供应商

商品列表

实测成功 · 2026-09-17

POST/openapi/supplier/Goods/Paging

实测 status = 1 可查到审核通过的商品;status = 2 本次返回空列表。分页记录位于 data.infos,总数位于 data.count。空列表不能说明签名失败。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码0(亿乐查询实测)

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明原文示例
pageinteger-1
list_rowsinteger-200
idnull-null
statusinteger审核状态,1:通过,2:未审核,3:拒绝2
goods_category_idnull分类查询451

请求正文

JSON
{
  "page": 1,
  "list_rows": 10,
  "id": null,
  "status": 1,
  "goods_category_id": null
}
原文请求注释
  • 最大200页

响应字段

以下类型来自 2026-09-17 的成功响应样本;不代表所有记录的可空范围。[] 表示数组元素。

字段路径实测类型说明
codeinteger业务状态码;易客成功为 100,亿乐成功为 0。
messagestring亿乐接口提示信息。
dataobject数据对象或分页记录,按所在层级区分。
data.countinteger亿乐分页记录总数。
data.infosarray亿乐分页记录数组。
data.infos[].idinteger亿乐资源编号;取值应来自本系列列表接口。
data.infos[].supplier_infostring实测返回字段,原文未说明具体含义。
data.infos[].is_card_codeinteger实测返回字段,原文未说明具体含义。
data.infos[].is_closeinteger关闭下单配置;原文 1 关闭、2 开启。
data.infos[].refund_statusnull可退单状态配置;本次可为 null。 仅观察到 null,非空类型尚未确认。
data.infos[].namestring名称,按商品或参数所在层级区分。
data.infos[].tagstring实测返回字段,原文未说明具体含义。
data.infos[].weightinteger实测返回字段,原文未说明具体含义。
data.infos[].goods_category_infostring实测返回字段,原文未说明具体含义。
data.infos[].pricenumber价格;不同接口可能是字符串或 JSON 数字,类型见本表。
data.infos[].buy_max_limitinteger最大购买数量。
data.infos[].stockinteger实测返回字段,原文未说明具体含义。
data.infos[].create_timeinteger创建时间字段,integer。
data.infos[].statusinteger商品审核状态;原文 1 通过、2 未审核、3 拒绝。

成功响应示例

HTTP 200。结构与类型来自实测;编号、名称、金额和业务数值已替换,数组仅保留一项。

JSON
{
  "code": 0,
  "message": "ok",
  "data": {
    "count": 1,
    "infos": [
      {
        "id": 10001,
        "supplier_info": "示例内容",
        "is_card_code": 0,
        "is_close": 0,
        "refund_status": null,
        "name": "示例名称",
        "tag": "",
        "weight": 0,
        "goods_category_info": "示例内容",
        "price": 0.0,
        "buy_max_limit": 0,
        "stock": 0,
        "create_time": 1760000000,
        "status": 1
      }
    ]
  }
}
原文响应定义对照

原文未提供成功响应正文。

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/openapi/supplier/Goods/Paging',
    method="POST",
    body={'page': 1,
     'list_rows': 10,
     'id': None,
     'status': 1,
     'goods_category_id': None},
    family="yile"
)
print(response)
原文地址与失败响应说明

127.0.0.1:9991/openapi/supplier/Goods/Paging

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

亿乐 API / 供应商

商品详情

实测成功 · 2026-09-17

POST/openapi/supplier/Goods/Show

实测有效商品 id 返回 code = 0,id = 0 返回 code = 1、message = 商品无效。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码0(亿乐查询实测)

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明
idinteger原文未标注商品编号;从亿乐商品列表的 data.infos[].id 获取。

请求正文

JSON
{
  "id": 504
}

响应字段

以下类型来自 2026-09-17 的成功响应样本;不代表所有记录的可空范围。[] 表示数组元素。

字段路径实测类型说明
codeinteger业务状态码;易客成功为 100,亿乐成功为 0。
messagestring亿乐接口提示信息。
dataobject数据对象或分页记录,按所在层级区分。
data.idinteger亿乐资源编号;取值应来自本系列列表接口。
data.is_card_codeinteger实测返回字段,原文未说明具体含义。
data.goods_category_idinteger一级分类编号。
data.goods_category_id2integer二级分类编号。
data.goods_category_id3integer三级分类编号。
data.namestring名称,按商品或参数所在层级区分。
data.create_timeinteger创建时间字段,integer。
data.weightinteger实测返回字段,原文未说明具体含义。
data.pricenumber价格;不同接口可能是字符串或 JSON 数字,类型见本表。
data.stockinteger实测返回字段,原文未说明具体含义。
data.unitstring商品单位。
data.buy_min_limitinteger最小购买数量。
data.buy_max_limitinteger最大购买数量。
data.is_repeatinteger重复下单配置;原文 1 允许、2 不允许。
data.is_closeinteger关闭下单配置;原文 1 关闭、2 开启。
data.is_batchinteger实测返回字段,原文未说明具体含义。
data.refund_statusnull可退单状态配置;本次可为 null。 仅观察到 null,非空类型尚未确认。
data.image_urlsarray商品图片地址数组。
data.image_urls[]string商品图片地址数组。
data.particularsstring商品详情。
data.statusinteger商品审核状态;原文 1 通过、2 未审核、3 拒绝。
data.buy_paramsarray购买参数数组;空订单查询曾返回 null。
data.buy_params[].descriptionstring商品或参数描述。
data.buy_params[].keystring参数键名。
data.buy_params[].namestring名称,按商品或参数所在层级区分。
data.buy_params[].typeinteger参数控件类型;原文未提供完整枚举。
data.buy_params[].type_configstring参数控件配置。
data.buy_params[].valuestring参数值。
data.buy_params[].verifyobject参数校验配置。
data.buy_params[].verify.maxinteger校验上限;特殊值含义请按服务端配置确认。
data.buy_params[].verify.mininteger校验下限。
data.price_show_numinteger实测返回字段,原文未说明具体含义。
data.descriptionstring商品或参数描述。
data.goods_category_namestring分类名称。
data.buy_rateinteger购买数量基数。
data.goodsThumbstring商品图片地址,可能为空字符串。

成功响应示例

HTTP 200。结构与类型来自实测;编号、名称、金额和业务数值已替换,数组仅保留一项。

JSON
{
  "code": 0,
  "message": "ok",
  "data": {
    "id": 10001,
    "is_card_code": 0,
    "goods_category_id": 10001,
    "goods_category_id2": 0,
    "goods_category_id3": 0,
    "name": "示例名称",
    "create_time": 1760000000,
    "weight": 0,
    "price": 0.0,
    "stock": 0,
    "unit": "",
    "buy_min_limit": 0,
    "buy_max_limit": 0,
    "is_repeat": 0,
    "is_close": 0,
    "is_batch": 0,
    "refund_status": null,
    "image_urls": [
      ""
    ],
    "particulars": "",
    "status": 1,
    "buy_params": [
      {
        "description": "示例内容",
        "key": "示例内容",
        "name": "示例名称",
        "type": 0,
        "type_config": "",
        "value": "",
        "verify": {
          "max": 0,
          "min": 0
        }
      }
    ],
    "price_show_num": 0,
    "description": "",
    "goods_category_name": "示例名称",
    "buy_rate": 0,
    "goodsThumb": ""
  }
}
原文响应定义对照

原文未提供成功响应正文。

错误响应(实测)

id = 0 时返回 HTTP 200:

JSON
{
  "code": 1,
  "message": "商品无效",
  "data": ""
}

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/openapi/supplier/Goods/Show',
    method="POST",
    body={'id': 504},
    family="yile"
)
print(response)
原文地址与失败响应说明

127.0.0.1:9991/openapi/supplier/Goods/Show

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

亿乐 API / 供应商

修改商品

原文定义 · 未验证写入

POST/openapi/supplier/Goods/Edit

原文标为开发中;请求参数说明由原文 JSON 注释整理,必填规则未提供。

原文接口状态:开发中。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码写入未验证;同系列查询成功为 0

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

原文没有参数表;以下类型和说明由请求示例整理,必填性未验证。

参数示例类型说明(原文注释)
idinteger商品 ID
goods_category_idinteger一级分类
goods_category_id2integer二级分类
goods_category_id3integer三级分类
namestring商品名称
priceinteger金额
stockinteger库存
unitstring单位
buy_rateinteger下单倍数
buy_min_limitinteger最小购买数量
buy_max_limitinteger最大购买数量
is_repeatinteger1 可以重复下单、2 不允许
is_closeinteger1 关闭下单、2 开启
refund_statusarray可退单状态
image_urlsarray商品图片数组
particularsstring商品详情
buy_paramsarray购买参数数组

请求正文

JSON
{
  "id": 504,
  "goods_category_id": 4,
  "goods_category_id2": 4,
  "goods_category_id3": 4,
  "name": "测试供货1",
  "price": 11,
  "stock": 10,
  "unit": "2",
  "buy_rate": 3,
  "buy_min_limit": 4,
  "buy_max_limit": 5,
  "is_repeat": 1,
  "is_close": 2,
  "refund_status": [],
  "image_urls": [
    "wwww.aa.a"
  ],
  "particulars": "ddffssdfdsf",
  "buy_params": [
    {
      "type": 4,
      "value": "",
      "key": "1",
      "description": "eeee",
      "name": "eee",
      "type_config": "",
      "verify": {
        "min": 1,
        "max": -1
      }
    }
  ]
}
原文请求注释
  • id
  • 类别1
  • 类别2
  • 类别3
  • 商品名称
  • 金额
  • 库存
  • 单位
  • 下单倍数
  • 最小
  • 最大
  • 1:可以重复下单,2:不可以
  • 1:关闭下单,2:开启
  • 可以退的状态
  • 商品图片
  • 商品详情

成功响应(原文)

原文未提供成功响应正文。

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/openapi/supplier/Goods/Edit',
    method="POST",
    body={'id': 504,
     'goods_category_id': 4,
     'goods_category_id2': 4,
     'goods_category_id3': 4,
     'name': '测试供货1',
     'price': 11,
     'stock': 10,
     'unit': '2',
     'buy_rate': 3,
     'buy_min_limit': 4,
     'buy_max_limit': 5,
     'is_repeat': 1,
     'is_close': 2,
     'refund_status': [],
     'image_urls': ['wwww.aa.a'],
     'particulars': 'ddffssdfdsf',
     'buy_params': [{'type': 4,
                     'value': '',
                     'key': '1',
                     'description': 'eeee',
                     'name': 'eee',
                     'type_config': '',
                     'verify': {'min': 1, 'max': -1}}]},
    family="yile"
)
print(response)
原文地址与失败响应说明

127.0.0.1:9991/openapi/supplier/Goods/Edit

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

亿乐 API / 供应商

修改商品价格

原文定义 · 未验证写入

POST/openapi/supplier/Goods/EditPrice

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码写入未验证;同系列查询成功为 0

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明
idinteger原文未标注商品编号。
pricenumber原文未标注商品单价。

请求正文

JSON
{
  "id": 504,
  "price": 1.25
}
原文请求注释
  • 商品ID
  • 商品单价

成功响应(原文)

原文未提供成功响应正文。

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/openapi/supplier/Goods/EditPrice',
    method="POST",
    body={'id': 504, 'price': 1.25},
    family="yile"
)
print(response)
原文地址与失败响应说明

127.0.0.1:9991/openapi/supplier/Goods/EditPrice

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

亿乐 API / 供应商

订单列表

实测成功 · 2026-09-17

POST/openapi/supplier/Order/Paging

实测 status = null 查询到已有订单。buy_params、status_changes 为数组,params、logs 为 JSON 字符串。订单状态不可套用易客的 state。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码0(亿乐查询实测)

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明
pageinteger原文未标注页码;本次验证为 1。
list_rowsinteger原文未标注分页数量;本次验证为 1。原文注释写“最大200页”,上限未验证。
idinteger / null原文未标注订单 ID 过滤;本次列表查询传 null。
statusinteger / null原文未标注订单状态过滤:1 已付款;2 待处理;3 处理中;4 补单中;5 退单中;6 已完成;7 已退单;8 已退款;9 有异常。传 null 不限定状态,本次已验证。
goods_idinteger / null原文未标注商品过滤;本次传 null。

请求正文

JSON
{
  "page": 1,
  "list_rows": 10,
  "id": null,
  "status": null,
  "goods_id": null
}
原文请求注释
  • 最大200页

响应字段

以下类型来自 2026-09-17 的成功响应样本;不代表所有记录的可空范围。[] 表示数组元素。

字段路径实测类型说明
codeinteger业务状态码;易客成功为 100,亿乐成功为 0。
messagestring亿乐接口提示信息。
dataobject数据对象或分页记录,按所在层级区分。
data.countinteger亿乐分页记录总数。
data.infosarray亿乐分页记录数组。
data.infos[].idinteger亿乐资源编号;取值应来自本系列列表接口。
data.infos[].goods_idstring商品编号;本次响应为字符串。
data.infos[].statusinteger亿乐订单状态:1 已付款;2 待处理;3 处理中;4 补单中;5 退单中;6 已完成;7 已退单;8 已退款;9 有异常。
data.infos[].customer_idinteger客户编号。
data.infos[].selling_pricestring售价字符串。
data.infos[].amountinteger订单金额;不同接口类型不同,单位和精度需按所属接口确认。
data.infos[].buy_paramsarray购买参数数组;空订单查询曾返回 null。
data.infos[].buy_params[].descriptionstring商品或参数描述。
data.infos[].buy_params[].is_defaultboolean是否默认参数。
data.infos[].buy_params[].keystring参数键名。
data.infos[].buy_params[].namestring名称,按商品或参数所在层级区分。
data.infos[].buy_params[].typeinteger参数控件类型;原文未提供完整枚举。
data.infos[].buy_params[].type_configstring参数控件配置。
data.infos[].buy_params[].valuestring参数值。
data.infos[].buy_params[].verifyobject参数校验配置。
data.infos[].buy_params[].verify.maxinteger校验上限;特殊值含义请按服务端配置确认。
data.infos[].buy_params[].verify.mininteger校验下限。
data.infos[].buy_numberstring购买数量字符串。
data.infos[].refund_amountinteger退款金额;实测 integer,单位未在原文明确。
data.infos[].start_numinteger开始数量。
data.infos[].current_numinteger当前数量。
data.infos[].card_code_idsnull实测返回字段,原文未说明具体含义。 仅观察到 null,非空类型尚未确认。
data.infos[].create_timeinteger创建时间字段,integer。
data.infos[].ipstringIP 字段;公开示例已替换。
data.infos[].remarkstring备注。
data.infos[].goodsNamestring商品名称。
data.infos[].status_changesarray状态变更记录数组。
data.infos[].status_changes[].Atstring记录时间字符串。
data.infos[].status_changes[].Namestring记录说明。
data.infos[].refundNumberinteger退款数量。
data.infos[].paramsstring订单参数;易客实测为数组,亿乐实测为 JSON 字符串。
data.infos[].logsstring操作记录;本次为字符串,内容可为序列化 JSON 数组。
data.infos[].cardNumberstring卡密内容字段,可能为空。

成功响应示例

HTTP 200。结构与类型来自实测;编号、名称、金额和业务数值已替换,数组仅保留一项。

JSON
{
  "code": 0,
  "message": "ok",
  "data": {
    "count": 1,
    "infos": [
      {
        "id": 10001,
        "goods_id": "10001",
        "status": 3,
        "customer_id": 10001,
        "selling_price": "1.00",
        "amount": 0,
        "buy_params": [
          {
            "description": "示例内容",
            "is_default": false,
            "key": "示例内容",
            "name": "示例名称",
            "type": 0,
            "type_config": "",
            "value": "https://example.com/image.png",
            "verify": {
              "max": 0,
              "min": 0
            }
          }
        ],
        "buy_number": "1",
        "refund_amount": 0,
        "start_num": 0,
        "current_num": 100,
        "card_code_ids": null,
        "create_time": 1760000000,
        "ip": "192.0.2.1",
        "remark": "",
        "goodsName": "示例名称",
        "status_changes": [
          {
            "At": "示例内容",
            "Name": "示例名称"
          }
        ],
        "refundNumber": 0,
        "params": "[{\"alias\":\"示例内容\",\"name\":\"示例名称\",\"value\":\"https://example.com/image.png\"}]",
        "logs": "[{\"content\":\"示例内容\",\"createdAt\":\"示例内容\"}]",
        "cardNumber": ""
      }
    ]
  }
}
原文响应定义对照

原文未提供成功响应正文。

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/openapi/supplier/Order/Paging',
    method="POST",
    body={'page': 1, 'list_rows': 10, 'id': None, 'status': None, 'goods_id': None},
    family="yile"
)
print(response)
原文地址与失败响应说明

127.0.0.1:9991/openapi/supplier/Order/Paging

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

亿乐 API / 供应商

订单详情

实测成功 · 2026-09-17

POST/openapi/supplier/Order/Show

有效订单 ID 的响应已验证。另一次 id = 0 查询仍返回 code = 0 和空值记录,因此不能仅以 code = 0 判断订单存在,应核对返回 id 及关键业务字段。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码0(亿乐查询实测)

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明
idinteger原文未标注从本系列订单列表中取得有效订单 ID。

请求正文

JSON
{
  "id": 7
}

响应字段

以下类型来自 2026-09-17 的成功响应样本;不代表所有记录的可空范围。[] 表示数组元素。

字段路径实测类型说明
codeinteger业务状态码;易客成功为 100,亿乐成功为 0。
messagestring亿乐接口提示信息。
dataobject数据对象或分页记录,按所在层级区分。
data.idinteger亿乐资源编号;取值应来自本系列列表接口。
data.goods_idstring商品编号;本次响应为字符串。
data.statusinteger亿乐订单状态:1 已付款;2 待处理;3 处理中;4 补单中;5 退单中;6 已完成;7 已退单;8 已退款;9 有异常。
data.customer_idinteger客户编号。
data.selling_pricestring售价字符串。
data.amountinteger订单金额;不同接口类型不同,单位和精度需按所属接口确认。
data.buy_paramsarray购买参数数组;空订单查询曾返回 null。
data.buy_params[].descriptionstring商品或参数描述。
data.buy_params[].is_defaultboolean是否默认参数。
data.buy_params[].keystring参数键名。
data.buy_params[].namestring名称,按商品或参数所在层级区分。
data.buy_params[].typeinteger参数控件类型;原文未提供完整枚举。
data.buy_params[].type_configstring参数控件配置。
data.buy_params[].valuestring参数值。
data.buy_params[].verifyobject参数校验配置。
data.buy_params[].verify.maxinteger校验上限;特殊值含义请按服务端配置确认。
data.buy_params[].verify.mininteger校验下限。
data.buy_numberstring购买数量字符串。
data.refund_amountinteger退款金额;实测 integer,单位未在原文明确。
data.start_numinteger开始数量。
data.current_numinteger当前数量。
data.card_code_idsnull实测返回字段,原文未说明具体含义。 仅观察到 null,非空类型尚未确认。
data.create_timeinteger创建时间字段,integer。
data.ipstringIP 字段;公开示例已替换。
data.remarkstring备注。
data.goodsNamestring商品名称。
data.status_changesarray状态变更记录数组。
data.status_changes[].Atstring记录时间字符串。
data.status_changes[].Namestring记录说明。
data.refundNumberinteger退款数量。
data.paramsstring订单参数;易客实测为数组,亿乐实测为 JSON 字符串。
data.logsstring操作记录;本次为字符串,内容可为序列化 JSON 数组。
data.cardNumberstring卡密内容字段,可能为空。

成功响应示例

HTTP 200。结构与类型来自实测;编号、名称、金额和业务数值已替换,数组仅保留一项。

JSON
{
  "code": 0,
  "message": "ok",
  "data": {
    "id": 10001,
    "goods_id": "10001",
    "status": 3,
    "customer_id": 10001,
    "selling_price": "1.00",
    "amount": 0,
    "buy_params": [
      {
        "description": "示例内容",
        "is_default": false,
        "key": "示例内容",
        "name": "示例名称",
        "type": 0,
        "type_config": "",
        "value": "https://example.com/image.png",
        "verify": {
          "max": 0,
          "min": 0
        }
      }
    ],
    "buy_number": "1",
    "refund_amount": 0,
    "start_num": 0,
    "current_num": 100,
    "card_code_ids": null,
    "create_time": 1760000000,
    "ip": "192.0.2.1",
    "remark": "",
    "goodsName": "示例名称",
    "status_changes": [
      {
        "At": "示例内容",
        "Name": "示例名称"
      }
    ],
    "refundNumber": 0,
    "params": "[{\"alias\":\"示例内容\",\"name\":\"示例名称\",\"value\":\"https://example.com/image.png\"}]",
    "logs": "[{\"content\":\"示例内容\",\"createdAt\":\"示例内容\"}]",
    "cardNumber": ""
  }
}
原文响应定义对照

原文未提供成功响应正文。

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/openapi/supplier/Order/Show',
    method="POST",
    body={'id': 7},
    family="yile"
)
print(response)
原文地址与失败响应说明

127.0.0.1:9991/openapi/supplier/Order/Show

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

亿乐 API / 供应商

订单进度修改

原文定义 · 未验证写入

POST/openapi/supplier/Order/ScheduleHandle

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码写入未验证;同系列查询成功为 0

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明
idinteger原文未标注订单 ID。
start_numinteger原文未标注开始数量。
current_numinteger原文未标注当前数量。
remarkstring原文未标注备注。

请求正文

JSON
{
  "id": 7,
  "start_num": 10,
  "current_num": 100,
  "remark": "sdfsdfsadfdfsfdsfsd"
}

成功响应(原文)

原文未提供成功响应正文。

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/openapi/supplier/Order/ScheduleHandle',
    method="POST",
    body={'id': 7,
     'start_num': 10,
     'current_num': 100,
     'remark': 'sdfsdfsadfdfsfdsfsd'},
    family="yile"
)
print(response)
原文地址与失败响应说明

127.0.0.1:9991/openapi/supplier/Order/ScheduleHandle

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。

亿乐 API / 供应商

订单状态更改

原文定义 · 未验证写入

POST/openapi/supplier/Order/StatusHandle

new_status = 8 表示已退款,refund_number 必传;4 表示补单中。请使用亿乐订单状态表,不要混用易客 state。状态更改接口未执行,允许的状态转换仍需按业务规则确认。

请求说明

项目说明
服务地址https://www.yikesup.com
请求方式POST
参数位置JSON Body
请求头AppId、AppToken、AppTimestamp;签名规则见公共章节
Content-Typeapplication/json
业务成功码写入未验证;同系列查询成功为 0

Content-Type 原文值:json。当前查询示例按实际验证的传输方式编写。

Body 参数

参数类型必填说明
old_statusinteger原文未标注订单原状态:1 已付款;2 待处理;3 处理中;4 补单中;5 退单中;6 已完成;7 已退单;8 已退款;9 有异常。
new_statusinteger原文未标注订单目标状态:1 已付款;2 待处理;3 处理中;4 补单中;5 退单中;6 已完成;7 已退单;8 已退款;9 有异常。
idinteger原文未标注订单 ID。
remarkstring原文未标注备注。
refund_numberinteger条件必填new_status = 8(已退款)时原文要求必传。

请求正文

JSON
{
  "old_status": 3,
  "new_status": 8,
  "id": 7,
  "remark": "111111",
  "refund_number": 1
}
请求示例说明
  • old_status = 3 表示原状态为处理中。
  • new_status = 8 表示目标状态为已退款,此时 refund_number 必传。

成功响应(原文)

原文未提供成功响应正文。

调用示例

使用公共 Python 调用函数。商品和订单编号为占位示例,需替换为当前账户下的有效编号。

PYTHON
response = request_api(
    '/openapi/supplier/Order/StatusHandle',
    method="POST",
    body={'old_status': 3,
     'new_status': 8,
     'id': 7,
     'remark': '111111',
     'refund_number': 1},
    family="yile"
)
print(response)
原文地址与失败响应说明

127.0.0.1:9991/openapi/supplier/Order/StatusHandle

原文列出 HTTP 404 失败响应,但未提供正文。业务错误也可能通过 HTTP 200 返回,应同时检查业务 code。